diff --git a/.github/workflows/maven-publish.yml b/.github/workflows/maven-publish.yml index 235ba84..b3e9e04 100644 --- a/.github/workflows/maven-publish.yml +++ b/.github/workflows/maven-publish.yml @@ -35,14 +35,14 @@ jobs: distribution: 'temurin' java-version: '11' server-id: ossrh # Value of the distributionManagement/repository/id field of the pom.xml - server-username: MAVEN_USERNAME # env variable for username in deploy - server-password: MAVEN_CENTRAL_TOKEN # env variable for token in deploy + server-username: MAVEN_CENTRAL_USERNAME # env variable for username in deploy + server-password: MAVEN_CENTRAL_PASSWORD # env variable for token in deploy gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }} # Value of the GPG private key to import gpg-passphrase: MAVEN_GPG_PASSPHRASE # env variable for GPG private key passphrase - name: Publish to Apache Maven Central run: mvn deploy env: - MAVEN_USERNAME: ${{ vars.MAVEN_USERNAME }} - MAVEN_CENTRAL_TOKEN: ${{ secrets.MAVEN_CENTRAL_TOKEN }} + MAVEN_CENTRAL_USERNAME: ${{ secrets.MAVEN_CENTRAL_USERNAME }} + MAVEN_CENTRAL_PASSWORD: ${{ secrets.MAVEN_CENTRAL_PASSWORD }} MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }} diff --git a/README.md b/README.md index 56d0ad0..6f1c3fc 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,14 @@ # gate-api -Gate API v4 +Gate API -- API version: 4.98.0 -- SDK version: 6.98.0 +- API version: v4.105.8 +- SDK version: 7.1.8 Welcome to Gate API +APIv4 provides operations 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 spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. - - For more information, please visit [https://www.gate.io/page/contacts](https://www.gate.io/page/contacts) + For more information, please visit [https://www.gate.com/page/contacts](https://www.gate.com/page/contacts) *Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)* @@ -53,7 +52,7 @@ Add this dependency to your project's POM: io.gate gate-api - 6.98.0 + 7.1.8 compile ``` @@ -63,7 +62,7 @@ Add this dependency to your project's POM: Add this dependency to your project's build file: ```groovy -compile "io.gate:gate-api:6.98.0" +compile "io.gate:gate-api:7.1.8" ``` ### Others @@ -76,7 +75,7 @@ mvn clean package Then manually install the following JARs: -* `target/gate-api-6.98.0.jar` +* `target/gate-api-7.1.8.jar` * `target/lib/*.jar` To install the API client library to your local Maven repository, simply execute: @@ -141,292 +140,285 @@ All URIs are relative to *https://api.gateio.ws/api/v4* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- -*AccountApi* | [**getAccountDetail**](docs/AccountApi.md#getAccountDetail) | **GET** /account/detail | Get account detail +*AccountApi* | [**getAccountDetail**](docs/AccountApi.md#getAccountDetail) | **GET** /account/detail | Retrieve user account information *AccountApi* | [**getAccountRateLimit**](docs/AccountApi.md#getAccountRateLimit) | **GET** /account/rate_limit | Get user transaction rate limit information -*AccountApi* | [**listSTPGroups**](docs/AccountApi.md#listSTPGroups) | **GET** /account/stp_groups | List STP Groups -*AccountApi* | [**createSTPGroup**](docs/AccountApi.md#createSTPGroup) | **POST** /account/stp_groups | Create STP Group -*AccountApi* | [**listSTPGroupsUsers**](docs/AccountApi.md#listSTPGroupsUsers) | **GET** /account/stp_groups/{stp_id}/users | List users of the STP group -*AccountApi* | [**addSTPGroupUsers**](docs/AccountApi.md#addSTPGroupUsers) | **POST** /account/stp_groups/{stp_id}/users | Add users to the STP group -*AccountApi* | [**deleteSTPGroupUsers**](docs/AccountApi.md#deleteSTPGroupUsers) | **DELETE** /account/stp_groups/{stp_id}/users | Delete the user in the STP group -*AccountApi* | [**getDebitFee**](docs/AccountApi.md#getDebitFee) | **GET** /account/debit_fee | Query GT deduction configuration. -*AccountApi* | [**setDebitFee**](docs/AccountApi.md#setDebitFee) | **POST** /account/debit_fee | Set GT deduction. -*CollateralLoanApi* | [**listCollateralLoanOrders**](docs/CollateralLoanApi.md#listCollateralLoanOrders) | **GET** /loan/collateral/orders | List Orders -*CollateralLoanApi* | [**createCollateralLoan**](docs/CollateralLoanApi.md#createCollateralLoan) | **POST** /loan/collateral/orders | Place order -*CollateralLoanApi* | [**getCollateralLoanOrderDetail**](docs/CollateralLoanApi.md#getCollateralLoanOrderDetail) | **GET** /loan/collateral/orders/{order_id} | Get a single order -*CollateralLoanApi* | [**repayCollateralLoan**](docs/CollateralLoanApi.md#repayCollateralLoan) | **POST** /loan/collateral/repay | Repayment -*CollateralLoanApi* | [**listRepayRecords**](docs/CollateralLoanApi.md#listRepayRecords) | **GET** /loan/collateral/repay_records | Repayment history +*AccountApi* | [**listSTPGroups**](docs/AccountApi.md#listSTPGroups) | **GET** /account/stp_groups | Query STP user groups created by the user +*AccountApi* | [**createSTPGroup**](docs/AccountApi.md#createSTPGroup) | **POST** /account/stp_groups | Create STP user group +*AccountApi* | [**listSTPGroupsUsers**](docs/AccountApi.md#listSTPGroupsUsers) | **GET** /account/stp_groups/{stp_id}/users | Query users in the STP user group +*AccountApi* | [**addSTPGroupUsers**](docs/AccountApi.md#addSTPGroupUsers) | **POST** /account/stp_groups/{stp_id}/users | Add users to the STP user group +*AccountApi* | [**deleteSTPGroupUsers**](docs/AccountApi.md#deleteSTPGroupUsers) | **DELETE** /account/stp_groups/{stp_id}/users | Delete users from the STP user group +*AccountApi* | [**getDebitFee**](docs/AccountApi.md#getDebitFee) | **GET** /account/debit_fee | Query GT fee deduction configuration +*AccountApi* | [**setDebitFee**](docs/AccountApi.md#setDebitFee) | **POST** /account/debit_fee | Configure GT fee deduction +*CollateralLoanApi* | [**listCollateralLoanOrders**](docs/CollateralLoanApi.md#listCollateralLoanOrders) | **GET** /loan/collateral/orders | Query collateral loan order list +*CollateralLoanApi* | [**createCollateralLoan**](docs/CollateralLoanApi.md#createCollateralLoan) | **POST** /loan/collateral/orders | Place collateral loan order +*CollateralLoanApi* | [**getCollateralLoanOrderDetail**](docs/CollateralLoanApi.md#getCollateralLoanOrderDetail) | **GET** /loan/collateral/orders/{order_id} | Query single order details +*CollateralLoanApi* | [**repayCollateralLoan**](docs/CollateralLoanApi.md#repayCollateralLoan) | **POST** /loan/collateral/repay | Collateral loan repayment +*CollateralLoanApi* | [**listRepayRecords**](docs/CollateralLoanApi.md#listRepayRecords) | **GET** /loan/collateral/repay_records | Query collateral loan repayment records *CollateralLoanApi* | [**listCollateralRecords**](docs/CollateralLoanApi.md#listCollateralRecords) | **GET** /loan/collateral/collaterals | Query collateral adjustment records *CollateralLoanApi* | [**operateCollateral**](docs/CollateralLoanApi.md#operateCollateral) | **POST** /loan/collateral/collaterals | Increase or redeem collateral -*CollateralLoanApi* | [**getUserTotalAmount**](docs/CollateralLoanApi.md#getUserTotalAmount) | **GET** /loan/collateral/total_amount | Query the total borrowing and collateral amount for the user -*CollateralLoanApi* | [**getUserLtvInfo**](docs/CollateralLoanApi.md#getUserLtvInfo) | **GET** /loan/collateral/ltv | Query user's collateralization ratio +*CollateralLoanApi* | [**getUserTotalAmount**](docs/CollateralLoanApi.md#getUserTotalAmount) | **GET** /loan/collateral/total_amount | Query user's total borrowing and collateral amount +*CollateralLoanApi* | [**getUserLtvInfo**](docs/CollateralLoanApi.md#getUserLtvInfo) | **GET** /loan/collateral/ltv | Query user's collateralization ratio and remaining borrowable currencies *CollateralLoanApi* | [**listCollateralCurrencies**](docs/CollateralLoanApi.md#listCollateralCurrencies) | **GET** /loan/collateral/currencies | Query supported borrowing and collateral currencies -*DeliveryApi* | [**listDeliveryContracts**](docs/DeliveryApi.md#listDeliveryContracts) | **GET** /delivery/{settle}/contracts | List all futures contracts -*DeliveryApi* | [**getDeliveryContract**](docs/DeliveryApi.md#getDeliveryContract) | **GET** /delivery/{settle}/contracts/{contract} | Get a single contract -*DeliveryApi* | [**listDeliveryOrderBook**](docs/DeliveryApi.md#listDeliveryOrderBook) | **GET** /delivery/{settle}/order_book | Futures order book -*DeliveryApi* | [**listDeliveryTrades**](docs/DeliveryApi.md#listDeliveryTrades) | **GET** /delivery/{settle}/trades | Futures trading history -*DeliveryApi* | [**listDeliveryCandlesticks**](docs/DeliveryApi.md#listDeliveryCandlesticks) | **GET** /delivery/{settle}/candlesticks | Get futures candlesticks -*DeliveryApi* | [**listDeliveryTickers**](docs/DeliveryApi.md#listDeliveryTickers) | **GET** /delivery/{settle}/tickers | List futures tickers -*DeliveryApi* | [**listDeliveryInsuranceLedger**](docs/DeliveryApi.md#listDeliveryInsuranceLedger) | **GET** /delivery/{settle}/insurance | Futures insurance balance history -*DeliveryApi* | [**listDeliveryAccounts**](docs/DeliveryApi.md#listDeliveryAccounts) | **GET** /delivery/{settle}/accounts | Query futures account -*DeliveryApi* | [**listDeliveryAccountBook**](docs/DeliveryApi.md#listDeliveryAccountBook) | **GET** /delivery/{settle}/account_book | Query account book -*DeliveryApi* | [**listDeliveryPositions**](docs/DeliveryApi.md#listDeliveryPositions) | **GET** /delivery/{settle}/positions | List all positions of a user -*DeliveryApi* | [**getDeliveryPosition**](docs/DeliveryApi.md#getDeliveryPosition) | **GET** /delivery/{settle}/positions/{contract} | Get single position +*DeliveryApi* | [**listDeliveryContracts**](docs/DeliveryApi.md#listDeliveryContracts) | **GET** /delivery/{settle}/contracts | Query all futures contracts +*DeliveryApi* | [**getDeliveryContract**](docs/DeliveryApi.md#getDeliveryContract) | **GET** /delivery/{settle}/contracts/{contract} | Query single contract information +*DeliveryApi* | [**listDeliveryOrderBook**](docs/DeliveryApi.md#listDeliveryOrderBook) | **GET** /delivery/{settle}/order_book | Query futures market depth information +*DeliveryApi* | [**listDeliveryTrades**](docs/DeliveryApi.md#listDeliveryTrades) | **GET** /delivery/{settle}/trades | Futures market transaction records +*DeliveryApi* | [**listDeliveryCandlesticks**](docs/DeliveryApi.md#listDeliveryCandlesticks) | **GET** /delivery/{settle}/candlesticks | Futures market K-line chart +*DeliveryApi* | [**listDeliveryTickers**](docs/DeliveryApi.md#listDeliveryTickers) | **GET** /delivery/{settle}/tickers | Get all futures trading statistics +*DeliveryApi* | [**listDeliveryInsuranceLedger**](docs/DeliveryApi.md#listDeliveryInsuranceLedger) | **GET** /delivery/{settle}/insurance | Futures market insurance fund history +*DeliveryApi* | [**listDeliveryAccounts**](docs/DeliveryApi.md#listDeliveryAccounts) | **GET** /delivery/{settle}/accounts | Get futures account +*DeliveryApi* | [**listDeliveryAccountBook**](docs/DeliveryApi.md#listDeliveryAccountBook) | **GET** /delivery/{settle}/account_book | Query futures account change history +*DeliveryApi* | [**listDeliveryPositions**](docs/DeliveryApi.md#listDeliveryPositions) | **GET** /delivery/{settle}/positions | Get user position list +*DeliveryApi* | [**getDeliveryPosition**](docs/DeliveryApi.md#getDeliveryPosition) | **GET** /delivery/{settle}/positions/{contract} | Get single position information *DeliveryApi* | [**updateDeliveryPositionMargin**](docs/DeliveryApi.md#updateDeliveryPositionMargin) | **POST** /delivery/{settle}/positions/{contract}/margin | Update position margin *DeliveryApi* | [**updateDeliveryPositionLeverage**](docs/DeliveryApi.md#updateDeliveryPositionLeverage) | **POST** /delivery/{settle}/positions/{contract}/leverage | Update position leverage *DeliveryApi* | [**updateDeliveryPositionRiskLimit**](docs/DeliveryApi.md#updateDeliveryPositionRiskLimit) | **POST** /delivery/{settle}/positions/{contract}/risk_limit | Update position risk limit -*DeliveryApi* | [**listDeliveryOrders**](docs/DeliveryApi.md#listDeliveryOrders) | **GET** /delivery/{settle}/orders | List futures orders -*DeliveryApi* | [**createDeliveryOrder**](docs/DeliveryApi.md#createDeliveryOrder) | **POST** /delivery/{settle}/orders | Create a futures order -*DeliveryApi* | [**cancelDeliveryOrders**](docs/DeliveryApi.md#cancelDeliveryOrders) | **DELETE** /delivery/{settle}/orders | Cancel all `open` orders matched -*DeliveryApi* | [**getDeliveryOrder**](docs/DeliveryApi.md#getDeliveryOrder) | **GET** /delivery/{settle}/orders/{order_id} | Get a single order -*DeliveryApi* | [**cancelDeliveryOrder**](docs/DeliveryApi.md#cancelDeliveryOrder) | **DELETE** /delivery/{settle}/orders/{order_id} | Cancel a single order -*DeliveryApi* | [**getMyDeliveryTrades**](docs/DeliveryApi.md#getMyDeliveryTrades) | **GET** /delivery/{settle}/my_trades | List personal trading history -*DeliveryApi* | [**listDeliveryPositionClose**](docs/DeliveryApi.md#listDeliveryPositionClose) | **GET** /delivery/{settle}/position_close | List position close history -*DeliveryApi* | [**listDeliveryLiquidates**](docs/DeliveryApi.md#listDeliveryLiquidates) | **GET** /delivery/{settle}/liquidates | List liquidation history -*DeliveryApi* | [**listDeliverySettlements**](docs/DeliveryApi.md#listDeliverySettlements) | **GET** /delivery/{settle}/settlements | List settlement history -*DeliveryApi* | [**listDeliveryRiskLimitTiers**](docs/DeliveryApi.md#listDeliveryRiskLimitTiers) | **GET** /delivery/{settle}/risk_limit_tiers | List risk limit tiers -*DeliveryApi* | [**listPriceTriggeredDeliveryOrders**](docs/DeliveryApi.md#listPriceTriggeredDeliveryOrders) | **GET** /delivery/{settle}/price_orders | List All Price-triggered Orders -*DeliveryApi* | [**createPriceTriggeredDeliveryOrder**](docs/DeliveryApi.md#createPriceTriggeredDeliveryOrder) | **POST** /delivery/{settle}/price_orders | Create a price-triggered order -*DeliveryApi* | [**cancelPriceTriggeredDeliveryOrderList**](docs/DeliveryApi.md#cancelPriceTriggeredDeliveryOrderList) | **DELETE** /delivery/{settle}/price_orders | Cancel All Price-triggered Orders -*DeliveryApi* | [**getPriceTriggeredDeliveryOrder**](docs/DeliveryApi.md#getPriceTriggeredDeliveryOrder) | **GET** /delivery/{settle}/price_orders/{order_id} | Get a price-triggered order -*DeliveryApi* | [**cancelPriceTriggeredDeliveryOrder**](docs/DeliveryApi.md#cancelPriceTriggeredDeliveryOrder) | **DELETE** /delivery/{settle}/price_orders/{order_id} | cancel a price-triggered order +*DeliveryApi* | [**listDeliveryOrders**](docs/DeliveryApi.md#listDeliveryOrders) | **GET** /delivery/{settle}/orders | Query futures order list +*DeliveryApi* | [**createDeliveryOrder**](docs/DeliveryApi.md#createDeliveryOrder) | **POST** /delivery/{settle}/orders | Place futures order +*DeliveryApi* | [**cancelDeliveryOrders**](docs/DeliveryApi.md#cancelDeliveryOrders) | **DELETE** /delivery/{settle}/orders | Cancel all orders with 'open' status +*DeliveryApi* | [**getDeliveryOrder**](docs/DeliveryApi.md#getDeliveryOrder) | **GET** /delivery/{settle}/orders/{order_id} | Query single order details +*DeliveryApi* | [**cancelDeliveryOrder**](docs/DeliveryApi.md#cancelDeliveryOrder) | **DELETE** /delivery/{settle}/orders/{order_id} | Cancel single order +*DeliveryApi* | [**getMyDeliveryTrades**](docs/DeliveryApi.md#getMyDeliveryTrades) | **GET** /delivery/{settle}/my_trades | Query personal trading records +*DeliveryApi* | [**listDeliveryPositionClose**](docs/DeliveryApi.md#listDeliveryPositionClose) | **GET** /delivery/{settle}/position_close | Query position close history +*DeliveryApi* | [**listDeliveryLiquidates**](docs/DeliveryApi.md#listDeliveryLiquidates) | **GET** /delivery/{settle}/liquidates | Query liquidation history +*DeliveryApi* | [**listDeliverySettlements**](docs/DeliveryApi.md#listDeliverySettlements) | **GET** /delivery/{settle}/settlements | Query settlement records +*DeliveryApi* | [**listDeliveryRiskLimitTiers**](docs/DeliveryApi.md#listDeliveryRiskLimitTiers) | **GET** /delivery/{settle}/risk_limit_tiers | Query risk limit tiers +*DeliveryApi* | [**listPriceTriggeredDeliveryOrders**](docs/DeliveryApi.md#listPriceTriggeredDeliveryOrders) | **GET** /delivery/{settle}/price_orders | Query auto order list +*DeliveryApi* | [**createPriceTriggeredDeliveryOrder**](docs/DeliveryApi.md#createPriceTriggeredDeliveryOrder) | **POST** /delivery/{settle}/price_orders | Create price-triggered order +*DeliveryApi* | [**cancelPriceTriggeredDeliveryOrderList**](docs/DeliveryApi.md#cancelPriceTriggeredDeliveryOrderList) | **DELETE** /delivery/{settle}/price_orders | Cancel all auto orders +*DeliveryApi* | [**getPriceTriggeredDeliveryOrder**](docs/DeliveryApi.md#getPriceTriggeredDeliveryOrder) | **GET** /delivery/{settle}/price_orders/{order_id} | Query single auto order details +*DeliveryApi* | [**cancelPriceTriggeredDeliveryOrder**](docs/DeliveryApi.md#cancelPriceTriggeredDeliveryOrder) | **DELETE** /delivery/{settle}/price_orders/{order_id} | Cancel single auto order *EarnApi* | [**swapETH2**](docs/EarnApi.md#swapETH2) | **POST** /earn/staking/eth2/swap | ETH2 swap -*EarnApi* | [**rateListETH2**](docs/EarnApi.md#rateListETH2) | **GET** /earn/staking/eth2/rate_records | ETH2 historical rate of return query +*EarnApi* | [**rateListETH2**](docs/EarnApi.md#rateListETH2) | **GET** /earn/staking/eth2/rate_records | ETH2 historical return rate query *EarnApi* | [**listDualInvestmentPlans**](docs/EarnApi.md#listDualInvestmentPlans) | **GET** /earn/dual/investment_plan | Dual Investment product list *EarnApi* | [**listDualOrders**](docs/EarnApi.md#listDualOrders) | **GET** /earn/dual/orders | Dual Investment order list *EarnApi* | [**placeDualOrder**](docs/EarnApi.md#placeDualOrder) | **POST** /earn/dual/orders | Place Dual Investment order *EarnApi* | [**listStructuredProducts**](docs/EarnApi.md#listStructuredProducts) | **GET** /earn/structured/products | Structured Product List *EarnApi* | [**listStructuredOrders**](docs/EarnApi.md#listStructuredOrders) | **GET** /earn/structured/orders | Structured Product Order List *EarnApi* | [**placeStructuredOrder**](docs/EarnApi.md#placeStructuredOrder) | **POST** /earn/structured/orders | Place Structured Product Order -*EarnUniApi* | [**listUniCurrencies**](docs/EarnUniApi.md#listUniCurrencies) | **GET** /earn/uni/currencies | List currencies for lending -*EarnUniApi* | [**getUniCurrency**](docs/EarnUniApi.md#getUniCurrency) | **GET** /earn/uni/currencies/{currency} | Get currency detail for lending -*EarnUniApi* | [**listUserUniLends**](docs/EarnUniApi.md#listUserUniLends) | **GET** /earn/uni/lends | List user's lending orders -*EarnUniApi* | [**createUniLend**](docs/EarnUniApi.md#createUniLend) | **POST** /earn/uni/lends | Lend or redeem -*EarnUniApi* | [**changeUniLend**](docs/EarnUniApi.md#changeUniLend) | **PATCH** /earn/uni/lends | Amend lending order -*EarnUniApi* | [**listUniLendRecords**](docs/EarnUniApi.md#listUniLendRecords) | **GET** /earn/uni/lend_records | List records of lending -*EarnUniApi* | [**getUniInterest**](docs/EarnUniApi.md#getUniInterest) | **GET** /earn/uni/interests/{currency} | Get the user's total interest income of specified currency -*EarnUniApi* | [**listUniInterestRecords**](docs/EarnUniApi.md#listUniInterestRecords) | **GET** /earn/uni/interest_records | List interest records -*EarnUniApi* | [**switchInterestReinvest**](docs/EarnUniApi.md#switchInterestReinvest) | **PUT** /earn/uni/interest_reinvest | Set interest reinvestment toggle -*EarnUniApi* | [**getUniInterestStatus**](docs/EarnUniApi.md#getUniInterestStatus) | **GET** /earn/uni/interest_status/{currency} | query currency interest compounding status +*EarnApi* | [**findCoin**](docs/EarnApi.md#findCoin) | **GET** /earn/staking/coins | Staking coins +*EarnApi* | [**swapStakingCoin**](docs/EarnApi.md#swapStakingCoin) | **POST** /earn/staking/swap | On-chain token swap for earned coins +*EarnUniApi* | [**listUniCurrencies**](docs/EarnUniApi.md#listUniCurrencies) | **GET** /earn/uni/currencies | Query lending currency list +*EarnUniApi* | [**getUniCurrency**](docs/EarnUniApi.md#getUniCurrency) | **GET** /earn/uni/currencies/{currency} | Query single lending currency details +*EarnUniApi* | [**listUserUniLends**](docs/EarnUniApi.md#listUserUniLends) | **GET** /earn/uni/lends | Query user's lending order list +*EarnUniApi* | [**createUniLend**](docs/EarnUniApi.md#createUniLend) | **POST** /earn/uni/lends | Create lending or redemption +*EarnUniApi* | [**changeUniLend**](docs/EarnUniApi.md#changeUniLend) | **PATCH** /earn/uni/lends | Amend user lending information +*EarnUniApi* | [**listUniLendRecords**](docs/EarnUniApi.md#listUniLendRecords) | **GET** /earn/uni/lend_records | Query lending transaction records +*EarnUniApi* | [**getUniInterest**](docs/EarnUniApi.md#getUniInterest) | **GET** /earn/uni/interests/{currency} | Query user's total interest income for specified currency +*EarnUniApi* | [**listUniInterestRecords**](docs/EarnUniApi.md#listUniInterestRecords) | **GET** /earn/uni/interest_records | Query user dividend records +*EarnUniApi* | [**getUniInterestStatus**](docs/EarnUniApi.md#getUniInterestStatus) | **GET** /earn/uni/interest_status/{currency} | Query currency interest compounding status *EarnUniApi* | [**listUniChart**](docs/EarnUniApi.md#listUniChart) | **GET** /earn/uni/chart | UniLoan currency annualized trend chart -*EarnUniApi* | [**listUniRate**](docs/EarnUniApi.md#listUniRate) | **GET** /earn/uni/rate | Currency estimate annualized interest rate +*EarnUniApi* | [**listUniRate**](docs/EarnUniApi.md#listUniRate) | **GET** /earn/uni/rate | Currency estimated annualized interest rate *FlashSwapApi* | [**listFlashSwapCurrencyPair**](docs/FlashSwapApi.md#listFlashSwapCurrencyPair) | **GET** /flash_swap/currency_pairs | List All Supported Currency Pairs In Flash Swap -*FlashSwapApi* | [**listFlashSwapOrders**](docs/FlashSwapApi.md#listFlashSwapOrders) | **GET** /flash_swap/orders | List all flash swap orders +*FlashSwapApi* | [**listFlashSwapOrders**](docs/FlashSwapApi.md#listFlashSwapOrders) | **GET** /flash_swap/orders | Query flash swap order list *FlashSwapApi* | [**createFlashSwapOrder**](docs/FlashSwapApi.md#createFlashSwapOrder) | **POST** /flash_swap/orders | Create a flash swap order -*FlashSwapApi* | [**getFlashSwapOrder**](docs/FlashSwapApi.md#getFlashSwapOrder) | **GET** /flash_swap/orders/{order_id} | Get a single flash swap order's detail -*FlashSwapApi* | [**previewFlashSwapOrder**](docs/FlashSwapApi.md#previewFlashSwapOrder) | **POST** /flash_swap/orders/preview | Initiate a flash swap order preview -*FuturesApi* | [**listFuturesContracts**](docs/FuturesApi.md#listFuturesContracts) | **GET** /futures/{settle}/contracts | List all futures contracts -*FuturesApi* | [**getFuturesContract**](docs/FuturesApi.md#getFuturesContract) | **GET** /futures/{settle}/contracts/{contract} | Get a single contract -*FuturesApi* | [**listFuturesOrderBook**](docs/FuturesApi.md#listFuturesOrderBook) | **GET** /futures/{settle}/order_book | Futures order book -*FuturesApi* | [**listFuturesTrades**](docs/FuturesApi.md#listFuturesTrades) | **GET** /futures/{settle}/trades | Futures trading history -*FuturesApi* | [**listFuturesCandlesticks**](docs/FuturesApi.md#listFuturesCandlesticks) | **GET** /futures/{settle}/candlesticks | Get futures candlesticks -*FuturesApi* | [**listFuturesPremiumIndex**](docs/FuturesApi.md#listFuturesPremiumIndex) | **GET** /futures/{settle}/premium_index | Premium Index K-Line -*FuturesApi* | [**listFuturesTickers**](docs/FuturesApi.md#listFuturesTickers) | **GET** /futures/{settle}/tickers | List futures tickers -*FuturesApi* | [**listFuturesFundingRateHistory**](docs/FuturesApi.md#listFuturesFundingRateHistory) | **GET** /futures/{settle}/funding_rate | Funding rate history -*FuturesApi* | [**listFuturesInsuranceLedger**](docs/FuturesApi.md#listFuturesInsuranceLedger) | **GET** /futures/{settle}/insurance | Futures insurance balance history -*FuturesApi* | [**listContractStats**](docs/FuturesApi.md#listContractStats) | **GET** /futures/{settle}/contract_stats | Futures stats -*FuturesApi* | [**getIndexConstituents**](docs/FuturesApi.md#getIndexConstituents) | **GET** /futures/{settle}/index_constituents/{index} | Get index constituents -*FuturesApi* | [**listLiquidatedOrders**](docs/FuturesApi.md#listLiquidatedOrders) | **GET** /futures/{settle}/liq_orders | Retrieve liquidation history -*FuturesApi* | [**listFuturesRiskLimitTiers**](docs/FuturesApi.md#listFuturesRiskLimitTiers) | **GET** /futures/{settle}/risk_limit_tiers | List risk limit tiers -*FuturesApi* | [**listFuturesAccounts**](docs/FuturesApi.md#listFuturesAccounts) | **GET** /futures/{settle}/accounts | Query futures account -*FuturesApi* | [**listFuturesAccountBook**](docs/FuturesApi.md#listFuturesAccountBook) | **GET** /futures/{settle}/account_book | Query account book -*FuturesApi* | [**listPositions**](docs/FuturesApi.md#listPositions) | **GET** /futures/{settle}/positions | List all positions of a user -*FuturesApi* | [**getPosition**](docs/FuturesApi.md#getPosition) | **GET** /futures/{settle}/positions/{contract} | Get single position +*FlashSwapApi* | [**getFlashSwapOrder**](docs/FlashSwapApi.md#getFlashSwapOrder) | **GET** /flash_swap/orders/{order_id} | Query single flash swap order +*FlashSwapApi* | [**previewFlashSwapOrder**](docs/FlashSwapApi.md#previewFlashSwapOrder) | **POST** /flash_swap/orders/preview | Flash swap order preview +*FuturesApi* | [**listFuturesContracts**](docs/FuturesApi.md#listFuturesContracts) | **GET** /futures/{settle}/contracts | Query all futures contracts +*FuturesApi* | [**getFuturesContract**](docs/FuturesApi.md#getFuturesContract) | **GET** /futures/{settle}/contracts/{contract} | Query single contract information +*FuturesApi* | [**listFuturesOrderBook**](docs/FuturesApi.md#listFuturesOrderBook) | **GET** /futures/{settle}/order_book | Query futures market depth information +*FuturesApi* | [**listFuturesTrades**](docs/FuturesApi.md#listFuturesTrades) | **GET** /futures/{settle}/trades | Futures market transaction records +*FuturesApi* | [**listFuturesCandlesticks**](docs/FuturesApi.md#listFuturesCandlesticks) | **GET** /futures/{settle}/candlesticks | Futures market K-line chart +*FuturesApi* | [**listFuturesPremiumIndex**](docs/FuturesApi.md#listFuturesPremiumIndex) | **GET** /futures/{settle}/premium_index | Premium Index K-line chart +*FuturesApi* | [**listFuturesTickers**](docs/FuturesApi.md#listFuturesTickers) | **GET** /futures/{settle}/tickers | Get all futures trading statistics +*FuturesApi* | [**listFuturesFundingRateHistory**](docs/FuturesApi.md#listFuturesFundingRateHistory) | **GET** /futures/{settle}/funding_rate | Futures market historical funding rate +*FuturesApi* | [**listFuturesInsuranceLedger**](docs/FuturesApi.md#listFuturesInsuranceLedger) | **GET** /futures/{settle}/insurance | Futures market insurance fund history +*FuturesApi* | [**listContractStats**](docs/FuturesApi.md#listContractStats) | **GET** /futures/{settle}/contract_stats | Futures statistics +*FuturesApi* | [**getIndexConstituents**](docs/FuturesApi.md#getIndexConstituents) | **GET** /futures/{settle}/index_constituents/{index} | Query index constituents +*FuturesApi* | [**listLiquidatedOrders**](docs/FuturesApi.md#listLiquidatedOrders) | **GET** /futures/{settle}/liq_orders | Query liquidation order history +*FuturesApi* | [**listFuturesRiskLimitTiers**](docs/FuturesApi.md#listFuturesRiskLimitTiers) | **GET** /futures/{settle}/risk_limit_tiers | Query risk limit tiers +*FuturesApi* | [**listFuturesAccounts**](docs/FuturesApi.md#listFuturesAccounts) | **GET** /futures/{settle}/accounts | Get futures account +*FuturesApi* | [**listFuturesAccountBook**](docs/FuturesApi.md#listFuturesAccountBook) | **GET** /futures/{settle}/account_book | Query futures account change history +*FuturesApi* | [**listPositions**](docs/FuturesApi.md#listPositions) | **GET** /futures/{settle}/positions | Get user position list +*FuturesApi* | [**getPosition**](docs/FuturesApi.md#getPosition) | **GET** /futures/{settle}/positions/{contract} | Get single position information *FuturesApi* | [**updatePositionMargin**](docs/FuturesApi.md#updatePositionMargin) | **POST** /futures/{settle}/positions/{contract}/margin | Update position margin *FuturesApi* | [**updatePositionLeverage**](docs/FuturesApi.md#updatePositionLeverage) | **POST** /futures/{settle}/positions/{contract}/leverage | Update position leverage -*FuturesApi* | [**updatePositionCrossMode**](docs/FuturesApi.md#updatePositionCrossMode) | **POST** /futures/{settle}/positions/cross_mode | Switch to the full position-by-store mode +*FuturesApi* | [**updatePositionCrossMode**](docs/FuturesApi.md#updatePositionCrossMode) | **POST** /futures/{settle}/positions/cross_mode | Switch Position Margin Mode +*FuturesApi* | [**updateDualCompPositionCrossMode**](docs/FuturesApi.md#updateDualCompPositionCrossMode) | **POST** /futures/{settle}/dual_comp/positions/cross_mode | Switch Between Cross and Isolated Margin Modes Under Hedge Mode *FuturesApi* | [**updatePositionRiskLimit**](docs/FuturesApi.md#updatePositionRiskLimit) | **POST** /futures/{settle}/positions/{contract}/risk_limit | Update position risk limit -*FuturesApi* | [**setDualMode**](docs/FuturesApi.md#setDualMode) | **POST** /futures/{settle}/dual_mode | Enable or disable dual mode -*FuturesApi* | [**getDualModePosition**](docs/FuturesApi.md#getDualModePosition) | **GET** /futures/{settle}/dual_comp/positions/{contract} | Retrieve position detail in dual mode +*FuturesApi* | [**setDualMode**](docs/FuturesApi.md#setDualMode) | **POST** /futures/{settle}/dual_mode | Set position mode +*FuturesApi* | [**getDualModePosition**](docs/FuturesApi.md#getDualModePosition) | **GET** /futures/{settle}/dual_comp/positions/{contract} | Get position information in dual mode *FuturesApi* | [**updateDualModePositionMargin**](docs/FuturesApi.md#updateDualModePositionMargin) | **POST** /futures/{settle}/dual_comp/positions/{contract}/margin | Update position margin in dual mode *FuturesApi* | [**updateDualModePositionLeverage**](docs/FuturesApi.md#updateDualModePositionLeverage) | **POST** /futures/{settle}/dual_comp/positions/{contract}/leverage | Update position leverage in dual mode *FuturesApi* | [**updateDualModePositionRiskLimit**](docs/FuturesApi.md#updateDualModePositionRiskLimit) | **POST** /futures/{settle}/dual_comp/positions/{contract}/risk_limit | Update position risk limit in dual mode -*FuturesApi* | [**listFuturesOrders**](docs/FuturesApi.md#listFuturesOrders) | **GET** /futures/{settle}/orders | List futures orders -*FuturesApi* | [**createFuturesOrder**](docs/FuturesApi.md#createFuturesOrder) | **POST** /futures/{settle}/orders | Create a futures order -*FuturesApi* | [**cancelFuturesOrders**](docs/FuturesApi.md#cancelFuturesOrders) | **DELETE** /futures/{settle}/orders | Cancel all `open` orders matched -*FuturesApi* | [**getOrdersWithTimeRange**](docs/FuturesApi.md#getOrdersWithTimeRange) | **GET** /futures/{settle}/orders_timerange | List Futures Orders By Time Range -*FuturesApi* | [**createBatchFuturesOrder**](docs/FuturesApi.md#createBatchFuturesOrder) | **POST** /futures/{settle}/batch_orders | Create a batch of futures orders -*FuturesApi* | [**getFuturesOrder**](docs/FuturesApi.md#getFuturesOrder) | **GET** /futures/{settle}/orders/{order_id} | Get a single order -*FuturesApi* | [**amendFuturesOrder**](docs/FuturesApi.md#amendFuturesOrder) | **PUT** /futures/{settle}/orders/{order_id} | Amend an order -*FuturesApi* | [**cancelFuturesOrder**](docs/FuturesApi.md#cancelFuturesOrder) | **DELETE** /futures/{settle}/orders/{order_id} | Cancel a single order -*FuturesApi* | [**getMyTrades**](docs/FuturesApi.md#getMyTrades) | **GET** /futures/{settle}/my_trades | List personal trading history -*FuturesApi* | [**getMyTradesWithTimeRange**](docs/FuturesApi.md#getMyTradesWithTimeRange) | **GET** /futures/{settle}/my_trades_timerange | List personal trading history by time range -*FuturesApi* | [**listPositionClose**](docs/FuturesApi.md#listPositionClose) | **GET** /futures/{settle}/position_close | List position close history -*FuturesApi* | [**listLiquidates**](docs/FuturesApi.md#listLiquidates) | **GET** /futures/{settle}/liquidates | List liquidation history -*FuturesApi* | [**listAutoDeleverages**](docs/FuturesApi.md#listAutoDeleverages) | **GET** /futures/{settle}/auto_deleverages | List Auto-Deleveraging History +*FuturesApi* | [**listFuturesOrders**](docs/FuturesApi.md#listFuturesOrders) | **GET** /futures/{settle}/orders | Query futures order list +*FuturesApi* | [**createFuturesOrder**](docs/FuturesApi.md#createFuturesOrder) | **POST** /futures/{settle}/orders | Place futures order +*FuturesApi* | [**cancelFuturesOrders**](docs/FuturesApi.md#cancelFuturesOrders) | **DELETE** /futures/{settle}/orders | Cancel all orders with 'open' status +*FuturesApi* | [**getOrdersWithTimeRange**](docs/FuturesApi.md#getOrdersWithTimeRange) | **GET** /futures/{settle}/orders_timerange | Query futures order list by time range +*FuturesApi* | [**createBatchFuturesOrder**](docs/FuturesApi.md#createBatchFuturesOrder) | **POST** /futures/{settle}/batch_orders | Place batch futures orders +*FuturesApi* | [**getFuturesOrder**](docs/FuturesApi.md#getFuturesOrder) | **GET** /futures/{settle}/orders/{order_id} | Query single order details +*FuturesApi* | [**amendFuturesOrder**](docs/FuturesApi.md#amendFuturesOrder) | **PUT** /futures/{settle}/orders/{order_id} | Amend single order +*FuturesApi* | [**cancelFuturesOrder**](docs/FuturesApi.md#cancelFuturesOrder) | **DELETE** /futures/{settle}/orders/{order_id} | Cancel single order +*FuturesApi* | [**getMyTrades**](docs/FuturesApi.md#getMyTrades) | **GET** /futures/{settle}/my_trades | Query personal trading records +*FuturesApi* | [**getMyTradesWithTimeRange**](docs/FuturesApi.md#getMyTradesWithTimeRange) | **GET** /futures/{settle}/my_trades_timerange | Query personal trading records by time range +*FuturesApi* | [**listPositionClose**](docs/FuturesApi.md#listPositionClose) | **GET** /futures/{settle}/position_close | Query position close history +*FuturesApi* | [**listLiquidates**](docs/FuturesApi.md#listLiquidates) | **GET** /futures/{settle}/liquidates | Query liquidation history +*FuturesApi* | [**listAutoDeleverages**](docs/FuturesApi.md#listAutoDeleverages) | **GET** /futures/{settle}/auto_deleverages | Query ADL auto-deleveraging order information *FuturesApi* | [**countdownCancelAllFutures**](docs/FuturesApi.md#countdownCancelAllFutures) | **POST** /futures/{settle}/countdown_cancel_all | Countdown cancel orders -*FuturesApi* | [**getFuturesFee**](docs/FuturesApi.md#getFuturesFee) | **GET** /futures/{settle}/fee | Query user trading fee rates -*FuturesApi* | [**cancelBatchFutureOrders**](docs/FuturesApi.md#cancelBatchFutureOrders) | **POST** /futures/{settle}/batch_cancel_orders | Cancel a batch of orders with an ID list -*FuturesApi* | [**amendBatchFutureOrders**](docs/FuturesApi.md#amendBatchFutureOrders) | **POST** /futures/{settle}/batch_amend_orders | Batch modify orders with specified IDs -*FuturesApi* | [**listPriceTriggeredOrders**](docs/FuturesApi.md#listPriceTriggeredOrders) | **GET** /futures/{settle}/price_orders | List All Price-triggered Orders -*FuturesApi* | [**createPriceTriggeredOrder**](docs/FuturesApi.md#createPriceTriggeredOrder) | **POST** /futures/{settle}/price_orders | Create a price-triggered order -*FuturesApi* | [**cancelPriceTriggeredOrderList**](docs/FuturesApi.md#cancelPriceTriggeredOrderList) | **DELETE** /futures/{settle}/price_orders | Cancel All Price-triggered Orders -*FuturesApi* | [**getPriceTriggeredOrder**](docs/FuturesApi.md#getPriceTriggeredOrder) | **GET** /futures/{settle}/price_orders/{order_id} | Get a price-triggered order -*FuturesApi* | [**cancelPriceTriggeredOrder**](docs/FuturesApi.md#cancelPriceTriggeredOrder) | **DELETE** /futures/{settle}/price_orders/{order_id} | cancel a price-triggered order +*FuturesApi* | [**getFuturesFee**](docs/FuturesApi.md#getFuturesFee) | **GET** /futures/{settle}/fee | Query futures market trading fee rates +*FuturesApi* | [**cancelBatchFutureOrders**](docs/FuturesApi.md#cancelBatchFutureOrders) | **POST** /futures/{settle}/batch_cancel_orders | Cancel batch orders by specified ID list +*FuturesApi* | [**amendBatchFutureOrders**](docs/FuturesApi.md#amendBatchFutureOrders) | **POST** /futures/{settle}/batch_amend_orders | Batch modify orders by specified IDs +*FuturesApi* | [**getFuturesRiskLimitTable**](docs/FuturesApi.md#getFuturesRiskLimitTable) | **GET** /futures/{settle}/risk_limit_table | Query risk limit table by table_id +*FuturesApi* | [**listPriceTriggeredOrders**](docs/FuturesApi.md#listPriceTriggeredOrders) | **GET** /futures/{settle}/price_orders | Query auto order list +*FuturesApi* | [**createPriceTriggeredOrder**](docs/FuturesApi.md#createPriceTriggeredOrder) | **POST** /futures/{settle}/price_orders | Create price-triggered order +*FuturesApi* | [**cancelPriceTriggeredOrderList**](docs/FuturesApi.md#cancelPriceTriggeredOrderList) | **DELETE** /futures/{settle}/price_orders | Cancel all auto orders +*FuturesApi* | [**getPriceTriggeredOrder**](docs/FuturesApi.md#getPriceTriggeredOrder) | **GET** /futures/{settle}/price_orders/{order_id} | Query single auto order details +*FuturesApi* | [**cancelPriceTriggeredOrder**](docs/FuturesApi.md#cancelPriceTriggeredOrder) | **DELETE** /futures/{settle}/price_orders/{order_id} | Cancel single auto order *MarginApi* | [**listMarginAccounts**](docs/MarginApi.md#listMarginAccounts) | **GET** /margin/accounts | Margin account list -*MarginApi* | [**listMarginAccountBook**](docs/MarginApi.md#listMarginAccountBook) | **GET** /margin/account_book | List margin account balance change history +*MarginApi* | [**listMarginAccountBook**](docs/MarginApi.md#listMarginAccountBook) | **GET** /margin/account_book | Query margin account balance change history *MarginApi* | [**listFundingAccounts**](docs/MarginApi.md#listFundingAccounts) | **GET** /margin/funding_accounts | Funding account list -*MarginApi* | [**getAutoRepayStatus**](docs/MarginApi.md#getAutoRepayStatus) | **GET** /margin/auto_repay | Retrieve user auto repayment setting -*MarginApi* | [**setAutoRepay**](docs/MarginApi.md#setAutoRepay) | **POST** /margin/auto_repay | Update user's auto repayment setting -*MarginApi* | [**getMarginTransferable**](docs/MarginApi.md#getMarginTransferable) | **GET** /margin/transferable | Get the max transferable amount for a specific margin currency -*MarginApi* | [**listCrossMarginCurrencies**](docs/MarginApi.md#listCrossMarginCurrencies) | **GET** /margin/cross/currencies | Currencies supported by cross margin.(deprecated) -*MarginApi* | [**getCrossMarginCurrency**](docs/MarginApi.md#getCrossMarginCurrency) | **GET** /margin/cross/currencies/{currency} | Retrieve detail of one single currency supported by cross margin. (deprecated) -*MarginApi* | [**getCrossMarginAccount**](docs/MarginApi.md#getCrossMarginAccount) | **GET** /margin/cross/accounts | Retrieve cross margin account. (deprecated) -*MarginApi* | [**listCrossMarginAccountBook**](docs/MarginApi.md#listCrossMarginAccountBook) | **GET** /margin/cross/account_book | Retrieve cross margin account change history. (deprecated) -*MarginApi* | [**listCrossMarginLoans**](docs/MarginApi.md#listCrossMarginLoans) | **GET** /margin/cross/loans | List cross margin borrow history. (deprecated) -*MarginApi* | [**createCrossMarginLoan**](docs/MarginApi.md#createCrossMarginLoan) | **POST** /margin/cross/loans | Create a cross margin borrow loan. (deprecated) -*MarginApi* | [**getCrossMarginLoan**](docs/MarginApi.md#getCrossMarginLoan) | **GET** /margin/cross/loans/{loan_id} | Retrieve single borrow loan detail. (deprecated) +*MarginApi* | [**getAutoRepayStatus**](docs/MarginApi.md#getAutoRepayStatus) | **GET** /margin/auto_repay | Query user auto repayment settings +*MarginApi* | [**setAutoRepay**](docs/MarginApi.md#setAutoRepay) | **POST** /margin/auto_repay | Update user auto repayment settings +*MarginApi* | [**getMarginTransferable**](docs/MarginApi.md#getMarginTransferable) | **GET** /margin/transferable | Get maximum transferable amount for isolated margin +*MarginApi* | [**getUserMarginTier**](docs/MarginApi.md#getUserMarginTier) | **GET** /margin/user/loan_margin_tiers | Query user's own leverage lending tiers in current market +*MarginApi* | [**getMarketMarginTier**](docs/MarginApi.md#getMarketMarginTier) | **GET** /margin/loan_margin_tiers | Query current market leverage lending tiers +*MarginApi* | [**setUserMarketLeverage**](docs/MarginApi.md#setUserMarketLeverage) | **POST** /margin/leverage/user_market_setting | Set user market leverage multiplier +*MarginApi* | [**listMarginUserAccount**](docs/MarginApi.md#listMarginUserAccount) | **GET** /margin/user/account | Query user's isolated margin account list +*MarginApi* | [**listCrossMarginLoans**](docs/MarginApi.md#listCrossMarginLoans) | **GET** /margin/cross/loans | Query cross margin borrow history (deprecated) *MarginApi* | [**listCrossMarginRepayments**](docs/MarginApi.md#listCrossMarginRepayments) | **GET** /margin/cross/repayments | Retrieve cross margin repayments. (deprecated) -*MarginApi* | [**repayCrossMarginLoan**](docs/MarginApi.md#repayCrossMarginLoan) | **POST** /margin/cross/repayments | Cross margin repayments. (deprecated) -*MarginApi* | [**getCrossMarginInterestRecords**](docs/MarginApi.md#getCrossMarginInterestRecords) | **GET** /margin/cross/interest_records | Interest records for the cross margin account. (deprecated) -*MarginApi* | [**getCrossMarginTransferable**](docs/MarginApi.md#getCrossMarginTransferable) | **GET** /margin/cross/transferable | Get the max transferable amount for a specific cross margin currency. (deprecated) -*MarginApi* | [**getCrossMarginEstimateRate**](docs/MarginApi.md#getCrossMarginEstimateRate) | **GET** /margin/cross/estimate_rate | Estimated interest rates. (deprecated) -*MarginApi* | [**getCrossMarginBorrowable**](docs/MarginApi.md#getCrossMarginBorrowable) | **GET** /margin/cross/borrowable | Get the max borrowable amount for a specific cross margin currency. (deprecated) -*MarginApi* | [**getUserMarginTier**](docs/MarginApi.md#getUserMarginTier) | **GET** /margin/user/loan_margin_tiers | Check the user's own leverage lending gradient in the current market -*MarginApi* | [**getMarketMarginTier**](docs/MarginApi.md#getMarketMarginTier) | **GET** /margin/loan_margin_tiers | Query the current market leverage lending gradient -*MarginApi* | [**setUserMarketLeverage**](docs/MarginApi.md#setUserMarketLeverage) | **POST** /margin/leverage/user_market_setting | Set the user market leverage multiple -*MarginApi* | [**listMarginUserAccount**](docs/MarginApi.md#listMarginUserAccount) | **GET** /margin/user/account | Query the user's leverage account list *MarginUniApi* | [**listUniCurrencyPairs**](docs/MarginUniApi.md#listUniCurrencyPairs) | **GET** /margin/uni/currency_pairs | List lending markets -*MarginUniApi* | [**getUniCurrencyPair**](docs/MarginUniApi.md#getUniCurrencyPair) | **GET** /margin/uni/currency_pairs/{currency_pair} | Get detail of lending market -*MarginUniApi* | [**getMarginUniEstimateRate**](docs/MarginUniApi.md#getMarginUniEstimateRate) | **GET** /margin/uni/estimate_rate | Estimate interest Rate -*MarginUniApi* | [**listUniLoans**](docs/MarginUniApi.md#listUniLoans) | **GET** /margin/uni/loans | List loans +*MarginUniApi* | [**getUniCurrencyPair**](docs/MarginUniApi.md#getUniCurrencyPair) | **GET** /margin/uni/currency_pairs/{currency_pair} | Get lending market details +*MarginUniApi* | [**getMarginUniEstimateRate**](docs/MarginUniApi.md#getMarginUniEstimateRate) | **GET** /margin/uni/estimate_rate | Estimate interest rate for isolated margin currencies +*MarginUniApi* | [**listUniLoans**](docs/MarginUniApi.md#listUniLoans) | **GET** /margin/uni/loans | Query loans *MarginUniApi* | [**createUniLoan**](docs/MarginUniApi.md#createUniLoan) | **POST** /margin/uni/loans | Borrow or repay -*MarginUniApi* | [**listUniLoanRecords**](docs/MarginUniApi.md#listUniLoanRecords) | **GET** /margin/uni/loan_records | Get load records -*MarginUniApi* | [**listUniLoanInterestRecords**](docs/MarginUniApi.md#listUniLoanInterestRecords) | **GET** /margin/uni/interest_records | List interest records -*MarginUniApi* | [**getUniBorrowable**](docs/MarginUniApi.md#getUniBorrowable) | **GET** /margin/uni/borrowable | Get maximum borrowable -*MultiCollateralLoanApi* | [**listMultiCollateralOrders**](docs/MultiCollateralLoanApi.md#listMultiCollateralOrders) | **GET** /loan/multi_collateral/orders | List Multi-Collateral Orders -*MultiCollateralLoanApi* | [**createMultiCollateral**](docs/MultiCollateralLoanApi.md#createMultiCollateral) | **POST** /loan/multi_collateral/orders | Create Multi-Collateral Order -*MultiCollateralLoanApi* | [**getMultiCollateralOrderDetail**](docs/MultiCollateralLoanApi.md#getMultiCollateralOrderDetail) | **GET** /loan/multi_collateral/orders/{order_id} | Get Multi-Collateral Order Detail -*MultiCollateralLoanApi* | [**listMultiRepayRecords**](docs/MultiCollateralLoanApi.md#listMultiRepayRecords) | **GET** /loan/multi_collateral/repay | List Multi-Collateral Repay Records -*MultiCollateralLoanApi* | [**repayMultiCollateralLoan**](docs/MultiCollateralLoanApi.md#repayMultiCollateralLoan) | **POST** /loan/multi_collateral/repay | Repay Multi-Collateral Loan +*MarginUniApi* | [**listUniLoanRecords**](docs/MarginUniApi.md#listUniLoanRecords) | **GET** /margin/uni/loan_records | Query loan records +*MarginUniApi* | [**listUniLoanInterestRecords**](docs/MarginUniApi.md#listUniLoanInterestRecords) | **GET** /margin/uni/interest_records | Query interest deduction records +*MarginUniApi* | [**getUniBorrowable**](docs/MarginUniApi.md#getUniBorrowable) | **GET** /margin/uni/borrowable | Query maximum borrowable amount by currency +*MultiCollateralLoanApi* | [**listMultiCollateralOrders**](docs/MultiCollateralLoanApi.md#listMultiCollateralOrders) | **GET** /loan/multi_collateral/orders | Query multi-currency collateral order list +*MultiCollateralLoanApi* | [**createMultiCollateral**](docs/MultiCollateralLoanApi.md#createMultiCollateral) | **POST** /loan/multi_collateral/orders | Place multi-currency collateral order +*MultiCollateralLoanApi* | [**getMultiCollateralOrderDetail**](docs/MultiCollateralLoanApi.md#getMultiCollateralOrderDetail) | **GET** /loan/multi_collateral/orders/{order_id} | Query order details +*MultiCollateralLoanApi* | [**listMultiRepayRecords**](docs/MultiCollateralLoanApi.md#listMultiRepayRecords) | **GET** /loan/multi_collateral/repay | Query multi-currency collateral repayment records +*MultiCollateralLoanApi* | [**repayMultiCollateralLoan**](docs/MultiCollateralLoanApi.md#repayMultiCollateralLoan) | **POST** /loan/multi_collateral/repay | Multi-currency collateral repayment *MultiCollateralLoanApi* | [**listMultiCollateralRecords**](docs/MultiCollateralLoanApi.md#listMultiCollateralRecords) | **GET** /loan/multi_collateral/mortgage | Query collateral adjustment records -*MultiCollateralLoanApi* | [**operateMultiCollateral**](docs/MultiCollateralLoanApi.md#operateMultiCollateral) | **POST** /loan/multi_collateral/mortgage | Operate Multi-Collateral -*MultiCollateralLoanApi* | [**listUserCurrencyQuota**](docs/MultiCollateralLoanApi.md#listUserCurrencyQuota) | **GET** /loan/multi_collateral/currency_quota | List User Currency Quota -*MultiCollateralLoanApi* | [**listMultiCollateralCurrencies**](docs/MultiCollateralLoanApi.md#listMultiCollateralCurrencies) | **GET** /loan/multi_collateral/currencies | Query supported borrowing and collateral currencies in Multi-Collateral -*MultiCollateralLoanApi* | [**getMultiCollateralLtv**](docs/MultiCollateralLoanApi.md#getMultiCollateralLtv) | **GET** /loan/multi_collateral/ltv | Get Multi-Collateral ratio -*MultiCollateralLoanApi* | [**getMultiCollateralFixRate**](docs/MultiCollateralLoanApi.md#getMultiCollateralFixRate) | **GET** /loan/multi_collateral/fixed_rate | Query fixed interest rates for the currency for 7 days and 30 days -*MultiCollateralLoanApi* | [**getMultiCollateralCurrentRate**](docs/MultiCollateralLoanApi.md#getMultiCollateralCurrentRate) | **GET** /loan/multi_collateral/current_rate | Query the current interest rate of the currency -*OptionsApi* | [**listOptionsUnderlyings**](docs/OptionsApi.md#listOptionsUnderlyings) | **GET** /options/underlyings | List all underlyings -*OptionsApi* | [**listOptionsExpirations**](docs/OptionsApi.md#listOptionsExpirations) | **GET** /options/expirations | List all expiration times -*OptionsApi* | [**listOptionsContracts**](docs/OptionsApi.md#listOptionsContracts) | **GET** /options/contracts | List all the contracts with specified underlying and expiration time -*OptionsApi* | [**getOptionsContract**](docs/OptionsApi.md#getOptionsContract) | **GET** /options/contracts/{contract} | Query specified contract detail +*MultiCollateralLoanApi* | [**operateMultiCollateral**](docs/MultiCollateralLoanApi.md#operateMultiCollateral) | **POST** /loan/multi_collateral/mortgage | Add or withdraw collateral +*MultiCollateralLoanApi* | [**listUserCurrencyQuota**](docs/MultiCollateralLoanApi.md#listUserCurrencyQuota) | **GET** /loan/multi_collateral/currency_quota | Query user's collateral and borrowing currency quota information +*MultiCollateralLoanApi* | [**listMultiCollateralCurrencies**](docs/MultiCollateralLoanApi.md#listMultiCollateralCurrencies) | **GET** /loan/multi_collateral/currencies | Query supported borrowing and collateral currencies for multi-currency collateral +*MultiCollateralLoanApi* | [**getMultiCollateralLtv**](docs/MultiCollateralLoanApi.md#getMultiCollateralLtv) | **GET** /loan/multi_collateral/ltv | Query collateralization ratio information +*MultiCollateralLoanApi* | [**getMultiCollateralFixRate**](docs/MultiCollateralLoanApi.md#getMultiCollateralFixRate) | **GET** /loan/multi_collateral/fixed_rate | Query currency's 7-day and 30-day fixed interest rates +*MultiCollateralLoanApi* | [**getMultiCollateralCurrentRate**](docs/MultiCollateralLoanApi.md#getMultiCollateralCurrentRate) | **GET** /loan/multi_collateral/current_rate | Query currency's current interest rate +*OptionsApi* | [**listOptionsUnderlyings**](docs/OptionsApi.md#listOptionsUnderlyings) | **GET** /options/underlyings | List all underlying assets +*OptionsApi* | [**listOptionsExpirations**](docs/OptionsApi.md#listOptionsExpirations) | **GET** /options/expirations | List all expiration dates +*OptionsApi* | [**listOptionsContracts**](docs/OptionsApi.md#listOptionsContracts) | **GET** /options/contracts | List all contracts for specified underlying and expiration date +*OptionsApi* | [**getOptionsContract**](docs/OptionsApi.md#getOptionsContract) | **GET** /options/contracts/{contract} | Query specified contract details *OptionsApi* | [**listOptionsSettlements**](docs/OptionsApi.md#listOptionsSettlements) | **GET** /options/settlements | List settlement history -*OptionsApi* | [**getOptionsSettlement**](docs/OptionsApi.md#getOptionsSettlement) | **GET** /options/settlements/{contract} | Get specified contract's settlement -*OptionsApi* | [**listMyOptionsSettlements**](docs/OptionsApi.md#listMyOptionsSettlements) | **GET** /options/my_settlements | List my options settlements -*OptionsApi* | [**listOptionsOrderBook**](docs/OptionsApi.md#listOptionsOrderBook) | **GET** /options/order_book | Options order book -*OptionsApi* | [**listOptionsTickers**](docs/OptionsApi.md#listOptionsTickers) | **GET** /options/tickers | List tickers of options contracts -*OptionsApi* | [**listOptionsUnderlyingTickers**](docs/OptionsApi.md#listOptionsUnderlyingTickers) | **GET** /options/underlying/tickers/{underlying} | Get underlying ticker -*OptionsApi* | [**listOptionsCandlesticks**](docs/OptionsApi.md#listOptionsCandlesticks) | **GET** /options/candlesticks | Get options candlesticks -*OptionsApi* | [**listOptionsUnderlyingCandlesticks**](docs/OptionsApi.md#listOptionsUnderlyingCandlesticks) | **GET** /options/underlying/candlesticks | Mark price candlesticks of an underlying -*OptionsApi* | [**listOptionsTrades**](docs/OptionsApi.md#listOptionsTrades) | **GET** /options/trades | Options trade history -*OptionsApi* | [**listOptionsAccount**](docs/OptionsApi.md#listOptionsAccount) | **GET** /options/accounts | List options account -*OptionsApi* | [**listOptionsAccountBook**](docs/OptionsApi.md#listOptionsAccountBook) | **GET** /options/account_book | List account changing history +*OptionsApi* | [**getOptionsSettlement**](docs/OptionsApi.md#getOptionsSettlement) | **GET** /options/settlements/{contract} | Get specified contract settlement information +*OptionsApi* | [**listMyOptionsSettlements**](docs/OptionsApi.md#listMyOptionsSettlements) | **GET** /options/my_settlements | Query personal settlement records +*OptionsApi* | [**listOptionsOrderBook**](docs/OptionsApi.md#listOptionsOrderBook) | **GET** /options/order_book | Query options contract order book +*OptionsApi* | [**listOptionsTickers**](docs/OptionsApi.md#listOptionsTickers) | **GET** /options/tickers | Query options market ticker information +*OptionsApi* | [**listOptionsUnderlyingTickers**](docs/OptionsApi.md#listOptionsUnderlyingTickers) | **GET** /options/underlying/tickers/{underlying} | Query underlying ticker information +*OptionsApi* | [**listOptionsCandlesticks**](docs/OptionsApi.md#listOptionsCandlesticks) | **GET** /options/candlesticks | Options contract market candlestick chart +*OptionsApi* | [**listOptionsUnderlyingCandlesticks**](docs/OptionsApi.md#listOptionsUnderlyingCandlesticks) | **GET** /options/underlying/candlesticks | Underlying index price candlestick chart +*OptionsApi* | [**listOptionsTrades**](docs/OptionsApi.md#listOptionsTrades) | **GET** /options/trades | Market trade records +*OptionsApi* | [**listOptionsAccount**](docs/OptionsApi.md#listOptionsAccount) | **GET** /options/accounts | Query account information +*OptionsApi* | [**listOptionsAccountBook**](docs/OptionsApi.md#listOptionsAccountBook) | **GET** /options/account_book | Query account change history *OptionsApi* | [**listOptionsPositions**](docs/OptionsApi.md#listOptionsPositions) | **GET** /options/positions | List user's positions of specified underlying *OptionsApi* | [**getOptionsPosition**](docs/OptionsApi.md#getOptionsPosition) | **GET** /options/positions/{contract} | Get specified contract position *OptionsApi* | [**listOptionsPositionClose**](docs/OptionsApi.md#listOptionsPositionClose) | **GET** /options/position_close | List user's liquidation history of specified underlying *OptionsApi* | [**listOptionsOrders**](docs/OptionsApi.md#listOptionsOrders) | **GET** /options/orders | List options orders *OptionsApi* | [**createOptionsOrder**](docs/OptionsApi.md#createOptionsOrder) | **POST** /options/orders | Create an options order -*OptionsApi* | [**cancelOptionsOrders**](docs/OptionsApi.md#cancelOptionsOrders) | **DELETE** /options/orders | Cancel all `open` orders matched -*OptionsApi* | [**getOptionsOrder**](docs/OptionsApi.md#getOptionsOrder) | **GET** /options/orders/{order_id} | Get a single order -*OptionsApi* | [**cancelOptionsOrder**](docs/OptionsApi.md#cancelOptionsOrder) | **DELETE** /options/orders/{order_id} | Cancel a single order +*OptionsApi* | [**cancelOptionsOrders**](docs/OptionsApi.md#cancelOptionsOrders) | **DELETE** /options/orders | Cancel all orders with 'open' status +*OptionsApi* | [**getOptionsOrder**](docs/OptionsApi.md#getOptionsOrder) | **GET** /options/orders/{order_id} | Query single order details +*OptionsApi* | [**cancelOptionsOrder**](docs/OptionsApi.md#cancelOptionsOrder) | **DELETE** /options/orders/{order_id} | Cancel single order *OptionsApi* | [**countdownCancelAllOptions**](docs/OptionsApi.md#countdownCancelAllOptions) | **POST** /options/countdown_cancel_all | Countdown cancel orders -*OptionsApi* | [**listMyOptionsTrades**](docs/OptionsApi.md#listMyOptionsTrades) | **GET** /options/my_trades | List personal trading history -*OptionsApi* | [**getOptionsMMP**](docs/OptionsApi.md#getOptionsMMP) | **GET** /options/mmp | MMP Query +*OptionsApi* | [**listMyOptionsTrades**](docs/OptionsApi.md#listMyOptionsTrades) | **GET** /options/my_trades | Query personal trading records +*OptionsApi* | [**getOptionsMMP**](docs/OptionsApi.md#getOptionsMMP) | **GET** /options/mmp | MMP Query. *OptionsApi* | [**setOptionsMMP**](docs/OptionsApi.md#setOptionsMMP) | **POST** /options/mmp | MMP Settings *OptionsApi* | [**resetOptionsMMP**](docs/OptionsApi.md#resetOptionsMMP) | **POST** /options/mmp/reset | MMP Reset -*RebateApi* | [**agencyTransactionHistory**](docs/RebateApi.md#agencyTransactionHistory) | **GET** /rebate/agency/transaction_history | The agency obtains the transaction history of the recommended user -*RebateApi* | [**agencyCommissionsHistory**](docs/RebateApi.md#agencyCommissionsHistory) | **GET** /rebate/agency/commission_history | The agency obtains the commission history of the recommended user -*RebateApi* | [**partnerTransactionHistory**](docs/RebateApi.md#partnerTransactionHistory) | **GET** /rebate/partner/transaction_history | Partner obtains transaction records of recommended users -*RebateApi* | [**partnerCommissionsHistory**](docs/RebateApi.md#partnerCommissionsHistory) | **GET** /rebate/partner/commission_history | Partner obtains commission records of recommended users +*RebateApi* | [**agencyTransactionHistory**](docs/RebateApi.md#agencyTransactionHistory) | **GET** /rebate/agency/transaction_history | Broker obtains transaction history of recommended users +*RebateApi* | [**agencyCommissionsHistory**](docs/RebateApi.md#agencyCommissionsHistory) | **GET** /rebate/agency/commission_history | Broker obtains rebate history of recommended users +*RebateApi* | [**partnerTransactionHistory**](docs/RebateApi.md#partnerTransactionHistory) | **GET** /rebate/partner/transaction_history | Partner obtains transaction history of recommended users +*RebateApi* | [**partnerCommissionsHistory**](docs/RebateApi.md#partnerCommissionsHistory) | **GET** /rebate/partner/commission_history | Partner obtains rebate records of recommended users *RebateApi* | [**partnerSubList**](docs/RebateApi.md#partnerSubList) | **GET** /rebate/partner/sub_list | Partner subordinate list -*RebateApi* | [**rebateBrokerCommissionHistory**](docs/RebateApi.md#rebateBrokerCommissionHistory) | **GET** /rebate/broker/commission_history | The broker obtains the user's commission rebate records -*RebateApi* | [**rebateBrokerTransactionHistory**](docs/RebateApi.md#rebateBrokerTransactionHistory) | **GET** /rebate/broker/transaction_history | The broker obtains the user's trading history -*RebateApi* | [**rebateUserInfo**](docs/RebateApi.md#rebateUserInfo) | **GET** /rebate/user/info | User retrieves rebate information -*RebateApi* | [**userSubRelation**](docs/RebateApi.md#userSubRelation) | **GET** /rebate/user/sub_relation | User-subordinate relationship -*SpotApi* | [**listCurrencies**](docs/SpotApi.md#listCurrencies) | **GET** /spot/currencies | List all currencies' details -*SpotApi* | [**getCurrency**](docs/SpotApi.md#getCurrency) | **GET** /spot/currencies/{currency} | Get details of a specific currency -*SpotApi* | [**listCurrencyPairs**](docs/SpotApi.md#listCurrencyPairs) | **GET** /spot/currency_pairs | List all currency pairs supported -*SpotApi* | [**getCurrencyPair**](docs/SpotApi.md#getCurrencyPair) | **GET** /spot/currency_pairs/{currency_pair} | Get details of a specifc currency pair -*SpotApi* | [**listTickers**](docs/SpotApi.md#listTickers) | **GET** /spot/tickers | Retrieve ticker information -*SpotApi* | [**listOrderBook**](docs/SpotApi.md#listOrderBook) | **GET** /spot/order_book | Retrieve order book -*SpotApi* | [**listTrades**](docs/SpotApi.md#listTrades) | **GET** /spot/trades | Retrieve market trades -*SpotApi* | [**listCandlesticks**](docs/SpotApi.md#listCandlesticks) | **GET** /spot/candlesticks | Market candlesticks -*SpotApi* | [**getFee**](docs/SpotApi.md#getFee) | **GET** /spot/fee | Query user trading fee rates -*SpotApi* | [**getBatchSpotFee**](docs/SpotApi.md#getBatchSpotFee) | **GET** /spot/batch_fee | Query a batch of user trading fee rates -*SpotApi* | [**listSpotAccounts**](docs/SpotApi.md#listSpotAccounts) | **GET** /spot/accounts | List spot accounts -*SpotApi* | [**listSpotAccountBook**](docs/SpotApi.md#listSpotAccountBook) | **GET** /spot/account_book | Query account book -*SpotApi* | [**createBatchOrders**](docs/SpotApi.md#createBatchOrders) | **POST** /spot/batch_orders | Create a batch of orders +*RebateApi* | [**rebateBrokerCommissionHistory**](docs/RebateApi.md#rebateBrokerCommissionHistory) | **GET** /rebate/broker/commission_history | Broker obtains user's rebate records +*RebateApi* | [**rebateBrokerTransactionHistory**](docs/RebateApi.md#rebateBrokerTransactionHistory) | **GET** /rebate/broker/transaction_history | Broker obtains user's trading history +*RebateApi* | [**rebateUserInfo**](docs/RebateApi.md#rebateUserInfo) | **GET** /rebate/user/info | User obtains rebate information +*RebateApi* | [**userSubRelation**](docs/RebateApi.md#userSubRelation) | **GET** /rebate/user/sub_relation | User subordinate relationship +*SpotApi* | [**listCurrencies**](docs/SpotApi.md#listCurrencies) | **GET** /spot/currencies | Query all currency information +*SpotApi* | [**getCurrency**](docs/SpotApi.md#getCurrency) | **GET** /spot/currencies/{currency} | Query single currency information +*SpotApi* | [**listCurrencyPairs**](docs/SpotApi.md#listCurrencyPairs) | **GET** /spot/currency_pairs | Query all supported currency pairs +*SpotApi* | [**getCurrencyPair**](docs/SpotApi.md#getCurrencyPair) | **GET** /spot/currency_pairs/{currency_pair} | Query single currency pair details +*SpotApi* | [**listTickers**](docs/SpotApi.md#listTickers) | **GET** /spot/tickers | Get currency pair ticker information +*SpotApi* | [**listOrderBook**](docs/SpotApi.md#listOrderBook) | **GET** /spot/order_book | Get market depth information +*SpotApi* | [**listTrades**](docs/SpotApi.md#listTrades) | **GET** /spot/trades | Query market transaction records +*SpotApi* | [**listCandlesticks**](docs/SpotApi.md#listCandlesticks) | **GET** /spot/candlesticks | Market K-line chart +*SpotApi* | [**getFee**](docs/SpotApi.md#getFee) | **GET** /spot/fee | Query account fee rates +*SpotApi* | [**getBatchSpotFee**](docs/SpotApi.md#getBatchSpotFee) | **GET** /spot/batch_fee | Batch query account fee rates +*SpotApi* | [**listSpotAccounts**](docs/SpotApi.md#listSpotAccounts) | **GET** /spot/accounts | List spot trading accounts +*SpotApi* | [**listSpotAccountBook**](docs/SpotApi.md#listSpotAccountBook) | **GET** /spot/account_book | Query spot account transaction history +*SpotApi* | [**createBatchOrders**](docs/SpotApi.md#createBatchOrders) | **POST** /spot/batch_orders | Batch place orders *SpotApi* | [**listAllOpenOrders**](docs/SpotApi.md#listAllOpenOrders) | **GET** /spot/open_orders | List all open orders -*SpotApi* | [**createCrossLiquidateOrder**](docs/SpotApi.md#createCrossLiquidateOrder) | **POST** /spot/cross_liquidate_orders | close position when cross-currency is disabled +*SpotApi* | [**createCrossLiquidateOrder**](docs/SpotApi.md#createCrossLiquidateOrder) | **POST** /spot/cross_liquidate_orders | Close position when cross-currency is disabled *SpotApi* | [**listOrders**](docs/SpotApi.md#listOrders) | **GET** /spot/orders | List orders *SpotApi* | [**createOrder**](docs/SpotApi.md#createOrder) | **POST** /spot/orders | Create an order *SpotApi* | [**cancelOrders**](docs/SpotApi.md#cancelOrders) | **DELETE** /spot/orders | Cancel all `open` orders in specified currency pair -*SpotApi* | [**cancelBatchOrders**](docs/SpotApi.md#cancelBatchOrders) | **POST** /spot/cancel_batch_orders | Cancel a batch of orders with an ID list -*SpotApi* | [**getOrder**](docs/SpotApi.md#getOrder) | **GET** /spot/orders/{order_id} | Get a single order -*SpotApi* | [**cancelOrder**](docs/SpotApi.md#cancelOrder) | **DELETE** /spot/orders/{order_id} | Cancel a single order -*SpotApi* | [**amendOrder**](docs/SpotApi.md#amendOrder) | **PATCH** /spot/orders/{order_id} | Amend an order -*SpotApi* | [**listMyTrades**](docs/SpotApi.md#listMyTrades) | **GET** /spot/my_trades | List personal trading history +*SpotApi* | [**cancelBatchOrders**](docs/SpotApi.md#cancelBatchOrders) | **POST** /spot/cancel_batch_orders | Cancel batch orders by specified ID list +*SpotApi* | [**getOrder**](docs/SpotApi.md#getOrder) | **GET** /spot/orders/{order_id} | Query single order details +*SpotApi* | [**cancelOrder**](docs/SpotApi.md#cancelOrder) | **DELETE** /spot/orders/{order_id} | Cancel single order +*SpotApi* | [**amendOrder**](docs/SpotApi.md#amendOrder) | **PATCH** /spot/orders/{order_id} | Amend single order +*SpotApi* | [**listMyTrades**](docs/SpotApi.md#listMyTrades) | **GET** /spot/my_trades | Query personal trading records *SpotApi* | [**getSystemTime**](docs/SpotApi.md#getSystemTime) | **GET** /spot/time | Get server current time *SpotApi* | [**countdownCancelAllSpot**](docs/SpotApi.md#countdownCancelAllSpot) | **POST** /spot/countdown_cancel_all | Countdown cancel orders *SpotApi* | [**amendBatchOrders**](docs/SpotApi.md#amendBatchOrders) | **POST** /spot/amend_batch_orders | Batch modification of orders *SpotApi* | [**getSpotInsuranceHistory**](docs/SpotApi.md#getSpotInsuranceHistory) | **GET** /spot/insurance_history | Query spot insurance fund historical data -*SpotApi* | [**listSpotPriceTriggeredOrders**](docs/SpotApi.md#listSpotPriceTriggeredOrders) | **GET** /spot/price_orders | Retrieve running auto order list -*SpotApi* | [**createSpotPriceTriggeredOrder**](docs/SpotApi.md#createSpotPriceTriggeredOrder) | **POST** /spot/price_orders | Create a price-triggered order -*SpotApi* | [**cancelSpotPriceTriggeredOrderList**](docs/SpotApi.md#cancelSpotPriceTriggeredOrderList) | **DELETE** /spot/price_orders | Cancel All Price-triggered Orders -*SpotApi* | [**getSpotPriceTriggeredOrder**](docs/SpotApi.md#getSpotPriceTriggeredOrder) | **GET** /spot/price_orders/{order_id} | Get a price-triggered order -*SpotApi* | [**cancelSpotPriceTriggeredOrder**](docs/SpotApi.md#cancelSpotPriceTriggeredOrder) | **DELETE** /spot/price_orders/{order_id} | cancel a price-triggered order +*SpotApi* | [**listSpotPriceTriggeredOrders**](docs/SpotApi.md#listSpotPriceTriggeredOrders) | **GET** /spot/price_orders | Query running auto order list +*SpotApi* | [**createSpotPriceTriggeredOrder**](docs/SpotApi.md#createSpotPriceTriggeredOrder) | **POST** /spot/price_orders | Create price-triggered order +*SpotApi* | [**cancelSpotPriceTriggeredOrderList**](docs/SpotApi.md#cancelSpotPriceTriggeredOrderList) | **DELETE** /spot/price_orders | Cancel all auto orders +*SpotApi* | [**getSpotPriceTriggeredOrder**](docs/SpotApi.md#getSpotPriceTriggeredOrder) | **GET** /spot/price_orders/{order_id} | Query single auto order details +*SpotApi* | [**cancelSpotPriceTriggeredOrder**](docs/SpotApi.md#cancelSpotPriceTriggeredOrder) | **DELETE** /spot/price_orders/{order_id} | Cancel single auto order *SubAccountApi* | [**listSubAccounts**](docs/SubAccountApi.md#listSubAccounts) | **GET** /sub_accounts | List sub-accounts *SubAccountApi* | [**createSubAccounts**](docs/SubAccountApi.md#createSubAccounts) | **POST** /sub_accounts | Create a new sub-account -*SubAccountApi* | [**getSubAccount**](docs/SubAccountApi.md#getSubAccount) | **GET** /sub_accounts/{user_id} | Get the sub-account -*SubAccountApi* | [**listSubAccountKeys**](docs/SubAccountApi.md#listSubAccountKeys) | **GET** /sub_accounts/{user_id}/keys | List all API Key of the sub-account -*SubAccountApi* | [**createSubAccountKeys**](docs/SubAccountApi.md#createSubAccountKeys) | **POST** /sub_accounts/{user_id}/keys | Create API Key of the sub-account -*SubAccountApi* | [**getSubAccountKey**](docs/SubAccountApi.md#getSubAccountKey) | **GET** /sub_accounts/{user_id}/keys/{key} | Get the API Key of the sub-account -*SubAccountApi* | [**updateSubAccountKeys**](docs/SubAccountApi.md#updateSubAccountKeys) | **PUT** /sub_accounts/{user_id}/keys/{key} | Update API key of the sub-account -*SubAccountApi* | [**deleteSubAccountKeys**](docs/SubAccountApi.md#deleteSubAccountKeys) | **DELETE** /sub_accounts/{user_id}/keys/{key} | Delete API key of the sub-account -*SubAccountApi* | [**lockSubAccount**](docs/SubAccountApi.md#lockSubAccount) | **POST** /sub_accounts/{user_id}/lock | Lock the sub-account -*SubAccountApi* | [**unlockSubAccount**](docs/SubAccountApi.md#unlockSubAccount) | **POST** /sub_accounts/{user_id}/unlock | Unlock the sub-account +*SubAccountApi* | [**getSubAccount**](docs/SubAccountApi.md#getSubAccount) | **GET** /sub_accounts/{user_id} | Get sub-account +*SubAccountApi* | [**listSubAccountKeys**](docs/SubAccountApi.md#listSubAccountKeys) | **GET** /sub_accounts/{user_id}/keys | List all API key pairs of the sub-account +*SubAccountApi* | [**createSubAccountKeys**](docs/SubAccountApi.md#createSubAccountKeys) | **POST** /sub_accounts/{user_id}/keys | Create new sub-account API key pair +*SubAccountApi* | [**getSubAccountKey**](docs/SubAccountApi.md#getSubAccountKey) | **GET** /sub_accounts/{user_id}/keys/{key} | Get specific API key pair of the sub-account +*SubAccountApi* | [**updateSubAccountKeys**](docs/SubAccountApi.md#updateSubAccountKeys) | **PUT** /sub_accounts/{user_id}/keys/{key} | Update sub-account API key pair +*SubAccountApi* | [**deleteSubAccountKeys**](docs/SubAccountApi.md#deleteSubAccountKeys) | **DELETE** /sub_accounts/{user_id}/keys/{key} | Delete sub-account API key pair +*SubAccountApi* | [**lockSubAccount**](docs/SubAccountApi.md#lockSubAccount) | **POST** /sub_accounts/{user_id}/lock | Lock sub-account +*SubAccountApi* | [**unlockSubAccount**](docs/SubAccountApi.md#unlockSubAccount) | **POST** /sub_accounts/{user_id}/unlock | Unlock sub-account *SubAccountApi* | [**listUnifiedMode**](docs/SubAccountApi.md#listUnifiedMode) | **GET** /sub_accounts/unified_mode | Get sub-account mode *UnifiedApi* | [**listUnifiedAccounts**](docs/UnifiedApi.md#listUnifiedAccounts) | **GET** /unified/accounts | Get unified account information -*UnifiedApi* | [**getUnifiedBorrowable**](docs/UnifiedApi.md#getUnifiedBorrowable) | **GET** /unified/borrowable | Query about the maximum borrowing for the unified account -*UnifiedApi* | [**getUnifiedTransferable**](docs/UnifiedApi.md#getUnifiedTransferable) | **GET** /unified/transferable | Query about the maximum transferable for the unified account -*UnifiedApi* | [**getUnifiedTransferables**](docs/UnifiedApi.md#getUnifiedTransferables) | **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* | [**getUnifiedBorrowableList**](docs/UnifiedApi.md#getUnifiedBorrowableList) | **GET** /unified/batch_borrowable | Batch query unified account can be borrowed up to a maximum -*UnifiedApi* | [**listUnifiedLoans**](docs/UnifiedApi.md#listUnifiedLoans) | **GET** /unified/loans | List loans +*UnifiedApi* | [**getUnifiedBorrowable**](docs/UnifiedApi.md#getUnifiedBorrowable) | **GET** /unified/borrowable | Query maximum borrowable amount for unified account +*UnifiedApi* | [**getUnifiedTransferable**](docs/UnifiedApi.md#getUnifiedTransferable) | **GET** /unified/transferable | Query maximum transferable amount for unified account +*UnifiedApi* | [**getUnifiedTransferables**](docs/UnifiedApi.md#getUnifiedTransferables) | **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* | [**getUnifiedBorrowableList**](docs/UnifiedApi.md#getUnifiedBorrowableList) | **GET** /unified/batch_borrowable | Batch query unified account maximum borrowable amount +*UnifiedApi* | [**listUnifiedLoans**](docs/UnifiedApi.md#listUnifiedLoans) | **GET** /unified/loans | Query loans *UnifiedApi* | [**createUnifiedLoan**](docs/UnifiedApi.md#createUnifiedLoan) | **POST** /unified/loans | Borrow or repay -*UnifiedApi* | [**listUnifiedLoanRecords**](docs/UnifiedApi.md#listUnifiedLoanRecords) | **GET** /unified/loan_records | Get load records -*UnifiedApi* | [**listUnifiedLoanInterestRecords**](docs/UnifiedApi.md#listUnifiedLoanInterestRecords) | **GET** /unified/interest_records | List interest records +*UnifiedApi* | [**listUnifiedLoanRecords**](docs/UnifiedApi.md#listUnifiedLoanRecords) | **GET** /unified/loan_records | Query loan records +*UnifiedApi* | [**listUnifiedLoanInterestRecords**](docs/UnifiedApi.md#listUnifiedLoanInterestRecords) | **GET** /unified/interest_records | Query interest deduction records *UnifiedApi* | [**getUnifiedRiskUnits**](docs/UnifiedApi.md#getUnifiedRiskUnits) | **GET** /unified/risk_units | Get user risk unit details *UnifiedApi* | [**getUnifiedMode**](docs/UnifiedApi.md#getUnifiedMode) | **GET** /unified/unified_mode | Query mode of the unified account -*UnifiedApi* | [**setUnifiedMode**](docs/UnifiedApi.md#setUnifiedMode) | **PUT** /unified/unified_mode | Set mode of the unified account -*UnifiedApi* | [**getUnifiedEstimateRate**](docs/UnifiedApi.md#getUnifiedEstimateRate) | **GET** /unified/estimate_rate | Get unified estimate rate -*UnifiedApi* | [**listCurrencyDiscountTiers**](docs/UnifiedApi.md#listCurrencyDiscountTiers) | **GET** /unified/currency_discount_tiers | List currency discount tiers -*UnifiedApi* | [**listLoanMarginTiers**](docs/UnifiedApi.md#listLoanMarginTiers) | **GET** /unified/loan_margin_tiers | List loan margin tiers +*UnifiedApi* | [**setUnifiedMode**](docs/UnifiedApi.md#setUnifiedMode) | **PUT** /unified/unified_mode | Set unified account mode +*UnifiedApi* | [**getUnifiedEstimateRate**](docs/UnifiedApi.md#getUnifiedEstimateRate) | **GET** /unified/estimate_rate | Query unified account estimated interest rate +*UnifiedApi* | [**listCurrencyDiscountTiers**](docs/UnifiedApi.md#listCurrencyDiscountTiers) | **GET** /unified/currency_discount_tiers | Query unified account tiered +*UnifiedApi* | [**listLoanMarginTiers**](docs/UnifiedApi.md#listLoanMarginTiers) | **GET** /unified/loan_margin_tiers | Query unified account tiered loan margin *UnifiedApi* | [**calculatePortfolioMargin**](docs/UnifiedApi.md#calculatePortfolioMargin) | **POST** /unified/portfolio_calculator | Portfolio margin calculator -*UnifiedApi* | [**getUserLeverageCurrencyConfig**](docs/UnifiedApi.md#getUserLeverageCurrencyConfig) | **GET** /unified/leverage/user_currency_config | Minimum currency leverage that can be set -*UnifiedApi* | [**getUserLeverageCurrencySetting**](docs/UnifiedApi.md#getUserLeverageCurrencySetting) | **GET** /unified/leverage/user_currency_setting | Get the leverage multiple of the user currency -*UnifiedApi* | [**setUserLeverageCurrencySetting**](docs/UnifiedApi.md#setUserLeverageCurrencySetting) | **POST** /unified/leverage/user_currency_setting | Set the loan currency leverage +*UnifiedApi* | [**getUserLeverageCurrencyConfig**](docs/UnifiedApi.md#getUserLeverageCurrencyConfig) | **GET** /unified/leverage/user_currency_config | Maximum and minimum currency leverage that can be set +*UnifiedApi* | [**getUserLeverageCurrencySetting**](docs/UnifiedApi.md#getUserLeverageCurrencySetting) | **GET** /unified/leverage/user_currency_setting | Get user currency leverage +*UnifiedApi* | [**setUserLeverageCurrencySetting**](docs/UnifiedApi.md#setUserLeverageCurrencySetting) | **POST** /unified/leverage/user_currency_setting | Set loan currency leverage *UnifiedApi* | [**listUnifiedCurrencies**](docs/UnifiedApi.md#listUnifiedCurrencies) | **GET** /unified/currencies | List of loan currencies supported by unified account -*UnifiedApi* | [**getHistoryLoanRate**](docs/UnifiedApi.md#getHistoryLoanRate) | **GET** /unified/history_loan_rate | get historical lending rates -*WalletApi* | [**listCurrencyChains**](docs/WalletApi.md#listCurrencyChains) | **GET** /wallet/currency_chains | List chains supported for specified currency +*UnifiedApi* | [**getHistoryLoanRate**](docs/UnifiedApi.md#getHistoryLoanRate) | **GET** /unified/history_loan_rate | Get historical lending rates +*UnifiedApi* | [**setUnifiedCollateral**](docs/UnifiedApi.md#setUnifiedCollateral) | **POST** /unified/collateral_currencies | Set collateral currency +*WalletApi* | [**listCurrencyChains**](docs/WalletApi.md#listCurrencyChains) | **GET** /wallet/currency_chains | Query chains supported for specified currency *WalletApi* | [**getDepositAddress**](docs/WalletApi.md#getDepositAddress) | **GET** /wallet/deposit_address | Generate currency deposit address -*WalletApi* | [**listWithdrawals**](docs/WalletApi.md#listWithdrawals) | **GET** /wallet/withdrawals | Retrieve withdrawal records -*WalletApi* | [**listDeposits**](docs/WalletApi.md#listDeposits) | **GET** /wallet/deposits | Retrieve deposit records +*WalletApi* | [**listWithdrawals**](docs/WalletApi.md#listWithdrawals) | **GET** /wallet/withdrawals | Get withdrawal records +*WalletApi* | [**listDeposits**](docs/WalletApi.md#listDeposits) | **GET** /wallet/deposits | Get deposit records *WalletApi* | [**transfer**](docs/WalletApi.md#transfer) | **POST** /wallet/transfers | Transfer between trading accounts -*WalletApi* | [**listSubAccountTransfers**](docs/WalletApi.md#listSubAccountTransfers) | **GET** /wallet/sub_account_transfers | Retrieve transfer records between main and sub accounts +*WalletApi* | [**listSubAccountTransfers**](docs/WalletApi.md#listSubAccountTransfers) | **GET** /wallet/sub_account_transfers | Get transfer records between main and sub accounts *WalletApi* | [**transferWithSubAccount**](docs/WalletApi.md#transferWithSubAccount) | **POST** /wallet/sub_account_transfers | Transfer between main and sub accounts -*WalletApi* | [**subAccountToSubAccount**](docs/WalletApi.md#subAccountToSubAccount) | **POST** /wallet/sub_account_to_sub_account | Sub-account transfers to sub-account +*WalletApi* | [**subAccountToSubAccount**](docs/WalletApi.md#subAccountToSubAccount) | **POST** /wallet/sub_account_to_sub_account | Transfer between sub-accounts *WalletApi* | [**getTransferOrderStatus**](docs/WalletApi.md#getTransferOrderStatus) | **GET** /wallet/order_status | Transfer status query -*WalletApi* | [**listWithdrawStatus**](docs/WalletApi.md#listWithdrawStatus) | **GET** /wallet/withdraw_status | Retrieve withdrawal status -*WalletApi* | [**listSubAccountBalances**](docs/WalletApi.md#listSubAccountBalances) | **GET** /wallet/sub_account_balances | Retrieve sub account balances -*WalletApi* | [**listSubAccountMarginBalances**](docs/WalletApi.md#listSubAccountMarginBalances) | **GET** /wallet/sub_account_margin_balances | Query sub accounts' margin balances -*WalletApi* | [**listSubAccountFuturesBalances**](docs/WalletApi.md#listSubAccountFuturesBalances) | **GET** /wallet/sub_account_futures_balances | Query sub accounts' futures account balances -*WalletApi* | [**listSubAccountCrossMarginBalances**](docs/WalletApi.md#listSubAccountCrossMarginBalances) | **GET** /wallet/sub_account_cross_margin_balances | Query subaccount's cross_margin account info -*WalletApi* | [**listSavedAddress**](docs/WalletApi.md#listSavedAddress) | **GET** /wallet/saved_address | Query saved address -*WalletApi* | [**getTradeFee**](docs/WalletApi.md#getTradeFee) | **GET** /wallet/fee | Retrieve personal trading fee -*WalletApi* | [**getTotalBalance**](docs/WalletApi.md#getTotalBalance) | **GET** /wallet/total_balance | Retrieve user's total balances -*WalletApi* | [**listSmallBalance**](docs/WalletApi.md#listSmallBalance) | **GET** /wallet/small_balance | List small balance -*WalletApi* | [**convertSmallBalance**](docs/WalletApi.md#convertSmallBalance) | **POST** /wallet/small_balance | Convert small balance -*WalletApi* | [**listSmallBalanceHistory**](docs/WalletApi.md#listSmallBalanceHistory) | **GET** /wallet/small_balance_history | List small balance history -*WalletApi* | [**listPushOrders**](docs/WalletApi.md#listPushOrders) | **GET** /wallet/push | Retrieve the UID transfer history +*WalletApi* | [**listWithdrawStatus**](docs/WalletApi.md#listWithdrawStatus) | **GET** /wallet/withdraw_status | Query withdrawal status +*WalletApi* | [**listSubAccountBalances**](docs/WalletApi.md#listSubAccountBalances) | **GET** /wallet/sub_account_balances | Query sub-account balance information +*WalletApi* | [**listSubAccountMarginBalances**](docs/WalletApi.md#listSubAccountMarginBalances) | **GET** /wallet/sub_account_margin_balances | Query sub-account isolated margin account balance information +*WalletApi* | [**listSubAccountFuturesBalances**](docs/WalletApi.md#listSubAccountFuturesBalances) | **GET** /wallet/sub_account_futures_balances | Query sub-account perpetual futures account balance information +*WalletApi* | [**listSubAccountCrossMarginBalances**](docs/WalletApi.md#listSubAccountCrossMarginBalances) | **GET** /wallet/sub_account_cross_margin_balances | Query sub-account cross margin account balance information +*WalletApi* | [**listSavedAddress**](docs/WalletApi.md#listSavedAddress) | **GET** /wallet/saved_address | Query withdrawal address whitelist +*WalletApi* | [**getTradeFee**](docs/WalletApi.md#getTradeFee) | **GET** /wallet/fee | Query personal trading fees +*WalletApi* | [**getTotalBalance**](docs/WalletApi.md#getTotalBalance) | **GET** /wallet/total_balance | Query personal account totals +*WalletApi* | [**listSmallBalance**](docs/WalletApi.md#listSmallBalance) | **GET** /wallet/small_balance | Get list of convertible small balance currencies +*WalletApi* | [**convertSmallBalance**](docs/WalletApi.md#convertSmallBalance) | **POST** /wallet/small_balance | Convert small balance currency +*WalletApi* | [**listSmallBalanceHistory**](docs/WalletApi.md#listSmallBalanceHistory) | **GET** /wallet/small_balance_history | Get convertible small balance currency history +*WalletApi* | [**listPushOrders**](docs/WalletApi.md#listPushOrders) | **GET** /wallet/push | Get UID transfer history *WithdrawalApi* | [**withdraw**](docs/WithdrawalApi.md#withdraw) | **POST** /withdrawals | Withdraw *WithdrawalApi* | [**withdrawPushOrder**](docs/WithdrawalApi.md#withdrawPushOrder) | **POST** /withdrawals/push | UID transfer *WithdrawalApi* | [**cancelWithdrawal**](docs/WithdrawalApi.md#cancelWithdrawal) | **DELETE** /withdrawals/{withdrawal_id} | Cancel withdrawal with specified ID @@ -450,6 +442,7 @@ Class | Method | HTTP request | Description - [BorrowCurrencyInfo](docs/BorrowCurrencyInfo.md) - [BrokerCommission](docs/BrokerCommission.md) - [BrokerCommission1](docs/BrokerCommission1.md) + - [BrokerCommissionSubBrokerInfo](docs/BrokerCommissionSubBrokerInfo.md) - [BrokerTransaction](docs/BrokerTransaction.md) - [BrokerTransaction1](docs/BrokerTransaction1.md) - [CancelBatchOrder](docs/CancelBatchOrder.md) @@ -476,15 +469,9 @@ Class | Method | HTTP request | Description - [CreateMultiCollateralOrder](docs/CreateMultiCollateralOrder.md) - [CreateUniLend](docs/CreateUniLend.md) - [CreateUniLoan](docs/CreateUniLoan.md) - - [CrossMarginAccount](docs/CrossMarginAccount.md) - - [CrossMarginAccountBook](docs/CrossMarginAccountBook.md) - [CrossMarginBalance](docs/CrossMarginBalance.md) - - [CrossMarginBalance1](docs/CrossMarginBalance1.md) - - [CrossMarginCurrency](docs/CrossMarginCurrency.md) - [CrossMarginLoan](docs/CrossMarginLoan.md) - - [CrossMarginRepayRequest](docs/CrossMarginRepayRequest.md) - [CrossMarginRepayment](docs/CrossMarginRepayment.md) - - [CrossMarginTransferable](docs/CrossMarginTransferable.md) - [Currency](docs/Currency.md) - [CurrencyChain](docs/CurrencyChain.md) - [CurrencyPair](docs/CurrencyPair.md) @@ -500,6 +487,7 @@ Class | Method | HTTP request | Description - [DualGetPlans](docs/DualGetPlans.md) - [Eth2RateList](docs/Eth2RateList.md) - [Eth2Swap](docs/Eth2Swap.md) + - [FindCoin](docs/FindCoin.md) - [FlashSwapCurrencyPair](docs/FlashSwapCurrencyPair.md) - [FlashSwapOrder](docs/FlashSwapOrder.md) - [FlashSwapOrderPreview](docs/FlashSwapOrderPreview.md) @@ -524,9 +512,11 @@ Class | Method | HTTP request | Description - [FuturesOrderAmendment](docs/FuturesOrderAmendment.md) - [FuturesOrderBook](docs/FuturesOrderBook.md) - [FuturesOrderBookItem](docs/FuturesOrderBookItem.md) + - [FuturesPositionCrossMode](docs/FuturesPositionCrossMode.md) - [FuturesPremiumIndex](docs/FuturesPremiumIndex.md) - [FuturesPriceTrigger](docs/FuturesPriceTrigger.md) - [FuturesPriceTriggeredOrder](docs/FuturesPriceTriggeredOrder.md) + - [FuturesRiskLimitTier](docs/FuturesRiskLimitTier.md) - [FuturesTicker](docs/FuturesTicker.md) - [FuturesTrade](docs/FuturesTrade.md) - [IndexConstituent](docs/IndexConstituent.md) @@ -632,8 +622,11 @@ Class | Method | HTTP request | Description - [SubAccountMarginBalance](docs/SubAccountMarginBalance.md) - [SubAccountToSubAccount](docs/SubAccountToSubAccount.md) - [SubAccountTransfer](docs/SubAccountTransfer.md) + - [SubAccountTransferRecordItem](docs/SubAccountTransferRecordItem.md) - [SubCrossMarginAccount](docs/SubCrossMarginAccount.md) - [SubUserMode](docs/SubUserMode.md) + - [SwapCoin](docs/SwapCoin.md) + - [SwapCoinStruct](docs/SwapCoinStruct.md) - [SystemTime](docs/SystemTime.md) - [Ticker](docs/Ticker.md) - [TotalBalance](docs/TotalBalance.md) @@ -651,7 +644,6 @@ Class | Method | HTTP request | Description - [UniCurrency](docs/UniCurrency.md) - [UniCurrencyInterest](docs/UniCurrencyInterest.md) - [UniCurrencyPair](docs/UniCurrencyPair.md) - - [UniInterestMode](docs/UniInterestMode.md) - [UniInterestRecord](docs/UniInterestRecord.md) - [UniLend](docs/UniLend.md) - [UniLendInterest](docs/UniLendInterest.md) @@ -663,6 +655,8 @@ Class | Method | HTTP request | Description - [UnifiedBalance](docs/UnifiedBalance.md) - [UnifiedBorrowable](docs/UnifiedBorrowable.md) - [UnifiedBorrowable1](docs/UnifiedBorrowable1.md) + - [UnifiedCollateralReq](docs/UnifiedCollateralReq.md) + - [UnifiedCollateralRes](docs/UnifiedCollateralRes.md) - [UnifiedCurrency](docs/UnifiedCurrency.md) - [UnifiedDiscount](docs/UnifiedDiscount.md) - [UnifiedDiscountTiers](docs/UnifiedDiscountTiers.md) @@ -702,5 +696,5 @@ It's recommended to create an instance of `ApiClient` per thread in a multi-thre ## Author -support@mail.gate.io +support@mail.gate.com diff --git a/build.gradle b/build.gradle index 0dcab8b..06a0965 100644 --- a/build.gradle +++ b/build.gradle @@ -3,7 +3,7 @@ apply plugin: 'eclipse' apply plugin: 'java' group = 'io.gate' -version = '6.98.0' +version = '7.1.8' buildscript { repositories { diff --git a/build.sbt b/build.sbt index 3fcf8ab..d90345d 100644 --- a/build.sbt +++ b/build.sbt @@ -2,7 +2,7 @@ lazy val root = (project in file(".")). settings( organization := "io.gate", name := "gate-api", - version := "6.98.0", + version := "7.1.8", scalaVersion := "2.11.4", scalacOptions ++= Seq("-feature"), javacOptions in compile ++= Seq("-Xlint:deprecation"), diff --git a/docs/AccountApi.md b/docs/AccountApi.md index 72e0f60..348ae04 100644 --- a/docs/AccountApi.md +++ b/docs/AccountApi.md @@ -4,22 +4,22 @@ All URIs are relative to *https://api.gateio.ws/api/v4* Method | HTTP request | Description ------------- | ------------- | ------------- -[**getAccountDetail**](AccountApi.md#getAccountDetail) | **GET** /account/detail | Get account detail +[**getAccountDetail**](AccountApi.md#getAccountDetail) | **GET** /account/detail | Retrieve user account information [**getAccountRateLimit**](AccountApi.md#getAccountRateLimit) | **GET** /account/rate_limit | Get user transaction rate limit information -[**listSTPGroups**](AccountApi.md#listSTPGroups) | **GET** /account/stp_groups | List STP Groups -[**createSTPGroup**](AccountApi.md#createSTPGroup) | **POST** /account/stp_groups | Create STP Group -[**listSTPGroupsUsers**](AccountApi.md#listSTPGroupsUsers) | **GET** /account/stp_groups/{stp_id}/users | List users of the STP group -[**addSTPGroupUsers**](AccountApi.md#addSTPGroupUsers) | **POST** /account/stp_groups/{stp_id}/users | Add users to the STP group -[**deleteSTPGroupUsers**](AccountApi.md#deleteSTPGroupUsers) | **DELETE** /account/stp_groups/{stp_id}/users | Delete the user in the STP group -[**getDebitFee**](AccountApi.md#getDebitFee) | **GET** /account/debit_fee | Query GT deduction configuration. -[**setDebitFee**](AccountApi.md#setDebitFee) | **POST** /account/debit_fee | Set GT deduction. +[**listSTPGroups**](AccountApi.md#listSTPGroups) | **GET** /account/stp_groups | Query STP user groups created by the user +[**createSTPGroup**](AccountApi.md#createSTPGroup) | **POST** /account/stp_groups | Create STP user group +[**listSTPGroupsUsers**](AccountApi.md#listSTPGroupsUsers) | **GET** /account/stp_groups/{stp_id}/users | Query users in the STP user group +[**addSTPGroupUsers**](AccountApi.md#addSTPGroupUsers) | **POST** /account/stp_groups/{stp_id}/users | Add users to the STP user group +[**deleteSTPGroupUsers**](AccountApi.md#deleteSTPGroupUsers) | **DELETE** /account/stp_groups/{stp_id}/users | Delete users from the STP user group +[**getDebitFee**](AccountApi.md#getDebitFee) | **GET** /account/debit_fee | Query GT fee deduction configuration +[**setDebitFee**](AccountApi.md#setDebitFee) | **POST** /account/debit_fee | Configure GT fee deduction # **getAccountDetail** > AccountDetail getAccountDetail() -Get account detail +Retrieve user account information ### Example @@ -77,7 +77,7 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful | - | +**200** | Successfully retrieved | - | # **getAccountRateLimit** @@ -141,15 +141,15 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful | - | +**200** | Successfully retrieved | - | # **listSTPGroups** > List<StpGroup> listSTPGroups().name(name).execute(); -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,7 +172,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); AccountApi apiInstance = new AccountApi(defaultClient); - String name = "group"; // String | Perform a fuzzy search based on the name + String name = "group"; // String | Fuzzy search by name try { List result = apiInstance.listSTPGroups() .name(name) @@ -195,7 +195,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **name** | **String**| Perform a fuzzy search based on the name | [optional] + **name** | **String**| Fuzzy search by name | [optional] ### Return type @@ -213,13 +213,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **createSTPGroup** > StpGroup createSTPGroup(stpGroup) -Create STP Group +Create STP user group Only the main account is allowed to create a new STP user group @@ -283,15 +283,15 @@ 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 | - | # **listSTPGroupsUsers** > List<StpGroupUser> listSTPGroupsUsers(stpId) -List users of the STP group +Query users in the STP user group -Only the main account that created this STP group is allowed to list the user ID of the STP group +Only the main account that created this STP group can query the account ID list in the current STP group ### Example @@ -353,15 +353,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **addSTPGroupUsers** > List<StpGroupUser> addSTPGroupUsers(stpId, requestBody) -Add users to the STP group +Add users to the STP user group -- Only the master account that created the STP user group is allowed to add users to the STP user group.- Only accounts under the main account are allowed to be added. Cross-account is not permitted +- Only the main account that created this STP group can add users to the STP user group - Only accounts under the current main account are allowed, cross-main account is not permitted ### Example @@ -425,13 +425,13 @@ 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 | - | # **deleteSTPGroupUsers** > List<StpGroupUser> deleteSTPGroupUsers(stpId, userId) -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 @@ -457,7 +457,7 @@ public class Example { AccountApi apiInstance = new AccountApi(defaultClient); Long stpId = 1L; // Long | STP Group ID - Long userId = 1L; // Long | STP user ID, multiple can be separated by commas + Long userId = 1L; // Long | STP user IDs, multiple IDs can be separated by commas try { List result = apiInstance.deleteSTPGroupUsers(stpId, userId); System.out.println(result); @@ -479,7 +479,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **stpId** | **Long**| STP Group ID | - **userId** | **Long**| STP user ID, multiple can be separated by commas | + **userId** | **Long**| STP user IDs, multiple IDs can be separated by commas | ### Return type @@ -497,15 +497,15 @@ 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 | - | # **getDebitFee** > DebitFee getDebitFee() -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 @@ -569,9 +569,9 @@ This endpoint does not need any parameter. # **setDebitFee** > setDebitFee(debitFee) -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 diff --git a/docs/AccountBalance.md b/docs/AccountBalance.md index 82aa609..1bb2651 100644 --- a/docs/AccountBalance.md +++ b/docs/AccountBalance.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **amount** | **String** | Account total balance amount | [optional] **currency** | [**CurrencyEnum**](#CurrencyEnum) | Currency | [optional] **unrealisedPnl** | **String** | Unrealised_pnl, this field will only appear in futures, options, delivery, and total accounts | [optional] -**borrowed** | **String** | Borrowed，this field will only appear in margin and cross_margin accounts | [optional] +**borrowed** | **String** | Total borrowed amount, this field will only appear in margin and cross_margin accounts | [optional] ## Enum: CurrencyEnum diff --git a/docs/AccountDetail.md b/docs/AccountDetail.md index fe95b76..d8ab381 100644 --- a/docs/AccountDetail.md +++ b/docs/AccountDetail.md @@ -1,16 +1,16 @@ # AccountDetail -Account detail +Account details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ipWhitelist** | **List<String>** | IP whitelist | [optional] -**currencyPairs** | **List<String>** | CurrencyPair whitelisting | [optional] +**ipWhitelist** | **List<String>** | IP Whitelist | [optional] +**currencyPairs** | **List<String>** | Trading pair whitelist | [optional] **userId** | **Long** | User ID | [optional] **tier** | **Long** | User VIP level | [optional] **key** | [**AccountDetailKey**](AccountDetailKey.md) | | [optional] -**copyTradingRole** | **Integer** | User role: 0 - Ordinary user 1 - Order leader 2 - Follower 3 - Order leader and follower | [optional] +**copyTradingRole** | **Integer** | User role: 0 - Normal user, 1 - Copy trading leader, 2 - Follower, 3 - Both leader and follower | [optional] diff --git a/docs/AccountDetailKey.md b/docs/AccountDetailKey.md index 801792f..57978ca 100644 --- a/docs/AccountDetailKey.md +++ b/docs/AccountDetailKey.md @@ -1,11 +1,11 @@ # AccountDetailKey -API Key detail +API Key details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**mode** | **Integer** | mode: 1 - classic account 2 - portfolio margin account | [optional] +**mode** | **Integer** | Mode: 1 - Classic mode, 2 - Legacy unified mode | [optional] diff --git a/docs/AccountRateLimit.md b/docs/AccountRateLimit.md index b84a8d8..747a17c 100644 --- a/docs/AccountRateLimit.md +++ b/docs/AccountRateLimit.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **tier** | **String** | Frequency limit level (For detailed frequency limit rules, see [Transaction ratio frequency limit](#rate-limit-based-on-fill-ratio)) | [optional] -**ratio** | **String** | Transaction rate | [optional] -**mainRatio** | **String** | Total transaction ratio of main account | [optional] +**ratio** | **String** | Fill rate | [optional] +**mainRatio** | **String** | Total fill ratio of main account | [optional] **updatedAt** | **String** | Update time | [optional] diff --git a/docs/AgencyCommission.md b/docs/AgencyCommission.md index 1162280..beaf7e5 100644 --- a/docs/AgencyCommission.md +++ b/docs/AgencyCommission.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**commissionTime** | **Long** | Commission Time. (unix timestamp) | [optional] +**commissionTime** | **Long** | Commission time (Unix timestamp in seconds) | [optional] **userId** | **Long** | User ID | [optional] **groupName** | **String** | Group name | [optional] -**commissionAmount** | **String** | Commission Amount | [optional] +**commissionAmount** | **String** | Transaction amount | [optional] **commissionAsset** | **String** | Commission Asset | [optional] -**source** | **String** | Source. SPOT - SPOT Rebate, FUTURES - Futures Rebate | [optional] +**source** | **String** | Commission source: SPOT - Spot commission, FUTURES - Futures commission | [optional] diff --git a/docs/AgencyCommissionHistory.md b/docs/AgencyCommissionHistory.md index 9a5b4c1..d74cc13 100644 --- a/docs/AgencyCommissionHistory.md +++ b/docs/AgencyCommissionHistory.md @@ -7,5 +7,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currencyPair** | **String** | Currency pair | [optional] **total** | **Long** | Total | [optional] -**list** | [**List<AgencyCommission>**](AgencyCommission.md) | List of comission history | [optional] +**list** | [**List<AgencyCommission>**](AgencyCommission.md) | List of commission history | [optional] diff --git a/docs/AgencyTransaction.md b/docs/AgencyTransaction.md index 81a851b..4483e3f 100644 --- a/docs/AgencyTransaction.md +++ b/docs/AgencyTransaction.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **fee** | **String** | Fee | [optional] **feeAsset** | **String** | Fee currency | [optional] **currencyPair** | **String** | Currency pair | [optional] -**amount** | **String** | Commission Amount | [optional] +**amount** | **String** | Transaction amount | [optional] **amountAsset** | **String** | Commission Asset | [optional] -**source** | **String** | Source. SPOT - SPOT Rebate, FUTURES - Futures Rebate | [optional] +**source** | **String** | Commission source: SPOT - Spot commission, FUTURES - Futures commission | [optional] diff --git a/docs/AutoRepaySetting.md b/docs/AutoRepaySetting.md index 176b917..cbcdb65 100644 --- a/docs/AutoRepaySetting.md +++ b/docs/AutoRepaySetting.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | [**StatusEnum**](#StatusEnum) | Auto repayment status. `on` - enabled, `off` - disabled | [optional] +**status** | [**StatusEnum**](#StatusEnum) | Auto repayment status: `on` - enabled, `off` - disabled | [optional] ## Enum: StatusEnum diff --git a/docs/BatchAmendItem.md b/docs/BatchAmendItem.md index 6cf798b..e37ee0d 100644 --- a/docs/BatchAmendItem.md +++ b/docs/BatchAmendItem.md @@ -7,11 +7,11 @@ Order information that needs to be modified Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**orderId** | **String** | The order ID returned upon successful creation or the custom ID specified by the user during creation (i.e., the 'text' field). | +**orderId** | **String** | The order ID returned upon successful creation or the custom ID specified by the user during creation (i.e., the 'text' field) | **currencyPair** | **String** | Currency pair | -**account** | **String** | Default spot, unified account and warehouse-by-store leverage account. | [optional] -**amount** | **String** | trade amount, only one of amount and price can be specified | [optional] -**price** | **String** | trade price, only one of amount and price can be specified | [optional] -**amendText** | **String** | Custom info during amending order | [optional] +**account** | **String** | Default spot, unified account and warehouse-by-store leverage account | [optional] +**amount** | **String** | Trading Quantity. Only one of `amount` or `price` can be specified | [optional] +**price** | **String** | Trading Price. Only one of `amount` or `price` can be specified | [optional] +**amendText** | **String** | Custom info during order amendment | [optional] **actionMode** | **String** | 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/BatchAmendOrderReq.md b/docs/BatchAmendOrderReq.md index 42dcbee..b4a5a3b 100644 --- a/docs/BatchAmendOrderReq.md +++ b/docs/BatchAmendOrderReq.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **orderId** | **Long** | Order id, order_id and text must contain at least one | [optional] **text** | **String** | User-defined order text, at least one of order_id and text must be passed | [optional] -**size** | **Long** | The new order size, including the executed order size. - If it is less than or equal to the executed quantity, the order will be cancelled. - The new order direction must be consistent with the original one. - The size of the closing order cannot be modified. - For orders that only reduce positions, if the size is increased, other orders that only reduce positions may be kicked out. - If the price is not modified, reducing the size will not affect the depth of the queue, and increasing the size will place it at the end of the current price. | [optional] -**price** | **String** | New order price. | [optional] -**amendText** | **String** | Custom info during amending order | [optional] +**size** | **Long** | 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** | **String** | New order price | [optional] +**amendText** | **String** | Custom info during order amendment | [optional] diff --git a/docs/BatchFuturesOrder.md b/docs/BatchFuturesOrder.md index 70afffc..5ed54b4 100644 --- a/docs/BatchFuturesOrder.md +++ b/docs/BatchFuturesOrder.md @@ -7,33 +7,33 @@ Futures order details Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**succeeded** | **Boolean** | Whether the batch of orders succeeded | [optional] +**succeeded** | **Boolean** | Request execution result | [optional] **label** | **String** | Error label, only exists if execution fails | [optional] **detail** | **String** | Error detail, only present if execution failed and details need to be given | [optional] **id** | **Long** | Futures order ID | [optional] [readonly] **user** | **Integer** | User ID | [optional] [readonly] **createTime** | **Double** | Creation time of order | [optional] [readonly] **finishTime** | **Double** | Order finished time. Not returned if order is open | [optional] [readonly] -**finishAs** | [**FinishAsEnum**](#FinishAsEnum) | How the order was finished. - filled: all filled - cancelled: manually cancelled - liquidated: cancelled because of liquidation - ioc: time in force is `IOC`, finish immediately - auto_deleveraged: finished by ADL - reduce_only: cancelled because of increasing position while `reduce-only` set- position_closed: cancelled because of position close - position_closed: canceled because the position was closed - reduce_out: only reduce positions by excluding hard-to-fill orders - stp: cancelled because self trade prevention | [optional] [readonly] -**status** | [**StatusEnum**](#StatusEnum) | Order status - `open`: waiting to be traded - `finished`: finished | [optional] [readonly] +**finishAs** | [**FinishAsEnum**](#FinishAsEnum) | 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** | [**StatusEnum**](#StatusEnum) | Order status - `open`: Pending - `finished`: Completed | [optional] [readonly] **contract** | **String** | Futures contract | [optional] -**size** | **Long** | Order size. Specify positive number to make a bid, and negative number to ask | [optional] -**iceberg** | **Long** | 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** | **String** | Order price. 0 for market order with `tif` set as `ioc` | [optional] +**size** | **Long** | Required. Trading quantity. Positive for buy, negative for sell. Set to 0 for close position orders. | [optional] +**iceberg** | **Long** | Display size for iceberg orders. 0 for non-iceberg orders. Note that hidden portions are charged taker fees. | [optional] +**price** | **String** | Order price. Price of 0 with `tif` set to `ioc` represents a market order. | [optional] **close** | **Boolean** | Set as `true` to close the position, with `size` set to 0 | [optional] **isClose** | **Boolean** | Is the order to close position | [optional] [readonly] **reduceOnly** | **Boolean** | Set as `true` to be reduce-only order | [optional] **isReduceOnly** | **Boolean** | Is the order reduce-only | [optional] [readonly] **isLiq** | **Boolean** | Is the order for liquidation | [optional] [readonly] **tif** | [**TifEnum**](#TifEnum) | 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] -**left** | **Long** | Size left to be traded | [optional] [readonly] -**fillPrice** | **String** | Fill price of the order | [optional] [readonly] +**left** | **Long** | Unfilled quantity | [optional] [readonly] +**fillPrice** | **String** | Fill price | [optional] [readonly] **text** | **String** | 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** | **String** | Taker fee | [optional] [readonly] **mkfr** | **String** | Maker fee | [optional] [readonly] -**refu** | **Integer** | Reference user ID | [optional] [readonly] +**refu** | **Integer** | Referrer user ID | [optional] [readonly] **autoSize** | [**AutoSizeEnum**](#AutoSizeEnum) | 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] -**stpAct** | [**StpActEnum**](#StpActEnum) | Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled | [optional] +**stpAct** | [**StpActEnum**](#StpActEnum) | 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] **stpId** | **Integer** | 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] ## Enum: FinishAsEnum diff --git a/docs/BatchOrder.md b/docs/BatchOrder.md index 6c9653f..36702e2 100644 --- a/docs/BatchOrder.md +++ b/docs/BatchOrder.md @@ -9,8 +9,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **orderId** | **String** | Order ID | [optional] **amendText** | **String** | The custom data that the user remarked when amending the order | [optional] -**text** | **String** | 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** | **Boolean** | Whether the batch of orders succeeded | [optional] +**text** | **String** | 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** | **Boolean** | Request execution result | [optional] **label** | **String** | Error label, if any, otherwise an empty string | [optional] **message** | **String** | Detailed error message, if any, otherwise an empty string | [optional] **id** | **String** | Order ID | [optional] [readonly] @@ -20,17 +20,17 @@ Name | Type | Description | Notes **updateTimeMs** | **Long** | Last modification time of order (in milliseconds) | [optional] [readonly] **status** | [**StatusEnum**](#StatusEnum) | Order status - `open`: to be filled - `closed`: filled - `cancelled`: cancelled | [optional] [readonly] **currencyPair** | **String** | Currency pair | [optional] -**type** | [**TypeEnum**](#TypeEnum) | Order Type - limit : Limit Order - market : Market Order | [optional] +**type** | [**TypeEnum**](#TypeEnum) | Order Type - limit : Limit Order - market : Market Order | [optional] **account** | [**AccountEnum**](#AccountEnum) | Account type, spot - spot account, margin - leveraged account, unified - unified account | [optional] -**side** | [**SideEnum**](#SideEnum) | Order side | [optional] +**side** | [**SideEnum**](#SideEnum) | Buy or sell order | [optional] **amount** | **String** | Trade amount | [optional] **price** | **String** | Order price | [optional] **timeInForce** | [**TimeInForceEnum**](#TimeInForceEnum) | 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] -**iceberg** | **String** | Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported. | [optional] -**autoBorrow** | **Boolean** | Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough. | [optional] -**autoRepay** | **Boolean** | Enable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order. | [optional] +**iceberg** | **String** | Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported | [optional] +**autoBorrow** | **Boolean** | Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough | [optional] +**autoRepay** | **Boolean** | 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** | **String** | Amount left to fill | [optional] [readonly] -**filledAmount** | **String** | Amount traded to fill | [optional] [readonly] +**filledAmount** | **String** | Amount filled | [optional] [readonly] **fillPrice** | **String** | Total filled in quote currency. Deprecated in favor of `filled_total` | [optional] [readonly] **filledTotal** | **String** | Total filled in quote currency | [optional] [readonly] **avgDealPrice** | **String** | Average fill price | [optional] [readonly] @@ -38,11 +38,11 @@ Name | Type | Description | Notes **feeCurrency** | **String** | Fee currency unit | [optional] [readonly] **pointFee** | **String** | Points used to deduct fee | [optional] [readonly] **gtFee** | **String** | GT used to deduct fee | [optional] [readonly] -**gtDiscount** | **Boolean** | Whether GT fee discount is used | [optional] [readonly] +**gtDiscount** | **Boolean** | Whether GT fee deduction is enabled | [optional] [readonly] **rebatedFee** | **String** | Rebated fee | [optional] [readonly] **rebatedFeeCurrency** | **String** | Rebated fee currency unit | [optional] [readonly] **stpId** | **Integer** | 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] -**stpAct** | [**StpActEnum**](#StpActEnum) | Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled | [optional] +**stpAct** | [**StpActEnum**](#StpActEnum) | 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] **finishAs** | [**FinishAsEnum**](#FinishAsEnum) | 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] ## Enum: StatusEnum diff --git a/docs/BorrowCurrencyInfo.md b/docs/BorrowCurrencyInfo.md index b91957e..7fe459d 100644 --- a/docs/BorrowCurrencyInfo.md +++ b/docs/BorrowCurrencyInfo.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | Currency | [optional] **indexPrice** | **String** | Currency Index Price | [optional] -**leftRepayPrincipal** | **String** | outstanding principal | [optional] -**leftRepayInterest** | **String** | outstanding interest | [optional] -**leftRepayUsdt** | **String** | Value of left total repayments amount in USDT | [optional] +**leftRepayPrincipal** | **String** | Outstanding principal | [optional] +**leftRepayInterest** | **String** | Outstanding interest | [optional] +**leftRepayUsdt** | **String** | Remaining total outstanding value converted to USDT | [optional] diff --git a/docs/BrokerCommission.md b/docs/BrokerCommission.md index f648e03..7a88b21 100644 --- a/docs/BrokerCommission.md +++ b/docs/BrokerCommission.md @@ -6,5 +6,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **total** | **Long** | Total | [optional] -**list** | [**List<BrokerCommission1>**](BrokerCommission1.md) | List of comission history | [optional] +**list** | [**List<BrokerCommission1>**](BrokerCommission1.md) | List of commission history | [optional] diff --git a/docs/BrokerCommission1.md b/docs/BrokerCommission1.md index 14a13a9..761aa6b 100644 --- a/docs/BrokerCommission1.md +++ b/docs/BrokerCommission1.md @@ -5,13 +5,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**commissionTime** | **Long** | Commission Time. (unix timestamp) | [optional] +**commissionTime** | **Long** | Commission time (Unix timestamp in seconds) | [optional] **userId** | **Long** | User ID | [optional] **groupName** | **String** | Group name | [optional] **amount** | **String** | The amount of commission rebates | [optional] **fee** | **String** | Fee | [optional] **feeAsset** | **String** | Fee currency | [optional] **rebateFee** | **String** | The income from rebates, converted to USDT | [optional] -**source** | **String** | Rebate Type: Spot、Futures、Options | [optional] +**source** | **String** | Commission transaction type: Spot, Futures, Options, Alpha | [optional] **currencyPair** | **String** | Currency pair | [optional] +**subBrokerInfo** | [**BrokerCommissionSubBrokerInfo**](BrokerCommissionSubBrokerInfo.md) | | [optional] +**alphaContractAddr** | **String** | Alpha contract address | [optional] diff --git a/docs/BrokerCommissionSubBrokerInfo.md b/docs/BrokerCommissionSubBrokerInfo.md new file mode 100644 index 0000000..9c71f9c --- /dev/null +++ b/docs/BrokerCommissionSubBrokerInfo.md @@ -0,0 +1,14 @@ + +# BrokerCommissionSubBrokerInfo + +Sub-broker information + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**userId** | **Long** | Sub-broker user ID | [optional] +**originalCommissionRate** | **String** | Sub-broker original commission rate | [optional] +**relativeCommissionRate** | **String** | Sub-broker relative commission rate | [optional] +**commissionRate** | **String** | Sub-broker actual commission rate | [optional] + diff --git a/docs/BrokerTransaction1.md b/docs/BrokerTransaction1.md index 9469854..627d8ce 100644 --- a/docs/BrokerTransaction1.md +++ b/docs/BrokerTransaction1.md @@ -8,9 +8,11 @@ Name | Type | Description | Notes **transactionTime** | **Long** | Transaction Time. (unix timestamp) | [optional] **userId** | **Long** | User ID | [optional] **groupName** | **String** | Group name | [optional] -**fee** | **String** | fee (usdt) | [optional] +**fee** | **String** | Fee amount (USDT) | [optional] **currencyPair** | **String** | Currency pair | [optional] -**amount** | **String** | Commission Amount | [optional] +**amount** | **String** | Transaction amount | [optional] **feeAsset** | **String** | Fee currency | [optional] -**source** | **String** | Rebate Type: Spot、Futures、Options | [optional] +**source** | **String** | Commission transaction type: Spot, Futures, Options, Alpha | [optional] +**subBrokerInfo** | [**BrokerCommissionSubBrokerInfo**](BrokerCommissionSubBrokerInfo.md) | | [optional] +**alphaContractAddr** | **String** | Alpha contract address | [optional] diff --git a/docs/CancelOrderResult.md b/docs/CancelOrderResult.md index 34066c2..2e4c268 100644 --- a/docs/CancelOrderResult.md +++ b/docs/CancelOrderResult.md @@ -12,6 +12,6 @@ Name | Type | Description | Notes **text** | **String** | Custom order information | [optional] **succeeded** | **Boolean** | Whether cancellation succeeded | [optional] **label** | **String** | Error label when failed to cancel the order; emtpy if succeeded | [optional] -**message** | **String** | Error message when failed to cancel the order; empty if succeeded | [optional] +**message** | **String** | Error description when cancellation fails, empty if successful | [optional] **account** | **String** | Default is empty (deprecated) | [optional] diff --git a/docs/CollateralAdjust.md b/docs/CollateralAdjust.md index e3413db..3f7aecf 100644 --- a/docs/CollateralAdjust.md +++ b/docs/CollateralAdjust.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **orderId** | **Long** | Order ID | -**type** | **String** | Operation types: append - for adding collateral, redeem - for withdrawing collateral | -**collaterals** | [**List<CollateralCurrency>**](CollateralCurrency.md) | Collateral Currency List | [optional] +**type** | **String** | Operation type: append - add collateral, redeem - withdraw collateral | +**collaterals** | [**List<CollateralCurrency>**](CollateralCurrency.md) | Collateral currency list | [optional] diff --git a/docs/CollateralAdjustRes.md b/docs/CollateralAdjustRes.md index bcce281..f26810d 100644 --- a/docs/CollateralAdjustRes.md +++ b/docs/CollateralAdjustRes.md @@ -1,12 +1,12 @@ # CollateralAdjustRes -Result of multi-collateral adjustment +Multi-collateral adjustment result ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **orderId** | **Long** | Order ID | [optional] -**collateralCurrencies** | [**List<CollateralCurrencyRes>**](CollateralCurrencyRes.md) | Collateral Currency Information | [optional] +**collateralCurrencies** | [**List<CollateralCurrencyRes>**](CollateralCurrencyRes.md) | Collateral currency information | [optional] diff --git a/docs/CollateralAlign.md b/docs/CollateralAlign.md index 7aae66a..022b44b 100644 --- a/docs/CollateralAlign.md +++ b/docs/CollateralAlign.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **orderId** | **Long** | Order ID | -**collateralCurrency** | **String** | Collateral | +**collateralCurrency** | **String** | Collateral currency | **collateralAmount** | **String** | Collateral amount | -**type** | **String** | Operation types: append - for adding collateral, redeem - for withdrawing collateral | +**type** | **String** | Operation type: append - add collateral, redeem - withdraw collateral | diff --git a/docs/CollateralCurrencyInfo.md b/docs/CollateralCurrencyInfo.md index 38b55f9..2c87685 100644 --- a/docs/CollateralCurrencyInfo.md +++ b/docs/CollateralCurrencyInfo.md @@ -7,6 +7,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | Currency | [optional] **indexPrice** | **String** | Currency Index Price | [optional] -**leftCollateral** | **String** | Left Collateral Amount | [optional] -**leftCollateralUsdt** | **String** | Value of left collateral amount in USDT | [optional] +**leftCollateral** | **String** | Remaining collateral amount | [optional] +**leftCollateralUsdt** | **String** | Remaining collateral value converted to USDT | [optional] diff --git a/docs/CollateralCurrencyRes.md b/docs/CollateralCurrencyRes.md index 22659bc..d0bad83 100644 --- a/docs/CollateralCurrencyRes.md +++ b/docs/CollateralCurrencyRes.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **succeeded** | **Boolean** | Update success status | [optional] -**label** | **String** | Error identifier for unsuccessful operations; empty for successful. | [optional] -**message** | **String** | Error description in case of operation failure; empty when successful. | [optional] +**label** | **String** | Error identifier for failed operations; empty when successful | [optional] +**message** | **String** | Error description for failed operations; empty when successful | [optional] **currency** | **String** | Currency | [optional] -**amount** | **String** | Quantity of successful collateral operation; 0 if the operation fails. | [optional] +**amount** | **String** | Successfully operated collateral quantity; 0 if operation fails | [optional] diff --git a/docs/CollateralCurrentRate.md b/docs/CollateralCurrentRate.md index 85ff1c8..3594c07 100644 --- a/docs/CollateralCurrentRate.md +++ b/docs/CollateralCurrentRate.md @@ -1,7 +1,7 @@ # CollateralCurrentRate -Multi-currency pledge current interest rate +Multi-collateral current interest rate ## Properties diff --git a/docs/CollateralFixRate.md b/docs/CollateralFixRate.md index 459d30b..1d725e3 100644 --- a/docs/CollateralFixRate.md +++ b/docs/CollateralFixRate.md @@ -8,7 +8,7 @@ Multi-collateral fixed interest rate Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | Currency | [optional] -**rate7d** | **String** | Fixed interest rate for a lending period of 7 days | [optional] -**rate30d** | **String** | Fixed interest rate for a lending period of 30 days | [optional] -**updateTime** | **Long** | Update time, timestamp, unit in seconds | [optional] +**rate7d** | **String** | Fixed interest rate for 7-day lending period | [optional] +**rate30d** | **String** | Fixed interest rate for 30-day lending period | [optional] +**updateTime** | **Long** | Update time, timestamp in seconds | [optional] diff --git a/docs/CollateralLoanApi.md b/docs/CollateralLoanApi.md index 8117fa0..881aa73 100644 --- a/docs/CollateralLoanApi.md +++ b/docs/CollateralLoanApi.md @@ -4,15 +4,15 @@ All URIs are relative to *https://api.gateio.ws/api/v4* Method | HTTP request | Description ------------- | ------------- | ------------- -[**listCollateralLoanOrders**](CollateralLoanApi.md#listCollateralLoanOrders) | **GET** /loan/collateral/orders | List Orders -[**createCollateralLoan**](CollateralLoanApi.md#createCollateralLoan) | **POST** /loan/collateral/orders | Place order -[**getCollateralLoanOrderDetail**](CollateralLoanApi.md#getCollateralLoanOrderDetail) | **GET** /loan/collateral/orders/{order_id} | Get a single order -[**repayCollateralLoan**](CollateralLoanApi.md#repayCollateralLoan) | **POST** /loan/collateral/repay | Repayment -[**listRepayRecords**](CollateralLoanApi.md#listRepayRecords) | **GET** /loan/collateral/repay_records | Repayment history +[**listCollateralLoanOrders**](CollateralLoanApi.md#listCollateralLoanOrders) | **GET** /loan/collateral/orders | Query collateral loan order list +[**createCollateralLoan**](CollateralLoanApi.md#createCollateralLoan) | **POST** /loan/collateral/orders | Place collateral loan order +[**getCollateralLoanOrderDetail**](CollateralLoanApi.md#getCollateralLoanOrderDetail) | **GET** /loan/collateral/orders/{order_id} | Query single order details +[**repayCollateralLoan**](CollateralLoanApi.md#repayCollateralLoan) | **POST** /loan/collateral/repay | Collateral loan repayment +[**listRepayRecords**](CollateralLoanApi.md#listRepayRecords) | **GET** /loan/collateral/repay_records | Query collateral loan repayment records [**listCollateralRecords**](CollateralLoanApi.md#listCollateralRecords) | **GET** /loan/collateral/collaterals | Query collateral adjustment records [**operateCollateral**](CollateralLoanApi.md#operateCollateral) | **POST** /loan/collateral/collaterals | Increase or redeem collateral -[**getUserTotalAmount**](CollateralLoanApi.md#getUserTotalAmount) | **GET** /loan/collateral/total_amount | Query the total borrowing and collateral amount for the user -[**getUserLtvInfo**](CollateralLoanApi.md#getUserLtvInfo) | **GET** /loan/collateral/ltv | Query user's collateralization ratio +[**getUserTotalAmount**](CollateralLoanApi.md#getUserTotalAmount) | **GET** /loan/collateral/total_amount | Query user's total borrowing and collateral amount +[**getUserLtvInfo**](CollateralLoanApi.md#getUserLtvInfo) | **GET** /loan/collateral/ltv | Query user's collateralization ratio and remaining borrowable currencies [**listCollateralCurrencies**](CollateralLoanApi.md#listCollateralCurrencies) | **GET** /loan/collateral/currencies | Query supported borrowing and collateral currencies @@ -20,7 +20,7 @@ Method | HTTP request | Description # **listCollateralLoanOrders** > List<CollateralOrder> listCollateralLoanOrders().page(page).limit(limit).collateralCurrency(collateralCurrency).borrowCurrency(borrowCurrency).execute(); -List Orders +Query collateral loan order list ### Example @@ -44,8 +44,8 @@ public class Example { CollateralLoanApi apiInstance = new CollateralLoanApi(defaultClient); Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list - String collateralCurrency = "BTC"; // String | Collateral + Integer limit = 100; // Integer | Maximum number of records returned in a single list + String collateralCurrency = "BTC"; // String | Collateral currency String borrowCurrency = "USDT"; // String | Borrowed currency try { List result = apiInstance.listCollateralLoanOrders() @@ -73,8 +73,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] - **collateralCurrency** | **String**| Collateral | [optional] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] + **collateralCurrency** | **String**| Collateral currency | [optional] **borrowCurrency** | **String**| Borrowed currency | [optional] ### Return type @@ -93,13 +93,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **createCollateralLoan** > OrderResp createCollateralLoan(createCollateralOrder) -Place order +Place collateral loan order ### Example @@ -161,13 +161,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | Order placed successfully | - | # **getCollateralLoanOrderDetail** > CollateralOrder getCollateralLoanOrderDetail(orderId) -Get a single order +Query single order details ### Example @@ -190,7 +190,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); CollateralLoanApi apiInstance = new CollateralLoanApi(defaultClient); - Long orderId = 100001L; // Long | Order ID returned on successful order creation + Long orderId = 100001L; // Long | Order ID returned when order is successfully created try { CollateralOrder result = apiInstance.getCollateralLoanOrderDetail(orderId); System.out.println(result); @@ -211,7 +211,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **orderId** | **Long**| Order ID returned on successful order creation | + **orderId** | **Long**| Order ID returned when order is successfully created | ### Return type @@ -229,13 +229,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | Order details queried successfully | - | # **repayCollateralLoan** > RepayResp repayCollateralLoan(repayLoan) -Repayment +Collateral loan repayment ### Example @@ -297,13 +297,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Operated successfully | - | +**200** | Operation successful | - | # **listRepayRecords** > List<RepayRecord> listRepayRecords(source).borrowCurrency(borrowCurrency).collateralCurrency(collateralCurrency).page(page).limit(limit).from(from).to(to).execute(); -Repayment history +Query collateral loan repayment records ### Example @@ -328,11 +328,11 @@ public class Example { CollateralLoanApi apiInstance = new CollateralLoanApi(defaultClient); String source = "repay"; // String | Operation type: repay - Regular repayment, liquidate - Liquidation String borrowCurrency = "USDT"; // String | Borrowed currency - String collateralCurrency = "BTC"; // String | Collateral + String collateralCurrency = "BTC"; // String | Collateral currency Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list - Long from = 1609459200L; // Long | Start timestamp of the query - Long to = 1609459200L; // Long | Time range ending, default to current time + Integer limit = 100; // Integer | Maximum number of records returned in a single list + Long from = 1609459200L; // Long | Start timestamp for the query + Long to = 1609459200L; // Long | End timestamp for the query, defaults to current time if not specified try { List result = apiInstance.listRepayRecords(source) .borrowCurrency(borrowCurrency) @@ -362,11 +362,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **source** | **String**| Operation type: repay - Regular repayment, liquidate - Liquidation | **borrowCurrency** | **String**| Borrowed currency | [optional] - **collateralCurrency** | **String**| Collateral | [optional] + **collateralCurrency** | **String**| Collateral currency | [optional] **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] - **from** | **Long**| Start timestamp of the query | [optional] - **to** | **Long**| Time range ending, default to current time | [optional] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] + **from** | **Long**| Start timestamp for the query | [optional] + **to** | **Long**| End timestamp for the query, defaults to current time if not specified | [optional] ### Return type @@ -384,7 +384,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listCollateralRecords** @@ -414,11 +414,11 @@ public class Example { CollateralLoanApi apiInstance = new CollateralLoanApi(defaultClient); Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list - Long from = 1609459200L; // Long | Start timestamp of the query - Long to = 1609459200L; // Long | Time range ending, default to current time + Integer limit = 100; // Integer | Maximum number of records returned in a single list + Long from = 1609459200L; // Long | Start timestamp for the query + Long to = 1609459200L; // Long | End timestamp for the query, defaults to current time if not specified String borrowCurrency = "USDT"; // String | Borrowed currency - String collateralCurrency = "BTC"; // String | Collateral + String collateralCurrency = "BTC"; // String | Collateral currency try { List result = apiInstance.listCollateralRecords() .page(page) @@ -447,11 +447,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] - **from** | **Long**| Start timestamp of the query | [optional] - **to** | **Long**| Time range ending, default to current time | [optional] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] + **from** | **Long**| Start timestamp for the query | [optional] + **to** | **Long**| End timestamp for the query, defaults to current time if not specified | [optional] **borrowCurrency** | **String**| Borrowed currency | [optional] - **collateralCurrency** | **String**| Collateral | [optional] + **collateralCurrency** | **String**| Collateral currency | [optional] ### Return type @@ -469,7 +469,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **operateCollateral** @@ -536,13 +536,13 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Operated successfully | - | +**204** | Operation successful | - | # **getUserTotalAmount** > UserTotalAmount getUserTotalAmount() -Query the total borrowing and collateral amount for the user +Query user's total borrowing and collateral amount ### Example @@ -600,13 +600,13 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **getUserLtvInfo** > UserLtvInfo getUserLtvInfo(collateralCurrency, borrowCurrency) -Query user's collateralization ratio +Query user's collateralization ratio and remaining borrowable currencies ### Example @@ -629,7 +629,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); CollateralLoanApi apiInstance = new CollateralLoanApi(defaultClient); - String collateralCurrency = "BTC"; // String | Collateral + String collateralCurrency = "BTC"; // String | Collateral currency String borrowCurrency = "USDT"; // String | Borrowed currency try { UserLtvInfo result = apiInstance.getUserLtvInfo(collateralCurrency, borrowCurrency); @@ -651,7 +651,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **collateralCurrency** | **String**| Collateral | + **collateralCurrency** | **String**| Collateral currency | **borrowCurrency** | **String**| Borrowed currency | ### Return type @@ -670,7 +670,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listCollateralCurrencies** @@ -695,7 +695,7 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); CollateralLoanApi apiInstance = new CollateralLoanApi(defaultClient); - String loanCurrency = "BTC"; // String | The parameter loan_currency is used to specify the borrowing currency. If loan_currency is not provided, the API will return all supported borrowing currencies. If loan_currency is provided, the API will return an array of collateral currencies supported for the specified borrowing currency. + String loanCurrency = "BTC"; // String | Parameter loan_currency. If omitted, returns all supported borrowing currencies; if provided, returns the array of collateral currencies supported for that borrowing currency try { List result = apiInstance.listCollateralCurrencies() .loanCurrency(loanCurrency) @@ -718,7 +718,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **loanCurrency** | **String**| The parameter loan_currency is used to specify the borrowing currency. If loan_currency is not provided, the API will return all supported borrowing currencies. If loan_currency is provided, the API will return an array of collateral currencies supported for the specified borrowing currency. | [optional] + **loanCurrency** | **String**| 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 @@ -736,5 +736,5 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | diff --git a/docs/CollateralLtv.md b/docs/CollateralLtv.md index 9812ae4..7d6af97 100644 --- a/docs/CollateralLtv.md +++ b/docs/CollateralLtv.md @@ -1,13 +1,13 @@ # CollateralLtv -Collateral Ratio +Multi-collateral ratio ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**initLtv** | **String** | The initial collateralization rate | [optional] -**alertLtv** | **String** | Warning collateralization ratio | [optional] -**liquidateLtv** | **String** | The liquidation collateralization rate | [optional] +**initLtv** | **String** | Initial collateralization rate | [optional] +**alertLtv** | **String** | Warning collateralization rate | [optional] +**liquidateLtv** | **String** | Liquidation collateralization rate | [optional] diff --git a/docs/CollateralOrder.md b/docs/CollateralOrder.md index bae42ce..19cb8bd 100644 --- a/docs/CollateralOrder.md +++ b/docs/CollateralOrder.md @@ -1,26 +1,26 @@ # CollateralOrder -Collateral Order +Collateral order ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **orderId** | **Long** | Order ID | [optional] -**collateralCurrency** | **String** | Collateral | [optional] +**collateralCurrency** | **String** | Collateral currency | [optional] **collateralAmount** | **String** | Collateral amount | [optional] **borrowCurrency** | **String** | Borrowed currency | [optional] -**borrowAmount** | **String** | Borrowing amount | [optional] +**borrowAmount** | **String** | Borrowed amount | [optional] **repaidAmount** | **String** | Repaid amount | [optional] **repaidPrincipal** | **String** | Repaid principal | [optional] **repaidInterest** | **String** | Repaid interest | [optional] -**initLtv** | **String** | The initial collateralization rate | [optional] -**currentLtv** | **String** | The current collateralization rate | [optional] -**liquidateLtv** | **String** | The liquidation collateralization rate | [optional] +**initLtv** | **String** | Initial collateralization rate | [optional] +**currentLtv** | **String** | Current collateralization rate | [optional] +**liquidateLtv** | **String** | Liquidation collateralization rate | [optional] **status** | **String** | 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] **borrowTime** | **Long** | Borrowing time, timestamp in seconds | [optional] **leftRepayTotal** | **String** | Outstanding principal and interest (outstanding principal + outstanding interest) | [optional] -**leftRepayPrincipal** | **String** | outstanding principal | [optional] -**leftRepayInterest** | **String** | outstanding interest | [optional] +**leftRepayPrincipal** | **String** | Outstanding principal | [optional] +**leftRepayInterest** | **String** | Outstanding interest | [optional] diff --git a/docs/CollateralRecord.md b/docs/CollateralRecord.md index e50dc83..da9834c 100644 --- a/docs/CollateralRecord.md +++ b/docs/CollateralRecord.md @@ -10,11 +10,11 @@ Name | Type | Description | Notes **orderId** | **Long** | Order ID | [optional] **recordId** | **Long** | Collateral record ID | [optional] **borrowCurrency** | **String** | Borrowed currency | [optional] -**borrowAmount** | **String** | Borrowing amount | [optional] -**collateralCurrency** | **String** | Collateral | [optional] -**beforeCollateral** | **String** | The collateral amount before adjustment | [optional] -**afterCollateral** | **String** | The collateral amount after adjustment | [optional] -**beforeLtv** | **String** | The collateral ratio before adjustment | [optional] -**afterLtv** | **String** | The collateral ratio after adjustment | [optional] -**operateTime** | **Long** | Timestamp of the operation, in seconds | [optional] +**borrowAmount** | **String** | Borrowed amount | [optional] +**collateralCurrency** | **String** | Collateral currency | [optional] +**beforeCollateral** | **String** | Collateral amount before adjustment | [optional] +**afterCollateral** | **String** | Collateral amount after adjustment | [optional] +**beforeLtv** | **String** | Collateral ratio before adjustment | [optional] +**afterLtv** | **String** | Collateral ratio after adjustment | [optional] +**operateTime** | **Long** | Operation time, timestamp in seconds | [optional] diff --git a/docs/Contract.md b/docs/Contract.md index c691186..2b2b400 100644 --- a/docs/Contract.md +++ b/docs/Contract.md @@ -8,41 +8,45 @@ Futures contract details Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | Futures contract | [optional] -**type** | [**TypeEnum**](#TypeEnum) | Futures contract type | [optional] +**type** | [**TypeEnum**](#TypeEnum) | Contract type: inverse - inverse contract, direct - direct contract | [optional] **quantoMultiplier** | **String** | Multiplier used in converting from invoicing to settlement currency | [optional] **leverageMin** | **String** | Minimum leverage | [optional] **leverageMax** | **String** | Maximum leverage | [optional] **maintenanceRate** | **String** | Maintenance rate of margin | [optional] -**markType** | [**MarkTypeEnum**](#MarkTypeEnum) | Mark price type, internal - based on internal trading, index - based on external index price | [optional] +**markType** | [**MarkTypeEnum**](#MarkTypeEnum) | Mark price type: internal - internal trading price, index - external index price | [optional] **markPrice** | **String** | Current mark price | [optional] **indexPrice** | **String** | Current index price | [optional] **lastPrice** | **String** | Last trading price | [optional] -**makerFeeRate** | **String** | Maker fee rate, where negative means rebate | [optional] +**makerFeeRate** | **String** | Maker fee rate, negative values indicate rebates | [optional] **takerFeeRate** | **String** | Taker fee rate | [optional] **orderPriceRound** | **String** | Minimum order price increment | [optional] **markPriceRound** | **String** | Minimum mark price increment | [optional] **fundingRate** | **String** | Current funding rate | [optional] **fundingInterval** | **Integer** | Funding application interval, unit in seconds | [optional] **fundingNextApply** | **Double** | Next funding time | [optional] -**riskLimitBase** | **String** | Risk limit base,deprecated | [optional] -**riskLimitStep** | **String** | Step of adjusting risk limit,deprecated | [optional] -**riskLimitMax** | **String** | Maximum risk limit the contract allowed,deprecated,It is recommended to use /futures/{settle}/risk_limit_tiers to query risk limits. | [optional] -**orderSizeMin** | **Long** | Minimum order size the contract allowed | [optional] -**orderSizeMax** | **Long** | Maximum order size the contract allowed | [optional] -**orderPriceDeviate** | **String** | 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] -**refDiscountRate** | **String** | Referral fee rate discount | [optional] -**refRebateRate** | **String** | Referrer commission rate | [optional] -**orderbookId** | **Long** | Current orderbook ID | [optional] +**riskLimitBase** | **String** | Base risk limit (deprecated) | [optional] +**riskLimitStep** | **String** | Risk limit adjustment step (deprecated) | [optional] +**riskLimitMax** | **String** | Maximum risk limit allowed by the contract (deprecated). It is recommended to use /futures/{settle}/risk_limit_tiers to query risk limits | [optional] +**orderSizeMin** | **Long** | Minimum order size allowed by the contract | [optional] +**orderSizeMax** | **Long** | Maximum order size allowed by the contract | [optional] +**orderPriceDeviate** | **String** | 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] +**refDiscountRate** | **String** | Trading fee discount for referred users | [optional] +**refRebateRate** | **String** | Commission rate for referrers | [optional] +**orderbookId** | **Long** | Orderbook update ID | [optional] **tradeId** | **Long** | Current trade ID | [optional] -**tradeSize** | **Long** | Historical accumulated trade size | [optional] +**tradeSize** | **Long** | Historical cumulative trading volume | [optional] **positionSize** | **Long** | Current total long position size | [optional] -**configChangeTime** | **Double** | Last changed time of configuration | [optional] -**inDelisting** | **Boolean** | `in_delisting=true` And when position_size>0, it means the contract is in the offline transition period `in_delisting=true` And when position_size=0, it means the contract is offline | [optional] -**ordersLimit** | **Integer** | Maximum number of open orders | [optional] -**enableBonus** | **Boolean** | Whether bouns is enabled | [optional] +**configChangeTime** | **Double** | Last configuration update time | [optional] +**inDelisting** | **Boolean** | `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] +**ordersLimit** | **Integer** | Maximum number of pending orders | [optional] +**enableBonus** | **Boolean** | Whether bonus is enabled | [optional] **enableCredit** | **Boolean** | Whether portfolio margin account is enabled | [optional] **createTime** | **Double** | Created time of the contract | [optional] **fundingCapRatio** | **String** | 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** | **String** | Contract status types include: prelaunch (pre-launch), trading (active), delisting (delisting), delisted (delisted), circuit_breaker (circuit breaker) | [optional] +**launchTime** | **Long** | Contract expiry timestamp | [optional] +**delistingTime** | **Long** | Timestamp when contract enters reduce-only state | [optional] +**delistedTime** | **Long** | Contract delisting time | [optional] ## Enum: TypeEnum diff --git a/docs/ContractStat.md b/docs/ContractStat.md index d8552a1..8bb0eb6 100644 --- a/docs/ContractStat.md +++ b/docs/ContractStat.md @@ -6,16 +6,17 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **time** | **Long** | Stat timestamp | [optional] -**lsrTaker** | [**BigDecimal**](BigDecimal.md) | Long/short account number ratio | [optional] -**lsrAccount** | [**BigDecimal**](BigDecimal.md) | Long/short taker size ratio | [optional] -**longLiqSize** | **Long** | Long liquidation size | [optional] -**longLiqAmount** | **Double** | Long liquidation amount(base currency) | [optional] -**longLiqUsd** | **Double** | Long liquidation volume(quote currency) | [optional] -**shortLiqSize** | **Long** | Short liquidation size | [optional] -**shortLiqAmount** | **Double** | Short liquidation amount(base currency) | [optional] -**shortLiqUsd** | **Double** | Short liquidation volume(quote currency) | [optional] -**openInterest** | **Long** | Open interest size | [optional] -**openInterestUsd** | **Double** | Open interest volume(quote currency) | [optional] +**lsrTaker** | [**BigDecimal**](BigDecimal.md) | Long/short taker ratio | [optional] +**lsrAccount** | [**BigDecimal**](BigDecimal.md) | Long/short position user ratio | [optional] +**longLiqSize** | **Long** | Long liquidation size (contracts) | [optional] +**longLiqAmount** | **Double** | Long liquidation amount (base currency) | [optional] +**longLiqUsd** | **Double** | Long liquidation volume (quote currency) | [optional] +**shortLiqSize** | **Long** | Short liquidation size (contracts) | [optional] +**shortLiqAmount** | **Double** | Short liquidation amount (base currency) | [optional] +**shortLiqUsd** | **Double** | Short liquidation volume (quote currency) | [optional] +**openInterest** | **Long** | Total open interest size (contracts) | [optional] +**openInterestUsd** | **Double** | Total open interest volume (quote currency) | [optional] **topLsrAccount** | **Double** | Top trader long/short account ratio | [optional] **topLsrSize** | **Double** | Top trader long/short position ratio | [optional] +**markPrice** | **Double** | Mark price | [optional] diff --git a/docs/ConvertSmallBalance.md b/docs/ConvertSmallBalance.md index b178eae..b661716 100644 --- a/docs/ConvertSmallBalance.md +++ b/docs/ConvertSmallBalance.md @@ -1,12 +1,12 @@ # ConvertSmallBalance -Convert Small Balance +Small Balance Conversion ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **List<String>** | Currency | [optional] -**isAll** | **Boolean** | Whether to exchange all | [optional] +**currency** | **List<String>** | Currency to be converted | [optional] +**isAll** | **Boolean** | Whether to convert all | [optional] diff --git a/docs/CountdownCancelAllFuturesTask.md b/docs/CountdownCancelAllFuturesTask.md index e148bc8..cf945ef 100644 --- a/docs/CountdownCancelAllFuturesTask.md +++ b/docs/CountdownCancelAllFuturesTask.md @@ -1,12 +1,12 @@ # CountdownCancelAllFuturesTask -Countdown cancel task detail +Countdown cancel task details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**timeout** | **Integer** | Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown | +**timeout** | **Integer** | Countdown time in seconds At least 5 seconds, 0 means cancel countdown | **contract** | **String** | Futures contract | [optional] diff --git a/docs/CountdownCancelAllOptionsTask.md b/docs/CountdownCancelAllOptionsTask.md index 97779c7..58afd19 100644 --- a/docs/CountdownCancelAllOptionsTask.md +++ b/docs/CountdownCancelAllOptionsTask.md @@ -1,13 +1,13 @@ # CountdownCancelAllOptionsTask -Countdown cancel task detail +Countdown cancel task details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**timeout** | **Integer** | Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown | +**timeout** | **Integer** | Countdown time in seconds At least 5 seconds, 0 means cancel countdown | **contract** | **String** | Options contract name | [optional] **underlying** | **String** | Underlying | [optional] diff --git a/docs/CountdownCancelAllSpotTask.md b/docs/CountdownCancelAllSpotTask.md index 797d188..8b8ffc2 100644 --- a/docs/CountdownCancelAllSpotTask.md +++ b/docs/CountdownCancelAllSpotTask.md @@ -1,12 +1,12 @@ # CountdownCancelAllSpotTask -Countdown cancel task detail +Countdown cancel task details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**timeout** | **Integer** | Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown | +**timeout** | **Integer** | Countdown time in seconds At least 5 seconds, 0 means cancel countdown | **currencyPair** | **String** | Currency pair | [optional] diff --git a/docs/CreateCollateralOrder.md b/docs/CreateCollateralOrder.md index f8aebc7..9d28efe 100644 --- a/docs/CreateCollateralOrder.md +++ b/docs/CreateCollateralOrder.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **collateralAmount** | **String** | Collateral amount | -**collateralCurrency** | **String** | Collateral | -**borrowAmount** | **String** | Borrowing amount | +**collateralCurrency** | **String** | Collateral currency | +**borrowAmount** | **String** | Borrowed amount | **borrowCurrency** | **String** | Borrowed currency | diff --git a/docs/CreateMultiCollateralOrder.md b/docs/CreateMultiCollateralOrder.md index 73064fe..73b75d2 100644 --- a/docs/CreateMultiCollateralOrder.md +++ b/docs/CreateMultiCollateralOrder.md @@ -6,12 +6,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **orderId** | **String** | Order ID | [optional] -**orderType** | **String** | current - current, fixed - fixed, if not specified, default to current | [optional] -**fixedType** | **String** | Fixed interest rate loan period: 7d - 7 days, 30d - 30 days. Must be provided for fixed | [optional] -**fixedRate** | **String** | Fixed interest rate, must be specified for fixed | [optional] -**autoRenew** | **Boolean** | Fixed interest rate, automatic renewal | [optional] -**autoRepay** | **Boolean** | Fixed interest rate, automatic repayment | [optional] +**orderType** | **String** | current - current rate, fixed - fixed rate, defaults to current if not specified | [optional] +**fixedType** | **String** | Fixed interest rate lending period: 7d - 7 days, 30d - 30 days. Required for fixed rate | [optional] +**fixedRate** | **String** | Fixed interest rate, required for fixed rate | [optional] +**autoRenew** | **Boolean** | Fixed interest rate, auto-renewal | [optional] +**autoRepay** | **Boolean** | Fixed interest rate, auto-repayment | [optional] **borrowCurrency** | **String** | Borrowed currency | -**borrowAmount** | **String** | Borrowing amount | +**borrowAmount** | **String** | Borrowed amount | **collateralCurrencies** | [**List<CollateralCurrency>**](CollateralCurrency.md) | Collateral currency and amount | [optional] diff --git a/docs/CreateUniLend.md b/docs/CreateUniLend.md index f280986..af2ee4a 100644 --- a/docs/CreateUniLend.md +++ b/docs/CreateUniLend.md @@ -1,16 +1,16 @@ # CreateUniLend -Lend or redeem +Create lending or redemption ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | Currency name | -**amount** | **String** | The amount of currency could be lent | -**type** | [**TypeEnum**](#TypeEnum) | type: lend - lend, redeem - redeem | -**minRate** | **String** | The minimum interest rate. If the value is too high, it might lead to the unsuccessful lending and no profit will be gained for that hour. | [optional] +**amount** | **String** | Amount to deposit into lending pool | +**type** | [**TypeEnum**](#TypeEnum) | Operation type: lend - Lend, redeem - Redeem | +**minRate** | **String** | Minimum interest rate. If set too high, lending may fail and no interest will be earned. Required for lending operations. | [optional] ## Enum: TypeEnum diff --git a/docs/CreateUniLoan.md b/docs/CreateUniLoan.md index 990887e..350308f 100644 --- a/docs/CreateUniLoan.md +++ b/docs/CreateUniLoan.md @@ -8,9 +8,9 @@ Borrow or repay Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | Currency | -**type** | [**TypeEnum**](#TypeEnum) | type: borrow - borrow, repay - repay | -**amount** | **String** | The amount of lending or repaying | -**repaidAll** | **Boolean** | Full repayment. Repay operation only. If the value is `true`, the amount will be ignored and the loan will be repaid in full. | [optional] +**type** | [**TypeEnum**](#TypeEnum) | Type: `borrow` - borrow, `repay` - repay | +**amount** | **String** | Borrow or repayment amount | +**repaidAll** | **Boolean** | Full repayment. For repayment operations only. When `true`, overrides `amount` and repays the full amount | [optional] **currencyPair** | **String** | Currency pair | ## Enum: TypeEnum diff --git a/docs/CrossMarginAccount.md b/docs/CrossMarginAccount.md deleted file mode 100644 index 1ea0b0a..0000000 --- a/docs/CrossMarginAccount.md +++ /dev/null @@ -1,25 +0,0 @@ - -# CrossMarginAccount - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**userId** | **Long** | User ID | [optional] -**refreshTime** | **Long** | Time of the most recent refresh | [optional] -**locked** | **Boolean** | Whether account is locked | [optional] -**balances** | [**Map<String, CrossMarginBalance>**](CrossMarginBalance.md) | | [optional] -**total** | **String** | Total account value in USDT, i.e., the sum of all currencies' `(available+freeze)*price*discount` | [optional] -**borrowed** | **String** | Total borrowed value in USDT, i.e., the sum of all currencies' `borrowed*price*discount` | [optional] -**interest** | **String** | Total unpaid interests in USDT, i.e., the sum of all currencies' `interest*price*discount` | [optional] -**risk** | **String** | Risk rate. When it belows 110%, liquidation will be triggered. Calculation formula: `total / (borrowed+interest)` | [optional] -**totalInitialMargin** | **String** | Total initial margin | [optional] -**totalMarginBalance** | **String** | Total Margin Balance (∑(positive equity ＊ index price * discount) + ∑(negative equity * index price)) | [optional] -**totalMaintenanceMargin** | **String** | Total maintenance margin | [optional] -**totalInitialMarginRate** | **String** | Total initial margin rate | [optional] -**totalMaintenanceMarginRate** | **String** | Total maintenance margin rate | [optional] -**totalAvailableMargin** | **String** | Total available margin | [optional] -**portfolioMarginTotal** | **String** | Total amount of the portfolio margin account | [optional] -**portfolioMarginTotalLiab** | **String** | Total liabilities of the portfolio margin account | [optional] -**portfolioMarginTotalEquity** | **String** | Total equity of the portfolio margin account | [optional] - diff --git a/docs/CrossMarginAccountBook.md b/docs/CrossMarginAccountBook.md deleted file mode 100644 index de80b26..0000000 --- a/docs/CrossMarginAccountBook.md +++ /dev/null @@ -1,14 +0,0 @@ - -# CrossMarginAccountBook - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | Balance change record ID | [optional] -**time** | **Long** | The timestamp of the change (in milliseconds) | [optional] -**currency** | **String** | Currency changed | [optional] -**change** | **String** | Amount changed. Positive value means transferring in, while negative out | [optional] -**balance** | **String** | Balance after change | [optional] -**type** | **String** | Account book type. Please refer to [account book type](#accountbook-type) for more detail | [optional] - diff --git a/docs/CrossMarginBalance.md b/docs/CrossMarginBalance.md index 84f02d6..347d99a 100644 --- a/docs/CrossMarginBalance.md +++ b/docs/CrossMarginBalance.md @@ -5,13 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**available** | **String** | Available amount | [optional] -**freeze** | **String** | Locked amount | [optional] -**borrowed** | **String** | Borrowed amount | [optional] -**interest** | **String** | Unpaid interests | [optional] -**negativeLiab** | **String** | Negative Liabilities. Formula:Min[available+total+unrealized_pnl,0] | [optional] -**futuresPosLiab** | **String** | Borrowing to Open Positions in Futures | [optional] -**equity** | **String** | Equity. Formula: available + freeze - borrowed + futures account's total + unrealized_pnl | [optional] -**totalFreeze** | **String** | Total freeze. Formula: freeze + position_initial_margin + order_margin | [optional] -**totalLiab** | **String** | Total liabilities. Formula: Max[Abs[Min[quity - total_freeze,0], borrowed]] - futures_pos_liab | [optional] +**available** | **String** | Available balance | [optional] +**freeze** | **String** | Locked balance | [optional] +**borrowed** | **String** | Borrowed balance | [optional] +**interest** | **String** | Unpaid interest | [optional] diff --git a/docs/CrossMarginBalance1.md b/docs/CrossMarginBalance1.md deleted file mode 100644 index 0ba73d5..0000000 --- a/docs/CrossMarginBalance1.md +++ /dev/null @@ -1,12 +0,0 @@ - -# CrossMarginBalance1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**available** | **String** | Available amount | [optional] -**freeze** | **String** | Locked amount | [optional] -**borrowed** | **String** | Borrowed amount | [optional] -**interest** | **String** | Unpaid interests | [optional] - diff --git a/docs/CrossMarginCurrency.md b/docs/CrossMarginCurrency.md deleted file mode 100644 index 2b97f98..0000000 --- a/docs/CrossMarginCurrency.md +++ /dev/null @@ -1,18 +0,0 @@ - -# CrossMarginCurrency - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **String** | Currency name | [optional] -**rate** | **String** | Minimum lending rate (hourly rate) | [optional] -**prec** | **String** | Currency precision | [optional] -**discount** | **String** | Currency value discount, which is used in total value calculation | [optional] -**minBorrowAmount** | **String** | Minimum currency borrow amount. Unit is currency itself | [optional] -**userMaxBorrowAmount** | **String** | Maximum borrow value allowed per user, in USDT | [optional] -**totalMaxBorrowAmount** | **String** | Maximum borrow value allowed for this currency, in USDT | [optional] -**price** | **String** | Price change between this currency and USDT | [optional] -**loanable** | **Boolean** | Whether currency is borrowed | [optional] -**status** | **Integer** | status - `0` : disable - `1` : enable | [optional] - diff --git a/docs/CrossMarginLoan.md b/docs/CrossMarginLoan.md index b9fe1d6..3572614 100644 --- a/docs/CrossMarginLoan.md +++ b/docs/CrossMarginLoan.md @@ -14,7 +14,7 @@ Name | Type | Description | Notes **status** | [**StatusEnum**](#StatusEnum) | 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** | **String** | Repaid amount | [optional] [readonly] **repaidInterest** | **String** | Repaid interest | [optional] [readonly] -**unpaidInterest** | **String** | Outstanding interest yet to be paid | [optional] [readonly] +**unpaidInterest** | **String** | Unpaid interest | [optional] [readonly] ## Enum: StatusEnum diff --git a/docs/CrossMarginRepayRequest.md b/docs/CrossMarginRepayRequest.md deleted file mode 100644 index 2e847b3..0000000 --- a/docs/CrossMarginRepayRequest.md +++ /dev/null @@ -1,10 +0,0 @@ - -# CrossMarginRepayRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**currency** | **String** | Repayment currency | -**amount** | **String** | Repayment amount | - diff --git a/docs/CrossMarginRepayment.md b/docs/CrossMarginRepayment.md index 5759bf6..04c92f9 100644 --- a/docs/CrossMarginRepayment.md +++ b/docs/CrossMarginRepayment.md @@ -11,5 +11,5 @@ Name | Type | Description | Notes **currency** | **String** | Currency name | [optional] **principal** | **String** | Repaid principal | [optional] **interest** | **String** | Repaid interest | [optional] -**repaymentType** | **String** | Repayment type: none - no repayment type, manual_repay - manual repayment, auto_repay - automatic repayment, cancel_auto_repay - automatic repayment after cancellation | [optional] [readonly] +**repaymentType** | **String** | Repayment type: none - no repayment type, manual_repay - manual repayment, auto_repay - automatic repayment after cancellation | [optional] [readonly] diff --git a/docs/CrossMarginTransferable.md b/docs/CrossMarginTransferable.md deleted file mode 100644 index ba551b9..0000000 --- a/docs/CrossMarginTransferable.md +++ /dev/null @@ -1,10 +0,0 @@ - -# CrossMarginTransferable - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**currency** | **String** | Currency detail | [optional] -**amount** | **String** | Max transferable amount | [optional] - diff --git a/docs/CurrencyChain.md b/docs/CurrencyChain.md index f5dde3b..ff36e70 100644 --- a/docs/CurrencyChain.md +++ b/docs/CurrencyChain.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **nameEn** | **String** | Chain name in English | [optional] **contractAddress** | **String** | Smart contract address for the currency; if no address is available, it will be an empty string | [optional] **isDisabled** | **Integer** | If it is disabled. 0 means NOT being disabled | [optional] -**isDepositDisabled** | **Integer** | Is deposit disabled. 0 means not | [optional] -**isWithdrawDisabled** | **Integer** | Is withdrawal disabled. 0 means not | [optional] +**isDepositDisabled** | **Integer** | Is deposit disabled. 0 means not disabled | [optional] +**isWithdrawDisabled** | **Integer** | Is withdrawal disabled. 0 means not disabled | [optional] **decimal** | **String** | Withdrawal precision | [optional] diff --git a/docs/CurrencyPair.md b/docs/CurrencyPair.md index 1ed4f0b..1295908 100644 --- a/docs/CurrencyPair.md +++ b/docs/CurrencyPair.md @@ -9,22 +9,23 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | Currency pair | [optional] **base** | **String** | Base currency | [optional] -**baseName** | **String** | Transaction currency name | [optional] +**baseName** | **String** | Base currency name | [optional] **quote** | **String** | Quote currency | [optional] -**quoteName** | **String** | Name of the denominated currency | [optional] -**fee** | **String** | Trading fee | [optional] +**quoteName** | **String** | Quote currency name | [optional] +**fee** | **String** | Trading fee rate | [optional] **minBaseAmount** | **String** | Minimum amount of base currency to trade, `null` means no limit | [optional] **minQuoteAmount** | **String** | Minimum amount of quote currency to trade, `null` means no limit | [optional] **maxBaseAmount** | **String** | Maximum amount of base currency to trade, `null` means no limit | [optional] **maxQuoteAmount** | **String** | Maximum amount of quote currency to trade, `null` means no limit | [optional] **amountPrecision** | **Integer** | Amount scale | [optional] **precision** | **Integer** | Price scale | [optional] -**tradeStatus** | [**TradeStatusEnum**](#TradeStatusEnum) | How currency pair can be traded - untradable: cannot be bought or sold - buyable: can be bought - sellable: can be sold - tradable: can be bought or sold | [optional] +**tradeStatus** | [**TradeStatusEnum**](#TradeStatusEnum) | Trading status - untradable: cannot be traded - buyable: can be bought - sellable: can be sold - tradable: can be bought and sold | [optional] **sellStart** | **Long** | Sell start unix timestamp in seconds | [optional] **buyStart** | **Long** | Buy start unix timestamp in seconds | [optional] **delistingTime** | **Long** | Expected time to remove the shelves, Unix timestamp in seconds | [optional] **type** | **String** | Trading pair type, normal: normal, premarket: pre-market | [optional] **tradeUrl** | **String** | Transaction link | [optional] +**stTag** | **Boolean** | Whether the trading pair is in ST risk assessment, false - No, true - Yes | [optional] ## Enum: TradeStatusEnum diff --git a/docs/CurrencyQuota.md b/docs/CurrencyQuota.md index c373522..93926c2 100644 --- a/docs/CurrencyQuota.md +++ b/docs/CurrencyQuota.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | Currency | [optional] **indexPrice** | **String** | Currency Index Price | [optional] -**minQuota** | **String** | Minimum borrowing/collateral quota for the currency | [optional] -**leftQuota** | **String** | Remaining borrowing/collateral limit for the currency | [optional] +**minQuota** | **String** | Minimum borrowing/collateral limit for the currency | [optional] +**leftQuota** | **String** | Remaining borrowing/collateral quota for the currency | [optional] **leftQuoteUsdt** | **String** | Remaining currency limit converted to USDT | [optional] diff --git a/docs/DebitFee.md b/docs/DebitFee.md index e1c5c1e..1a736a8 100644 --- a/docs/DebitFee.md +++ b/docs/DebitFee.md @@ -5,5 +5,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**enabled** | **Boolean** | Whether GT fee discount is used | +**enabled** | **Boolean** | Whether GT fee deduction is enabled | diff --git a/docs/DeliveryApi.md b/docs/DeliveryApi.md index 63f29c3..21bb9c4 100644 --- a/docs/DeliveryApi.md +++ b/docs/DeliveryApi.md @@ -4,42 +4,42 @@ All URIs are relative to *https://api.gateio.ws/api/v4* Method | HTTP request | Description ------------- | ------------- | ------------- -[**listDeliveryContracts**](DeliveryApi.md#listDeliveryContracts) | **GET** /delivery/{settle}/contracts | List all futures contracts -[**getDeliveryContract**](DeliveryApi.md#getDeliveryContract) | **GET** /delivery/{settle}/contracts/{contract} | Get a single contract -[**listDeliveryOrderBook**](DeliveryApi.md#listDeliveryOrderBook) | **GET** /delivery/{settle}/order_book | Futures order book -[**listDeliveryTrades**](DeliveryApi.md#listDeliveryTrades) | **GET** /delivery/{settle}/trades | Futures trading history -[**listDeliveryCandlesticks**](DeliveryApi.md#listDeliveryCandlesticks) | **GET** /delivery/{settle}/candlesticks | Get futures candlesticks -[**listDeliveryTickers**](DeliveryApi.md#listDeliveryTickers) | **GET** /delivery/{settle}/tickers | List futures tickers -[**listDeliveryInsuranceLedger**](DeliveryApi.md#listDeliveryInsuranceLedger) | **GET** /delivery/{settle}/insurance | Futures insurance balance history -[**listDeliveryAccounts**](DeliveryApi.md#listDeliveryAccounts) | **GET** /delivery/{settle}/accounts | Query futures account -[**listDeliveryAccountBook**](DeliveryApi.md#listDeliveryAccountBook) | **GET** /delivery/{settle}/account_book | Query account book -[**listDeliveryPositions**](DeliveryApi.md#listDeliveryPositions) | **GET** /delivery/{settle}/positions | List all positions of a user -[**getDeliveryPosition**](DeliveryApi.md#getDeliveryPosition) | **GET** /delivery/{settle}/positions/{contract} | Get single position +[**listDeliveryContracts**](DeliveryApi.md#listDeliveryContracts) | **GET** /delivery/{settle}/contracts | Query all futures contracts +[**getDeliveryContract**](DeliveryApi.md#getDeliveryContract) | **GET** /delivery/{settle}/contracts/{contract} | Query single contract information +[**listDeliveryOrderBook**](DeliveryApi.md#listDeliveryOrderBook) | **GET** /delivery/{settle}/order_book | Query futures market depth information +[**listDeliveryTrades**](DeliveryApi.md#listDeliveryTrades) | **GET** /delivery/{settle}/trades | Futures market transaction records +[**listDeliveryCandlesticks**](DeliveryApi.md#listDeliveryCandlesticks) | **GET** /delivery/{settle}/candlesticks | Futures market K-line chart +[**listDeliveryTickers**](DeliveryApi.md#listDeliveryTickers) | **GET** /delivery/{settle}/tickers | Get all futures trading statistics +[**listDeliveryInsuranceLedger**](DeliveryApi.md#listDeliveryInsuranceLedger) | **GET** /delivery/{settle}/insurance | Futures market insurance fund history +[**listDeliveryAccounts**](DeliveryApi.md#listDeliveryAccounts) | **GET** /delivery/{settle}/accounts | Get futures account +[**listDeliveryAccountBook**](DeliveryApi.md#listDeliveryAccountBook) | **GET** /delivery/{settle}/account_book | Query futures account change history +[**listDeliveryPositions**](DeliveryApi.md#listDeliveryPositions) | **GET** /delivery/{settle}/positions | Get user position list +[**getDeliveryPosition**](DeliveryApi.md#getDeliveryPosition) | **GET** /delivery/{settle}/positions/{contract} | Get single position information [**updateDeliveryPositionMargin**](DeliveryApi.md#updateDeliveryPositionMargin) | **POST** /delivery/{settle}/positions/{contract}/margin | Update position margin [**updateDeliveryPositionLeverage**](DeliveryApi.md#updateDeliveryPositionLeverage) | **POST** /delivery/{settle}/positions/{contract}/leverage | Update position leverage [**updateDeliveryPositionRiskLimit**](DeliveryApi.md#updateDeliveryPositionRiskLimit) | **POST** /delivery/{settle}/positions/{contract}/risk_limit | Update position risk limit -[**listDeliveryOrders**](DeliveryApi.md#listDeliveryOrders) | **GET** /delivery/{settle}/orders | List futures orders -[**createDeliveryOrder**](DeliveryApi.md#createDeliveryOrder) | **POST** /delivery/{settle}/orders | Create a futures order -[**cancelDeliveryOrders**](DeliveryApi.md#cancelDeliveryOrders) | **DELETE** /delivery/{settle}/orders | Cancel all `open` orders matched -[**getDeliveryOrder**](DeliveryApi.md#getDeliveryOrder) | **GET** /delivery/{settle}/orders/{order_id} | Get a single order -[**cancelDeliveryOrder**](DeliveryApi.md#cancelDeliveryOrder) | **DELETE** /delivery/{settle}/orders/{order_id} | Cancel a single order -[**getMyDeliveryTrades**](DeliveryApi.md#getMyDeliveryTrades) | **GET** /delivery/{settle}/my_trades | List personal trading history -[**listDeliveryPositionClose**](DeliveryApi.md#listDeliveryPositionClose) | **GET** /delivery/{settle}/position_close | List position close history -[**listDeliveryLiquidates**](DeliveryApi.md#listDeliveryLiquidates) | **GET** /delivery/{settle}/liquidates | List liquidation history -[**listDeliverySettlements**](DeliveryApi.md#listDeliverySettlements) | **GET** /delivery/{settle}/settlements | List settlement history -[**listDeliveryRiskLimitTiers**](DeliveryApi.md#listDeliveryRiskLimitTiers) | **GET** /delivery/{settle}/risk_limit_tiers | List risk limit tiers -[**listPriceTriggeredDeliveryOrders**](DeliveryApi.md#listPriceTriggeredDeliveryOrders) | **GET** /delivery/{settle}/price_orders | List All Price-triggered Orders -[**createPriceTriggeredDeliveryOrder**](DeliveryApi.md#createPriceTriggeredDeliveryOrder) | **POST** /delivery/{settle}/price_orders | Create a price-triggered order -[**cancelPriceTriggeredDeliveryOrderList**](DeliveryApi.md#cancelPriceTriggeredDeliveryOrderList) | **DELETE** /delivery/{settle}/price_orders | Cancel All Price-triggered Orders -[**getPriceTriggeredDeliveryOrder**](DeliveryApi.md#getPriceTriggeredDeliveryOrder) | **GET** /delivery/{settle}/price_orders/{order_id} | Get a price-triggered order -[**cancelPriceTriggeredDeliveryOrder**](DeliveryApi.md#cancelPriceTriggeredDeliveryOrder) | **DELETE** /delivery/{settle}/price_orders/{order_id} | cancel a price-triggered order +[**listDeliveryOrders**](DeliveryApi.md#listDeliveryOrders) | **GET** /delivery/{settle}/orders | Query futures order list +[**createDeliveryOrder**](DeliveryApi.md#createDeliveryOrder) | **POST** /delivery/{settle}/orders | Place futures order +[**cancelDeliveryOrders**](DeliveryApi.md#cancelDeliveryOrders) | **DELETE** /delivery/{settle}/orders | Cancel all orders with 'open' status +[**getDeliveryOrder**](DeliveryApi.md#getDeliveryOrder) | **GET** /delivery/{settle}/orders/{order_id} | Query single order details +[**cancelDeliveryOrder**](DeliveryApi.md#cancelDeliveryOrder) | **DELETE** /delivery/{settle}/orders/{order_id} | Cancel single order +[**getMyDeliveryTrades**](DeliveryApi.md#getMyDeliveryTrades) | **GET** /delivery/{settle}/my_trades | Query personal trading records +[**listDeliveryPositionClose**](DeliveryApi.md#listDeliveryPositionClose) | **GET** /delivery/{settle}/position_close | Query position close history +[**listDeliveryLiquidates**](DeliveryApi.md#listDeliveryLiquidates) | **GET** /delivery/{settle}/liquidates | Query liquidation history +[**listDeliverySettlements**](DeliveryApi.md#listDeliverySettlements) | **GET** /delivery/{settle}/settlements | Query settlement records +[**listDeliveryRiskLimitTiers**](DeliveryApi.md#listDeliveryRiskLimitTiers) | **GET** /delivery/{settle}/risk_limit_tiers | Query risk limit tiers +[**listPriceTriggeredDeliveryOrders**](DeliveryApi.md#listPriceTriggeredDeliveryOrders) | **GET** /delivery/{settle}/price_orders | Query auto order list +[**createPriceTriggeredDeliveryOrder**](DeliveryApi.md#createPriceTriggeredDeliveryOrder) | **POST** /delivery/{settle}/price_orders | Create price-triggered order +[**cancelPriceTriggeredDeliveryOrderList**](DeliveryApi.md#cancelPriceTriggeredDeliveryOrderList) | **DELETE** /delivery/{settle}/price_orders | Cancel all auto orders +[**getPriceTriggeredDeliveryOrder**](DeliveryApi.md#getPriceTriggeredDeliveryOrder) | **GET** /delivery/{settle}/price_orders/{order_id} | Query single auto order details +[**cancelPriceTriggeredDeliveryOrder**](DeliveryApi.md#cancelPriceTriggeredDeliveryOrder) | **DELETE** /delivery/{settle}/price_orders/{order_id} | Cancel single auto order # **listDeliveryContracts** > List<DeliveryContract> listDeliveryContracts(settle) -List all futures contracts +Query all futures contracts ### Example @@ -97,13 +97,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **getDeliveryContract** > DeliveryContract getDeliveryContract(settle, contract) -Get a single contract +Query single contract information ### Example @@ -169,7 +169,7 @@ No authorization required # **listDeliveryOrderBook** > FuturesOrderBook listDeliveryOrderBook(settle, contract).interval(interval).limit(limit).withId(withId).execute(); -Futures order book +Query futures market depth information Bids will be sorted by price from high to low, while asks sorted reversely @@ -192,9 +192,9 @@ public class Example { DeliveryApi apiInstance = new DeliveryApi(defaultClient); String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT_20200814"; // String | Futures contract - String interval = "0"; // String | Order depth. 0 means no aggregation is applied. default to 0 - Integer limit = 10; // Integer | Maximum number of order depth data in asks or bids - Boolean withId = false; // Boolean | Whether the order book update ID will be returned. This ID increases by 1 on every order book update + String interval = "0"; // String | Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified + Integer limit = 10; // Integer | Number of depth levels + Boolean withId = false; // Boolean | Whether to return depth update ID. This ID increments by 1 each time depth changes try { FuturesOrderBook result = apiInstance.listDeliveryOrderBook(settle, contract) .interval(interval) @@ -221,9 +221,9 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: usdt] **contract** | **String**| Futures contract | - **interval** | **String**| Order depth. 0 means no aggregation is applied. default to 0 | [optional] [default to 0] [enum: 0, 0.1, 0.01] - **limit** | **Integer**| Maximum number of order depth data in asks or bids | [optional] [default to 10] - **withId** | **Boolean**| Whether the order book update ID will be returned. This ID increases by 1 on every order book update | [optional] [default to false] + **interval** | **String**| Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified | [optional] [default to 0] [enum: 0, 0.1, 0.01] + **limit** | **Integer**| Number of depth levels | [optional] [default to 10] + **withId** | **Boolean**| Whether to return depth update ID. This ID increments by 1 each time depth changes | [optional] [default to false] ### Return type @@ -241,13 +241,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order book retrieved | - | +**200** | Depth query successful | - | # **listDeliveryTrades** > List<FuturesTrade> listDeliveryTrades(settle, contract).limit(limit).lastId(lastId).from(from).to(to).execute(); -Futures trading history +Futures market transaction records ### Example @@ -268,10 +268,10 @@ public class Example { DeliveryApi apiInstance = new DeliveryApi(defaultClient); String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT_20200814"; // String | Futures contract - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list - String lastId = "12345"; // String | 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 + Integer limit = 100; // Integer | Maximum number of records returned in a single list + String lastId = "12345"; // String | 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 Long from = 1546905600L; // Long | 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. - Long to = 1546935600L; // Long | Specify end time in Unix seconds, default to current time + Long to = 1546935600L; // Long | Specify end time in Unix seconds, default to current time. try { List result = apiInstance.listDeliveryTrades(settle, contract) .limit(limit) @@ -299,10 +299,10 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: usdt] **contract** | **String**| Futures contract | - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] - **lastId** | **String**| Specify the starting point for this list based on a previously retrieved id This parameter is deprecated. Use `from` and `to` instead to limit time range | [optional] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] + **lastId** | **String**| 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** | **Long**| 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** | **Long**| Specify end time in Unix seconds, default to current time | [optional] + **to** | **Long**| Specify end time in Unix seconds, default to current time. | [optional] ### Return type @@ -320,13 +320,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listDeliveryCandlesticks** > List<DeliveryCandlestick> listDeliveryCandlesticks(settle, contract).from(from).to(to).limit(limit).interval(interval).execute(); -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` @@ -350,9 +350,9 @@ public class Example { String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT_20200814"; // String | Futures contract Long from = 1546905600L; // Long | Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified - Long to = 1546935600L; // Long | End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time - Integer limit = 100; // Integer | Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected. - String interval = "5m"; // String | Interval time between data points. Note that `1w` means natual week(Mon-Sun), while `7d` means every 7d since unix 0 + Long to = 1546935600L; // Long | 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 + Integer limit = 100; // Integer | 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. + String interval = "5m"; // String | Time interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial time try { List result = apiInstance.listDeliveryCandlesticks(settle, contract) .from(from) @@ -381,9 +381,9 @@ Name | Type | Description | Notes **settle** | **String**| Settle currency | [enum: usdt] **contract** | **String**| Futures contract | **from** | **Long**| Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified | [optional] - **to** | **Long**| End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time | [optional] - **limit** | **Integer**| 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** | **String**| Interval time between data points. Note that `1w` means natual week(Mon-Sun), while `7d` means every 7d since unix 0 | [optional] [default to 5m] [enum: 10s, 30s, 1m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 7d, 1w, 30d] + **to** | **Long**| 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** | **Integer**| 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** | **String**| Time interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial time | [optional] [default to 5m] [enum: 10s, 30s, 1m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 7d, 1w, 30d] ### Return type @@ -401,13 +401,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listDeliveryTickers** > List<DeliveryTicker> listDeliveryTickers(settle).contract(contract).execute(); -List futures tickers +Get all futures trading statistics ### Example @@ -469,13 +469,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listDeliveryInsuranceLedger** > List<InsuranceRecord> listDeliveryInsuranceLedger(settle).limit(limit).execute(); -Futures insurance balance history +Futures market insurance fund history ### Example @@ -495,7 +495,7 @@ public class Example { DeliveryApi apiInstance = new DeliveryApi(defaultClient); String settle = "usdt"; // String | Settle currency - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list try { List result = apiInstance.listDeliveryInsuranceLedger(settle) .limit(limit) @@ -519,7 +519,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: usdt] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] ### Return type @@ -537,13 +537,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listDeliveryAccounts** > FuturesAccount listDeliveryAccounts(settle) -Query futures account +Get futures account ### Example @@ -605,13 +605,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listDeliveryAccountBook** > List<FuturesAccountBook> listDeliveryAccountBook(settle).limit(limit).from(from).to(to).type(type).execute(); -Query account book +Query futures account change history ### Example @@ -635,10 +635,10 @@ public class Example { DeliveryApi apiInstance = new DeliveryApi(defaultClient); String settle = "usdt"; // String | Settle currency - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list - Long from = 1547706332L; // Long | Start timestamp - Long to = 1547706332L; // Long | End timestamp - String type = "dnw"; // String | Changing Type: - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate + Integer limit = 100; // Integer | Maximum number of records returned in a single list + Long from = 1547706332L; // Long | 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) + Long to = 1547706332L; // Long | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp + String type = "dnw"; // String | 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 try { List result = apiInstance.listDeliveryAccountBook(settle) .limit(limit) @@ -665,10 +665,10 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: usdt] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] - **from** | **Long**| Start timestamp | [optional] - **to** | **Long**| End timestamp | [optional] - **type** | **String**| Changing Type: - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate | [optional] [enum: dnw, pnl, fee, refr, fund, point_dnw, point_fee, point_refr] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] + **from** | **Long**| 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** | **Long**| 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** | **String**| 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] [enum: dnw, pnl, fee, refr, fund, point_dnw, point_fee, point_refr] ### Return type @@ -686,13 +686,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listDeliveryPositions** > List<Position> listDeliveryPositions(settle) -List all positions of a user +Get user position list ### Example @@ -754,13 +754,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **getDeliveryPosition** > Position getDeliveryPosition(settle, contract) -Get single position +Get single position information ### Example @@ -855,7 +855,7 @@ public class Example { DeliveryApi apiInstance = new DeliveryApi(defaultClient); String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT_20200814"; // String | Futures contract - String change = "0.01"; // String | Margin change. Use positive number to increase margin, negative number otherwise. + String change = "0.01"; // String | Margin change amount, positive number increases, negative number decreases try { Position result = apiInstance.updateDeliveryPositionMargin(settle, contract, change); System.out.println(result); @@ -878,7 +878,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: usdt] **contract** | **String**| Futures contract | - **change** | **String**| Margin change. Use positive number to increase margin, negative number otherwise. | + **change** | **String**| Margin change amount, positive number increases, negative number decreases | ### Return type @@ -1046,9 +1046,9 @@ Name | Type | Description | Notes # **listDeliveryOrders** > List<FuturesOrder> listDeliveryOrders(settle, status).contract(contract).limit(limit).offset(offset).lastId(lastId).countTotal(countTotal).execute(); -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 @@ -1072,12 +1072,12 @@ public class Example { DeliveryApi apiInstance = new DeliveryApi(defaultClient); String settle = "usdt"; // String | Settle currency - String status = "open"; // String | Only list the orders with this status + String status = "open"; // String | Query order list based on status String contract = "BTC_USDT_20200814"; // String | Futures contract - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 - String lastId = "12345"; // String | Specify list staring point using the `id` of last record in previous list-query results - Integer countTotal = 0; // Integer | Whether to return total number matched. Default to 0(no return) + String lastId = "12345"; // String | 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 + Integer countTotal = 0; // Integer | Whether to return total number matched, defaults to 0 (no return) try { List result = apiInstance.listDeliveryOrders(settle, status) .contract(contract) @@ -1105,12 +1105,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: usdt] - **status** | **String**| Only list the orders with this status | [enum: open, finished] + **status** | **String**| Query order list based on status | [enum: open, finished] **contract** | **String**| Futures contract | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] - **lastId** | **String**| Specify list staring point using the `id` of last record in previous list-query results | [optional] - **countTotal** | **Integer**| Whether to return total number matched. Default to 0(no return) | [optional] [default to 0] [enum: 0, 1] + **lastId** | **String**| 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] + **countTotal** | **Integer**| Whether to return total number matched, defaults to 0 (no return) | [optional] [default to 0] [enum: 0, 1] ### Return type @@ -1128,15 +1128,15 @@ 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
| # **createDeliveryOrder** > FuturesOrder createDeliveryOrder(settle, futuresOrder) -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 @@ -1206,9 +1206,9 @@ Name | Type | Description | Notes # **cancelDeliveryOrders** > List<FuturesOrder> cancelDeliveryOrders(settle, contract, 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 @@ -1233,7 +1233,7 @@ public class Example { DeliveryApi apiInstance = new DeliveryApi(defaultClient); String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT_20200814"; // String | Futures contract - String side = "ask"; // String | All bids or asks. Both included if not specified + String side = "ask"; // String | Specify all bids or all asks, both included if not specified try { List result = apiInstance.cancelDeliveryOrders(settle, contract, side); System.out.println(result); @@ -1256,7 +1256,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: usdt] **contract** | **String**| Futures contract | - **side** | **String**| All bids or asks. Both included if not specified | [optional] [enum: ask, bid] + **side** | **String**| Specify all bids or all asks, both included if not specified | [optional] [enum: ask, bid] ### Return type @@ -1274,15 +1274,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | All orders matched cancelled | - | +**200** | Batch cancellation successful | - | # **getDeliveryOrder** > FuturesOrder getDeliveryOrder(settle, orderId) -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 @@ -1306,7 +1306,7 @@ public class Example { DeliveryApi apiInstance = new DeliveryApi(defaultClient); String settle = "usdt"; // String | Settle currency - String orderId = "12345"; // String | Retrieve the data of the order with the specified ID + String orderId = "12345"; // String | ID returned when order is successfully created try { FuturesOrder result = apiInstance.getDeliveryOrder(settle, orderId); System.out.println(result); @@ -1328,7 +1328,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: usdt] - **orderId** | **String**| Retrieve the data of the order with the specified ID | + **orderId** | **String**| ID returned when order is successfully created | ### Return type @@ -1352,7 +1352,7 @@ Name | Type | Description | Notes # **cancelDeliveryOrder** > FuturesOrder cancelDeliveryOrder(settle, orderId) -Cancel a single order +Cancel single order ### Example @@ -1376,7 +1376,7 @@ public class Example { DeliveryApi apiInstance = new DeliveryApi(defaultClient); String settle = "usdt"; // String | Settle currency - String orderId = "12345"; // String | Retrieve the data of the order with the specified ID + String orderId = "12345"; // String | ID returned when order is successfully created try { FuturesOrder result = apiInstance.cancelDeliveryOrder(settle, orderId); System.out.println(result); @@ -1398,7 +1398,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: usdt] - **orderId** | **String**| Retrieve the data of the order with the specified ID | + **orderId** | **String**| ID returned when order is successfully created | ### Return type @@ -1422,7 +1422,7 @@ Name | Type | Description | Notes # **getMyDeliveryTrades** > List<MyFuturesTrade> getMyDeliveryTrades(settle).contract(contract).order(order).limit(limit).offset(offset).lastId(lastId).countTotal(countTotal).execute(); -List personal trading history +Query personal trading records ### Example @@ -1448,10 +1448,10 @@ public class Example { String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT_20200814"; // String | Futures contract Long order = 12345L; // Long | Futures order ID, return related data only if specified - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 - String lastId = "12345"; // String | Specify list staring point using the `id` of last record in previous list-query results - Integer countTotal = 0; // Integer | Whether to return total number matched. Default to 0(no return) + String lastId = "12345"; // String | 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 + Integer countTotal = 0; // Integer | Whether to return total number matched, defaults to 0 (no return) try { List result = apiInstance.getMyDeliveryTrades(settle) .contract(contract) @@ -1482,10 +1482,10 @@ Name | Type | Description | Notes **settle** | **String**| Settle currency | [enum: usdt] **contract** | **String**| Futures contract | [optional] **order** | **Long**| Futures order ID, return related data only if specified | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] - **lastId** | **String**| Specify list staring point using the `id` of last record in previous list-query results | [optional] - **countTotal** | **Integer**| Whether to return total number matched. Default to 0(no return) | [optional] [default to 0] [enum: 0, 1] + **lastId** | **String**| 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] + **countTotal** | **Integer**| Whether to return total number matched, defaults to 0 (no return) | [optional] [default to 0] [enum: 0, 1] ### Return type @@ -1503,13 +1503,13 @@ 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
| # **listDeliveryPositionClose** > List<PositionClose> listDeliveryPositionClose(settle).contract(contract).limit(limit).execute(); -List position close history +Query position close history ### Example @@ -1534,7 +1534,7 @@ public class Example { DeliveryApi apiInstance = new DeliveryApi(defaultClient); String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT_20200814"; // String | Futures contract - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list try { List result = apiInstance.listDeliveryPositionClose(settle) .contract(contract) @@ -1560,7 +1560,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: usdt] **contract** | **String**| Futures contract | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] ### Return type @@ -1578,13 +1578,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listDeliveryLiquidates** > List<FuturesLiquidate> listDeliveryLiquidates(settle).contract(contract).limit(limit).at(at).execute(); -List liquidation history +Query liquidation history ### Example @@ -1609,8 +1609,8 @@ public class Example { DeliveryApi apiInstance = new DeliveryApi(defaultClient); String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT_20200814"; // String | Futures contract - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list - Integer at = 0; // Integer | Specify a liquidation timestamp + Integer limit = 100; // Integer | Maximum number of records returned in a single list + Integer at = 0; // Integer | Specify liquidation timestamp try { List result = apiInstance.listDeliveryLiquidates(settle) .contract(contract) @@ -1637,8 +1637,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: usdt] **contract** | **String**| Futures contract | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] - **at** | **Integer**| Specify a liquidation timestamp | [optional] [default to 0] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] + **at** | **Integer**| Specify liquidation timestamp | [optional] [default to 0] ### Return type @@ -1656,13 +1656,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listDeliverySettlements** > List<DeliverySettlement> listDeliverySettlements(settle).contract(contract).limit(limit).at(at).execute(); -List settlement history +Query settlement records ### Example @@ -1687,8 +1687,8 @@ public class Example { DeliveryApi apiInstance = new DeliveryApi(defaultClient); String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT_20200814"; // String | Futures contract - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list - Integer at = 0; // Integer | Specify a settlement timestamp + Integer limit = 100; // Integer | Maximum number of records returned in a single list + Integer at = 0; // Integer | Specify settlement timestamp try { List result = apiInstance.listDeliverySettlements(settle) .contract(contract) @@ -1715,8 +1715,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: usdt] **contract** | **String**| Futures contract | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] - **at** | **Integer**| Specify a settlement timestamp | [optional] [default to 0] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] + **at** | **Integer**| Specify settlement timestamp | [optional] [default to 0] ### Return type @@ -1734,15 +1734,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listDeliveryRiskLimitTiers** > List<FuturesLimitRiskTiers> listDeliveryRiskLimitTiers(settle).contract(contract).limit(limit).offset(offset).execute(); -List risk limit tiers +Query risk limit tiers -When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets.'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the 'contract' parameter is empty. +When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets. 'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the contract parameter is empty. ### Example @@ -1763,7 +1763,7 @@ public class Example { DeliveryApi apiInstance = new DeliveryApi(defaultClient); String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT_20200814"; // String | Futures contract - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 try { List result = apiInstance.listDeliveryRiskLimitTiers(settle) @@ -1791,7 +1791,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: usdt] **contract** | **String**| Futures contract | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] ### Return type @@ -1810,13 +1810,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listPriceTriggeredDeliveryOrders** > List<FuturesPriceTriggeredOrder> listPriceTriggeredDeliveryOrders(settle, status).contract(contract).limit(limit).offset(offset).execute(); -List All Price-triggered Orders +Query auto order list ### Example @@ -1840,9 +1840,9 @@ public class Example { DeliveryApi apiInstance = new DeliveryApi(defaultClient); String settle = "usdt"; // String | Settle currency - String status = "status_example"; // String | Only list the orders with this status + String status = "status_example"; // String | Query order list based on status String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 try { List result = apiInstance.listPriceTriggeredDeliveryOrders(settle, status) @@ -1869,9 +1869,9 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: usdt] - **status** | **String**| Only list the orders with this status | [enum: open, finished] + **status** | **String**| Query order list based on status | [enum: open, finished] **contract** | **String**| Futures contract, return related data only if specified | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] ### Return type @@ -1890,13 +1890,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **createPriceTriggeredDeliveryOrder** > TriggerOrderResponse createPriceTriggeredDeliveryOrder(settle, futuresPriceTriggeredOrder) -Create a price-triggered order +Create price-triggered order ### Example @@ -1960,13 +1960,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Order created | - | +**201** | Order created successfully | - | # **cancelPriceTriggeredDeliveryOrderList** > List<FuturesPriceTriggeredOrder> cancelPriceTriggeredDeliveryOrderList(settle, contract) -Cancel All Price-triggered Orders +Cancel all auto orders ### Example @@ -2030,13 +2030,13 @@ 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 | - | # **getPriceTriggeredDeliveryOrder** > FuturesPriceTriggeredOrder getPriceTriggeredDeliveryOrder(settle, orderId) -Get a price-triggered order +Query single auto order details ### Example @@ -2060,7 +2060,7 @@ public class Example { DeliveryApi apiInstance = new DeliveryApi(defaultClient); String settle = "usdt"; // String | Settle currency - String orderId = "orderId_example"; // String | Retrieve the data of the order with the specified ID + String orderId = "orderId_example"; // String | ID returned when order is successfully created try { FuturesPriceTriggeredOrder result = apiInstance.getPriceTriggeredDeliveryOrder(settle, orderId); System.out.println(result); @@ -2082,7 +2082,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: usdt] - **orderId** | **String**| Retrieve the data of the order with the specified ID | + **orderId** | **String**| ID returned when order is successfully created | ### Return type @@ -2100,13 +2100,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Auto order detail | - | +**200** | Auto order details | - | # **cancelPriceTriggeredDeliveryOrder** > FuturesPriceTriggeredOrder cancelPriceTriggeredDeliveryOrder(settle, orderId) -cancel a price-triggered order +Cancel single auto order ### Example @@ -2130,7 +2130,7 @@ public class Example { DeliveryApi apiInstance = new DeliveryApi(defaultClient); String settle = "usdt"; // String | Settle currency - String orderId = "orderId_example"; // String | Retrieve the data of the order with the specified ID + String orderId = "orderId_example"; // String | ID returned when order is successfully created try { FuturesPriceTriggeredOrder result = apiInstance.cancelPriceTriggeredDeliveryOrder(settle, orderId); System.out.println(result); @@ -2152,7 +2152,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: usdt] - **orderId** | **String**| Retrieve the data of the order with the specified ID | + **orderId** | **String**| ID returned when order is successfully created | ### Return type @@ -2170,5 +2170,5 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Auto order detail | - | +**200** | Auto order details | - | diff --git a/docs/DeliveryContract.md b/docs/DeliveryContract.md index e61232d..de254b3 100644 --- a/docs/DeliveryContract.md +++ b/docs/DeliveryContract.md @@ -10,16 +10,16 @@ Name | Type | Description | Notes **name** | **String** | Futures contract | [optional] **underlying** | **String** | Underlying | [optional] **cycle** | [**CycleEnum**](#CycleEnum) | Cycle type, e.g. WEEKLY, QUARTERLY | [optional] -**type** | [**TypeEnum**](#TypeEnum) | Futures contract type | [optional] +**type** | [**TypeEnum**](#TypeEnum) | Contract type: inverse - inverse contract, direct - direct contract | [optional] **quantoMultiplier** | **String** | Multiplier used in converting from invoicing to settlement currency | [optional] **leverageMin** | **String** | Minimum leverage | [optional] **leverageMax** | **String** | Maximum leverage | [optional] **maintenanceRate** | **String** | Maintenance rate of margin | [optional] -**markType** | [**MarkTypeEnum**](#MarkTypeEnum) | Mark price type, internal - based on internal trading, index - based on external index price | [optional] +**markType** | [**MarkTypeEnum**](#MarkTypeEnum) | Mark price type: internal - internal trading price, index - external index price | [optional] **markPrice** | **String** | Current mark price | [optional] **indexPrice** | **String** | Current index price | [optional] **lastPrice** | **String** | Last trading price | [optional] -**makerFeeRate** | **String** | Maker fee rate, where negative means rebate | [optional] +**makerFeeRate** | **String** | Maker fee rate, negative values indicate rebates | [optional] **takerFeeRate** | **String** | Taker fee rate | [optional] **orderPriceRound** | **String** | Minimum order price increment | [optional] **markPriceRound** | **String** | Minimum mark price increment | [optional] @@ -33,18 +33,18 @@ Name | Type | Description | Notes **riskLimitBase** | **String** | Risk limit base | [optional] **riskLimitStep** | **String** | Step of adjusting risk limit | [optional] **riskLimitMax** | **String** | Maximum risk limit the contract allowed | [optional] -**orderSizeMin** | **Long** | Minimum order size the contract allowed | [optional] -**orderSizeMax** | **Long** | Maximum order size the contract allowed | [optional] -**orderPriceDeviate** | **String** | 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] -**refDiscountRate** | **String** | Referral fee rate discount | [optional] -**refRebateRate** | **String** | Referrer commission rate | [optional] -**orderbookId** | **Long** | Current orderbook ID | [optional] +**orderSizeMin** | **Long** | Minimum order size allowed by the contract | [optional] +**orderSizeMax** | **Long** | Maximum order size allowed by the contract | [optional] +**orderPriceDeviate** | **String** | 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] +**refDiscountRate** | **String** | Trading fee discount for referred users | [optional] +**refRebateRate** | **String** | Commission rate for referrers | [optional] +**orderbookId** | **Long** | Orderbook update ID | [optional] **tradeId** | **Long** | Current trade ID | [optional] -**tradeSize** | **Long** | Historical accumulated trade size | [optional] +**tradeSize** | **Long** | Historical cumulative trading volume | [optional] **positionSize** | **Long** | Current total long position size | [optional] -**configChangeTime** | **Double** | Last changed time of configuration | [optional] +**configChangeTime** | **Double** | Last configuration update time | [optional] **inDelisting** | **Boolean** | Contract is delisting | [optional] -**ordersLimit** | **Integer** | Maximum number of open orders | [optional] +**ordersLimit** | **Integer** | Maximum number of pending orders | [optional] ## Enum: CycleEnum diff --git a/docs/DeliveryTicker.md b/docs/DeliveryTicker.md index 858013a..ef83368 100644 --- a/docs/DeliveryTicker.md +++ b/docs/DeliveryTicker.md @@ -7,16 +7,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **contract** | **String** | Futures contract | [optional] **last** | **String** | Last trading price | [optional] -**changePercentage** | **String** | Change percentage. | [optional] +**changePercentage** | **String** | Price change percentage. Negative values indicate price decrease, e.g. -7.45 | [optional] **totalSize** | **String** | Contract total size | [optional] -**low24h** | **String** | Lowest trading price in recent 24h | [optional] -**high24h** | **String** | Highest trading price in recent 24h | [optional] -**volume24h** | **String** | Trade size in recent 24h | [optional] -**volume24hBtc** | **String** | Trade volumes in recent 24h in BTC(deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) | [optional] -**volume24hUsd** | **String** | Trade volumes in recent 24h in USD(deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) | [optional] -**volume24hBase** | **String** | Trade volume in recent 24h, in base currency | [optional] -**volume24hQuote** | **String** | Trade volume in recent 24h, in quote currency | [optional] -**volume24hSettle** | **String** | Trade volume in recent 24h, in settle currency | [optional] +**low24h** | **String** | 24-hour lowest price | [optional] +**high24h** | **String** | 24-hour highest price | [optional] +**volume24h** | **String** | 24-hour trading volume | [optional] +**volume24hBtc** | **String** | 24-hour trading volume in BTC (deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) | [optional] +**volume24hUsd** | **String** | 24-hour trading volume in USD (deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) | [optional] +**volume24hBase** | **String** | 24-hour trading volume in base currency | [optional] +**volume24hQuote** | **String** | 24-hour trading volume in quote currency | [optional] +**volume24hSettle** | **String** | 24-hour trading volume in settle currency | [optional] **markPrice** | **String** | Recent mark price | [optional] **fundingRate** | **String** | Funding rate | [optional] **fundingRateIndicative** | **String** | Indicative Funding rate in next period. (deprecated. use `funding_rate`) | [optional] diff --git a/docs/DepositRecord.md b/docs/DepositRecord.md index 826ff86..77e8e6f 100644 --- a/docs/DepositRecord.md +++ b/docs/DepositRecord.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **txid** | **String** | Hash record of the withdrawal | [optional] [readonly] **withdrawOrderId** | **String** | Client order id, up to 32 length and can only include 0-9, A-Z, a-z, underscore(_), hyphen(-) or dot(.) | [optional] **timestamp** | **String** | Operation time | [optional] [readonly] -**amount** | **String** | Currency amount | +**amount** | **String** | Token amount | **currency** | **String** | Currency name | **address** | **String** | Withdrawal address. Required for withdrawals | [optional] **memo** | **String** | Additional remarks with regards to the withdrawal | [optional] diff --git a/docs/DualGetOrders.md b/docs/DualGetOrders.md index bcb0fe1..79966da 100644 --- a/docs/DualGetOrders.md +++ b/docs/DualGetOrders.md @@ -6,20 +6,20 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Integer** | Order ID | [optional] -**planId** | **Integer** | Plan ID | [optional] -**copies** | **String** | Copies | [optional] -**investAmount** | **String** | Investment Amount | [optional] -**settlementAmount** | **String** | Settlement Amount | [optional] -**createTime** | **Integer** | Creation time | [optional] -**completeTime** | **Integer** | Completion Time | [optional] -**status** | **String** | Status: `INIT`-INIT `SETTLEMENT_SUCCESS`-Settlement Success `SETTLEMENT_PROCESSING`-SEttlement Processing `CANCELED`-Canceled `FAILED`-Failed | [optional] -**investCurrency** | **String** | Investment Currency | [optional] -**exerciseCurrency** | **String** | Strike Currency | [optional] +**planId** | **Integer** | Product ID | [optional] +**copies** | **String** | Units | [optional] +**investAmount** | **String** | Investment Quantity | [optional] +**settlementAmount** | **String** | Settlement Quantity | [optional] +**createTime** | **Integer** | Created time | [optional] +**completeTime** | **Integer** | Completed Time | [optional] +**status** | **String** | Status: `INIT`-Created `SETTLEMENT_SUCCESS`-Settlement Success `SETTLEMENT_PROCESSING`-Settlement Processing `CANCELED`-Canceled `FAILED`-Failed | [optional] +**investCurrency** | **String** | Investment Token | [optional] +**exerciseCurrency** | **String** | Strike Token | [optional] **exercisePrice** | **String** | Strike price | [optional] -**settlementPrice** | **String** | settlement price | [optional] -**settlementCurrency** | **String** | Settle currency | [optional] -**apyDisplay** | **String** | APY | [optional] -**apySettlement** | **String** | Settlement APY | [optional] +**settlementPrice** | **String** | Settlement price | [optional] +**settlementCurrency** | **String** | Settlement currency | [optional] +**apyDisplay** | **String** | Annual Yield | [optional] +**apySettlement** | **String** | Settlement Annual Yield | [optional] **deliveryTime** | **Integer** | Settlement time | [optional] **text** | **String** | Custom order information | [optional] diff --git a/docs/DualGetPlans.md b/docs/DualGetPlans.md index a91215e..0fa8521 100644 --- a/docs/DualGetPlans.md +++ b/docs/DualGetPlans.md @@ -5,17 +5,17 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Integer** | Plan ID | [optional] -**instrumentName** | **String** | Instrument Name | [optional] -**investCurrency** | **String** | Investment Currency | [optional] -**exerciseCurrency** | **String** | Strike Currency | [optional] +**id** | **Integer** | Product ID | [optional] +**instrumentName** | **String** | Product Name | [optional] +**investCurrency** | **String** | Investment Token | [optional] +**exerciseCurrency** | **String** | Strike Token | [optional] **exercisePrice** | **Double** | Strike price | [optional] **deliveryTime** | **Integer** | Settlement time | [optional] -**minCopies** | **Integer** | Minimum Copies | [optional] -**maxCopies** | **Integer** | Maximum Copies | [optional] -**perValue** | **String** | Per Unit Value | [optional] -**apyDisplay** | **String** | APY | [optional] -**startTime** | **Integer** | start time | [optional] -**endTime** | **Integer** | Finished time | [optional] -**status** | **String** | Status: `NOTSTARTED`-not started `ONGOING`-ongoing `ENDED`-ended | [optional] +**minCopies** | **Integer** | Minimum Units | [optional] +**maxCopies** | **Integer** | Maximum Units | [optional] +**perValue** | **String** | Value Per Unit | [optional] +**apyDisplay** | **String** | Annual Yield | [optional] +**startTime** | **Integer** | Start Time | [optional] +**endTime** | **Integer** | End time | [optional] +**status** | **String** | Status: `NOTSTARTED`-Not Started `ONGOING`-In Progress `ENDED`-Ended | [optional] diff --git a/docs/EarnApi.md b/docs/EarnApi.md index 2de1448..78e2408 100644 --- a/docs/EarnApi.md +++ b/docs/EarnApi.md @@ -5,13 +5,15 @@ All URIs are relative to *https://api.gateio.ws/api/v4* Method | HTTP request | Description ------------- | ------------- | ------------- [**swapETH2**](EarnApi.md#swapETH2) | **POST** /earn/staking/eth2/swap | ETH2 swap -[**rateListETH2**](EarnApi.md#rateListETH2) | **GET** /earn/staking/eth2/rate_records | ETH2 historical rate of return query +[**rateListETH2**](EarnApi.md#rateListETH2) | **GET** /earn/staking/eth2/rate_records | ETH2 historical return rate query [**listDualInvestmentPlans**](EarnApi.md#listDualInvestmentPlans) | **GET** /earn/dual/investment_plan | Dual Investment product list [**listDualOrders**](EarnApi.md#listDualOrders) | **GET** /earn/dual/orders | Dual Investment order list [**placeDualOrder**](EarnApi.md#placeDualOrder) | **POST** /earn/dual/orders | Place Dual Investment order [**listStructuredProducts**](EarnApi.md#listStructuredProducts) | **GET** /earn/structured/products | Structured Product List [**listStructuredOrders**](EarnApi.md#listStructuredOrders) | **GET** /earn/structured/orders | Structured Product Order List [**placeStructuredOrder**](EarnApi.md#placeStructuredOrder) | **POST** /earn/structured/orders | Place Structured Product Order +[**findCoin**](EarnApi.md#findCoin) | **GET** /earn/staking/coins | Staking coins +[**swapStakingCoin**](EarnApi.md#swapStakingCoin) | **POST** /earn/staking/swap | On-chain token swap for earned coins @@ -79,15 +81,15 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | swap success | - | +**200** | Swap successful | - | # **rateListETH2** > List<Eth2RateList> rateListETH2() -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 @@ -145,7 +147,7 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful | - | +**200** | Successfully retrieved | - | # **listDualInvestmentPlans** @@ -170,7 +172,7 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); EarnApi apiInstance = new EarnApi(defaultClient); - Long planId = 1L; // Long | Financial project id + Long planId = 1L; // Long | Financial project ID try { List result = apiInstance.listDualInvestmentPlans() .planId(planId) @@ -193,7 +195,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **planId** | **Long**| Financial project id | [optional] + **planId** | **Long**| Financial project ID | [optional] ### Return type @@ -211,7 +213,7 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful | - | +**200** | Successfully retrieved | - | # **listDualOrders** @@ -240,10 +242,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); EarnApi apiInstance = new EarnApi(defaultClient); - Long from = 1740727000L; // Long | Start checkout time + Long from = 1740727000L; // Long | Start settlement time Long to = 1740729000L; // Long | End settlement time Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list try { List result = apiInstance.listDualOrders() .from(from) @@ -269,10 +271,10 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **from** | **Long**| Start checkout time | [optional] + **from** | **Long**| Start settlement time | [optional] **to** | **Long**| End settlement time | [optional] **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] ### Return type @@ -290,7 +292,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful | - | +**200** | Successfully retrieved | - | # **placeDualOrder** @@ -357,7 +359,7 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | Order placed successfully | - | # **listStructuredProducts** @@ -382,10 +384,10 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); EarnApi apiInstance = new EarnApi(defaultClient); - String status = "in_process"; // String | Status (default: all) `in_process`-processing `will_begin`-unstarted `wait_settlement`-unsettled `done`-finish - String type = "BullishSharkFin"; // String | Product Type (default all) `SharkFin2.0`-SharkFin `BullishSharkFin`-BullishSharkFin `BearishSharkFin`-BearishSharkFin `DoubleNoTouch`-DoubleNoTouch `RangeAccrual`-RangeAccrual `SnowBall`-SnowBall + String status = "in_process"; // String | Status (Default empty to query all) `in_process`-In progress `will_begin`-Not started `wait_settlement`-Pending settlement `done`-Completed + String type = "BullishSharkFin"; // String | 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 Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list try { List result = apiInstance.listStructuredProducts(status) .type(type) @@ -410,10 +412,10 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **status** | **String**| Status (default: all) `in_process`-processing `will_begin`-unstarted `wait_settlement`-unsettled `done`-finish | - **type** | **String**| Product Type (default all) `SharkFin2.0`-SharkFin `BullishSharkFin`-BullishSharkFin `BearishSharkFin`-BearishSharkFin `DoubleNoTouch`-DoubleNoTouch `RangeAccrual`-RangeAccrual `SnowBall`-SnowBall | [optional] + **status** | **String**| Status (Default empty to query all) `in_process`-In progress `will_begin`-Not started `wait_settlement`-Pending settlement `done`-Completed | + **type** | **String**| 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** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] ### Return type @@ -431,7 +433,7 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful | - | +**200** | Successfully retrieved | - | # **listStructuredOrders** @@ -460,10 +462,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); EarnApi apiInstance = new EarnApi(defaultClient); - Long from = 1547706332L; // Long | Start timestamp - Long to = 1547706332L; // Long | End timestamp + Long from = 1547706332L; // Long | 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) + Long to = 1547706332L; // Long | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list try { List result = apiInstance.listStructuredOrders() .from(from) @@ -489,10 +491,10 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **from** | **Long**| Start timestamp | [optional] - **to** | **Long**| End timestamp | [optional] + **from** | **Long**| 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** | **Long**| 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** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] ### Return type @@ -510,7 +512,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful | - | +**200** | Successfully retrieved | - | # **placeStructuredOrder** @@ -577,5 +579,141 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | Order placed successfully | - | + + +# **findCoin** +> Object findCoin(findCoin) + +Staking coins + +### Example + +```java +// Import classes: +import io.gate.gateapi.ApiClient; +import io.gate.gateapi.ApiException; +import io.gate.gateapi.Configuration; +import io.gate.gateapi.GateApiException; +import io.gate.gateapi.auth.*; +import io.gate.gateapi.models.*; +import io.gate.gateapi.api.EarnApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.gateio.ws/api/v4"); + + // Configure APIv4 authorization: apiv4 + defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); + + EarnApi apiInstance = new EarnApi(defaultClient); + FindCoin findCoin = new FindCoin(); // FindCoin | + try { + Object result = apiInstance.findCoin(findCoin); + System.out.println(result); + } catch (GateApiException e) { + System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage())); + e.printStackTrace(); + } catch (ApiException e) { + System.err.println("Exception when calling EarnApi#findCoin"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **findCoin** | [**FindCoin**](FindCoin.md)| | + +### Return type + +**Object** + +### Authorization + +[apiv4](../README.md#apiv4) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successfully retrieved | - | + + +# **swapStakingCoin** +> SwapCoinStruct swapStakingCoin(swapCoin) + +On-chain token swap for earned coins + +### Example + +```java +// Import classes: +import io.gate.gateapi.ApiClient; +import io.gate.gateapi.ApiException; +import io.gate.gateapi.Configuration; +import io.gate.gateapi.GateApiException; +import io.gate.gateapi.auth.*; +import io.gate.gateapi.models.*; +import io.gate.gateapi.api.EarnApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.gateio.ws/api/v4"); + + // Configure APIv4 authorization: apiv4 + defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); + + EarnApi apiInstance = new EarnApi(defaultClient); + SwapCoin swapCoin = new SwapCoin(); // SwapCoin | + try { + SwapCoinStruct result = apiInstance.swapStakingCoin(swapCoin); + System.out.println(result); + } catch (GateApiException e) { + System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage())); + e.printStackTrace(); + } catch (ApiException e) { + System.err.println("Exception when calling EarnApi#swapStakingCoin"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **swapCoin** | [**SwapCoin**](SwapCoin.md)| | + +### Return type + +[**SwapCoinStruct**](SwapCoinStruct.md) + +### Authorization + +[apiv4](../README.md#apiv4) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Swap successful | - | diff --git a/docs/EarnUniApi.md b/docs/EarnUniApi.md index e99b174..769e34c 100644 --- a/docs/EarnUniApi.md +++ b/docs/EarnUniApi.md @@ -4,25 +4,24 @@ All URIs are relative to *https://api.gateio.ws/api/v4* Method | HTTP request | Description ------------- | ------------- | ------------- -[**listUniCurrencies**](EarnUniApi.md#listUniCurrencies) | **GET** /earn/uni/currencies | List currencies for lending -[**getUniCurrency**](EarnUniApi.md#getUniCurrency) | **GET** /earn/uni/currencies/{currency} | Get currency detail for lending -[**listUserUniLends**](EarnUniApi.md#listUserUniLends) | **GET** /earn/uni/lends | List user's lending orders -[**createUniLend**](EarnUniApi.md#createUniLend) | **POST** /earn/uni/lends | Lend or redeem -[**changeUniLend**](EarnUniApi.md#changeUniLend) | **PATCH** /earn/uni/lends | Amend lending order -[**listUniLendRecords**](EarnUniApi.md#listUniLendRecords) | **GET** /earn/uni/lend_records | List records of lending -[**getUniInterest**](EarnUniApi.md#getUniInterest) | **GET** /earn/uni/interests/{currency} | Get the user's total interest income of specified currency -[**listUniInterestRecords**](EarnUniApi.md#listUniInterestRecords) | **GET** /earn/uni/interest_records | List interest records -[**switchInterestReinvest**](EarnUniApi.md#switchInterestReinvest) | **PUT** /earn/uni/interest_reinvest | Set interest reinvestment toggle -[**getUniInterestStatus**](EarnUniApi.md#getUniInterestStatus) | **GET** /earn/uni/interest_status/{currency} | query currency interest compounding status +[**listUniCurrencies**](EarnUniApi.md#listUniCurrencies) | **GET** /earn/uni/currencies | Query lending currency list +[**getUniCurrency**](EarnUniApi.md#getUniCurrency) | **GET** /earn/uni/currencies/{currency} | Query single lending currency details +[**listUserUniLends**](EarnUniApi.md#listUserUniLends) | **GET** /earn/uni/lends | Query user's lending order list +[**createUniLend**](EarnUniApi.md#createUniLend) | **POST** /earn/uni/lends | Create lending or redemption +[**changeUniLend**](EarnUniApi.md#changeUniLend) | **PATCH** /earn/uni/lends | Amend user lending information +[**listUniLendRecords**](EarnUniApi.md#listUniLendRecords) | **GET** /earn/uni/lend_records | Query lending transaction records +[**getUniInterest**](EarnUniApi.md#getUniInterest) | **GET** /earn/uni/interests/{currency} | Query user's total interest income for specified currency +[**listUniInterestRecords**](EarnUniApi.md#listUniInterestRecords) | **GET** /earn/uni/interest_records | Query user dividend records +[**getUniInterestStatus**](EarnUniApi.md#getUniInterestStatus) | **GET** /earn/uni/interest_status/{currency} | Query currency interest compounding status [**listUniChart**](EarnUniApi.md#listUniChart) | **GET** /earn/uni/chart | UniLoan currency annualized trend chart -[**listUniRate**](EarnUniApi.md#listUniRate) | **GET** /earn/uni/rate | Currency estimate annualized interest rate +[**listUniRate**](EarnUniApi.md#listUniRate) | **GET** /earn/uni/rate | Currency estimated annualized interest rate # **listUniCurrencies** > List<UniCurrency> listUniCurrencies() -List currencies for lending +Query lending currency list ### Example @@ -76,13 +75,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **getUniCurrency** > UniCurrency getUniCurrency(currency) -Get currency detail for lending +Query single lending currency details ### Example @@ -140,13 +139,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listUserUniLends** > List<UniLend> listUserUniLends().currency(currency).page(page).limit(limit).execute(); -List user's lending orders +Query user's lending order list ### Example @@ -169,9 +168,9 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); EarnUniApi apiInstance = new EarnUniApi(defaultClient); - String currency = "BTC"; // String | Retrieve data of the specified currency + String currency = "BTC"; // String | Query by specified currency name Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 100 + Integer limit = 100; // Integer | Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 try { List result = apiInstance.listUserUniLends() .currency(currency) @@ -196,9 +195,9 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | [optional] + **currency** | **String**| Query by specified currency name | [optional] **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100] + **limit** | **Integer**| Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100] ### Return type @@ -216,15 +215,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **createUniLend** > createUniLend(createUniLend) -Lend or redeem +Create lending or redemption -`Lending`: The minimum interest rate is required in lending. The lending result is updated hourly and the interest profit is paid on the next hour. A high interest rate might lead to unsuccessful lending and no profit will be gained for that hour. If the funds are redeemed before the hourly settlement, no interest can be obtained for that hour. About priority: the orders created or amended first under the same interest rate will be lent out first `Redemption`: Funds that failed to be lent can be redeemed immediately. For the successfully lent funds, enjoy the hourly income, and the redemption will arrive at the next hour `Note`: Two minutes before and after the hour is the settlement time, lending and redemption are prohibited. +Lending: When lending, a minimum lending rate must be set. After successful lending is determined on an hourly basis, earnings will be calculated based on the determined rate. Earnings for each hour will be settled at the top of the hour. If lending fails due to an excessively high interest rate, no interest will be earned for that hour. If funds are redeemed before the hourly for that hour. Priority: Under the same interest rate, wealth management products created or modified earlier will be prioritized for lending. Redemption: For funds that failed to be lent, redemption will be credited immediately. For funds successfully lent, they are entitled to the earnings for that hour, and redemption will be credited in the next hourly interval. Note: The two minutes before and after the hourly mark are the settlement period, during which lending and redemption are prohibited. ### Example @@ -285,15 +284,15 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Operated successfully | - | +**204** | Operation successful | - | # **changeUniLend** > changeUniLend(patchUniLend) -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 @@ -354,13 +353,13 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Updated | - | +**204** | Updated successfully | - | # **listUniLendRecords** > List<UniLendRecord> listUniLendRecords().currency(currency).page(page).limit(limit).from(from).to(to).type(type).execute(); -List records of lending +Query lending transaction records ### Example @@ -383,12 +382,12 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); EarnUniApi apiInstance = new EarnUniApi(defaultClient); - String currency = "BTC"; // String | Retrieve data of the specified currency + String currency = "BTC"; // String | Query by specified currency name Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 100 - Long from = 1547706332L; // Long | Start timestamp - Long to = 1547706332L; // Long | End timestamp - String type = "lend"; // String | type: lend - lend, redeem - redeem + Integer limit = 100; // Integer | Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 + Long from = 1547706332L; // Long | 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) + Long to = 1547706332L; // Long | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp + String type = "lend"; // String | Operation type: lend - Lend, redeem - Redeem try { List result = apiInstance.listUniLendRecords() .currency(currency) @@ -416,12 +415,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | [optional] + **currency** | **String**| Query by specified currency name | [optional] **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100] - **from** | **Long**| Start timestamp | [optional] - **to** | **Long**| End timestamp | [optional] - **type** | **String**| type: lend - lend, redeem - redeem | [optional] [enum: lend, redeem] + **limit** | **Integer**| Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100] + **from** | **Long**| 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** | **Long**| 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** | **String**| Operation type: lend - Lend, redeem - Redeem | [optional] [enum: lend, redeem] ### Return type @@ -439,13 +438,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **getUniInterest** > UniLendInterest getUniInterest(currency) -Get the user's total interest income of specified currency +Query user's total interest income for specified currency ### Example @@ -507,13 +506,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listUniInterestRecords** > List<UniInterestRecord> listUniInterestRecords().currency(currency).page(page).limit(limit).from(from).to(to).execute(); -List interest records +Query user dividend records ### Example @@ -536,11 +535,11 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); EarnUniApi apiInstance = new EarnUniApi(defaultClient); - String currency = "BTC"; // String | Retrieve data of the specified currency + String currency = "BTC"; // String | Query by specified currency name Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 100 - Long from = 1547706332L; // Long | Start timestamp - Long to = 1547706332L; // Long | End timestamp + Integer limit = 100; // Integer | Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 + Long from = 1547706332L; // Long | 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) + Long to = 1547706332L; // Long | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp try { List result = apiInstance.listUniInterestRecords() .currency(currency) @@ -567,11 +566,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | [optional] + **currency** | **String**| Query by specified currency name | [optional] **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100] - **from** | **Long**| Start timestamp | [optional] - **to** | **Long**| End timestamp | [optional] + **limit** | **Integer**| Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100] + **from** | **Long**| 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** | **Long**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional] ### Return type @@ -589,80 +588,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | - - -# **switchInterestReinvest** -> switchInterestReinvest(uniInterestMode) - -Set interest reinvestment toggle - -### Example - -```java -// Import classes: -import io.gate.gateapi.ApiClient; -import io.gate.gateapi.ApiException; -import io.gate.gateapi.Configuration; -import io.gate.gateapi.GateApiException; -import io.gate.gateapi.auth.*; -import io.gate.gateapi.models.*; -import io.gate.gateapi.api.EarnUniApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("https://api.gateio.ws/api/v4"); - - // Configure APIv4 authorization: apiv4 - defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); - - EarnUniApi apiInstance = new EarnUniApi(defaultClient); - UniInterestMode uniInterestMode = new UniInterestMode(); // UniInterestMode | - try { - apiInstance.switchInterestReinvest(uniInterestMode); - } catch (GateApiException e) { - System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage())); - e.printStackTrace(); - } catch (ApiException e) { - System.err.println("Exception when calling EarnUniApi#switchInterestReinvest"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **uniInterestMode** | [**UniInterestMode**](UniInterestMode.md)| | - -### Return type - -null (empty response body) - -### Authorization - -[apiv4](../README.md#apiv4) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: Not defined - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Success | - | +**200** | Query successful | - | # **getUniInterestStatus** > UniCurrencyInterest getUniInterestStatus(currency) -query currency interest compounding status +Query currency interest compounding status ### Example @@ -724,7 +656,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listUniChart** @@ -732,7 +664,7 @@ Name | Type | Description | Notes UniLoan currency annualized trend chart -Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-06-04 01:35+0000 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <LL@li.org> Plural-Forms: nplurals=2; plural=(n != 1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 +Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <L@li.org> Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 ### Example @@ -755,8 +687,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); EarnUniApi apiInstance = new EarnUniApi(defaultClient); - Long from = 1719763200L; // Long | Start timestamp, unit s, maximum span of 30 days - Long to = 1722441600L; // Long | End timestamp, unit s, maximum span of 30 days + Long from = 1719763200L; // Long | Start timestamp in seconds, maximum span 30 days + Long to = 1722441600L; // Long | End timestamp in seconds, maximum span 30 days String asset = "BTC"; // String | Currency name try { List result = apiInstance.listUniChart(from, to, asset); @@ -778,8 +710,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **from** | **Long**| Start timestamp, unit s, maximum span of 30 days | - **to** | **Long**| End timestamp, unit s, maximum span of 30 days | + **from** | **Long**| Start timestamp in seconds, maximum span 30 days | + **to** | **Long**| End timestamp in seconds, maximum span 30 days | **asset** | **String**| Currency name | ### Return type @@ -798,15 +730,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-06-04 01:35+0000 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <LL@li.org> Plural-Forms: nplurals=2; plural=(n != 1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 | - | +**200** | Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <L@li.org> Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 | - | # **listUniRate** > List<InlineResponse2001> listUniRate() -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-06-04 01:35+0000 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <LL@li.org> Plural-Forms: nplurals=2; plural=(n != 1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 +Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <L@li.org> Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 ### Example @@ -864,5 +796,5 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-06-04 01:35+0000 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <LL@li.org> Plural-Forms: nplurals=2; plural=(n != 1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 | - | +**200** | Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <L@li.org> Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 | - | diff --git a/docs/Eth2RateList.md b/docs/Eth2RateList.md index 7aca9b4..0dbf7cc 100644 --- a/docs/Eth2RateList.md +++ b/docs/Eth2RateList.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dateTime** | **Long** | Date and Time Stamp | [optional] +**dateTime** | **Long** | Date Timestamp | [optional] **date** | **String** | Date | [optional] -**rate** | **String** | percentage | [optional] +**rate** | **String** | Percentage Rate | [optional] diff --git a/docs/Eth2Swap.md b/docs/Eth2Swap.md index d6955d0..a1a8eed 100644 --- a/docs/Eth2Swap.md +++ b/docs/Eth2Swap.md @@ -1,12 +1,12 @@ # Eth2Swap -ETH2 Staking +ETH2 Mining ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**side** | **String** | 1-Forward Swap（ETH -> ETH2）, 2-Reverse Swap（ETH2 -> ETH） | -**amount** | **String** | amount | +**side** | **String** | 1-Forward Swap (ETH -> ETH2), 2-Reverse Swap (ETH2 -> ETH) | +**amount** | **String** | Swap Amount | diff --git a/docs/FindCoin.md b/docs/FindCoin.md new file mode 100644 index 0000000..65b8e44 --- /dev/null +++ b/docs/FindCoin.md @@ -0,0 +1,9 @@ + +# FindCoin + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cointype** | **String** | Currency type: swap - voucher; lock - locked position; debt - US Treasury bond. | [optional] + diff --git a/docs/FlashSwapApi.md b/docs/FlashSwapApi.md index 4a03b41..5cd0034 100644 --- a/docs/FlashSwapApi.md +++ b/docs/FlashSwapApi.md @@ -5,10 +5,10 @@ All URIs are relative to *https://api.gateio.ws/api/v4* Method | HTTP request | Description ------------- | ------------- | ------------- [**listFlashSwapCurrencyPair**](FlashSwapApi.md#listFlashSwapCurrencyPair) | **GET** /flash_swap/currency_pairs | List All Supported Currency Pairs In Flash Swap -[**listFlashSwapOrders**](FlashSwapApi.md#listFlashSwapOrders) | **GET** /flash_swap/orders | List all flash swap orders +[**listFlashSwapOrders**](FlashSwapApi.md#listFlashSwapOrders) | **GET** /flash_swap/orders | Query flash swap order list [**createFlashSwapOrder**](FlashSwapApi.md#createFlashSwapOrder) | **POST** /flash_swap/orders | Create a flash swap order -[**getFlashSwapOrder**](FlashSwapApi.md#getFlashSwapOrder) | **GET** /flash_swap/orders/{order_id} | Get a single flash swap order's detail -[**previewFlashSwapOrder**](FlashSwapApi.md#previewFlashSwapOrder) | **POST** /flash_swap/orders/preview | Initiate a flash swap order preview +[**getFlashSwapOrder**](FlashSwapApi.md#getFlashSwapOrder) | **GET** /flash_swap/orders/{order_id} | Query single flash swap order +[**previewFlashSwapOrder**](FlashSwapApi.md#previewFlashSwapOrder) | **POST** /flash_swap/orders/preview | Flash swap order preview @@ -36,9 +36,9 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); FlashSwapApi apiInstance = new FlashSwapApi(defaultClient); - String currency = "BTC"; // String | Retrieve data of the specified currency + String currency = "BTC"; // String | Query by specified currency name Integer page = 1; // Integer | Page number - Integer limit = 1000; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 1000 + Integer limit = 1000; // Integer | Maximum number of items returned. Default: 1000, minimum: 1, maximum: 1000 try { List result = apiInstance.listFlashSwapCurrencyPair() .currency(currency) @@ -63,9 +63,9 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | [optional] + **currency** | **String**| Query by specified currency name | [optional] **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum response items. Default: 100, minimum: 1, Maximum: 1000 | [optional] [default to 1000] + **limit** | **Integer**| Maximum number of items returned. Default: 1000, minimum: 1, maximum: 1000 | [optional] [default to 1000] ### Return type @@ -83,13 +83,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listFlashSwapOrders** > List<FlashSwapOrder> listFlashSwapOrders().status(status).sellCurrency(sellCurrency).buyCurrency(buyCurrency).reverse(reverse).limit(limit).page(page).execute(); -List all flash swap orders +Query flash swap order list ### Example @@ -112,11 +112,11 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FlashSwapApi apiInstance = new FlashSwapApi(defaultClient); - Integer status = 1; // Integer | Flash swap order status `1` - success `2` - failure - String sellCurrency = "BTC"; // String | Currency to sell which can be retrieved from supported currency list API `GET /flash_swap/currencies` - String buyCurrency = "BTC"; // String | Currency to buy which can be retrieved from supported currency list API `GET /flash_swap/currencies` - Boolean reverse = true; // Boolean | If results are sorted by id in reverse order. Default to `true` - `true`: sort by id in descending order(recent first) - `false`: sort by id in ascending order(oldest first) - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer status = 1; // Integer | Flash swap order status `1` - success `2` - failed + String sellCurrency = "BTC"; // String | Asset name to sell - Retrieved from API `GET /flash_swap/currencies` for supported flash swap currencies + String buyCurrency = "BTC"; // String | Asset name to buy - Retrieved from API `GET /flash_swap/currencies` for supported flash swap currencies + Boolean reverse = true; // Boolean | 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) + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer page = 1; // Integer | Page number try { List result = apiInstance.listFlashSwapOrders() @@ -145,11 +145,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **status** | **Integer**| Flash swap order status `1` - success `2` - failure | [optional] - **sellCurrency** | **String**| Currency to sell which can be retrieved from supported currency list API `GET /flash_swap/currencies` | [optional] - **buyCurrency** | **String**| Currency to buy which can be retrieved from supported currency list API `GET /flash_swap/currencies` | [optional] - **reverse** | **Boolean**| If results are sorted by id in reverse order. Default to `true` - `true`: sort by id in descending order(recent first) - `false`: sort by id in ascending order(oldest first) | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **status** | **Integer**| Flash swap order status `1` - success `2` - failed | [optional] + **sellCurrency** | **String**| Asset name to sell - Retrieved from API `GET /flash_swap/currencies` for supported flash swap currencies | [optional] + **buyCurrency** | **String**| Asset name to buy - Retrieved from API `GET /flash_swap/currencies` for supported flash swap currencies | [optional] + **reverse** | **Boolean**| 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** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **page** | **Integer**| Page number | [optional] [default to 1] ### Return type @@ -168,7 +168,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **createFlashSwapOrder** @@ -238,13 +238,13 @@ 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 | - | # **getFlashSwapOrder** > FlashSwapOrder getFlashSwapOrder(orderId) -Get a single flash swap order's detail +Query single flash swap order ### Example @@ -306,13 +306,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **previewFlashSwapOrder** > FlashSwapOrderPreview previewFlashSwapOrder(flashSwapPreviewRequest) -Initiate a flash swap order preview +Flash swap order preview ### Example @@ -374,5 +374,5 @@ 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 | - | diff --git a/docs/FlashSwapCurrencyPair.md b/docs/FlashSwapCurrencyPair.md index 79406b1..2ad2f0a 100644 --- a/docs/FlashSwapCurrencyPair.md +++ b/docs/FlashSwapCurrencyPair.md @@ -7,11 +7,11 @@ List all supported currencies in flash swap Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currencyPair** | **String** | The currency pair, BTC_USDT represents selling Bitcoin (BTC) and buying Tether (USDT). | [optional] [readonly] -**sellCurrency** | **String** | The currency to be sold | [optional] [readonly] -**buyCurrency** | **String** | The currency to be bought | [optional] [readonly] -**sellMinAmount** | **String** | The minimum quantity required for selling | [optional] [readonly] -**sellMaxAmount** | **String** | The maximum quantity allowed for selling | [optional] [readonly] -**buyMinAmount** | **String** | The minimum quantity required for buying | [optional] [readonly] -**buyMaxAmount** | **String** | The maximum quantity allowed for buying | [optional] [readonly] +**currencyPair** | **String** | Currency pair, `BTC_USDT` represents selling `BTC` and buying `USDT` | [optional] [readonly] +**sellCurrency** | **String** | Currency to sell | [optional] [readonly] +**buyCurrency** | **String** | Currency to buy | [optional] [readonly] +**sellMinAmount** | **String** | Minimum sell quantity | [optional] [readonly] +**sellMaxAmount** | **String** | Maximum sell quantity | [optional] [readonly] +**buyMinAmount** | **String** | Minimum buy quantity | [optional] [readonly] +**buyMaxAmount** | **String** | Maximum buy quantity | [optional] [readonly] diff --git a/docs/FlashSwapOrderPreview.md b/docs/FlashSwapOrderPreview.md index bba0595..b25622d 100644 --- a/docs/FlashSwapOrderPreview.md +++ b/docs/FlashSwapOrderPreview.md @@ -1,16 +1,16 @@ # FlashSwapOrderPreview -Initiate a flash swap order preview +Flash swap order preview ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **previewId** | **String** | Preview result ID | [optional] -**sellCurrency** | **String** | Currency to sell which can be retrieved from supported currency list API `GET /flash_swap/currencies` | [optional] +**sellCurrency** | **String** | Name of the sold asset, Refer to the interface Query the list of currencies supported for flash swap GET /flash_swap/currenciesto obtain | [optional] **sellAmount** | **String** | Amount to sell | [optional] -**buyCurrency** | **String** | Currency to buy which can be retrieved from supported currency list API `GET /flash_swap/currencies` | [optional] +**buyCurrency** | **String** | Name of the purchased asset, Refer to the interface Query the list of currencies supported for flash swap GET /flash_swap/currenciesto obtain | [optional] **buyAmount** | **String** | Amount to buy | [optional] **price** | **String** | Price | [optional] diff --git a/docs/FlashSwapOrderRequest.md b/docs/FlashSwapOrderRequest.md index 43ddd0f..100b504 100644 --- a/docs/FlashSwapOrderRequest.md +++ b/docs/FlashSwapOrderRequest.md @@ -8,8 +8,8 @@ Parameters of flash swap order creation Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **previewId** | **String** | Preview result ID | -**sellCurrency** | **String** | 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. | +**sellCurrency** | **String** | 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 | **sellAmount** | **String** | Amount to sell (based on the preview result) | -**buyCurrency** | **String** | 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. | +**buyCurrency** | **String** | 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 | **buyAmount** | **String** | Amount to buy (based on the preview result) | diff --git a/docs/FlashSwapPreviewRequest.md b/docs/FlashSwapPreviewRequest.md index 1fec8a3..0819b9c 100644 --- a/docs/FlashSwapPreviewRequest.md +++ b/docs/FlashSwapPreviewRequest.md @@ -7,8 +7,8 @@ Parameters of flash swap order creation Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**sellCurrency** | **String** | 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. | +**sellCurrency** | **String** | 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 | **sellAmount** | **String** | Amount to sell. It is required to choose one parameter between `sell_amount` and `buy_amount` | [optional] -**buyCurrency** | **String** | 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. | +**buyCurrency** | **String** | 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 | **buyAmount** | **String** | Amount to buy. It is required to choose one parameter between `sell_amount` and `buy_amount` | [optional] diff --git a/docs/FutureCancelOrderResult.md b/docs/FutureCancelOrderResult.md index 7a7ebec..78b53f0 100644 --- a/docs/FutureCancelOrderResult.md +++ b/docs/FutureCancelOrderResult.md @@ -10,5 +10,5 @@ Name | Type | Description | Notes **id** | **String** | Order ID | [optional] **userId** | **Long** | User ID | [optional] **succeeded** | **Boolean** | Whether cancellation succeeded | [optional] -**message** | **String** | Error message when failed to cancel the order; empty if succeeded | [optional] +**message** | **String** | Error description when cancellation fails, empty if successful | [optional] diff --git a/docs/FuturesAccount.md b/docs/FuturesAccount.md index d2099e2..0ff4e6d 100644 --- a/docs/FuturesAccount.md +++ b/docs/FuturesAccount.md @@ -9,25 +9,27 @@ Name | Type | Description | Notes **unrealisedPnl** | **String** | Unrealized PNL | [optional] **positionMargin** | **String** | Position margin | [optional] **orderMargin** | **String** | Order margin of unfinished orders | [optional] -**available** | **String** | The available balance for transferring or trading(including bonus. Bonus can't be be withdrawn. The transfer amount needs to deduct the bonus) | [optional] -**point** | **String** | POINT amount | [optional] -**currency** | **String** | Settle currency | [optional] +**available** | **String** | Available balance for transferring or trading (including bonus. Bonus cannot be withdrawn, so transfer amount needs to deduct bonus) | [optional] +**point** | **String** | Point card amount | [optional] +**currency** | **String** | Settlement currency | [optional] **inDualMode** | **Boolean** | Whether dual mode is enabled | [optional] +**positionMode** | **String** | Position mode: single - one-way, dual - dual-side, split - sub-positions (in_dual_mode is deprecated) | [optional] **enableCredit** | **Boolean** | Whether portfolio margin account mode is enabled | [optional] -**positionInitialMargin** | **String** | Initial margin position, applicable to the portfolio margin account model | [optional] -**maintenanceMargin** | **String** | The maintenance deposit occupied by the position is suitable for the new classic account margin model and unified account model | [optional] -**bonus** | **String** | Perpetual Contract Bonus | [optional] +**positionInitialMargin** | **String** | Initial margin occupied by positions, applicable to unified account mode | [optional] +**maintenanceMargin** | **String** | Maintenance margin occupied by positions, applicable to new classic account margin mode and unified account mode | [optional] +**bonus** | **String** | Bonus | [optional] **enableEvolvedClassic** | **Boolean** | Classic account margin mode, true-new mode, false-old mode | [optional] -**crossOrderMargin** | **String** | Full -warehouse hanging order deposit, suitable for the new classic account margin model | [optional] -**crossInitialMargin** | **String** | The initial security deposit of the full warehouse is suitable for the new classic account margin model | [optional] -**crossMaintenanceMargin** | **String** | Maintain deposit in full warehouse, suitable for new classic account margin models | [optional] -**crossUnrealisedPnl** | **String** | The full warehouse does not achieve profit and loss, suitable for the new classic account margin model | [optional] -**crossAvailable** | **String** | Full warehouse available amount, suitable for the new classic account margin model | [optional] -**crossMarginBalance** | **String** | Full margin balance, suitable for the new classic account margin model | [optional] -**crossMmr** | **String** | Maintain margin ratio for the full position, suitable for the new classic account margin model | [optional] -**crossImr** | **String** | The initial margin rate of the full position is suitable for the new classic account margin model | [optional] -**isolatedPositionMargin** | **String** | Ware -position margin, suitable for the new classic account margin model | [optional] +**crossOrderMargin** | **String** | Cross margin order margin, applicable to new classic account margin mode | [optional] +**crossInitialMargin** | **String** | Cross margin initial margin, applicable to new classic account margin mode | [optional] +**crossMaintenanceMargin** | **String** | Cross margin maintenance margin, applicable to new classic account margin mode | [optional] +**crossUnrealisedPnl** | **String** | Cross margin unrealized P&L, applicable to new classic account margin mode | [optional] +**crossAvailable** | **String** | Cross margin available balance, applicable to new classic account margin mode | [optional] +**crossMarginBalance** | **String** | Cross margin balance, applicable to new classic account margin mode | [optional] +**crossMmr** | **String** | Cross margin maintenance margin rate, applicable to new classic account margin mode | [optional] +**crossImr** | **String** | Cross margin initial margin rate, applicable to new classic account margin mode | [optional] +**isolatedPositionMargin** | **String** | Isolated position margin, applicable to new classic account margin mode | [optional] **enableNewDualMode** | **Boolean** | Whether to open a new two-way position mode | [optional] **marginMode** | **Integer** | Margin mode, 0-classic margin mode, 1-cross-currency margin mode, 2-combined margin mode | [optional] +**enableTieredMm** | **Boolean** | Whether to enable tiered maintenance margin calculation | [optional] **history** | [**FuturesAccountHistory**](FuturesAccountHistory.md) | | [optional] diff --git a/docs/FuturesAccountBook.md b/docs/FuturesAccountBook.md index bd14fe6..46191b9 100644 --- a/docs/FuturesAccountBook.md +++ b/docs/FuturesAccountBook.md @@ -8,11 +8,11 @@ Name | Type | Description | Notes **time** | **Double** | Change time | [optional] **change** | **String** | Change amount | [optional] **balance** | **String** | Balance after change | [optional] -**type** | [**TypeEnum**](#TypeEnum) | Changing Type： - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction | [optional] +**type** | [**TypeEnum**](#TypeEnum) | 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** | **String** | Comment | [optional] -**contract** | **String** | Futures contract, the field is only available for data after 2023-10-30. | [optional] +**contract** | **String** | Futures contract, the field is only available for data after 2023-10-30 | [optional] **tradeId** | **String** | trade id | [optional] -**id** | **String** | 账户变更记录 id | [optional] +**id** | **String** | Account change record ID | [optional] ## Enum: TypeEnum diff --git a/docs/FuturesApi.md b/docs/FuturesApi.md index 2531d72..3495c30 100644 --- a/docs/FuturesApi.md +++ b/docs/FuturesApi.md @@ -4,61 +4,63 @@ All URIs are relative to *https://api.gateio.ws/api/v4* Method | HTTP request | Description ------------- | ------------- | ------------- -[**listFuturesContracts**](FuturesApi.md#listFuturesContracts) | **GET** /futures/{settle}/contracts | List all futures contracts -[**getFuturesContract**](FuturesApi.md#getFuturesContract) | **GET** /futures/{settle}/contracts/{contract} | Get a single contract -[**listFuturesOrderBook**](FuturesApi.md#listFuturesOrderBook) | **GET** /futures/{settle}/order_book | Futures order book -[**listFuturesTrades**](FuturesApi.md#listFuturesTrades) | **GET** /futures/{settle}/trades | Futures trading history -[**listFuturesCandlesticks**](FuturesApi.md#listFuturesCandlesticks) | **GET** /futures/{settle}/candlesticks | Get futures candlesticks -[**listFuturesPremiumIndex**](FuturesApi.md#listFuturesPremiumIndex) | **GET** /futures/{settle}/premium_index | Premium Index K-Line -[**listFuturesTickers**](FuturesApi.md#listFuturesTickers) | **GET** /futures/{settle}/tickers | List futures tickers -[**listFuturesFundingRateHistory**](FuturesApi.md#listFuturesFundingRateHistory) | **GET** /futures/{settle}/funding_rate | Funding rate history -[**listFuturesInsuranceLedger**](FuturesApi.md#listFuturesInsuranceLedger) | **GET** /futures/{settle}/insurance | Futures insurance balance history -[**listContractStats**](FuturesApi.md#listContractStats) | **GET** /futures/{settle}/contract_stats | Futures stats -[**getIndexConstituents**](FuturesApi.md#getIndexConstituents) | **GET** /futures/{settle}/index_constituents/{index} | Get index constituents -[**listLiquidatedOrders**](FuturesApi.md#listLiquidatedOrders) | **GET** /futures/{settle}/liq_orders | Retrieve liquidation history -[**listFuturesRiskLimitTiers**](FuturesApi.md#listFuturesRiskLimitTiers) | **GET** /futures/{settle}/risk_limit_tiers | List risk limit tiers -[**listFuturesAccounts**](FuturesApi.md#listFuturesAccounts) | **GET** /futures/{settle}/accounts | Query futures account -[**listFuturesAccountBook**](FuturesApi.md#listFuturesAccountBook) | **GET** /futures/{settle}/account_book | Query account book -[**listPositions**](FuturesApi.md#listPositions) | **GET** /futures/{settle}/positions | List all positions of a user -[**getPosition**](FuturesApi.md#getPosition) | **GET** /futures/{settle}/positions/{contract} | Get single position +[**listFuturesContracts**](FuturesApi.md#listFuturesContracts) | **GET** /futures/{settle}/contracts | Query all futures contracts +[**getFuturesContract**](FuturesApi.md#getFuturesContract) | **GET** /futures/{settle}/contracts/{contract} | Query single contract information +[**listFuturesOrderBook**](FuturesApi.md#listFuturesOrderBook) | **GET** /futures/{settle}/order_book | Query futures market depth information +[**listFuturesTrades**](FuturesApi.md#listFuturesTrades) | **GET** /futures/{settle}/trades | Futures market transaction records +[**listFuturesCandlesticks**](FuturesApi.md#listFuturesCandlesticks) | **GET** /futures/{settle}/candlesticks | Futures market K-line chart +[**listFuturesPremiumIndex**](FuturesApi.md#listFuturesPremiumIndex) | **GET** /futures/{settle}/premium_index | Premium Index K-line chart +[**listFuturesTickers**](FuturesApi.md#listFuturesTickers) | **GET** /futures/{settle}/tickers | Get all futures trading statistics +[**listFuturesFundingRateHistory**](FuturesApi.md#listFuturesFundingRateHistory) | **GET** /futures/{settle}/funding_rate | Futures market historical funding rate +[**listFuturesInsuranceLedger**](FuturesApi.md#listFuturesInsuranceLedger) | **GET** /futures/{settle}/insurance | Futures market insurance fund history +[**listContractStats**](FuturesApi.md#listContractStats) | **GET** /futures/{settle}/contract_stats | Futures statistics +[**getIndexConstituents**](FuturesApi.md#getIndexConstituents) | **GET** /futures/{settle}/index_constituents/{index} | Query index constituents +[**listLiquidatedOrders**](FuturesApi.md#listLiquidatedOrders) | **GET** /futures/{settle}/liq_orders | Query liquidation order history +[**listFuturesRiskLimitTiers**](FuturesApi.md#listFuturesRiskLimitTiers) | **GET** /futures/{settle}/risk_limit_tiers | Query risk limit tiers +[**listFuturesAccounts**](FuturesApi.md#listFuturesAccounts) | **GET** /futures/{settle}/accounts | Get futures account +[**listFuturesAccountBook**](FuturesApi.md#listFuturesAccountBook) | **GET** /futures/{settle}/account_book | Query futures account change history +[**listPositions**](FuturesApi.md#listPositions) | **GET** /futures/{settle}/positions | Get user position list +[**getPosition**](FuturesApi.md#getPosition) | **GET** /futures/{settle}/positions/{contract} | Get single position information [**updatePositionMargin**](FuturesApi.md#updatePositionMargin) | **POST** /futures/{settle}/positions/{contract}/margin | Update position margin [**updatePositionLeverage**](FuturesApi.md#updatePositionLeverage) | **POST** /futures/{settle}/positions/{contract}/leverage | Update position leverage -[**updatePositionCrossMode**](FuturesApi.md#updatePositionCrossMode) | **POST** /futures/{settle}/positions/cross_mode | Switch to the full position-by-store mode +[**updatePositionCrossMode**](FuturesApi.md#updatePositionCrossMode) | **POST** /futures/{settle}/positions/cross_mode | Switch Position Margin Mode +[**updateDualCompPositionCrossMode**](FuturesApi.md#updateDualCompPositionCrossMode) | **POST** /futures/{settle}/dual_comp/positions/cross_mode | Switch Between Cross and Isolated Margin Modes Under Hedge Mode [**updatePositionRiskLimit**](FuturesApi.md#updatePositionRiskLimit) | **POST** /futures/{settle}/positions/{contract}/risk_limit | Update position risk limit -[**setDualMode**](FuturesApi.md#setDualMode) | **POST** /futures/{settle}/dual_mode | Enable or disable dual mode -[**getDualModePosition**](FuturesApi.md#getDualModePosition) | **GET** /futures/{settle}/dual_comp/positions/{contract} | Retrieve position detail in dual mode +[**setDualMode**](FuturesApi.md#setDualMode) | **POST** /futures/{settle}/dual_mode | Set position mode +[**getDualModePosition**](FuturesApi.md#getDualModePosition) | **GET** /futures/{settle}/dual_comp/positions/{contract} | Get position information in dual mode [**updateDualModePositionMargin**](FuturesApi.md#updateDualModePositionMargin) | **POST** /futures/{settle}/dual_comp/positions/{contract}/margin | Update position margin in dual mode [**updateDualModePositionLeverage**](FuturesApi.md#updateDualModePositionLeverage) | **POST** /futures/{settle}/dual_comp/positions/{contract}/leverage | Update position leverage in dual mode [**updateDualModePositionRiskLimit**](FuturesApi.md#updateDualModePositionRiskLimit) | **POST** /futures/{settle}/dual_comp/positions/{contract}/risk_limit | Update position risk limit in dual mode -[**listFuturesOrders**](FuturesApi.md#listFuturesOrders) | **GET** /futures/{settle}/orders | List futures orders -[**createFuturesOrder**](FuturesApi.md#createFuturesOrder) | **POST** /futures/{settle}/orders | Create a futures order -[**cancelFuturesOrders**](FuturesApi.md#cancelFuturesOrders) | **DELETE** /futures/{settle}/orders | Cancel all `open` orders matched -[**getOrdersWithTimeRange**](FuturesApi.md#getOrdersWithTimeRange) | **GET** /futures/{settle}/orders_timerange | List Futures Orders By Time Range -[**createBatchFuturesOrder**](FuturesApi.md#createBatchFuturesOrder) | **POST** /futures/{settle}/batch_orders | Create a batch of futures orders -[**getFuturesOrder**](FuturesApi.md#getFuturesOrder) | **GET** /futures/{settle}/orders/{order_id} | Get a single order -[**amendFuturesOrder**](FuturesApi.md#amendFuturesOrder) | **PUT** /futures/{settle}/orders/{order_id} | Amend an order -[**cancelFuturesOrder**](FuturesApi.md#cancelFuturesOrder) | **DELETE** /futures/{settle}/orders/{order_id} | Cancel a single order -[**getMyTrades**](FuturesApi.md#getMyTrades) | **GET** /futures/{settle}/my_trades | List personal trading history -[**getMyTradesWithTimeRange**](FuturesApi.md#getMyTradesWithTimeRange) | **GET** /futures/{settle}/my_trades_timerange | List personal trading history by time range -[**listPositionClose**](FuturesApi.md#listPositionClose) | **GET** /futures/{settle}/position_close | List position close history -[**listLiquidates**](FuturesApi.md#listLiquidates) | **GET** /futures/{settle}/liquidates | List liquidation history -[**listAutoDeleverages**](FuturesApi.md#listAutoDeleverages) | **GET** /futures/{settle}/auto_deleverages | List Auto-Deleveraging History +[**listFuturesOrders**](FuturesApi.md#listFuturesOrders) | **GET** /futures/{settle}/orders | Query futures order list +[**createFuturesOrder**](FuturesApi.md#createFuturesOrder) | **POST** /futures/{settle}/orders | Place futures order +[**cancelFuturesOrders**](FuturesApi.md#cancelFuturesOrders) | **DELETE** /futures/{settle}/orders | Cancel all orders with 'open' status +[**getOrdersWithTimeRange**](FuturesApi.md#getOrdersWithTimeRange) | **GET** /futures/{settle}/orders_timerange | Query futures order list by time range +[**createBatchFuturesOrder**](FuturesApi.md#createBatchFuturesOrder) | **POST** /futures/{settle}/batch_orders | Place batch futures orders +[**getFuturesOrder**](FuturesApi.md#getFuturesOrder) | **GET** /futures/{settle}/orders/{order_id} | Query single order details +[**amendFuturesOrder**](FuturesApi.md#amendFuturesOrder) | **PUT** /futures/{settle}/orders/{order_id} | Amend single order +[**cancelFuturesOrder**](FuturesApi.md#cancelFuturesOrder) | **DELETE** /futures/{settle}/orders/{order_id} | Cancel single order +[**getMyTrades**](FuturesApi.md#getMyTrades) | **GET** /futures/{settle}/my_trades | Query personal trading records +[**getMyTradesWithTimeRange**](FuturesApi.md#getMyTradesWithTimeRange) | **GET** /futures/{settle}/my_trades_timerange | Query personal trading records by time range +[**listPositionClose**](FuturesApi.md#listPositionClose) | **GET** /futures/{settle}/position_close | Query position close history +[**listLiquidates**](FuturesApi.md#listLiquidates) | **GET** /futures/{settle}/liquidates | Query liquidation history +[**listAutoDeleverages**](FuturesApi.md#listAutoDeleverages) | **GET** /futures/{settle}/auto_deleverages | Query ADL auto-deleveraging order information [**countdownCancelAllFutures**](FuturesApi.md#countdownCancelAllFutures) | **POST** /futures/{settle}/countdown_cancel_all | Countdown cancel orders -[**getFuturesFee**](FuturesApi.md#getFuturesFee) | **GET** /futures/{settle}/fee | Query user trading fee rates -[**cancelBatchFutureOrders**](FuturesApi.md#cancelBatchFutureOrders) | **POST** /futures/{settle}/batch_cancel_orders | Cancel a batch of orders with an ID list -[**amendBatchFutureOrders**](FuturesApi.md#amendBatchFutureOrders) | **POST** /futures/{settle}/batch_amend_orders | Batch modify orders with specified IDs -[**listPriceTriggeredOrders**](FuturesApi.md#listPriceTriggeredOrders) | **GET** /futures/{settle}/price_orders | List All Price-triggered Orders -[**createPriceTriggeredOrder**](FuturesApi.md#createPriceTriggeredOrder) | **POST** /futures/{settle}/price_orders | Create a price-triggered order -[**cancelPriceTriggeredOrderList**](FuturesApi.md#cancelPriceTriggeredOrderList) | **DELETE** /futures/{settle}/price_orders | Cancel All Price-triggered Orders -[**getPriceTriggeredOrder**](FuturesApi.md#getPriceTriggeredOrder) | **GET** /futures/{settle}/price_orders/{order_id} | Get a price-triggered order -[**cancelPriceTriggeredOrder**](FuturesApi.md#cancelPriceTriggeredOrder) | **DELETE** /futures/{settle}/price_orders/{order_id} | cancel a price-triggered order +[**getFuturesFee**](FuturesApi.md#getFuturesFee) | **GET** /futures/{settle}/fee | Query futures market trading fee rates +[**cancelBatchFutureOrders**](FuturesApi.md#cancelBatchFutureOrders) | **POST** /futures/{settle}/batch_cancel_orders | Cancel batch orders by specified ID list +[**amendBatchFutureOrders**](FuturesApi.md#amendBatchFutureOrders) | **POST** /futures/{settle}/batch_amend_orders | Batch modify orders by specified IDs +[**getFuturesRiskLimitTable**](FuturesApi.md#getFuturesRiskLimitTable) | **GET** /futures/{settle}/risk_limit_table | Query risk limit table by table_id +[**listPriceTriggeredOrders**](FuturesApi.md#listPriceTriggeredOrders) | **GET** /futures/{settle}/price_orders | Query auto order list +[**createPriceTriggeredOrder**](FuturesApi.md#createPriceTriggeredOrder) | **POST** /futures/{settle}/price_orders | Create price-triggered order +[**cancelPriceTriggeredOrderList**](FuturesApi.md#cancelPriceTriggeredOrderList) | **DELETE** /futures/{settle}/price_orders | Cancel all auto orders +[**getPriceTriggeredOrder**](FuturesApi.md#getPriceTriggeredOrder) | **GET** /futures/{settle}/price_orders/{order_id} | Query single auto order details +[**cancelPriceTriggeredOrder**](FuturesApi.md#cancelPriceTriggeredOrder) | **DELETE** /futures/{settle}/price_orders/{order_id} | Cancel single auto order # **listFuturesContracts** > List<Contract> listFuturesContracts(settle).limit(limit).offset(offset).execute(); -List all futures contracts +Query all futures contracts ### Example @@ -78,7 +80,7 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 try { List result = apiInstance.listFuturesContracts(settle) @@ -104,7 +106,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] ### Return type @@ -123,13 +125,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **getFuturesContract** > Contract getFuturesContract(settle, contract) -Get a single contract +Query single contract information ### Example @@ -195,7 +197,7 @@ No authorization required # **listFuturesOrderBook** > FuturesOrderBook listFuturesOrderBook(settle, contract).interval(interval).limit(limit).withId(withId).execute(); -Futures order book +Query futures market depth information Bids will be sorted by price from high to low, while asks sorted reversely @@ -218,9 +220,9 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT"; // String | Futures contract - String interval = "\"0\""; // String | Order depth. 0 means no aggregation is applied. default to 0 - Integer limit = 10; // Integer | Maximum number of order depth data in asks or bids - Boolean withId = false; // Boolean | Whether the order book update ID will be returned. This ID increases by 1 on every order book update + String interval = "\"0\""; // String | Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified + Integer limit = 10; // Integer | Number of depth levels + Boolean withId = false; // Boolean | Whether to return depth update ID. This ID increments by 1 each time depth changes try { FuturesOrderBook result = apiInstance.listFuturesOrderBook(settle, contract) .interval(interval) @@ -247,9 +249,9 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] **contract** | **String**| Futures contract | - **interval** | **String**| Order depth. 0 means no aggregation is applied. default to 0 | [optional] [default to "0"] - **limit** | **Integer**| Maximum number of order depth data in asks or bids | [optional] [default to 10] - **withId** | **Boolean**| Whether the order book update ID will be returned. This ID increases by 1 on every order book update | [optional] [default to false] + **interval** | **String**| Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified | [optional] [default to "0"] + **limit** | **Integer**| Number of depth levels | [optional] [default to 10] + **withId** | **Boolean**| Whether to return depth update ID. This ID increments by 1 each time depth changes | [optional] [default to false] ### Return type @@ -267,13 +269,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order book retrieved | - | +**200** | Depth query successful | - | # **listFuturesTrades** > List<FuturesTrade> listFuturesTrades(settle, contract).limit(limit).offset(offset).lastId(lastId).from(from).to(to).execute(); -Futures trading history +Futures market transaction records ### Example @@ -294,11 +296,11 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT"; // String | Futures contract - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 String lastId = "12345"; // String | 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 Long from = 1546905600L; // Long | 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. - Long to = 1546935600L; // Long | Specify end time in Unix seconds, default to current time + Long to = 1546935600L; // Long | Specify end time in Unix seconds, default to current time. try { List result = apiInstance.listFuturesTrades(settle, contract) .limit(limit) @@ -327,11 +329,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] **contract** | **String**| Futures contract | - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] **lastId** | **String**| 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** | **Long**| 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** | **Long**| Specify end time in Unix seconds, default to current time | [optional] + **to** | **Long**| Specify end time in Unix seconds, default to current time. | [optional] ### Return type @@ -349,13 +351,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listFuturesCandlesticks** -> List<FuturesCandlestick> listFuturesCandlesticks(settle, contract).from(from).to(to).limit(limit).interval(interval).execute(); +> List<FuturesCandlestick> listFuturesCandlesticks(settle, contract).from(from).to(to).limit(limit).interval(interval).timezone(timezone).execute(); -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` @@ -379,15 +381,17 @@ public class Example { String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT"; // String | Futures contract Long from = 1546905600L; // Long | Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified - Long to = 1546935600L; // Long | End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time - Integer limit = 100; // Integer | Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected. - String interval = "\"5m\""; // String | Interval time between data points. Note that `1w` means natual week(Mon-Sun), while `7d` means every 7d since unix 0. Note that 30d means 1 natual month, not 30 days + Long to = 1546935600L; // Long | 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 + Integer limit = 100; // Integer | 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. + String interval = "5m"; // String | 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 + String timezone = "\"utc0\""; // String | Time zone: all/utc0/utc8, default utc0 try { List result = apiInstance.listFuturesCandlesticks(settle, contract) .from(from) .to(to) .limit(limit) .interval(interval) + .timezone(timezone) .execute(); System.out.println(result); } catch (GateApiException e) { @@ -410,9 +414,10 @@ Name | Type | Description | Notes **settle** | **String**| Settle currency | [enum: btc, usdt] **contract** | **String**| Futures contract | **from** | **Long**| Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified | [optional] - **to** | **Long**| End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time | [optional] - **limit** | **Integer**| 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** | **String**| Interval time between data points. Note that `1w` means natual week(Mon-Sun), while `7d` means every 7d since unix 0. Note that 30d means 1 natual month, not 30 days | [optional] [default to "5m"] + **to** | **Long**| 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** | **Integer**| 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** | **String**| 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] [enum: 10s, 1m, 5m, 15m, 30m, 1h, 4h, 8h, 1d, 7d] + **timezone** | **String**| Time zone: all/utc0/utc8, default utc0 | [optional] [default to "utc0"] ### Return type @@ -430,13 +435,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listFuturesPremiumIndex** > List<FuturesPremiumIndex> listFuturesPremiumIndex(settle, contract).from(from).to(to).limit(limit).interval(interval).execute(); -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 @@ -460,9 +465,9 @@ public class Example { String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT"; // String | Futures contract Long from = 1546905600L; // Long | Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified - Long to = 1546935600L; // Long | End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time - Integer limit = 100; // Integer | Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected. - String interval = "\"5m\""; // String | Interval time between data points + Long to = 1546935600L; // Long | 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 + Integer limit = 100; // Integer | 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. + String interval = "5m"; // String | Time interval between data points try { List result = apiInstance.listFuturesPremiumIndex(settle, contract) .from(from) @@ -491,9 +496,9 @@ Name | Type | Description | Notes **settle** | **String**| Settle currency | [enum: btc, usdt] **contract** | **String**| Futures contract | **from** | **Long**| Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified | [optional] - **to** | **Long**| End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time | [optional] - **limit** | **Integer**| 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** | **String**| Interval time between data points | [optional] [default to "5m"] + **to** | **Long**| 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** | **Integer**| 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** | **String**| Time interval between data points | [optional] [default to 5m] [enum: 10s, 1m, 5m, 15m, 30m, 1h, 4h, 8h, 1d, 7d] ### Return type @@ -511,13 +516,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listFuturesTickers** > List<FuturesTicker> listFuturesTickers(settle).contract(contract).execute(); -List futures tickers +Get all futures trading statistics ### Example @@ -579,13 +584,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listFuturesFundingRateHistory** > List<FundingRateRecord> listFuturesFundingRateHistory(settle, contract).limit(limit).from(from).to(to).execute(); -Funding rate history +Futures market historical funding rate ### Example @@ -606,9 +611,9 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT"; // String | Futures contract - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list - Long from = 1547706332L; // Long | Start timestamp - Long to = 1547706332L; // Long | End timestamp + Integer limit = 100; // Integer | Maximum number of records returned in a single list + Long from = 1547706332L; // Long | 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) + Long to = 1547706332L; // Long | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp try { List result = apiInstance.listFuturesFundingRateHistory(settle, contract) .limit(limit) @@ -635,9 +640,9 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] **contract** | **String**| Futures contract | - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] - **from** | **Long**| Start timestamp | [optional] - **to** | **Long**| End timestamp | [optional] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] + **from** | **Long**| 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** | **Long**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional] ### Return type @@ -655,13 +660,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | History retrieved | - | +**200** | History query successful | - | # **listFuturesInsuranceLedger** > List<InsuranceRecord> listFuturesInsuranceLedger(settle).limit(limit).execute(); -Futures insurance balance history +Futures market insurance fund history ### Example @@ -681,7 +686,7 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list try { List result = apiInstance.listFuturesInsuranceLedger(settle) .limit(limit) @@ -705,7 +710,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] ### Return type @@ -723,13 +728,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listContractStats** > List<ContractStat> listContractStats(settle, contract).from(from).interval(interval).limit(limit).execute(); -Futures stats +Futures statistics ### Example @@ -799,13 +804,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **getIndexConstituents** > FuturesIndexConstituents getIndexConstituents(settle, index) -Get index constituents +Query index constituents ### Example @@ -865,15 +870,15 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listLiquidatedOrders** > List<FuturesLiqOrder> listLiquidatedOrders(settle).contract(contract).from(from).to(to).limit(limit).execute(); -Retrieve liquidation history +Query liquidation order history -Interval between `from` and `to` cannot exceeds 3600. Some private fields will not be returned in public endpoints. Refer to field description for detail. +The time interval between from and to is maximum 3600. Some private fields are not returned by public interfaces, refer to field descriptions for details ### Example @@ -894,9 +899,9 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified - Long from = 1547706332L; // Long | Start timestamp - Long to = 1547706332L; // Long | End timestamp - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Long from = 1547706332L; // Long | 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) + Long to = 1547706332L; // Long | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp + Integer limit = 100; // Integer | Maximum number of records returned in a single list try { List result = apiInstance.listLiquidatedOrders(settle) .contract(contract) @@ -924,9 +929,9 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] **contract** | **String**| Futures contract, return related data only if specified | [optional] - **from** | **Long**| Start timestamp | [optional] - **to** | **Long**| End timestamp | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **from** | **Long**| 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** | **Long**| 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** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] ### Return type @@ -944,15 +949,15 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listFuturesRiskLimitTiers** > List<FuturesLimitRiskTiers> listFuturesRiskLimitTiers(settle).contract(contract).limit(limit).offset(offset).execute(); -List risk limit tiers +Query risk limit tiers -When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets.'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the 'contract' parameter is empty. +When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets. 'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the contract parameter is empty. ### Example @@ -973,7 +978,7 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 try { List result = apiInstance.listFuturesRiskLimitTiers(settle) @@ -1001,7 +1006,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] **contract** | **String**| Futures contract, return related data only if specified | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] ### Return type @@ -1020,13 +1025,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listFuturesAccounts** > FuturesAccount listFuturesAccounts(settle) -Query futures account +Get futures account ### Example @@ -1088,15 +1093,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listFuturesAccountBook** > List<FuturesAccountBook> listFuturesAccountBook(settle).contract(contract).limit(limit).offset(offset).from(from).to(to).type(type).execute(); -Query account book +Query futures account change history -If the `contract` field is provided, it can only filter records that include this field after 2023-10-30. +If the contract field is passed, only records containing this field after 2023-10-30 can be filtered. ### Example @@ -1121,11 +1126,11 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 - Long from = 1547706332L; // Long | Start timestamp - Long to = 1547706332L; // Long | End timestamp - String type = "dnw"; // String | Changing Type： - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction + Long from = 1547706332L; // Long | 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) + Long to = 1547706332L; // Long | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp + String type = "dnw"; // String | 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 try { List result = apiInstance.listFuturesAccountBook(settle) .contract(contract) @@ -1155,11 +1160,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] **contract** | **String**| Futures contract, return related data only if specified | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] - **from** | **Long**| Start timestamp | [optional] - **to** | **Long**| End timestamp | [optional] - **type** | **String**| Changing Type： - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction | [optional] + **from** | **Long**| 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** | **Long**| 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** | **String**| 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 @@ -1177,13 +1182,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listPositions** > List<Position> listPositions(settle).holding(holding).limit(limit).offset(offset).execute(); -List all positions of a user +Get user position list ### Example @@ -1207,8 +1212,8 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency - Boolean holding = true; // Boolean | Return only real positions - true, return all - false. - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Boolean holding = true; // Boolean | Return only real positions - true, return all - false + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 try { List result = apiInstance.listPositions(settle) @@ -1235,8 +1240,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] - **holding** | **Boolean**| Return only real positions - true, return all - false. | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **holding** | **Boolean**| Return only real positions - true, return all - false | [optional] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] ### Return type @@ -1255,13 +1260,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **getPosition** > Position getPosition(settle, contract).execute(); -Get single position +Get single position information ### Example @@ -1357,7 +1362,7 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT"; // String | Futures contract - String change = "0.01"; // String | Margin change. Use positive number to increase margin, negative number otherwise. + String change = "0.01"; // String | Margin change amount, positive number increases, negative number decreases try { Position result = apiInstance.updatePositionMargin(settle, contract, change); System.out.println(result); @@ -1380,7 +1385,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] **contract** | **String**| Futures contract | - **change** | **String**| Margin change. Use positive number to increase margin, negative number otherwise. | + **change** | **String**| Margin change amount, positive number increases, negative number decreases | ### Return type @@ -1402,7 +1407,7 @@ Name | Type | Description | Notes # **updatePositionLeverage** -> Position updatePositionLeverage(settle, contract, leverage, crossLeverageLimit) +> Position updatePositionLeverage(settle, contract, leverage, crossLeverageLimit, pid) Update position leverage @@ -1430,9 +1435,10 @@ public class Example { String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT"; // String | Futures contract String leverage = "10"; // String | New position leverage - String crossLeverageLimit = "10"; // String | Cross margin leverage(valid only when `leverage` is 0) + String crossLeverageLimit = "10"; // String | Cross margin leverage (valid only when `leverage` is 0) + Integer pid = 1; // Integer | Product ID try { - Position result = apiInstance.updatePositionLeverage(settle, contract, leverage, crossLeverageLimit); + Position result = apiInstance.updatePositionLeverage(settle, contract, leverage, crossLeverageLimit, pid); System.out.println(result); } catch (GateApiException e) { System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage())); @@ -1454,7 +1460,8 @@ Name | Type | Description | Notes **settle** | **String**| Settle currency | [enum: btc, usdt] **contract** | **String**| Futures contract | **leverage** | **String**| New position leverage | - **crossLeverageLimit** | **String**| Cross margin leverage(valid only when `leverage` is 0) | [optional] + **crossLeverageLimit** | **String**| Cross margin leverage (valid only when `leverage` is 0) | [optional] + **pid** | **Integer**| Product ID | [optional] ### Return type @@ -1476,9 +1483,9 @@ Name | Type | Description | Notes # **updatePositionCrossMode** -> Position updatePositionCrossMode(settle, inlineObject) +> Position updatePositionCrossMode(settle, futuresPositionCrossMode) -Switch to the full position-by-store mode +Switch Position Margin Mode ### Example @@ -1502,9 +1509,9 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency - InlineObject inlineObject = new InlineObject(); // InlineObject | + FuturesPositionCrossMode futuresPositionCrossMode = new FuturesPositionCrossMode(); // FuturesPositionCrossMode | try { - Position result = apiInstance.updatePositionCrossMode(settle, inlineObject); + Position result = apiInstance.updatePositionCrossMode(settle, futuresPositionCrossMode); System.out.println(result); } catch (GateApiException e) { System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage())); @@ -1524,7 +1531,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] - **inlineObject** | [**InlineObject**](InlineObject.md)| | + **futuresPositionCrossMode** | [**FuturesPositionCrossMode**](FuturesPositionCrossMode.md)| | ### Return type @@ -1544,6 +1551,76 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | Position information | - | + +# **updateDualCompPositionCrossMode** +> List<Position> updateDualCompPositionCrossMode(settle, inlineObject) + +Switch Between Cross and Isolated Margin Modes Under Hedge Mode + +### Example + +```java +// Import classes: +import io.gate.gateapi.ApiClient; +import io.gate.gateapi.ApiException; +import io.gate.gateapi.Configuration; +import io.gate.gateapi.GateApiException; +import io.gate.gateapi.auth.*; +import io.gate.gateapi.models.*; +import io.gate.gateapi.api.FuturesApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.gateio.ws/api/v4"); + + // Configure APIv4 authorization: apiv4 + defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); + + FuturesApi apiInstance = new FuturesApi(defaultClient); + String settle = "usdt"; // String | Settle currency + InlineObject inlineObject = new InlineObject(); // InlineObject | + try { + List result = apiInstance.updateDualCompPositionCrossMode(settle, inlineObject); + System.out.println(result); + } catch (GateApiException e) { + System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage())); + e.printStackTrace(); + } catch (ApiException e) { + System.err.println("Exception when calling FuturesApi#updateDualCompPositionCrossMode"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **settle** | **String**| Settle currency | [enum: btc, usdt] + **inlineObject** | [**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 | - | + # **updatePositionRiskLimit** > Position updatePositionRiskLimit(settle, contract, riskLimit) @@ -1573,7 +1650,7 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT"; // String | Futures contract - String riskLimit = "1000000"; // String | New Risk Limit Value + String riskLimit = "1000000"; // String | New risk limit value try { Position result = apiInstance.updatePositionRiskLimit(settle, contract, riskLimit); System.out.println(result); @@ -1596,7 +1673,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] **contract** | **String**| Futures contract | - **riskLimit** | **String**| New Risk Limit Value | + **riskLimit** | **String**| New risk limit value | ### Return type @@ -1620,9 +1697,9 @@ Name | Type | Description | Notes # **setDualMode** > FuturesAccount setDualMode(settle, dualMode) -Enable or disable dual mode +Set position mode -Before setting dual mode, make sure all positions are closed and no orders are open +The prerequisite for changing mode is that all positions have no holdings and no pending orders ### Example @@ -1686,13 +1763,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Updated | - | +**200** | Updated successfully | - | # **getDualModePosition** > List<Position> getDualModePosition(settle, contract).execute(); -Retrieve position detail in dual mode +Get position information in dual mode ### Example @@ -1757,7 +1834,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **updateDualModePositionMargin** @@ -1788,7 +1865,7 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT"; // String | Futures contract - String change = "0.01"; // String | Margin change. Use positive number to increase margin, negative number otherwise. + String change = "0.01"; // String | Margin change amount, positive number increases, negative number decreases String dualSide = "dual_long"; // String | Long or short position try { List result = apiInstance.updateDualModePositionMargin(settle, contract, change, dualSide); @@ -1812,7 +1889,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] **contract** | **String**| Futures contract | - **change** | **String**| Margin change. Use positive number to increase margin, negative number otherwise. | + **change** | **String**| Margin change amount, positive number increases, negative number decreases | **dualSide** | **String**| Long or short position | ### Return type @@ -1831,7 +1908,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **updateDualModePositionLeverage** @@ -1863,7 +1940,7 @@ public class Example { String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT"; // String | Futures contract String leverage = "10"; // String | New position leverage - String crossLeverageLimit = "10"; // String | Cross margin leverage(valid only when `leverage` is 0) + String crossLeverageLimit = "10"; // String | Cross margin leverage (valid only when `leverage` is 0) try { List result = apiInstance.updateDualModePositionLeverage(settle, contract, leverage, crossLeverageLimit); System.out.println(result); @@ -1887,7 +1964,7 @@ Name | Type | Description | Notes **settle** | **String**| Settle currency | [enum: btc, usdt] **contract** | **String**| Futures contract | **leverage** | **String**| New position leverage | - **crossLeverageLimit** | **String**| Cross margin leverage(valid only when `leverage` is 0) | [optional] + **crossLeverageLimit** | **String**| Cross margin leverage (valid only when `leverage` is 0) | [optional] ### Return type @@ -1905,7 +1982,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **updateDualModePositionRiskLimit** @@ -1936,7 +2013,7 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT"; // String | Futures contract - String riskLimit = "1000000"; // String | New Risk Limit Value + String riskLimit = "1000000"; // String | New risk limit value try { List result = apiInstance.updateDualModePositionRiskLimit(settle, contract, riskLimit); System.out.println(result); @@ -1959,7 +2036,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] **contract** | **String**| Futures contract | - **riskLimit** | **String**| New Risk Limit Value | + **riskLimit** | **String**| New risk limit value | ### Return type @@ -1977,13 +2054,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listFuturesOrders** > List<FuturesOrder> listFuturesOrders(settle, status).contract(contract).limit(limit).offset(offset).lastId(lastId).execute(); -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`. @@ -2009,11 +2086,11 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency - String status = "open"; // String | Only list the orders with this status + String status = "open"; // String | Query order list based on status String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 - String lastId = "12345"; // String | Specify list staring point using the `id` of last record in previous list-query results + String lastId = "12345"; // String | 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 try { List result = apiInstance.listFuturesOrders(settle, status) .contract(contract) @@ -2040,11 +2117,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] - **status** | **String**| Only list the orders with this status | + **status** | **String**| Query order list based on status | **contract** | **String**| Futures contract, return related data only if specified | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] - **lastId** | **String**| Specify list staring point using the `id` of last record in previous list-query results | [optional] + **lastId** | **String**| 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 @@ -2062,15 +2139,15 @@ 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
| # **createFuturesOrder** > FuturesOrder createFuturesOrder(settle, futuresOrder, xGateExptime) -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 position: reduce_only=false, size is a positive 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` +- When placing an order, the number of contracts is specified `size`, not the number of coins. The number of coins corresponding to each contract is returned in the contract details interface `quanto_multiplier` - 0 The order that was completed cannot be obtained after 10 minutes of withdrawal, and the order will be mentioned that the order does not exist - Setting `reduce_only` to `true` can prevent the position from being penetrated when reducing the position - In single-position mode, if you need to close the position, you need to set `size` to 0 and `close` to `true` - In dual warehouse mode, - Reduce position: reduce_only=true, size is a positive number that indicates short position, negative number that indicates long position - Add number that indicates adding long positions, and negative numbers indicate adding short positions - Close position: size=0, set the direction of closing position according to auto_size, and set `reduce_only` to true at the same time - reduce_only: Make sure to only perform position reduction operations to prevent increased positions - Set `stp_act` to determine the use of a strategy that restricts user transactions. For detailed usage, refer to the body parameter `stp_act` ### Example @@ -2140,11 +2217,11 @@ Name | Type | Description | Notes # **cancelFuturesOrders** -> List<FuturesOrder> cancelFuturesOrders(settle, contract, xGateExptime, side) +> List<FuturesOrder> cancelFuturesOrders(settle, contract, xGateExptime, side, excludeReduceOnly, 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 @@ -2170,9 +2247,11 @@ public class Example { String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT"; // String | Futures contract String xGateExptime = "1689560679123"; // String | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected - String side = "ask"; // String | Specify all buy orders or all sell orders, if not specify them, both are included. Revoke all buy orders and revoke all sell orders and make ask + String side = "ask"; // String | 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 + Boolean excludeReduceOnly = false; // Boolean | Whether to exclude reduce-only orders + String text = "cancel by user"; // String | Remark for order cancellation try { - List result = apiInstance.cancelFuturesOrders(settle, contract, xGateExptime, side); + List result = apiInstance.cancelFuturesOrders(settle, contract, xGateExptime, side, excludeReduceOnly, text); System.out.println(result); } catch (GateApiException e) { System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage())); @@ -2194,7 +2273,9 @@ Name | Type | Description | Notes **settle** | **String**| Settle currency | [enum: btc, usdt] **contract** | **String**| Futures contract | **xGateExptime** | **String**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional] - **side** | **String**| Specify all buy orders or all sell orders, if not specify them, both are included. Revoke all buy orders and revoke all sell orders and make ask | [optional] + **side** | **String**| 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] + **excludeReduceOnly** | **Boolean**| Whether to exclude reduce-only orders | [optional] [default to false] + **text** | **String**| Remark for order cancellation | [optional] ### Return type @@ -2212,13 +2293,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | All orders matched cancelled | - | +**200** | Batch cancellation successful | - | # **getOrdersWithTimeRange** > List<FuturesOrder> getOrdersWithTimeRange(settle).contract(contract).from(from).to(to).limit(limit).offset(offset).execute(); -List Futures Orders By Time Range +Query futures order list by time range ### Example @@ -2243,9 +2324,9 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified - Long from = 1547706332L; // Long | Start timestamp - Long to = 1547706332L; // Long | End timestamp - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Long from = 1547706332L; // Long | 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) + Long to = 1547706332L; // Long | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 try { List result = apiInstance.getOrdersWithTimeRange(settle) @@ -2275,9 +2356,9 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] **contract** | **String**| Futures contract, return related data only if specified | [optional] - **from** | **Long**| Start timestamp | [optional] - **to** | **Long**| End timestamp | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **from** | **Long**| 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** | **Long**| 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** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] ### Return type @@ -2296,13 +2377,13 @@ 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
| # **createBatchFuturesOrder** > List<BatchFuturesOrder> createBatchFuturesOrder(settle, futuresOrder, xGateExptime) -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 @@ -2370,13 +2451,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Request is completed | - | +**200** | Request execution completed | - | # **getFuturesOrder** > FuturesOrder getFuturesOrder(settle, orderId) -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. @@ -2402,7 +2483,7 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency - String orderId = "12345"; // String | Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. + String orderId = "12345"; // String | 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 { FuturesOrder result = apiInstance.getFuturesOrder(settle, orderId); System.out.println(result); @@ -2424,7 +2505,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] - **orderId** | **String**| Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. | + **orderId** | **String**| 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 @@ -2448,7 +2529,7 @@ Name | Type | Description | Notes # **amendFuturesOrder** > FuturesOrder amendFuturesOrder(settle, orderId, futuresOrderAmendment, xGateExptime) -Amend an order +Amend single order ### Example @@ -2472,7 +2553,7 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency - String orderId = "12345"; // String | Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. + String orderId = "12345"; // String | 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. FuturesOrderAmendment futuresOrderAmendment = new FuturesOrderAmendment(); // FuturesOrderAmendment | String xGateExptime = "1689560679123"; // String | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected try { @@ -2496,7 +2577,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] - **orderId** | **String**| Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. | + **orderId** | **String**| 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. | **futuresOrderAmendment** | [**FuturesOrderAmendment**](FuturesOrderAmendment.md)| | **xGateExptime** | **String**| Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected | [optional] @@ -2522,7 +2603,7 @@ Name | Type | Description | Notes # **cancelFuturesOrder** > FuturesOrder cancelFuturesOrder(settle, orderId, xGateExptime) -Cancel a single order +Cancel single order ### Example @@ -2546,7 +2627,7 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency - String orderId = "12345"; // String | Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. + String orderId = "12345"; // String | 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. String xGateExptime = "1689560679123"; // String | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected try { FuturesOrder result = apiInstance.cancelFuturesOrder(settle, orderId, xGateExptime); @@ -2569,7 +2650,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] - **orderId** | **String**| Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. | + **orderId** | **String**| 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. | **xGateExptime** | **String**| 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 @@ -2594,7 +2675,7 @@ Name | Type | Description | Notes # **getMyTrades** > List<MyFuturesTrade> getMyTrades(settle).contract(contract).order(order).limit(limit).offset(offset).lastId(lastId).execute(); -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`. @@ -2622,7 +2703,7 @@ public class Example { String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified Long order = 12345L; // Long | Futures order ID, return related data only if specified - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 String lastId = "12345"; // String | 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'. try { @@ -2654,7 +2735,7 @@ Name | Type | Description | Notes **settle** | **String**| Settle currency | [enum: btc, usdt] **contract** | **String**| Futures contract, return related data only if specified | [optional] **order** | **Long**| Futures order ID, return related data only if specified | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] **lastId** | **String**| 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] @@ -2674,13 +2755,13 @@ 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
| # **getMyTradesWithTimeRange** > List<MyFuturesTradeTimeRange> getMyTradesWithTimeRange(settle).contract(contract).from(from).to(to).limit(limit).offset(offset).role(role).execute(); -List personal trading history by time range +Query personal trading records by time range ### Example @@ -2705,11 +2786,11 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified - Long from = 1547706332L; // Long | Start timestamp - Long to = 1547706332L; // Long | End timestamp - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Long from = 1547706332L; // Long | 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) + Long to = 1547706332L; // Long | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 - String role = "maker"; // String | Query role, maker or taker. + String role = "maker"; // String | Query role, maker or taker try { List result = apiInstance.getMyTradesWithTimeRange(settle) .contract(contract) @@ -2739,11 +2820,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] **contract** | **String**| Futures contract, return related data only if specified | [optional] - **from** | **Long**| Start timestamp | [optional] - **to** | **Long**| End timestamp | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **from** | **Long**| 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** | **Long**| 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** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] - **role** | **String**| Query role, maker or taker. | [optional] + **role** | **String**| Query role, maker or taker | [optional] ### Return type @@ -2761,13 +2842,13 @@ 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
| # **listPositionClose** > List<PositionClose> listPositionClose(settle).contract(contract).limit(limit).offset(offset).from(from).to(to).side(side).pnl(pnl).execute(); -List position close history +Query position close history ### Example @@ -2792,11 +2873,11 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 - Long from = 1547706332L; // Long | Start timestamp - Long to = 1547706332L; // Long | End timestamp - String side = "short"; // String | Query side. long or shot + Long from = 1547706332L; // Long | 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) + Long to = 1547706332L; // Long | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp + String side = "short"; // String | Query side. long or shot String pnl = "profit"; // String | Query profit or loss try { List result = apiInstance.listPositionClose(settle) @@ -2828,11 +2909,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] **contract** | **String**| Futures contract, return related data only if specified | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] - **from** | **Long**| Start timestamp | [optional] - **to** | **Long**| End timestamp | [optional] - **side** | **String**| Query side. long or shot | [optional] + **from** | **Long**| 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** | **Long**| 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** | **String**| Query side. long or shot | [optional] **pnl** | **String**| Query profit or loss | [optional] ### Return type @@ -2851,13 +2932,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listLiquidates** -> List<FuturesLiquidate> listLiquidates(settle).contract(contract).limit(limit).at(at).execute(); +> List<FuturesLiquidate> listLiquidates(settle).contract(contract).limit(limit).offset(offset).from(from).to(to).at(at).execute(); -List liquidation history +Query liquidation history ### Example @@ -2882,12 +2963,18 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list - Integer at = 0; // Integer | Specify a liquidation timestamp + Integer limit = 100; // Integer | Maximum number of records returned in a single list + Integer offset = 0; // Integer | List offset, starting from 0 + Long from = 1547706332L; // Long | 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) + Long to = 1547706332L; // Long | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp + Integer at = 0; // Integer | Specify liquidation timestamp try { List result = apiInstance.listLiquidates(settle) .contract(contract) .limit(limit) + .offset(offset) + .from(from) + .to(to) .at(at) .execute(); System.out.println(result); @@ -2910,8 +2997,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] **contract** | **String**| Futures contract, return related data only if specified | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] - **at** | **Integer**| Specify a liquidation timestamp | [optional] [default to 0] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] + **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **from** | **Long**| 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** | **Long**| 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** | **Integer**| Specify liquidation timestamp | [optional] [default to 0] ### Return type @@ -2929,13 +3019,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listAutoDeleverages** -> List<FuturesAutoDeleverage> listAutoDeleverages(settle).contract(contract).limit(limit).at(at).execute(); +> List<FuturesAutoDeleverage> listAutoDeleverages(settle).contract(contract).limit(limit).offset(offset).from(from).to(to).at(at).execute(); -List Auto-Deleveraging History +Query ADL auto-deleveraging order information ### Example @@ -2960,12 +3050,18 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list - Integer at = 0; // Integer | Specify an auto-deleveraging timestamp + Integer limit = 100; // Integer | Maximum number of records returned in a single list + Integer offset = 0; // Integer | List offset, starting from 0 + Long from = 1547706332L; // Long | 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) + Long to = 1547706332L; // Long | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp + Integer at = 0; // Integer | Specify auto-deleveraging timestamp try { List result = apiInstance.listAutoDeleverages(settle) .contract(contract) .limit(limit) + .offset(offset) + .from(from) + .to(to) .at(at) .execute(); System.out.println(result); @@ -2988,8 +3084,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] **contract** | **String**| Futures contract, return related data only if specified | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] - **at** | **Integer**| Specify an auto-deleveraging timestamp | [optional] [default to 0] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] + **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **from** | **Long**| 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** | **Long**| 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** | **Integer**| Specify auto-deleveraging timestamp | [optional] [default to 0] ### Return type @@ -3007,7 +3106,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **countdownCancelAllFutures** @@ -3015,7 +3114,7 @@ Name | Type | Description | Notes Countdown cancel orders -When the timeout set by the user is reached, if there is no cancel or set a new countdown, the related pending orders will be automatically cancelled. This endpoint can be called repeatedly to set a new countdown or cancel the countdown. For example, call this endpoint at 30s intervals, each countdown`timeout` is set to 30s. If this endpoint is not called again within 30 seconds, all pending orders on the specified `market` will be automatically cancelled, if no `market` is specified, all market pending orders will be cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the cacnel function will be cancelled. +Heartbeat detection for contract orders: When the user-set `timeout` time is reached, if neither the existing countdown is canceled nor a new countdown is set, the relevant contract orders will be automatically canceled. This API can be called repeatedly to or cancel the countdown. Usage example: Repeatedly call this API at 30-second intervals, setting the `timeout` to 30 (seconds) each time. If this API is not called again within 30 seconds, all open orders on your specified `market` will be automatically canceled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will terminate, and the automatic order cancellation function will be disabled. ### Example @@ -3079,13 +3178,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Set countdown successfully | - | +**200** | Countdown set successfully | - | # **getFuturesFee** > Map<String, FuturesFee> getFuturesFee(settle).contract(contract).execute(); -Query user trading fee rates +Query futures market trading fee rates ### Example @@ -3151,15 +3250,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **cancelBatchFutureOrders** > List<FutureCancelOrderResult> cancelBatchFutureOrders(settle, requestBody, xGateExptime) -Cancel a batch of orders with an ID list +Cancel batch orders by specified ID list -Multiple distinct order ID list can be specified。Each request can cancel a maximum of 20 records. +Multiple different order IDs can be specified, maximum 20 records per request ### Example @@ -3231,9 +3330,9 @@ Name | Type | Description | Notes # **amendBatchFutureOrders** > List<BatchFuturesOrder> amendBatchFutureOrders(settle, batchAmendOrderReq, xGateExptime) -Batch modify orders with specified IDs +Batch modify orders by specified IDs -You can specify multiple different order IDs. You can only modify up to 10 orders in one request. +Multiple different order IDs can be specified, maximum 10 orders per request ### Example @@ -3299,13 +3398,81 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Request is completed | - | +**200** | Request execution completed | - | + + +# **getFuturesRiskLimitTable** +> List<FuturesRiskLimitTier> getFuturesRiskLimitTable(settle, tableId) + +Query risk limit table by table_id + +Just pass table_id + +### Example + +```java +// Import classes: +import io.gate.gateapi.ApiClient; +import io.gate.gateapi.ApiException; +import io.gate.gateapi.Configuration; +import io.gate.gateapi.GateApiException; +import io.gate.gateapi.models.*; +import io.gate.gateapi.api.FuturesApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.gateio.ws/api/v4"); + + FuturesApi apiInstance = new FuturesApi(defaultClient); + String settle = "usdt"; // String | Settle currency + String tableId = "CYBER_USDT_20241122"; // String | Risk limit table ID + try { + List result = apiInstance.getFuturesRiskLimitTable(settle, tableId); + System.out.println(result); + } catch (GateApiException e) { + System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage())); + e.printStackTrace(); + } catch (ApiException e) { + System.err.println("Exception when calling FuturesApi#getFuturesRiskLimitTable"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **settle** | **String**| Settle currency | [enum: btc, usdt] + **tableId** | **String**| Risk limit table ID | + +### Return type + +[**List<FuturesRiskLimitTier>**](FuturesRiskLimitTier.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Query successful | - | # **listPriceTriggeredOrders** > List<FuturesPriceTriggeredOrder> listPriceTriggeredOrders(settle, status).contract(contract).limit(limit).offset(offset).execute(); -List All Price-triggered Orders +Query auto order list ### Example @@ -3329,9 +3496,9 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency - String status = "status_example"; // String | Only list the orders with this status + String status = "status_example"; // String | Query order list based on status String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 try { List result = apiInstance.listPriceTriggeredOrders(settle, status) @@ -3358,9 +3525,9 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] - **status** | **String**| Only list the orders with this status | [enum: open, finished] + **status** | **String**| Query order list based on status | [enum: open, finished] **contract** | **String**| Futures contract, return related data only if specified | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] ### Return type @@ -3379,13 +3546,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **createPriceTriggeredOrder** > TriggerOrderResponse createPriceTriggeredOrder(settle, futuresPriceTriggeredOrder) -Create a price-triggered order +Create price-triggered order ### Example @@ -3449,13 +3616,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Order created | - | +**201** | Order created successfully | - | # **cancelPriceTriggeredOrderList** > List<FuturesPriceTriggeredOrder> cancelPriceTriggeredOrderList(settle, contract) -Cancel All Price-triggered Orders +Cancel all auto orders ### Example @@ -3519,13 +3686,13 @@ 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 | - | # **getPriceTriggeredOrder** > FuturesPriceTriggeredOrder getPriceTriggeredOrder(settle, orderId) -Get a price-triggered order +Query single auto order details ### Example @@ -3549,7 +3716,7 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency - String orderId = "orderId_example"; // String | Retrieve the data of the order with the specified ID + String orderId = "orderId_example"; // String | ID returned when order is successfully created try { FuturesPriceTriggeredOrder result = apiInstance.getPriceTriggeredOrder(settle, orderId); System.out.println(result); @@ -3571,7 +3738,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] - **orderId** | **String**| Retrieve the data of the order with the specified ID | + **orderId** | **String**| ID returned when order is successfully created | ### Return type @@ -3589,13 +3756,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Auto order detail | - | +**200** | Auto order details | - | # **cancelPriceTriggeredOrder** > FuturesPriceTriggeredOrder cancelPriceTriggeredOrder(settle, orderId) -cancel a price-triggered order +Cancel single auto order ### Example @@ -3619,7 +3786,7 @@ public class Example { FuturesApi apiInstance = new FuturesApi(defaultClient); String settle = "usdt"; // String | Settle currency - String orderId = "orderId_example"; // String | Retrieve the data of the order with the specified ID + String orderId = "orderId_example"; // String | ID returned when order is successfully created try { FuturesPriceTriggeredOrder result = apiInstance.cancelPriceTriggeredOrder(settle, orderId); System.out.println(result); @@ -3641,7 +3808,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **settle** | **String**| Settle currency | [enum: btc, usdt] - **orderId** | **String**| Retrieve the data of the order with the specified ID | + **orderId** | **String**| ID returned when order is successfully created | ### Return type @@ -3659,5 +3826,5 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Auto order detail | - | +**200** | Auto order details | - | diff --git a/docs/FuturesAutoDeleverage.md b/docs/FuturesAutoDeleverage.md index a094eef..30e8f27 100644 --- a/docs/FuturesAutoDeleverage.md +++ b/docs/FuturesAutoDeleverage.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **orderId** | **Long** | Order ID. Order IDs before 2023-02-20 are null | [optional] [readonly] **contract** | **String** | Futures contract | [optional] [readonly] **leverage** | **String** | Position leverage | [optional] [readonly] -**crossLeverageLimit** | **String** | Cross margin leverage(valid only when `leverage` is 0) | [optional] [readonly] +**crossLeverageLimit** | **String** | Cross margin leverage (valid only when `leverage` is 0) | [optional] [readonly] **entryPrice** | **String** | Average entry price | [optional] [readonly] **fillPrice** | **String** | Average fill price | [optional] [readonly] **tradeSize** | **Long** | Trading size | [optional] [readonly] diff --git a/docs/FuturesBatchAmendOrderRequest.md b/docs/FuturesBatchAmendOrderRequest.md index 8f6d76d..246fed6 100644 --- a/docs/FuturesBatchAmendOrderRequest.md +++ b/docs/FuturesBatchAmendOrderRequest.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **orderId** | **Long** | Order id, order_id and text must contain at least one | [optional] **text** | **String** | User-defined order text, at least one of order_id and text must be passed | [optional] -**size** | **Long** | The new order size, including the executed order size. - If it is less than or equal to the executed quantity, the order will be cancelled. - The new order direction must be consistent with the original one. - The size of the closing order cannot be modified. - For orders that only reduce positions, if the size is increased, other orders that only reduce positions may be kicked out. - If the price is not modified, reducing the size will not affect the depth of the queue, and increasing the size will place it at the end of the current price. | [optional] -**price** | **String** | New order price. | [optional] -**amendText** | **String** | Custom info during amending order | [optional] +**size** | **Long** | 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** | **String** | New order price | [optional] +**amendText** | **String** | Custom info during order amendment | [optional] diff --git a/docs/FuturesFee.md b/docs/FuturesFee.md index a6756bf..c3b9cbd 100644 --- a/docs/FuturesFee.md +++ b/docs/FuturesFee.md @@ -1,7 +1,7 @@ # FuturesFee -The returned result is a map type, where the key represents the market and the value represents the taker and maker fee rates. +The returned result is a map type, where the key represents the market and taker and maker fee rates ## Properties diff --git a/docs/FuturesInitialOrder.md b/docs/FuturesInitialOrder.md index bf2dda0..3c1f79d 100644 --- a/docs/FuturesInitialOrder.md +++ b/docs/FuturesInitialOrder.md @@ -9,10 +9,10 @@ Name | Type | Description | Notes **size** | **Long** | 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** | **String** | Order price. Set to 0 to use market price | **close** | **Boolean** | 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] -**tif** | [**TifEnum**](#TifEnum) | Time in force strategy, default is gtc, market order currently only supports ioc mode Market order currently only supports ioc mode - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled | [optional] -**text** | **String** | The source of the order, including: - web: web - api: api - app: app | [optional] +**tif** | [**TifEnum**](#TifEnum) | Time in force strategy, default is gtc, market orders currently only support ioc mode - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled | [optional] +**text** | **String** | The source of the order, including: - web: Web - api: API call - app: Mobile app | [optional] **reduceOnly** | **Boolean** | 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] -**autoSize** | **String** | 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] +**autoSize** | **String** | 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] **isReduceOnly** | **Boolean** | Is the order reduce-only | [optional] [readonly] **isClose** | **Boolean** | Is the order to close position | [optional] [readonly] diff --git a/docs/FuturesLimitRiskTiers.md b/docs/FuturesLimitRiskTiers.md index 86dd259..9b69262 100644 --- a/docs/FuturesLimitRiskTiers.md +++ b/docs/FuturesLimitRiskTiers.md @@ -1,7 +1,7 @@ # FuturesLimitRiskTiers -Retrieve risk limit configurations for different tiers under a specified contract. +Retrieve risk limit configurations for different tiers under a specified contract ## Properties @@ -12,5 +12,6 @@ Name | Type | Description | Notes **initialRate** | **String** | Initial margin rate | [optional] **maintenanceRate** | **String** | Maintenance margin rate | [optional] **leverageMax** | **String** | Maximum leverage | [optional] -**contract** | **String** | Markets, visible only during market pagination requests | [optional] +**contract** | **String** | Market, only visible when market pagination is requested | [optional] +**deduction** | **String** | Maintenance margin quick calculation deduction amount | [optional] diff --git a/docs/FuturesLiquidate.md b/docs/FuturesLiquidate.md index 4f6d8f0..82f4b49 100644 --- a/docs/FuturesLiquidate.md +++ b/docs/FuturesLiquidate.md @@ -7,13 +7,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **time** | **Long** | Liquidation time | [optional] [readonly] **contract** | **String** | Futures contract | [optional] [readonly] -**leverage** | **String** | Position leverage. Not returned in public endpoints. | [optional] [readonly] +**leverage** | **String** | Position leverage. Not returned in public endpoints | [optional] [readonly] **size** | **Long** | Position size | [optional] [readonly] -**margin** | **String** | Position margin. Not returned in public endpoints. | [optional] [readonly] -**entryPrice** | **String** | Average entry price. Not returned in public endpoints. | [optional] [readonly] -**liqPrice** | **String** | Liquidation price. Not returned in public endpoints. | [optional] [readonly] -**markPrice** | **String** | Mark price. Not returned in public endpoints. | [optional] [readonly] -**orderId** | **Long** | Liquidation order ID. Not returned in public endpoints. | [optional] [readonly] +**margin** | **String** | Position margin. Not returned in public endpoints | [optional] [readonly] +**entryPrice** | **String** | Average entry price. Not returned in public endpoints | [optional] [readonly] +**liqPrice** | **String** | Liquidation price. Not returned in public endpoints | [optional] [readonly] +**markPrice** | **String** | Mark price. Not returned in public endpoints | [optional] [readonly] +**orderId** | **Long** | Liquidation order ID. Not returned in public endpoints | [optional] [readonly] **orderPrice** | **String** | Liquidation order price | [optional] [readonly] **fillPrice** | **String** | Liquidation order average taker price | [optional] [readonly] **left** | **Long** | Liquidation order maker size | [optional] [readonly] diff --git a/docs/FuturesOrder.md b/docs/FuturesOrder.md index 887fe33..7c451b2 100644 --- a/docs/FuturesOrder.md +++ b/docs/FuturesOrder.md @@ -10,30 +10,32 @@ Name | Type | Description | Notes **id** | **Long** | Futures order ID | [optional] [readonly] **user** | **Integer** | User ID | [optional] [readonly] **createTime** | **Double** | Creation time of order | [optional] [readonly] +**updateTime** | **Double** | OrderUpdateTime | [optional] [readonly] **finishTime** | **Double** | Order finished time. Not returned if order is open | [optional] [readonly] -**finishAs** | [**FinishAsEnum**](#FinishAsEnum) | How the order was finished. - filled: all filled - cancelled: manually cancelled - liquidated: cancelled because of liquidation - ioc: time in force is `IOC`, finish immediately - auto_deleveraged: finished by ADL - reduce_only: cancelled because of increasing position while `reduce-only` set- position_closed: cancelled because of position close - position_closed: canceled because the position was closed - reduce_out: only reduce positions by excluding hard-to-fill orders - stp: cancelled because self trade prevention | [optional] [readonly] -**status** | [**StatusEnum**](#StatusEnum) | Order status - `open`: waiting to be traded - `finished`: finished | [optional] [readonly] +**finishAs** | [**FinishAsEnum**](#FinishAsEnum) | 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** | [**StatusEnum**](#StatusEnum) | Order status - `open`: Pending - `finished`: Completed | [optional] [readonly] **contract** | **String** | Futures contract | -**size** | **Long** | Order size. Specify positive number to make a bid, and negative number to ask | -**iceberg** | **Long** | 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** | **String** | Order price. 0 for market order with `tif` set as `ioc` | [optional] +**size** | **Long** | Required. Trading quantity. Positive for buy, negative for sell. Set to 0 for close position orders. | +**iceberg** | **Long** | Display size for iceberg orders. 0 for non-iceberg orders. Note that hidden portions are charged taker fees. | [optional] +**price** | **String** | Order price. Price of 0 with `tif` set to `ioc` represents a market order. | [optional] **close** | **Boolean** | Set as `true` to close the position, with `size` set to 0 | [optional] **isClose** | **Boolean** | Is the order to close position | [optional] [readonly] **reduceOnly** | **Boolean** | Set as `true` to be reduce-only order | [optional] **isReduceOnly** | **Boolean** | Is the order reduce-only | [optional] [readonly] **isLiq** | **Boolean** | Is the order for liquidation | [optional] [readonly] **tif** | [**TifEnum**](#TifEnum) | 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] -**left** | **Long** | Size left to be traded | [optional] [readonly] -**fillPrice** | **String** | Fill price of the order | [optional] [readonly] -**text** | **String** | 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-xxx: a. Liquidation under the classic account’s 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-xxx: 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] +**left** | **Long** | Unfilled quantity | [optional] [readonly] +**fillPrice** | **String** | Fill price | [optional] [readonly] +**text** | **String** | 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** | **String** | Taker fee | [optional] [readonly] **mkfr** | **String** | Maker fee | [optional] [readonly] -**refu** | **Integer** | Reference user ID | [optional] [readonly] +**refu** | **Integer** | Referrer user ID | [optional] [readonly] **autoSize** | [**AutoSizeEnum**](#AutoSizeEnum) | 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] **stpId** | **Integer** | 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] -**stpAct** | [**StpActEnum**](#StpActEnum) | Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled | [optional] +**stpAct** | [**StpActEnum**](#StpActEnum) | 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] **amendText** | **String** | The custom data that the user remarked when amending the order | [optional] [readonly] -**bizInfo** | **String** | Additional information | [optional] [readonly] +**limitVip** | **Long** | 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** | **Long** | Position ID | [optional] ## Enum: FinishAsEnum diff --git a/docs/FuturesOrderAmendment.md b/docs/FuturesOrderAmendment.md index 4c499dc..8fb2998 100644 --- a/docs/FuturesOrderAmendment.md +++ b/docs/FuturesOrderAmendment.md @@ -6,8 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **size** | **Long** | 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** | **String** | New order price. | [optional] -**amendText** | **String** | Custom info during amending order | [optional] -**bizInfo** | **String** | Users can annotate this modification with information. | [optional] -**bbo** | **String** | Users are able to modify the offer price manually. | [optional] +**price** | **String** | New order price | [optional] +**amendText** | **String** | Custom info during order amendment | [optional] +**text** | **String** | Internal users can modify information in the text field. | [optional] diff --git a/docs/FuturesOrderBook.md b/docs/FuturesOrderBook.md index 448950b..b208487 100644 --- a/docs/FuturesOrderBook.md +++ b/docs/FuturesOrderBook.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **id** | **Long** | Order Book ID. Increases by 1 on every order book change. Set `with_id=true` to include this field in response | [optional] **current** | **Double** | Response data generation timestamp | [optional] **update** | **Double** | Order book changed timestamp | [optional] -**asks** | [**List<FuturesOrderBookItem>**](FuturesOrderBookItem.md) | Asks order depth | -**bids** | [**List<FuturesOrderBookItem>**](FuturesOrderBookItem.md) | Bids order depth | +**asks** | [**List<FuturesOrderBookItem>**](FuturesOrderBookItem.md) | Ask Depth | +**bids** | [**List<FuturesOrderBookItem>**](FuturesOrderBookItem.md) | Bid Depth | diff --git a/docs/FuturesPositionCrossMode.md b/docs/FuturesPositionCrossMode.md new file mode 100644 index 0000000..3c18231 --- /dev/null +++ b/docs/FuturesPositionCrossMode.md @@ -0,0 +1,10 @@ + +# FuturesPositionCrossMode + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mode** | **String** | Cross margin or isolated margin mode. ISOLATED - isolated margin mode, CROSS - cross margin mode | +**contract** | **String** | Futures market | + diff --git a/docs/FuturesPremiumIndex.md b/docs/FuturesPremiumIndex.md index 759ceb9..3ba1a47 100644 --- a/docs/FuturesPremiumIndex.md +++ b/docs/FuturesPremiumIndex.md @@ -10,6 +10,6 @@ Name | Type | Description | Notes **t** | **Double** | Unix timestamp in seconds | [optional] **c** | **String** | Close price | [optional] **h** | **String** | Highest price | [optional] -**l** | **String** | Lowest price` | [optional] +**l** | **String** | Lowest price | [optional] **o** | **String** | Open price | [optional] diff --git a/docs/FuturesPriceTrigger.md b/docs/FuturesPriceTrigger.md index 0b7d8cb..8471bf9 100644 --- a/docs/FuturesPriceTrigger.md +++ b/docs/FuturesPriceTrigger.md @@ -5,11 +5,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**strategyType** | [**StrategyTypeEnum**](#StrategyTypeEnum) | 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] -**priceType** | [**PriceTypeEnum**](#PriceTypeEnum) | Price type. 0 - latest deal price, 1 - mark price, 2 - index price | [optional] -**price** | **String** | Value of price on price triggered, or price gap on price gap triggered | [optional] -**rule** | [**RuleEnum**](#RuleEnum) | 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 - 2: Indicates that the price calculated based on `strategy_type` and `price_type` is less than or equal to `Trigger.Price` Trigger, and Trigger.Price must < last_price | [optional] -**expiration** | **Integer** | How long (in seconds) to wait for the condition to be triggered before cancelling the order. | [optional] +**strategyType** | [**StrategyTypeEnum**](#StrategyTypeEnum) | 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] +**priceType** | [**PriceTypeEnum**](#PriceTypeEnum) | Reference price type. 0 - Latest trade price, 1 - Mark price, 2 - Index price | [optional] +**price** | **String** | Price value for price trigger, or spread value for spread trigger | [optional] +**rule** | [**RuleEnum**](#RuleEnum) | 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** | **Integer** | Maximum wait time for trigger condition (in seconds). Order will be cancelled if timeout | [optional] ## Enum: StrategyTypeEnum diff --git a/docs/FuturesPriceTriggeredOrder.md b/docs/FuturesPriceTriggeredOrder.md index 498d04d..10b3fa9 100644 --- a/docs/FuturesPriceTriggeredOrder.md +++ b/docs/FuturesPriceTriggeredOrder.md @@ -1,7 +1,7 @@ # FuturesPriceTriggeredOrder -Futures order details +Futures price-triggered order details ## Properties @@ -11,14 +11,14 @@ Name | Type | Description | Notes **trigger** | [**FuturesPriceTrigger**](FuturesPriceTrigger.md) | | **id** | **Long** | Auto order ID | [optional] [readonly] **user** | **Integer** | User ID | [optional] [readonly] -**createTime** | **Double** | Creation time | [optional] [readonly] -**finishTime** | **Double** | Finished time | [optional] [readonly] -**tradeId** | **Long** | ID of the newly created order on condition triggered | [optional] [readonly] -**status** | [**StatusEnum**](#StatusEnum) | Auto order status - `open`: order is active - `finished`: order is finished - `inactive`: order is not active, only for close-long-order or close-short-order - `invalid`: order is invalid, only for close-long-order or close-short-order | [optional] [readonly] -**finishAs** | [**FinishAsEnum**](#FinishAsEnum) | How order is finished | [optional] [readonly] -**reason** | **String** | Additional remarks on how the order was finished | [optional] [readonly] -**orderType** | **String** | Types of stop-profit and stop-loss, including: - `close-long-order`: Entrusting order stop profit and stop loss, flat long position - `close-short-order`: Entrusted order stop profit and stop 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] -**meOrderId** | **Long** | Corresponding order ID of order take-profit/stop-loss. | [optional] [readonly] +**createTime** | **Double** | Created time | [optional] [readonly] +**finishTime** | **Double** | End time | [optional] [readonly] +**tradeId** | **Long** | ID of the order created after trigger | [optional] [readonly] +**status** | [**StatusEnum**](#StatusEnum) | 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] +**finishAs** | [**FinishAsEnum**](#FinishAsEnum) | Finish status: cancelled - Cancelled; succeeded - Succeeded; failed - Failed; expired - Expired | [optional] [readonly] +**reason** | **String** | Additional description of how the order was completed | [optional] [readonly] +**orderType** | **String** | 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] +**meOrderId** | **Long** | Corresponding order ID for order take-profit/stop-loss orders | [optional] [readonly] ## Enum: StatusEnum diff --git a/docs/FuturesRiskLimitTier.md b/docs/FuturesRiskLimitTier.md new file mode 100644 index 0000000..cc06201 --- /dev/null +++ b/docs/FuturesRiskLimitTier.md @@ -0,0 +1,16 @@ + +# FuturesRiskLimitTier + +Information for each tier of the gradient risk limit table + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tier** | **Integer** | Tier | [optional] +**riskLimit** | **String** | Position risk limit | [optional] +**initialRate** | **String** | Initial margin rate | [optional] +**maintenanceRate** | **String** | Maintenance margin rate | [optional] +**leverageMax** | **String** | Maximum leverage | [optional] +**deduction** | **String** | Maintenance margin quick calculation deduction amount | [optional] + diff --git a/docs/FuturesTicker.md b/docs/FuturesTicker.md index b035bee..0a0bab6 100644 --- a/docs/FuturesTicker.md +++ b/docs/FuturesTicker.md @@ -7,16 +7,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **contract** | **String** | Futures contract | [optional] **last** | **String** | Last trading price | [optional] -**changePercentage** | **String** | Change percentage. | [optional] +**changePercentage** | **String** | Price change percentage. Negative values indicate price decrease, e.g. -7.45 | [optional] **totalSize** | **String** | Contract total size | [optional] -**low24h** | **String** | Lowest trading price in recent 24h | [optional] -**high24h** | **String** | Highest trading price in recent 24h | [optional] -**volume24h** | **String** | Trade size in recent 24h | [optional] -**volume24hBtc** | **String** | Trade volumes in recent 24h in BTC(deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) | [optional] -**volume24hUsd** | **String** | Trade volumes in recent 24h in USD(deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) | [optional] -**volume24hBase** | **String** | Trade volume in recent 24h, in base currency | [optional] -**volume24hQuote** | **String** | Trade volume in recent 24h, in quote currency | [optional] -**volume24hSettle** | **String** | Trade volume in recent 24h, in settle currency | [optional] +**low24h** | **String** | 24-hour lowest price | [optional] +**high24h** | **String** | 24-hour highest price | [optional] +**volume24h** | **String** | 24-hour trading volume | [optional] +**volume24hBtc** | **String** | 24-hour trading volume in BTC (deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) | [optional] +**volume24hUsd** | **String** | 24-hour trading volume in USD (deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) | [optional] +**volume24hBase** | **String** | 24-hour trading volume in base currency | [optional] +**volume24hQuote** | **String** | 24-hour trading volume in quote currency | [optional] +**volume24hSettle** | **String** | 24-hour trading volume in settle currency | [optional] **markPrice** | **String** | Recent mark price | [optional] **fundingRate** | **String** | Funding rate | [optional] **fundingRateIndicative** | **String** | Indicative Funding rate in next period. (deprecated. use `funding_rate`) | [optional] @@ -26,4 +26,9 @@ Name | Type | Description | Notes **lowestSize** | **String** | The latest seller's lowest price order quantity | [optional] **highestBid** | **String** | Recent highest bid | [optional] **highestSize** | **String** | The latest buyer's highest price order volume | [optional] +**changeUtc0** | **String** | Percentage change at utc0. Negative values indicate a drop, e.g., -7.45% | [optional] +**changeUtc8** | **String** | Percentage change at utc8. Negative values indicate a drop, e.g., -7.45% | [optional] +**changePrice** | **String** | 24h change amount. Negative values indicate a drop, e.g., -7.45 | [optional] +**changeUtc0Price** | **String** | Change amount at utc0. Negative values indicate a drop, e.g., -7.45 | [optional] +**changeUtc8Price** | **String** | Change amount at utc8. Negative values indicate a drop, e.g., -7.45 | [optional] diff --git a/docs/FuturesTrade.md b/docs/FuturesTrade.md index 94b908d..01c91f6 100644 --- a/docs/FuturesTrade.md +++ b/docs/FuturesTrade.md @@ -5,11 +5,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Long** | Trade ID | [optional] -**createTime** | **Double** | Trading time | [optional] -**createTimeMs** | **Double** | Trading time, with milliseconds set to 3 decimal places. | [optional] +**id** | **Long** | Fill ID | [optional] +**createTime** | **Double** | Fill Time | [optional] +**createTimeMs** | **Double** | Trade time, with millisecond precision to 3 decimal places | [optional] **contract** | **String** | Futures contract | [optional] **size** | **Long** | Trading size | [optional] -**price** | **String** | Trading price (quote currency) | [optional] -**isInternal** | **Boolean** | Whether internal trade. Internal trade refers to the takeover of liquidation orders by the insurance fund and ADL users. Since it is not a normal matching on the market depth, the transaction price may deviate, and it will not be recorded in the K-line. If it is not an internal trade, this field will not be returned. | [optional] +**price** | **String** | Trade price (quote currency) | [optional] +**isInternal** | **Boolean** | 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] diff --git a/docs/InlineObject.md b/docs/InlineObject.md index 1779c28..3965959 100644 --- a/docs/InlineObject.md +++ b/docs/InlineObject.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**mode** | **String** | Full position-by-position model, ISOLATED-by-position, CROSS-full position | -**contract** | **String** | Contract Market | +**mode** | **String** | Cross margin or isolated margin mode. ISOLATED - isolated margin mode, CROSS - cross margin mode | +**contract** | **String** | Futures market | diff --git a/docs/LedgerRecord.md b/docs/LedgerRecord.md index 13a44df..9625498 100644 --- a/docs/LedgerRecord.md +++ b/docs/LedgerRecord.md @@ -7,14 +7,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | Record ID | [optional] [readonly] **txid** | **String** | Hash record of the withdrawal | [optional] [readonly] -**withdrawOrderId** | **String** | User-defined order number when withdrawing. Default is empty. When not empty, the specified user-defined order number record will be queried | [optional] +**withdrawOrderId** | **String** | User-defined order number for withdrawal. Default is empty. When not empty, the specified user-defined order number record will be queried | [optional] **timestamp** | **String** | Operation time | [optional] [readonly] -**amount** | **String** | Currency amount | +**amount** | **String** | Token amount | **currency** | **String** | Currency name | **address** | **String** | Withdrawal address. Required for withdrawals | [optional] **memo** | **String** | Additional remarks with regards to the withdrawal | [optional] -**withdrawId** | **String** | 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] -**assetClass** | **String** | 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** | **String** | 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] +**withdrawId** | **String** | 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] +**assetClass** | **String** | 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** | **String** | 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** | **String** | Name of the chain used in withdrawals | diff --git a/docs/LiquidateOrder.md b/docs/LiquidateOrder.md index 2f7b46a..cd32ef4 100644 --- a/docs/LiquidateOrder.md +++ b/docs/LiquidateOrder.md @@ -1,15 +1,15 @@ # LiquidateOrder -Liquidate Order detail +Spot liquidation order details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**text** | **String** | User defined information. If not empty, must follow the rules below: 1. prefixed with `t-` 2. no longer than 28 bytes without `t-` prefix 3. can only include 0-9, A-Z, a-z, underscore(_), hyphen(-) or dot(.) | [optional] +**text** | **String** | 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] **currencyPair** | **String** | Currency pair | **amount** | **String** | Trade amount | **price** | **String** | Order price | -**actionMode** | **String** | 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] +**actionMode** | **String** | 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] diff --git a/docs/MarginAccount.md b/docs/MarginAccount.md index b55facc..ce57b53 100644 --- a/docs/MarginAccount.md +++ b/docs/MarginAccount.md @@ -1,18 +1,18 @@ # 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 ------------ | ------------- | ------------- | ------------- **currencyPair** | **String** | Currency pair | [optional] -**accountType** | **String** | Account type, risk - risk rate account, mmr - maintenance margin rate account, inactive - market not activated | [optional] -**leverage** | **String** | User current market leverage multiple | [optional] -**locked** | **Boolean** | Whether account is locked | [optional] -**risk** | **String** | Leveraged Account Current Risk Rate (Returned when the Account is a Risk Rate Account) | [optional] -**mmr** | **String** | Leveraged Account Current Maintenance Margin Rate (returned when the Account is a Maintenance Margin Rate Account) | [optional] +**accountType** | **String** | Account type: risk - risk rate account, mmr - maintenance margin rate account, inactive - market not activated | [optional] +**leverage** | **String** | User's current market leverage multiplier | [optional] +**locked** | **Boolean** | Whether the account is locked | [optional] +**risk** | **String** | Current risk rate of the margin account (returned when the account is a risk rate account) | [optional] +**mmr** | **String** | 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 57291ac..094301c 100644 --- a/docs/MarginAccountBook.md +++ b/docs/MarginAccountBook.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | Balance change record ID | [optional] -**time** | **String** | Balance changed timestamp | [optional] +**time** | **String** | Account change timestamp | [optional] **timeMs** | **Long** | The timestamp of the change (in milliseconds) | [optional] **currency** | **String** | Currency changed | [optional] -**currencyPair** | **String** | Account currency pair | [optional] +**currencyPair** | **String** | Account trading pair | [optional] **change** | **String** | Amount changed. Positive value means transferring in, while negative out | [optional] **balance** | **String** | Balance after change | [optional] -**type** | **String** | Account book type. Please refer to [account book type](#accountbook-type) for more detail | [optional] +**type** | **String** | Account book type. Please refer to [account book type](#accountbook-type) for more detail | [optional] diff --git a/docs/MarginAccountCurrency.md b/docs/MarginAccountCurrency.md index 266de33..427e461 100644 --- a/docs/MarginAccountCurrency.md +++ b/docs/MarginAccountCurrency.md @@ -1,15 +1,15 @@ # MarginAccountCurrency -Account currency details +Currency account information ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | Currency name | [optional] -**available** | **String** | Amount suitable for margin trading. | [optional] -**locked** | **String** | Locked amount, used in margin trading | [optional] -**borrowed** | **String** | Borrowed amount | [optional] -**interest** | **String** | Unpaid interests | [optional] +**available** | **String** | Amount available for margin trading, available = margin + borrowed | [optional] +**locked** | **String** | Frozen funds, such as amounts already placed in margin market for order trading | [optional] +**borrowed** | **String** | Borrowed funds | [optional] +**interest** | **String** | Unpaid interest | [optional] diff --git a/docs/MarginApi.md b/docs/MarginApi.md index c2050bc..2dc7496 100644 --- a/docs/MarginApi.md +++ b/docs/MarginApi.md @@ -5,28 +5,17 @@ All URIs are relative to *https://api.gateio.ws/api/v4* Method | HTTP request | Description ------------- | ------------- | ------------- [**listMarginAccounts**](MarginApi.md#listMarginAccounts) | **GET** /margin/accounts | Margin account list -[**listMarginAccountBook**](MarginApi.md#listMarginAccountBook) | **GET** /margin/account_book | List margin account balance change history +[**listMarginAccountBook**](MarginApi.md#listMarginAccountBook) | **GET** /margin/account_book | Query margin account balance change history [**listFundingAccounts**](MarginApi.md#listFundingAccounts) | **GET** /margin/funding_accounts | Funding account list -[**getAutoRepayStatus**](MarginApi.md#getAutoRepayStatus) | **GET** /margin/auto_repay | Retrieve user auto repayment setting -[**setAutoRepay**](MarginApi.md#setAutoRepay) | **POST** /margin/auto_repay | Update user's auto repayment setting -[**getMarginTransferable**](MarginApi.md#getMarginTransferable) | **GET** /margin/transferable | Get the max transferable amount for a specific margin currency -[**listCrossMarginCurrencies**](MarginApi.md#listCrossMarginCurrencies) | **GET** /margin/cross/currencies | Currencies supported by cross margin.(deprecated) -[**getCrossMarginCurrency**](MarginApi.md#getCrossMarginCurrency) | **GET** /margin/cross/currencies/{currency} | Retrieve detail of one single currency supported by cross margin. (deprecated) -[**getCrossMarginAccount**](MarginApi.md#getCrossMarginAccount) | **GET** /margin/cross/accounts | Retrieve cross margin account. (deprecated) -[**listCrossMarginAccountBook**](MarginApi.md#listCrossMarginAccountBook) | **GET** /margin/cross/account_book | Retrieve cross margin account change history. (deprecated) -[**listCrossMarginLoans**](MarginApi.md#listCrossMarginLoans) | **GET** /margin/cross/loans | List cross margin borrow history. (deprecated) -[**createCrossMarginLoan**](MarginApi.md#createCrossMarginLoan) | **POST** /margin/cross/loans | Create a cross margin borrow loan. (deprecated) -[**getCrossMarginLoan**](MarginApi.md#getCrossMarginLoan) | **GET** /margin/cross/loans/{loan_id} | Retrieve single borrow loan detail. (deprecated) +[**getAutoRepayStatus**](MarginApi.md#getAutoRepayStatus) | **GET** /margin/auto_repay | Query user auto repayment settings +[**setAutoRepay**](MarginApi.md#setAutoRepay) | **POST** /margin/auto_repay | Update user auto repayment settings +[**getMarginTransferable**](MarginApi.md#getMarginTransferable) | **GET** /margin/transferable | Get maximum transferable amount for isolated margin +[**getUserMarginTier**](MarginApi.md#getUserMarginTier) | **GET** /margin/user/loan_margin_tiers | Query user's own leverage lending tiers in current market +[**getMarketMarginTier**](MarginApi.md#getMarketMarginTier) | **GET** /margin/loan_margin_tiers | Query current market leverage lending tiers +[**setUserMarketLeverage**](MarginApi.md#setUserMarketLeverage) | **POST** /margin/leverage/user_market_setting | Set user market leverage multiplier +[**listMarginUserAccount**](MarginApi.md#listMarginUserAccount) | **GET** /margin/user/account | Query user's isolated margin account list +[**listCrossMarginLoans**](MarginApi.md#listCrossMarginLoans) | **GET** /margin/cross/loans | Query cross margin borrow history (deprecated) [**listCrossMarginRepayments**](MarginApi.md#listCrossMarginRepayments) | **GET** /margin/cross/repayments | Retrieve cross margin repayments. (deprecated) -[**repayCrossMarginLoan**](MarginApi.md#repayCrossMarginLoan) | **POST** /margin/cross/repayments | Cross margin repayments. (deprecated) -[**getCrossMarginInterestRecords**](MarginApi.md#getCrossMarginInterestRecords) | **GET** /margin/cross/interest_records | Interest records for the cross margin account. (deprecated) -[**getCrossMarginTransferable**](MarginApi.md#getCrossMarginTransferable) | **GET** /margin/cross/transferable | Get the max transferable amount for a specific cross margin currency. (deprecated) -[**getCrossMarginEstimateRate**](MarginApi.md#getCrossMarginEstimateRate) | **GET** /margin/cross/estimate_rate | Estimated interest rates. (deprecated) -[**getCrossMarginBorrowable**](MarginApi.md#getCrossMarginBorrowable) | **GET** /margin/cross/borrowable | Get the max borrowable amount for a specific cross margin currency. (deprecated) -[**getUserMarginTier**](MarginApi.md#getUserMarginTier) | **GET** /margin/user/loan_margin_tiers | Check the user's own leverage lending gradient in the current market -[**getMarketMarginTier**](MarginApi.md#getMarketMarginTier) | **GET** /margin/loan_margin_tiers | Query the current market leverage lending gradient -[**setUserMarketLeverage**](MarginApi.md#setUserMarketLeverage) | **POST** /margin/leverage/user_market_setting | Set the user market leverage multiple -[**listMarginUserAccount**](MarginApi.md#listMarginUserAccount) | **GET** /margin/user/account | Query the user's leverage account list @@ -97,15 +86,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listMarginAccountBook** > List<MarginAccountBook> listMarginAccountBook().currency(currency).currencyPair(currencyPair).type(type).from(from).to(to).page(page).limit(limit).execute(); -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 @@ -128,13 +117,13 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginApi apiInstance = new MarginApi(defaultClient); - String currency = "currency_example"; // String | List records related to specified currency only. If specified, `currency_pair` is also required. - String currencyPair = "currencyPair_example"; // String | List records related to specified currency pair. Used in combination with `currency`. Ignored if `currency` is not provided - String type = "lend"; // String | Only retrieve changes of the specified type. All types will be returned if not specified. - Long from = 1627706330L; // Long | Start timestamp of the query - Long to = 1635329650L; // Long | Time range ending, default to current time + String currency = "currency_example"; // String | Query history for specified currency. If `currency` is specified, `currency_pair` must also be specified. + String currencyPair = "currencyPair_example"; // String | Specify margin account currency pair. Used in combination with `currency`. Ignored if `currency` is not specified + String type = "lend"; // String | Query by specified account change type. If not specified, all change types will be included. + Long from = 1627706330L; // Long | Start timestamp for the query + Long to = 1635329650L; // Long | End timestamp for the query, defaults to current time if not specified Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list try { List result = apiInstance.listMarginAccountBook() .currency(currency) @@ -163,13 +152,13 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| List records related to specified currency only. If specified, `currency_pair` is also required. | [optional] - **currencyPair** | **String**| List records related to specified currency pair. Used in combination with `currency`. Ignored if `currency` is not provided | [optional] - **type** | **String**| Only retrieve changes of the specified type. All types will be returned if not specified. | [optional] - **from** | **Long**| Start timestamp of the query | [optional] - **to** | **Long**| Time range ending, default to current time | [optional] + **currency** | **String**| Query history for specified currency. If `currency` is specified, `currency_pair` must also be specified. | [optional] + **currencyPair** | **String**| Specify margin account currency pair. Used in combination with `currency`. Ignored if `currency` is not specified | [optional] + **type** | **String**| Query by specified account change type. If not specified, all change types will be included. | [optional] + **from** | **Long**| Start timestamp for the query | [optional] + **to** | **Long**| End timestamp for the query, defaults to current time if not specified | [optional] **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] ### Return type @@ -187,7 +176,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listFundingAccounts** @@ -216,7 +205,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginApi apiInstance = new MarginApi(defaultClient); - String currency = "BTC"; // String | Retrieve data of the specified currency + String currency = "BTC"; // String | Query by specified currency name try { List result = apiInstance.listFundingAccounts() .currency(currency) @@ -239,7 +228,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | [optional] + **currency** | **String**| Query by specified currency name | [optional] ### Return type @@ -257,13 +246,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **getAutoRepayStatus** > AutoRepaySetting getAutoRepayStatus() -Retrieve user auto repayment setting +Query user auto repayment settings ### Example @@ -321,13 +310,13 @@ 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 | - | # **setAutoRepay** > AutoRepaySetting setAutoRepay(status) -Update user's auto repayment setting +Update user auto repayment settings ### Example @@ -350,7 +339,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginApi apiInstance = new MarginApi(defaultClient); - String status = "on"; // String | New auto repayment status. `on` - enabled, `off` - disabled + String status = "on"; // String | Whether to enable auto repayment: `on` - enabled, `off` - disabled try { AutoRepaySetting result = apiInstance.setAutoRepay(status); System.out.println(result); @@ -371,7 +360,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **status** | **String**| New auto repayment status. `on` - enabled, `off` - disabled | + **status** | **String**| Whether to enable auto repayment: `on` - enabled, `off` - disabled | ### Return type @@ -389,13 +378,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Current auto repayment setting | - | +**200** | User's current auto repayment settings | - | # **getMarginTransferable** > MarginTransferable getMarginTransferable(currency).currencyPair(currencyPair).execute(); -Get the max transferable amount for a specific margin currency +Get maximum transferable amount for isolated margin ### Example @@ -418,7 +407,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginApi apiInstance = new MarginApi(defaultClient); - String currency = "BTC"; // String | Retrieve data of the specified currency + String currency = "BTC"; // String | Query by specified currency name String currencyPair = "BTC_USDT"; // String | Currency pair try { MarginTransferable result = apiInstance.getMarginTransferable(currency) @@ -442,7 +431,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | + **currency** | **String**| Query by specified currency name | **currencyPair** | **String**| Currency pair | [optional] ### Return type @@ -461,13 +450,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | - -# **listCrossMarginCurrencies** -> List<CrossMarginCurrency> listCrossMarginCurrencies() + +# **getUserMarginTier** +> List<MarginLeverageTier> getUserMarginTier(currencyPair) -Currencies supported by cross margin.(deprecated) +Query user's own leverage lending tiers in current market ### Example @@ -477,6 +466,7 @@ import io.gate.gateapi.ApiClient; import io.gate.gateapi.ApiException; import io.gate.gateapi.Configuration; import io.gate.gateapi.GateApiException; +import io.gate.gateapi.auth.*; import io.gate.gateapi.models.*; import io.gate.gateapi.api.MarginApi; @@ -484,16 +474,20 @@ public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("https://api.gateio.ws/api/v4"); + + // Configure APIv4 authorization: apiv4 + defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginApi apiInstance = new MarginApi(defaultClient); + String currencyPair = "BTC_USDT"; // String | Currency pair try { - List result = apiInstance.listCrossMarginCurrencies(); + List result = apiInstance.getUserMarginTier(currencyPair); System.out.println(result); } catch (GateApiException e) { System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage())); e.printStackTrace(); } catch (ApiException e) { - System.err.println("Exception when calling MarginApi#listCrossMarginCurrencies"); + System.err.println("Exception when calling MarginApi#getUserMarginTier"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -503,15 +497,18 @@ public class Example { ``` ### Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **currencyPair** | **String**| Currency pair | ### Return type -[**List<CrossMarginCurrency>**](CrossMarginCurrency.md) +[**List<MarginLeverageTier>**](MarginLeverageTier.md) ### Authorization -No authorization required +[apiv4](../README.md#apiv4) ### HTTP request headers @@ -521,13 +518,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | Query successful | - | - -# **getCrossMarginCurrency** -> CrossMarginCurrency getCrossMarginCurrency(currency) + +# **getMarketMarginTier** +> List<MarginLeverageTier> getMarketMarginTier(currencyPair) -Retrieve detail of one single currency supported by cross margin. (deprecated) +Query current market leverage lending tiers ### Example @@ -546,15 +543,15 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); MarginApi apiInstance = new MarginApi(defaultClient); - String currency = "BTC"; // String | Currency name + String currencyPair = "BTC_USDT"; // String | Currency pair try { - CrossMarginCurrency result = apiInstance.getCrossMarginCurrency(currency); + List result = apiInstance.getMarketMarginTier(currencyPair); System.out.println(result); } catch (GateApiException e) { System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage())); e.printStackTrace(); } catch (ApiException e) { - System.err.println("Exception when calling MarginApi#getCrossMarginCurrency"); + System.err.println("Exception when calling MarginApi#getMarketMarginTier"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -567,11 +564,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Currency name | + **currencyPair** | **String**| Currency pair | ### Return type -[**CrossMarginCurrency**](CrossMarginCurrency.md) +[**List<MarginLeverageTier>**](MarginLeverageTier.md) ### Authorization @@ -585,13 +582,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | - -# **getCrossMarginAccount** -> CrossMarginAccount getCrossMarginAccount() + +# **setUserMarketLeverage** +> setUserMarketLeverage(marginMarketLeverage) -Retrieve cross margin account. (deprecated) +Set user market leverage multiplier ### Example @@ -614,14 +611,14 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginApi apiInstance = new MarginApi(defaultClient); + MarginMarketLeverage marginMarketLeverage = new MarginMarketLeverage(); // MarginMarketLeverage | try { - CrossMarginAccount result = apiInstance.getCrossMarginAccount(); - System.out.println(result); + apiInstance.setUserMarketLeverage(marginMarketLeverage); } catch (GateApiException e) { System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage())); e.printStackTrace(); } catch (ApiException e) { - System.err.println("Exception when calling MarginApi#getCrossMarginAccount"); + System.err.println("Exception when calling MarginApi#setUserMarketLeverage"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -631,11 +628,14 @@ public class Example { ``` ### Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **marginMarketLeverage** | [**MarginMarketLeverage**](MarginMarketLeverage.md)| | ### Return type -[**CrossMarginAccount**](CrossMarginAccount.md) +null (empty response body) ### Authorization @@ -643,21 +643,21 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json + - **Content-Type**: application/json + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**204** | Set successfully | - | - -# **listCrossMarginAccountBook** -> List<CrossMarginAccountBook> listCrossMarginAccountBook().currency(currency).from(from).to(to).page(page).limit(limit).type(type).execute(); + +# **listMarginUserAccount** +> List<MarginAccount> listMarginUserAccount().currencyPair(currencyPair).execute(); -Retrieve cross margin account change history. (deprecated) +Query user's isolated margin account list -The record query time range is not allowed to exceed 30 days. When using the limit&page paging function to retrieve data, the maximum number of pages is 100,000, that is, (limit page - 1) <= 100000. +Supports querying risk ratio isolated accounts and margin ratio isolated accounts ### Example @@ -680,27 +680,17 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginApi apiInstance = new MarginApi(defaultClient); - String currency = "currency_example"; // String | Filter by currency - Long from = 1627706330L; // Long | Start timestamp of the query - Long to = 1635329650L; // Long | Time range ending, default to current time - Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list - String type = "borrow"; // String | Only retrieve changes of the specified type. All types will be returned if not specified. + String currencyPair = "BTC_USDT"; // String | Currency pair try { - List result = apiInstance.listCrossMarginAccountBook() - .currency(currency) - .from(from) - .to(to) - .page(page) - .limit(limit) - .type(type) + List result = apiInstance.listMarginUserAccount() + .currencyPair(currencyPair) .execute(); System.out.println(result); } catch (GateApiException e) { System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage())); e.printStackTrace(); } catch (ApiException e) { - System.err.println("Exception when calling MarginApi#listCrossMarginAccountBook"); + System.err.println("Exception when calling MarginApi#listMarginUserAccount"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -713,16 +703,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Filter by currency | [optional] - **from** | **Long**| Start timestamp of the query | [optional] - **to** | **Long**| Time range ending, default to current time | [optional] - **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] - **type** | **String**| Only retrieve changes of the specified type. All types will be returned if not specified. | [optional] + **currencyPair** | **String**| Currency pair | [optional] ### Return type -[**List<CrossMarginAccountBook>**](CrossMarginAccountBook.md) +[**List<MarginAccount>**](MarginAccount.md) ### Authorization @@ -736,15 +721,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listCrossMarginLoans** > List<CrossMarginLoan> listCrossMarginLoans(status).currency(currency).limit(limit).offset(offset).reverse(reverse).execute(); -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 @@ -768,8 +753,8 @@ public class Example { MarginApi apiInstance = new MarginApi(defaultClient); Integer status = 56; // Integer | Filter by status. Supported values are 2 and 3. (deprecated.) - String currency = "currency_example"; // String | Filter by currency - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + String currency = "currency_example"; // String | Query by specified currency, includes all currencies if not specified + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 Boolean reverse = true; // Boolean | Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results try { @@ -798,8 +783,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | **Integer**| Filter by status. Supported values are 2 and 3. (deprecated.) | - **currency** | **String**| Filter by currency | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **currency** | **String**| Query by specified currency, includes all currencies if not specified | [optional] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] **reverse** | **Boolean**| Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results | [optional] [default to true] @@ -819,145 +804,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | - - -# **createCrossMarginLoan** -> CrossMarginLoan createCrossMarginLoan(crossMarginLoan) - -Create a cross margin borrow loan. (deprecated) - -Borrow amount cannot be less than currency minimum borrow amount - -### Example - -```java -// Import classes: -import io.gate.gateapi.ApiClient; -import io.gate.gateapi.ApiException; -import io.gate.gateapi.Configuration; -import io.gate.gateapi.GateApiException; -import io.gate.gateapi.auth.*; -import io.gate.gateapi.models.*; -import io.gate.gateapi.api.MarginApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("https://api.gateio.ws/api/v4"); - - // Configure APIv4 authorization: apiv4 - defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); - - MarginApi apiInstance = new MarginApi(defaultClient); - CrossMarginLoan crossMarginLoan = new CrossMarginLoan(); // CrossMarginLoan | - try { - CrossMarginLoan result = apiInstance.createCrossMarginLoan(crossMarginLoan); - System.out.println(result); - } catch (GateApiException e) { - System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage())); - e.printStackTrace(); - } catch (ApiException e) { - System.err.println("Exception when calling MarginApi#createCrossMarginLoan"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **crossMarginLoan** | [**CrossMarginLoan**](CrossMarginLoan.md)| | - -### Return type - -[**CrossMarginLoan**](CrossMarginLoan.md) - -### Authorization - -[apiv4](../README.md#apiv4) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successfully borrowed | - | - - -# **getCrossMarginLoan** -> CrossMarginLoan getCrossMarginLoan(loanId) - -Retrieve single borrow loan detail. (deprecated) - -### Example - -```java -// Import classes: -import io.gate.gateapi.ApiClient; -import io.gate.gateapi.ApiException; -import io.gate.gateapi.Configuration; -import io.gate.gateapi.GateApiException; -import io.gate.gateapi.auth.*; -import io.gate.gateapi.models.*; -import io.gate.gateapi.api.MarginApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("https://api.gateio.ws/api/v4"); - - // Configure APIv4 authorization: apiv4 - defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); - - MarginApi apiInstance = new MarginApi(defaultClient); - String loanId = "12345"; // String | Borrow loan ID - try { - CrossMarginLoan result = apiInstance.getCrossMarginLoan(loanId); - System.out.println(result); - } catch (GateApiException e) { - System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage())); - e.printStackTrace(); - } catch (ApiException e) { - System.err.println("Exception when calling MarginApi#getCrossMarginLoan"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **loanId** | **String**| Borrow loan ID | - -### Return type - -[**CrossMarginLoan**](CrossMarginLoan.md) - -### Authorization - -[apiv4](../README.md#apiv4) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listCrossMarginRepayments** @@ -965,7 +812,7 @@ Name | Type | Description | Notes 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 @@ -990,7 +837,7 @@ public class Example { MarginApi apiInstance = new MarginApi(defaultClient); String currency = "BTC"; // String | String loanId = "12345"; // String | - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 Boolean reverse = true; // Boolean | Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results try { @@ -1021,7 +868,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **currency** | **String**| | [optional] **loanId** | **String**| | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] **reverse** | **Boolean**| Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results | [optional] [default to true] @@ -1041,634 +888,5 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | - - -# **repayCrossMarginLoan** -> List<CrossMarginLoan> repayCrossMarginLoan(crossMarginRepayRequest) - -Cross margin repayments. (deprecated) - -When the liquidity of the currency is insufficient and the transaction risk is high, the currency will be disabled, and funds cannot be transferred.When the available balance of cross-margin is insufficient, the balance of the spot account can be used for repayment. Please ensure that the balance of the spot account is sufficient, and system uses cross-margin account for repayment first - -### Example - -```java -// Import classes: -import io.gate.gateapi.ApiClient; -import io.gate.gateapi.ApiException; -import io.gate.gateapi.Configuration; -import io.gate.gateapi.GateApiException; -import io.gate.gateapi.auth.*; -import io.gate.gateapi.models.*; -import io.gate.gateapi.api.MarginApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("https://api.gateio.ws/api/v4"); - - // Configure APIv4 authorization: apiv4 - defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); - - MarginApi apiInstance = new MarginApi(defaultClient); - CrossMarginRepayRequest crossMarginRepayRequest = new CrossMarginRepayRequest(); // CrossMarginRepayRequest | - try { - List result = apiInstance.repayCrossMarginLoan(crossMarginRepayRequest); - System.out.println(result); - } catch (GateApiException e) { - System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage())); - e.printStackTrace(); - } catch (ApiException e) { - System.err.println("Exception when calling MarginApi#repayCrossMarginLoan"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **crossMarginRepayRequest** | [**CrossMarginRepayRequest**](CrossMarginRepayRequest.md)| | - -### Return type - -[**List<CrossMarginLoan>**](CrossMarginLoan.md) - -### Authorization - -[apiv4](../README.md#apiv4) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Loan repaid | - | - - -# **getCrossMarginInterestRecords** -> List<UniLoanInterestRecord> getCrossMarginInterestRecords().currency(currency).page(page).limit(limit).from(from).to(to).execute(); - -Interest records for the cross margin account. (deprecated) - -### Example - -```java -// Import classes: -import io.gate.gateapi.ApiClient; -import io.gate.gateapi.ApiException; -import io.gate.gateapi.Configuration; -import io.gate.gateapi.GateApiException; -import io.gate.gateapi.auth.*; -import io.gate.gateapi.models.*; -import io.gate.gateapi.api.MarginApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("https://api.gateio.ws/api/v4"); - - // Configure APIv4 authorization: apiv4 - defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); - - MarginApi apiInstance = new MarginApi(defaultClient); - String currency = "BTC"; // String | Retrieve data of the specified currency - Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 100 - Long from = 1547706332L; // Long | Start timestamp - Long to = 1547706332L; // Long | End timestamp - try { - List result = apiInstance.getCrossMarginInterestRecords() - .currency(currency) - .page(page) - .limit(limit) - .from(from) - .to(to) - .execute(); - System.out.println(result); - } catch (GateApiException e) { - System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage())); - e.printStackTrace(); - } catch (ApiException e) { - System.err.println("Exception when calling MarginApi#getCrossMarginInterestRecords"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | [optional] - **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100] - **from** | **Long**| Start timestamp | [optional] - **to** | **Long**| End timestamp | [optional] - -### Return type - -[**List<UniLoanInterestRecord>**](UniLoanInterestRecord.md) - -### Authorization - -[apiv4](../README.md#apiv4) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successfully retrieved | - | - - -# **getCrossMarginTransferable** -> CrossMarginTransferable getCrossMarginTransferable(currency) - -Get the max transferable amount for a specific cross margin currency. (deprecated) - -### Example - -```java -// Import classes: -import io.gate.gateapi.ApiClient; -import io.gate.gateapi.ApiException; -import io.gate.gateapi.Configuration; -import io.gate.gateapi.GateApiException; -import io.gate.gateapi.auth.*; -import io.gate.gateapi.models.*; -import io.gate.gateapi.api.MarginApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("https://api.gateio.ws/api/v4"); - - // Configure APIv4 authorization: apiv4 - defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); - - MarginApi apiInstance = new MarginApi(defaultClient); - String currency = "BTC"; // String | Retrieve data of the specified currency - try { - CrossMarginTransferable result = apiInstance.getCrossMarginTransferable(currency); - System.out.println(result); - } catch (GateApiException e) { - System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage())); - e.printStackTrace(); - } catch (ApiException e) { - System.err.println("Exception when calling MarginApi#getCrossMarginTransferable"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | - -### Return type - -[**CrossMarginTransferable**](CrossMarginTransferable.md) - -### Authorization - -[apiv4](../README.md#apiv4) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successfully retrieved | - | - - -# **getCrossMarginEstimateRate** -> Map<String, String> getCrossMarginEstimateRate(currencies) - -Estimated interest rates. (deprecated) - -Please note that the interest rates are subject to change based on the borrowing and lending demand, and therefore, the provided rates may not be entirely accurate. - -### Example - -```java -// Import classes: -import io.gate.gateapi.ApiClient; -import io.gate.gateapi.ApiException; -import io.gate.gateapi.Configuration; -import io.gate.gateapi.GateApiException; -import io.gate.gateapi.auth.*; -import io.gate.gateapi.models.*; -import io.gate.gateapi.api.MarginApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("https://api.gateio.ws/api/v4"); - - // Configure APIv4 authorization: apiv4 - defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); - - MarginApi apiInstance = new MarginApi(defaultClient); - List currencies = Arrays.asList(); // List | An array of up to 10 specifying the currency name - try { - Map result = apiInstance.getCrossMarginEstimateRate(currencies); - System.out.println(result); - } catch (GateApiException e) { - System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage())); - e.printStackTrace(); - } catch (ApiException e) { - System.err.println("Exception when calling MarginApi#getCrossMarginEstimateRate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **currencies** | [**List<String>**](String.md)| An array of up to 10 specifying the currency name | - -### Return type - -**Map<String, String>** - -### Authorization - -[apiv4](../README.md#apiv4) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successfully retrieved | - | - - -# **getCrossMarginBorrowable** -> UnifiedBorrowable getCrossMarginBorrowable(currency) - -Get the max borrowable amount for a specific cross margin currency. (deprecated) - -### Example - -```java -// Import classes: -import io.gate.gateapi.ApiClient; -import io.gate.gateapi.ApiException; -import io.gate.gateapi.Configuration; -import io.gate.gateapi.GateApiException; -import io.gate.gateapi.auth.*; -import io.gate.gateapi.models.*; -import io.gate.gateapi.api.MarginApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("https://api.gateio.ws/api/v4"); - - // Configure APIv4 authorization: apiv4 - defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); - - MarginApi apiInstance = new MarginApi(defaultClient); - String currency = "BTC"; // String | Retrieve data of the specified currency - try { - UnifiedBorrowable result = apiInstance.getCrossMarginBorrowable(currency); - System.out.println(result); - } catch (GateApiException e) { - System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage())); - e.printStackTrace(); - } catch (ApiException e) { - System.err.println("Exception when calling MarginApi#getCrossMarginBorrowable"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | - -### Return type - -[**UnifiedBorrowable**](UnifiedBorrowable.md) - -### Authorization - -[apiv4](../README.md#apiv4) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successfully retrieved | - | - - -# **getUserMarginTier** -> List<MarginLeverageTier> getUserMarginTier(currencyPair) - -Check the user's own leverage lending gradient in the current market - -### Example - -```java -// Import classes: -import io.gate.gateapi.ApiClient; -import io.gate.gateapi.ApiException; -import io.gate.gateapi.Configuration; -import io.gate.gateapi.GateApiException; -import io.gate.gateapi.auth.*; -import io.gate.gateapi.models.*; -import io.gate.gateapi.api.MarginApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("https://api.gateio.ws/api/v4"); - - // Configure APIv4 authorization: apiv4 - defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); - - MarginApi apiInstance = new MarginApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Currency pair - try { - List result = apiInstance.getUserMarginTier(currencyPair); - System.out.println(result); - } catch (GateApiException e) { - System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage())); - e.printStackTrace(); - } catch (ApiException e) { - System.err.println("Exception when calling MarginApi#getUserMarginTier"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair | - -### Return type - -[**List<MarginLeverageTier>**](MarginLeverageTier.md) - -### Authorization - -[apiv4](../README.md#apiv4) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successfully retrieved | - | - - -# **getMarketMarginTier** -> List<MarginLeverageTier> getMarketMarginTier(currencyPair) - -Query the current market leverage lending gradient - -### Example - -```java -// Import classes: -import io.gate.gateapi.ApiClient; -import io.gate.gateapi.ApiException; -import io.gate.gateapi.Configuration; -import io.gate.gateapi.GateApiException; -import io.gate.gateapi.models.*; -import io.gate.gateapi.api.MarginApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("https://api.gateio.ws/api/v4"); - - MarginApi apiInstance = new MarginApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Currency pair - try { - List result = apiInstance.getMarketMarginTier(currencyPair); - System.out.println(result); - } catch (GateApiException e) { - System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage())); - e.printStackTrace(); - } catch (ApiException e) { - System.err.println("Exception when calling MarginApi#getMarketMarginTier"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair | - -### Return type - -[**List<MarginLeverageTier>**](MarginLeverageTier.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Successfully retrieved | - | - - -# **setUserMarketLeverage** -> setUserMarketLeverage(marginMarketLeverage) - -Set the user market leverage multiple - -### Example - -```java -// Import classes: -import io.gate.gateapi.ApiClient; -import io.gate.gateapi.ApiException; -import io.gate.gateapi.Configuration; -import io.gate.gateapi.GateApiException; -import io.gate.gateapi.auth.*; -import io.gate.gateapi.models.*; -import io.gate.gateapi.api.MarginApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("https://api.gateio.ws/api/v4"); - - // Configure APIv4 authorization: apiv4 - defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); - - MarginApi apiInstance = new MarginApi(defaultClient); - MarginMarketLeverage marginMarketLeverage = new MarginMarketLeverage(); // MarginMarketLeverage | - try { - apiInstance.setUserMarketLeverage(marginMarketLeverage); - } catch (GateApiException e) { - System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage())); - e.printStackTrace(); - } catch (ApiException e) { - System.err.println("Exception when calling MarginApi#setUserMarketLeverage"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **marginMarketLeverage** | [**MarginMarketLeverage**](MarginMarketLeverage.md)| | - -### Return type - -null (empty response body) - -### Authorization - -[apiv4](../README.md#apiv4) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: Not defined - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | Success | - | - - -# **listMarginUserAccount** -> List<MarginAccount> listMarginUserAccount().currencyPair(currencyPair).execute(); - -Query the user's leverage account list - -Support querying risk rate per position account and margin rate per position account - -### Example - -```java -// Import classes: -import io.gate.gateapi.ApiClient; -import io.gate.gateapi.ApiException; -import io.gate.gateapi.Configuration; -import io.gate.gateapi.GateApiException; -import io.gate.gateapi.auth.*; -import io.gate.gateapi.models.*; -import io.gate.gateapi.api.MarginApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("https://api.gateio.ws/api/v4"); - - // Configure APIv4 authorization: apiv4 - defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); - - MarginApi apiInstance = new MarginApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Currency pair - try { - List result = apiInstance.listMarginUserAccount() - .currencyPair(currencyPair) - .execute(); - System.out.println(result); - } catch (GateApiException e) { - System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage())); - e.printStackTrace(); - } catch (ApiException e) { - System.err.println("Exception when calling MarginApi#listMarginUserAccount"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair | [optional] - -### Return type - -[**List<MarginAccount>**](MarginAccount.md) - -### Authorization - -[apiv4](../README.md#apiv4) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | diff --git a/docs/MarginMarketLeverage.md b/docs/MarginMarketLeverage.md index 38af405..2dcd63d 100644 --- a/docs/MarginMarketLeverage.md +++ b/docs/MarginMarketLeverage.md @@ -7,6 +7,6 @@ Market leverage settings Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currencyPair** | **String** | Currency pair | [optional] +**currencyPair** | **String** | Market | [optional] **leverage** | **String** | Position leverage | diff --git a/docs/MarginUniApi.md b/docs/MarginUniApi.md index 2594a68..54e1d25 100644 --- a/docs/MarginUniApi.md +++ b/docs/MarginUniApi.md @@ -5,13 +5,13 @@ All URIs are relative to *https://api.gateio.ws/api/v4* Method | HTTP request | Description ------------- | ------------- | ------------- [**listUniCurrencyPairs**](MarginUniApi.md#listUniCurrencyPairs) | **GET** /margin/uni/currency_pairs | List lending markets -[**getUniCurrencyPair**](MarginUniApi.md#getUniCurrencyPair) | **GET** /margin/uni/currency_pairs/{currency_pair} | Get detail of lending market -[**getMarginUniEstimateRate**](MarginUniApi.md#getMarginUniEstimateRate) | **GET** /margin/uni/estimate_rate | Estimate interest Rate -[**listUniLoans**](MarginUniApi.md#listUniLoans) | **GET** /margin/uni/loans | List loans +[**getUniCurrencyPair**](MarginUniApi.md#getUniCurrencyPair) | **GET** /margin/uni/currency_pairs/{currency_pair} | Get lending market details +[**getMarginUniEstimateRate**](MarginUniApi.md#getMarginUniEstimateRate) | **GET** /margin/uni/estimate_rate | Estimate interest rate for isolated margin currencies +[**listUniLoans**](MarginUniApi.md#listUniLoans) | **GET** /margin/uni/loans | Query loans [**createUniLoan**](MarginUniApi.md#createUniLoan) | **POST** /margin/uni/loans | Borrow or repay -[**listUniLoanRecords**](MarginUniApi.md#listUniLoanRecords) | **GET** /margin/uni/loan_records | Get load records -[**listUniLoanInterestRecords**](MarginUniApi.md#listUniLoanInterestRecords) | **GET** /margin/uni/interest_records | List interest records -[**getUniBorrowable**](MarginUniApi.md#getUniBorrowable) | **GET** /margin/uni/borrowable | Get maximum borrowable +[**listUniLoanRecords**](MarginUniApi.md#listUniLoanRecords) | **GET** /margin/uni/loan_records | Query loan records +[**listUniLoanInterestRecords**](MarginUniApi.md#listUniLoanInterestRecords) | **GET** /margin/uni/interest_records | Query interest deduction records +[**getUniBorrowable**](MarginUniApi.md#getUniBorrowable) | **GET** /margin/uni/borrowable | Query maximum borrowable amount by currency @@ -72,13 +72,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **getUniCurrencyPair** > UniCurrencyPair getUniCurrencyPair(currencyPair) -Get detail of lending market +Get lending market details ### Example @@ -136,15 +136,15 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **getMarginUniEstimateRate** > Map<String, String> getMarginUniEstimateRate(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 @@ -167,7 +167,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginUniApi apiInstance = new MarginUniApi(defaultClient); - List currencies = Arrays.asList(); // List | An array of up to 10 specifying the currency name + List currencies = Arrays.asList(); // List | Array of currency names to query, maximum 10 try { Map result = apiInstance.getMarginUniEstimateRate(currencies); System.out.println(result); @@ -188,7 +188,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencies** | [**List<String>**](String.md)| An array of up to 10 specifying the currency name | + **currencies** | [**List<String>**](String.md)| Array of currency names to query, maximum 10 | ### Return type @@ -206,13 +206,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listUniLoans** > List<UniLoan> listUniLoans().currencyPair(currencyPair).currency(currency).page(page).limit(limit).execute(); -List loans +Query loans ### Example @@ -236,9 +236,9 @@ public class Example { MarginUniApi apiInstance = new MarginUniApi(defaultClient); String currencyPair = "BTC_USDT"; // String | Currency pair - String currency = "BTC"; // String | Retrieve data of the specified currency + String currency = "BTC"; // String | Query by specified currency name Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 100 + Integer limit = 100; // Integer | Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 try { List result = apiInstance.listUniLoans() .currencyPair(currencyPair) @@ -265,9 +265,9 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **currencyPair** | **String**| Currency pair | [optional] - **currency** | **String**| Retrieve data of the specified currency | [optional] + **currency** | **String**| Query by specified currency name | [optional] **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100] + **limit** | **Integer**| Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100] ### Return type @@ -285,7 +285,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **createUniLoan** @@ -352,13 +352,13 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Operated successfully | - | +**204** | Operation successful | - | # **listUniLoanRecords** > List<UniLoanRecord> listUniLoanRecords().type(type).currency(currency).currencyPair(currencyPair).page(page).limit(limit).execute(); -Get load records +Query loan records ### Example @@ -381,11 +381,11 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginUniApi apiInstance = new MarginUniApi(defaultClient); - String type = "type_example"; // String | type: borrow - borrow, repay - repay - String currency = "BTC"; // String | Retrieve data of the specified currency + String type = "type_example"; // String | Type: `borrow` - borrow, `repay` - repay + String currency = "BTC"; // String | Query by specified currency name String currencyPair = "BTC_USDT"; // String | Currency pair Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 100 + Integer limit = 100; // Integer | Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 try { List result = apiInstance.listUniLoanRecords() .type(type) @@ -412,11 +412,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **type** | **String**| type: borrow - borrow, repay - repay | [optional] [enum: borrow, repay] - **currency** | **String**| Retrieve data of the specified currency | [optional] + **type** | **String**| Type: `borrow` - borrow, `repay` - repay | [optional] [enum: borrow, repay] + **currency** | **String**| Query by specified currency name | [optional] **currencyPair** | **String**| Currency pair | [optional] **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100] + **limit** | **Integer**| Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100] ### Return type @@ -434,13 +434,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listUniLoanInterestRecords** > List<UniLoanInterestRecord> listUniLoanInterestRecords().currencyPair(currencyPair).currency(currency).page(page).limit(limit).from(from).to(to).execute(); -List interest records +Query interest deduction records ### Example @@ -464,11 +464,11 @@ public class Example { MarginUniApi apiInstance = new MarginUniApi(defaultClient); String currencyPair = "BTC_USDT"; // String | Currency pair - String currency = "BTC"; // String | Retrieve data of the specified currency + String currency = "BTC"; // String | Query by specified currency name Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list - Long from = 1547706332L; // Long | Start timestamp - Long to = 1547706332L; // Long | End timestamp + Integer limit = 100; // Integer | Maximum number of records returned in a single list + Long from = 1547706332L; // Long | 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) + Long to = 1547706332L; // Long | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp try { List result = apiInstance.listUniLoanInterestRecords() .currencyPair(currencyPair) @@ -497,11 +497,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **currencyPair** | **String**| Currency pair | [optional] - **currency** | **String**| Retrieve data of the specified currency | [optional] + **currency** | **String**| Query by specified currency name | [optional] **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] - **from** | **Long**| Start timestamp | [optional] - **to** | **Long**| End timestamp | [optional] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] + **from** | **Long**| 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** | **Long**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional] ### Return type @@ -519,13 +519,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **getUniBorrowable** > MaxUniBorrowable getUniBorrowable(currency, currencyPair) -Get maximum borrowable +Query maximum borrowable amount by currency ### Example @@ -548,7 +548,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginUniApi apiInstance = new MarginUniApi(defaultClient); - String currency = "BTC"; // String | Retrieve data of the specified currency + String currency = "BTC"; // String | Query by specified currency name String currencyPair = "BTC_USDT"; // String | Currency pair try { MaxUniBorrowable result = apiInstance.getUniBorrowable(currency, currencyPair); @@ -570,7 +570,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | + **currency** | **String**| Query by specified currency name | **currencyPair** | **String**| Currency pair | ### Return type @@ -589,5 +589,5 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | diff --git a/docs/MockFuturesOrder.md b/docs/MockFuturesOrder.md index 983dd7f..8860ed2 100644 --- a/docs/MockFuturesOrder.md +++ b/docs/MockFuturesOrder.md @@ -7,7 +7,7 @@ Futures order Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**contract** | **String** | Futures name, currently only supports perpetual futures for BTC and ETH with USDT. | -**size** | **String** | Futures quantity, representing the initial order quantity, not involved in actual settlement. | +**contract** | **String** | Futures name, currently only supports USDT perpetual contracts for BTC and ETH | +**size** | **String** | Contract quantity, representing the initial order quantity, not involved in actual settlement | **left** | **String** | Unfilled contract quantity, involved in actual calculation | diff --git a/docs/MockFuturesPosition.md b/docs/MockFuturesPosition.md index d477aab..733eff4 100644 --- a/docs/MockFuturesPosition.md +++ b/docs/MockFuturesPosition.md @@ -7,6 +7,6 @@ Futures positions Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**contract** | **String** | Futures name, currently only supports perpetual futures for BTC and ETH with USDT. | -**size** | **String** | Position size, measured in contract units. | +**contract** | **String** | Futures name, currently only supports USDT perpetual contracts for BTC and ETH | +**size** | **String** | Position size, measured in contract quantity | diff --git a/docs/MockMarginResult.md b/docs/MockMarginResult.md index d555dd7..2a01ae7 100644 --- a/docs/MockMarginResult.md +++ b/docs/MockMarginResult.md @@ -8,7 +8,7 @@ Margin result Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **String** | Position combination type `original_position` - Original position `long_delta_original_position` - Positive delta + Original position `short_delta_original_position` - Negative delta + Original position | [optional] -**profitLossRanges** | [**List<ProfitLossRange>**](ProfitLossRange.md) | The results of 33 pressure scenarios for MR1 | [optional] +**profitLossRanges** | [**List<ProfitLossRange>**](ProfitLossRange.md) | Results of 33 stress scenarios for MR1 | [optional] **maxLoss** | [**ProfitLossRange**](.md) | 最大损失 | [optional] **mr1** | **String** | Stress testing | [optional] **mr2** | **String** | Basis spread risk | [optional] diff --git a/docs/MockOptionsOrder.md b/docs/MockOptionsOrder.md index 1a48951..41ff221 100644 --- a/docs/MockOptionsOrder.md +++ b/docs/MockOptionsOrder.md @@ -7,7 +7,7 @@ Option orders Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**optionsName** | **String** | Option name, currently only supports options for BTC and ETH with USDT. | +**optionsName** | **String** | Option name, currently only supports USDT options for BTC and ETH | **size** | **String** | Initial order quantity, not involved in actual calculation | **left** | **String** | Unfilled contract quantity, involved in actual calculation | diff --git a/docs/MockOptionsPosition.md b/docs/MockOptionsPosition.md index ea6712c..c0b8c66 100644 --- a/docs/MockOptionsPosition.md +++ b/docs/MockOptionsPosition.md @@ -7,6 +7,6 @@ Options positions Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**optionsName** | **String** | Option name, currently only supports options for BTC and ETH with USDT. | -**size** | **String** | Position size, measured in contract units. | +**optionsName** | **String** | Option name, currently only supports USDT options for BTC and ETH | +**size** | **String** | Position size, measured in contract quantity | diff --git a/docs/MockRiskUnit.md b/docs/MockRiskUnit.md index eb4ec63..2080695 100644 --- a/docs/MockRiskUnit.md +++ b/docs/MockRiskUnit.md @@ -8,7 +8,7 @@ Risk unit Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **symbol** | **String** | Risk unit name | [optional] -**spotInUse** | **String** | Spot usage | [optional] +**spotInUse** | **String** | Spot hedge usage | [optional] **maintainMargin** | **String** | Maintenance margin | [optional] **initialMargin** | **String** | Initial margin | [optional] **marginResult** | [**List<MockMarginResult>**](MockMarginResult.md) | Margin result | [optional] diff --git a/docs/MockSpotBalance.md b/docs/MockSpotBalance.md index ab2cdf4..a1228c5 100644 --- a/docs/MockSpotBalance.md +++ b/docs/MockSpotBalance.md @@ -8,5 +8,5 @@ Spot Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | Currency name | -**equity** | **String** | Currency equity, where equity = balance - borrowed, represents the net delta exposure of your spot positions, which can be negative. Currently only supports three currencies: BTC, ETH. | +**equity** | **String** | 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 | diff --git a/docs/MockSpotOrder.md b/docs/MockSpotOrder.md index 7874584..df55fea 100644 --- a/docs/MockSpotOrder.md +++ b/docs/MockSpotOrder.md @@ -7,9 +7,9 @@ Spot orders Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currencyPairs** | **String** | Currency pair | +**currencyPairs** | **String** | Market | **orderPrice** | **String** | Price | -**count** | **String** | Initial order quantity for spot trading pairs, not involved in actual calculation. Currently only supports three currencies: BTC, ETH. | [optional] -**left** | **String** | Unfilled quantity, involved in actual calculation. | -**type** | **String** | Order type, sell - sell order, buy - buy order. | +**count** | **String** | 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** | **String** | Unfilled quantity, involved in actual calculation | +**type** | **String** | Order type, sell - sell order, buy - buy order | diff --git a/docs/MultiCollateralCurrency.md b/docs/MultiCollateralCurrency.md index 06d701a..b1e08bc 100644 --- a/docs/MultiCollateralCurrency.md +++ b/docs/MultiCollateralCurrency.md @@ -1,7 +1,7 @@ # MultiCollateralCurrency -Borrowing and collateral currencies supported for Multi-Collateral. +Borrowing and collateral currencies supported for Multi-Collateral ## Properties diff --git a/docs/MultiCollateralLoanApi.md b/docs/MultiCollateralLoanApi.md index bc7ee1e..7724c39 100644 --- a/docs/MultiCollateralLoanApi.md +++ b/docs/MultiCollateralLoanApi.md @@ -4,25 +4,25 @@ All URIs are relative to *https://api.gateio.ws/api/v4* Method | HTTP request | Description ------------- | ------------- | ------------- -[**listMultiCollateralOrders**](MultiCollateralLoanApi.md#listMultiCollateralOrders) | **GET** /loan/multi_collateral/orders | List Multi-Collateral Orders -[**createMultiCollateral**](MultiCollateralLoanApi.md#createMultiCollateral) | **POST** /loan/multi_collateral/orders | Create Multi-Collateral Order -[**getMultiCollateralOrderDetail**](MultiCollateralLoanApi.md#getMultiCollateralOrderDetail) | **GET** /loan/multi_collateral/orders/{order_id} | Get Multi-Collateral Order Detail -[**listMultiRepayRecords**](MultiCollateralLoanApi.md#listMultiRepayRecords) | **GET** /loan/multi_collateral/repay | List Multi-Collateral Repay Records -[**repayMultiCollateralLoan**](MultiCollateralLoanApi.md#repayMultiCollateralLoan) | **POST** /loan/multi_collateral/repay | Repay Multi-Collateral Loan +[**listMultiCollateralOrders**](MultiCollateralLoanApi.md#listMultiCollateralOrders) | **GET** /loan/multi_collateral/orders | Query multi-currency collateral order list +[**createMultiCollateral**](MultiCollateralLoanApi.md#createMultiCollateral) | **POST** /loan/multi_collateral/orders | Place multi-currency collateral order +[**getMultiCollateralOrderDetail**](MultiCollateralLoanApi.md#getMultiCollateralOrderDetail) | **GET** /loan/multi_collateral/orders/{order_id} | Query order details +[**listMultiRepayRecords**](MultiCollateralLoanApi.md#listMultiRepayRecords) | **GET** /loan/multi_collateral/repay | Query multi-currency collateral repayment records +[**repayMultiCollateralLoan**](MultiCollateralLoanApi.md#repayMultiCollateralLoan) | **POST** /loan/multi_collateral/repay | Multi-currency collateral repayment [**listMultiCollateralRecords**](MultiCollateralLoanApi.md#listMultiCollateralRecords) | **GET** /loan/multi_collateral/mortgage | Query collateral adjustment records -[**operateMultiCollateral**](MultiCollateralLoanApi.md#operateMultiCollateral) | **POST** /loan/multi_collateral/mortgage | Operate Multi-Collateral -[**listUserCurrencyQuota**](MultiCollateralLoanApi.md#listUserCurrencyQuota) | **GET** /loan/multi_collateral/currency_quota | List User Currency Quota -[**listMultiCollateralCurrencies**](MultiCollateralLoanApi.md#listMultiCollateralCurrencies) | **GET** /loan/multi_collateral/currencies | Query supported borrowing and collateral currencies in Multi-Collateral -[**getMultiCollateralLtv**](MultiCollateralLoanApi.md#getMultiCollateralLtv) | **GET** /loan/multi_collateral/ltv | Get Multi-Collateral ratio -[**getMultiCollateralFixRate**](MultiCollateralLoanApi.md#getMultiCollateralFixRate) | **GET** /loan/multi_collateral/fixed_rate | Query fixed interest rates for the currency for 7 days and 30 days -[**getMultiCollateralCurrentRate**](MultiCollateralLoanApi.md#getMultiCollateralCurrentRate) | **GET** /loan/multi_collateral/current_rate | Query the current interest rate of the currency +[**operateMultiCollateral**](MultiCollateralLoanApi.md#operateMultiCollateral) | **POST** /loan/multi_collateral/mortgage | Add or withdraw collateral +[**listUserCurrencyQuota**](MultiCollateralLoanApi.md#listUserCurrencyQuota) | **GET** /loan/multi_collateral/currency_quota | Query user's collateral and borrowing currency quota information +[**listMultiCollateralCurrencies**](MultiCollateralLoanApi.md#listMultiCollateralCurrencies) | **GET** /loan/multi_collateral/currencies | Query supported borrowing and collateral currencies for multi-currency collateral +[**getMultiCollateralLtv**](MultiCollateralLoanApi.md#getMultiCollateralLtv) | **GET** /loan/multi_collateral/ltv | Query collateralization ratio information +[**getMultiCollateralFixRate**](MultiCollateralLoanApi.md#getMultiCollateralFixRate) | **GET** /loan/multi_collateral/fixed_rate | Query currency's 7-day and 30-day fixed interest rates +[**getMultiCollateralCurrentRate**](MultiCollateralLoanApi.md#getMultiCollateralCurrentRate) | **GET** /loan/multi_collateral/current_rate | Query currency's current interest rate # **listMultiCollateralOrders** > List<MultiCollateralOrder> listMultiCollateralOrders().page(page).limit(limit).sort(sort).orderType(orderType).execute(); -List Multi-Collateral Orders +Query multi-currency collateral order list ### Example @@ -46,9 +46,9 @@ public class Example { MultiCollateralLoanApi apiInstance = new MultiCollateralLoanApi(defaultClient); Integer page = 1; // Integer | Page number - Integer limit = 10; // Integer | Maximum number of records to be returned in a single list - String sort = "ltv_asc"; // String | Sort types: time_desc - default sorting by creation time in descending order, ltv_asc - ascending order of ltv, ltv_desc - descending order of ltv. - String orderType = "current"; // String | Order type, current - query current orders, fixed - query fixed orders. If not specified, default to querying current orders + Integer limit = 10; // Integer | Maximum number of records returned in a single list + String sort = "ltv_asc"; // String | Sort type: `time_desc` - Created time descending (default), `ltv_asc` - Collateral ratio ascending, `ltv_desc` - Collateral ratio descending. + String orderType = "current"; // String | Order type: current - Query current orders, fixed - Query fixed orders, defaults to current orders if not specified try { List result = apiInstance.listMultiCollateralOrders() .page(page) @@ -75,9 +75,9 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 10] - **sort** | **String**| Sort types: time_desc - default sorting by creation time in descending order, ltv_asc - ascending order of ltv, ltv_desc - descending order of ltv. | [optional] - **orderType** | **String**| Order type, current - query current orders, fixed - query fixed orders. If not specified, default to querying current orders | [optional] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 10] + **sort** | **String**| Sort type: `time_desc` - Created time descending (default), `ltv_asc` - Collateral ratio ascending, `ltv_desc` - Collateral ratio descending. | [optional] + **orderType** | **String**| Order type: current - Query current orders, fixed - Query fixed orders, defaults to current orders if not specified | [optional] ### Return type @@ -95,13 +95,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **createMultiCollateral** > OrderResp createMultiCollateral(createMultiCollateralOrder) -Create Multi-Collateral Order +Place multi-currency collateral order ### Example @@ -163,13 +163,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | Order placed successfully | - | # **getMultiCollateralOrderDetail** > MultiCollateralOrder getMultiCollateralOrderDetail(orderId) -Get Multi-Collateral Order Detail +Query order details ### Example @@ -192,7 +192,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MultiCollateralLoanApi apiInstance = new MultiCollateralLoanApi(defaultClient); - String orderId = "12345"; // String | Order ID returned on successful order creation + String orderId = "12345"; // String | Order ID returned when order is successfully created try { MultiCollateralOrder result = apiInstance.getMultiCollateralOrderDetail(orderId); System.out.println(result); @@ -213,7 +213,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **orderId** | **String**| Order ID returned on successful order creation | + **orderId** | **String**| Order ID returned when order is successfully created | ### Return type @@ -231,13 +231,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | Order details queried successfully | - | # **listMultiRepayRecords** > List<MultiRepayRecord> listMultiRepayRecords(type).borrowCurrency(borrowCurrency).page(page).limit(limit).from(from).to(to).execute(); -List Multi-Collateral Repay Records +Query multi-currency collateral repayment records ### Example @@ -263,9 +263,9 @@ public class Example { String type = "repay"; // String | Operation type: repay - Regular repayment, liquidate - Liquidation String borrowCurrency = "USDT"; // String | Borrowed currency Integer page = 1; // Integer | Page number - Integer limit = 10; // Integer | Maximum number of records to be returned in a single list - Long from = 1609459200L; // Long | Start timestamp of the query - Long to = 1609459200L; // Long | Time range ending, default to current time + Integer limit = 10; // Integer | Maximum number of records returned in a single list + Long from = 1609459200L; // Long | Start timestamp for the query + Long to = 1609459200L; // Long | End timestamp for the query, defaults to current time if not specified try { List result = apiInstance.listMultiRepayRecords(type) .borrowCurrency(borrowCurrency) @@ -295,9 +295,9 @@ Name | Type | Description | Notes **type** | **String**| Operation type: repay - Regular repayment, liquidate - Liquidation | **borrowCurrency** | **String**| Borrowed currency | [optional] **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 10] - **from** | **Long**| Start timestamp of the query | [optional] - **to** | **Long**| Time range ending, default to current time | [optional] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 10] + **from** | **Long**| Start timestamp for the query | [optional] + **to** | **Long**| End timestamp for the query, defaults to current time if not specified | [optional] ### Return type @@ -315,13 +315,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **repayMultiCollateralLoan** > MultiRepayResp repayMultiCollateralLoan(repayMultiLoan) -Repay Multi-Collateral Loan +Multi-currency collateral repayment ### Example @@ -383,7 +383,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Operated successfully | - | +**200** | Operation successful | - | # **listMultiCollateralRecords** @@ -413,10 +413,10 @@ public class Example { MultiCollateralLoanApi apiInstance = new MultiCollateralLoanApi(defaultClient); Integer page = 1; // Integer | Page number - Integer limit = 10; // Integer | Maximum number of records to be returned in a single list - Long from = 1609459200L; // Long | Start timestamp of the query - Long to = 1609459200L; // Long | Time range ending, default to current time - String collateralCurrency = "BTC"; // String | Collateral + Integer limit = 10; // Integer | Maximum number of records returned in a single list + Long from = 1609459200L; // Long | Start timestamp for the query + Long to = 1609459200L; // Long | End timestamp for the query, defaults to current time if not specified + String collateralCurrency = "BTC"; // String | Collateral currency try { List result = apiInstance.listMultiCollateralRecords() .page(page) @@ -444,10 +444,10 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 10] - **from** | **Long**| Start timestamp of the query | [optional] - **to** | **Long**| Time range ending, default to current time | [optional] - **collateralCurrency** | **String**| Collateral | [optional] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 10] + **from** | **Long**| Start timestamp for the query | [optional] + **to** | **Long**| End timestamp for the query, defaults to current time if not specified | [optional] + **collateralCurrency** | **String**| Collateral currency | [optional] ### Return type @@ -465,13 +465,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **operateMultiCollateral** > CollateralAdjustRes operateMultiCollateral(collateralAdjust) -Operate Multi-Collateral +Add or withdraw collateral ### Example @@ -533,13 +533,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Operated successfully | - | +**200** | Operation successful | - | # **listUserCurrencyQuota** > List<CurrencyQuota> listUserCurrencyQuota(type, currency) -List User Currency Quota +Query user's collateral and borrowing currency quota information ### Example @@ -562,8 +562,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MultiCollateralLoanApi apiInstance = new MultiCollateralLoanApi(defaultClient); - String type = "collateral"; // String | Currency types: collateral - collateral currency, borrow - borrowing currency. - String currency = "BTC"; // String | When specifying collateral currencies, you can use commas to separate multiple currencies; for borrowing currencies, only one currency can be provided. + String type = "collateral"; // String | Currency type: collateral - Collateral currency, borrow - Borrowing currency + String currency = "BTC"; // String | 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 result = apiInstance.listUserCurrencyQuota(type, currency); System.out.println(result); @@ -584,8 +584,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **type** | **String**| Currency types: collateral - collateral currency, borrow - borrowing currency. | - **currency** | **String**| When specifying collateral currencies, you can use commas to separate multiple currencies; for borrowing currencies, only one currency can be provided. | + **type** | **String**| Currency type: collateral - Collateral currency, borrow - Borrowing currency | + **currency** | **String**| 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 @@ -603,13 +603,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listMultiCollateralCurrencies** > MultiCollateralCurrency listMultiCollateralCurrencies() -Query supported borrowing and collateral currencies in Multi-Collateral +Query supported borrowing and collateral currencies for multi-currency collateral ### Example @@ -663,15 +663,15 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **getMultiCollateralLtv** > CollateralLtv getMultiCollateralLtv() -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 @@ -725,13 +725,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **getMultiCollateralFixRate** > List<CollateralFixRate> getMultiCollateralFixRate() -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 @@ -785,15 +785,15 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **getMultiCollateralCurrentRate** > List<CollateralCurrentRate> getMultiCollateralCurrentRate(currencies).vipLevel(vipLevel).execute(); -Query the current interest rate of the currency +Query currency's current interest rate -Query the current interest rate of the currency in the last hour. The current interest rate is updated every hour. +Query currency's current interest rate for the previous hour, current interest rate updates hourly ### Example @@ -812,8 +812,8 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); MultiCollateralLoanApi apiInstance = new MultiCollateralLoanApi(defaultClient); - List currencies = Arrays.asList(); // List | Specify the currency name to query the array. The array is separated by commas and has a maximum of 100 items. - String vipLevel = "\"0\""; // String | VIP level, defaults to 0 if not transferred + List currencies = Arrays.asList(); // List | Specify currency name query array, separated by commas, maximum 100 items + String vipLevel = "\"0\""; // String | VIP level, defaults to 0 if not specified try { List result = apiInstance.getMultiCollateralCurrentRate(currencies) .vipLevel(vipLevel) @@ -836,8 +836,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencies** | [**List<String>**](String.md)| Specify the currency name to query the array. The array is separated by commas and has a maximum of 100 items. | - **vipLevel** | **String**| VIP level, defaults to 0 if not transferred | [optional] [default to "0"] + **currencies** | [**List<String>**](String.md)| Specify currency name query array, separated by commas, maximum 100 items | + **vipLevel** | **String**| VIP level, defaults to 0 if not specified | [optional] [default to "0"] ### Return type @@ -855,5 +855,5 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | diff --git a/docs/MultiCollateralOrder.md b/docs/MultiCollateralOrder.md index c93c5e5..bc39f2c 100644 --- a/docs/MultiCollateralOrder.md +++ b/docs/MultiCollateralOrder.md @@ -9,16 +9,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **orderId** | **String** | Order ID | [optional] **orderType** | **String** | current - current, fixed - fixed | [optional] -**fixedType** | **String** | Fixed interest rate loan periods: 7d - 7 days, 30d - 30 days. | [optional] +**fixedType** | **String** | Fixed interest rate loan periods: 7d - 7 days, 30d - 30 days | [optional] **fixedRate** | **String** | Fixed interest rate | [optional] -**expireTime** | **Long** | Expiration time, timestamp, unit in seconds. | [optional] -**autoRenew** | **Boolean** | Fixed interest rate, automatic renewal | [optional] -**autoRepay** | **Boolean** | Fixed interest rate, automatic repayment | [optional] -**currentLtv** | **String** | The current collateralization rate | [optional] +**expireTime** | **Long** | Expiration time, timestamp, unit in seconds | [optional] +**autoRenew** | **Boolean** | Fixed interest rate, auto-renewal | [optional] +**autoRepay** | **Boolean** | Fixed interest rate, auto-repayment | [optional] +**currentLtv** | **String** | Current collateralization rate | [optional] **status** | **String** | 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] **borrowTime** | **Long** | Borrowing time, timestamp in seconds | [optional] -**totalLeftRepayUsdt** | **String** | Value of Left repay amount converted in USDT | [optional] -**totalLeftCollateralUsdt** | **String** | Value of Collateral amount in USDT | [optional] +**totalLeftRepayUsdt** | **String** | Total outstanding value converted to USDT | [optional] +**totalLeftCollateralUsdt** | **String** | Total collateral value converted to USDT | [optional] **borrowCurrencies** | [**List<BorrowCurrencyInfo>**](BorrowCurrencyInfo.md) | Borrowing Currency List | [optional] **collateralCurrencies** | [**List<CollateralCurrencyInfo>**](CollateralCurrencyInfo.md) | Collateral Currency List | [optional] diff --git a/docs/MultiCollateralRecord.md b/docs/MultiCollateralRecord.md index dc86761..c800ba4 100644 --- a/docs/MultiCollateralRecord.md +++ b/docs/MultiCollateralRecord.md @@ -1,7 +1,7 @@ # MultiCollateralRecord -Multi-Collateral adjustment record. +Multi-Collateral adjustment record ## Properties @@ -9,9 +9,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **orderId** | **Long** | Order ID | [optional] **recordId** | **Long** | Collateral record ID | [optional] -**beforeLtv** | **String** | The collateral ratio before adjustment | [optional] -**afterLtv** | **String** | The collateral ratio before adjustment | [optional] -**operateTime** | **Long** | Operation time, timestamp in seconds. | [optional] +**beforeLtv** | **String** | Collateral ratio before adjustment | [optional] +**afterLtv** | **String** | Collateral ratio before adjustment | [optional] +**operateTime** | **Long** | Operation time, timestamp in seconds | [optional] **borrowCurrencies** | [**List<MultiCollateralRecordCurrency>**](MultiCollateralRecordCurrency.md) | Borrowing Currency List | [optional] **collateralCurrencies** | [**List<MultiCollateralRecordCurrency>**](MultiCollateralRecordCurrency.md) | Collateral Currency List | [optional] diff --git a/docs/MultiCollateralRecordCurrency.md b/docs/MultiCollateralRecordCurrency.md index 1b931fc..b147ff0 100644 --- a/docs/MultiCollateralRecordCurrency.md +++ b/docs/MultiCollateralRecordCurrency.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **currency** | **String** | Currency | [optional] **indexPrice** | **String** | Currency Index Price | [optional] **beforeAmount** | **String** | Amount before the operation | [optional] -**beforeAmountUsdt** | **String** | USDT Amount before the operation. | [optional] -**afterAmount** | **String** | Amount after the operation. | [optional] -**afterAmountUsdt** | **String** | USDT Amount after the operation. | [optional] +**beforeAmountUsdt** | **String** | USDT Amount before the operation | [optional] +**afterAmount** | **String** | Amount after the operation | [optional] +**afterAmountUsdt** | **String** | USDT Amount after the operation | [optional] diff --git a/docs/MultiLoanRepayItem.md b/docs/MultiLoanRepayItem.md index 17a3604..0a563aa 100644 --- a/docs/MultiLoanRepayItem.md +++ b/docs/MultiLoanRepayItem.md @@ -7,5 +7,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | Repayment currency | [optional] **amount** | **String** | Size | [optional] -**repaidAll** | **Boolean** | Repayment method, set to true for full repayment, false for partial repayment. | [optional] +**repaidAll** | **Boolean** | Repayment method, set to true for full repayment, false for partial repayment | diff --git a/docs/MultiRepayRecord.md b/docs/MultiRepayRecord.md index 398f4c0..43880bd 100644 --- a/docs/MultiRepayRecord.md +++ b/docs/MultiRepayRecord.md @@ -1,7 +1,7 @@ # MultiRepayRecord -Mult Repay Record +Multi-Collateral Repayment Record ## Properties @@ -9,14 +9,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **orderId** | **Long** | Order ID | [optional] **recordId** | **Long** | Repayment record ID | [optional] -**initLtv** | **String** | The initial collateralization rate | [optional] +**initLtv** | **String** | Initial collateralization rate | [optional] **beforeLtv** | **String** | Ltv before the operation | [optional] **afterLtv** | **String** | Ltv after the operation | [optional] -**borrowTime** | **Long** | Borrowing time, timestamp in seconds. | [optional] -**repayTime** | **Long** | Repayment time, timestamp in seconds. | [optional] +**borrowTime** | **Long** | Borrowing time, timestamp in seconds | [optional] +**repayTime** | **Long** | Repayment time, timestamp in seconds | [optional] **borrowCurrencies** | [**List<RepayRecordCurrency>**](RepayRecordCurrency.md) | List of borrowing information | [optional] **collateralCurrencies** | [**List<RepayRecordCurrency>**](RepayRecordCurrency.md) | List of collateral information | [optional] **repaidCurrencies** | [**List<RepayRecordRepaidCurrency>**](RepayRecordRepaidCurrency.md) | Repay Currency List | [optional] **totalInterestList** | [**List<RepayRecordTotalInterest>**](RepayRecordTotalInterest.md) | Total Interest List | [optional] -**leftRepayInterestList** | [**List<RepayRecordLeftInterest>**](RepayRecordLeftInterest.md) | List of left repay interest | [optional] +**leftRepayInterestList** | [**List<RepayRecordLeftInterest>**](RepayRecordLeftInterest.md) | List of remaining interest to be repaid | [optional] diff --git a/docs/MultiRepayResp.md b/docs/MultiRepayResp.md index 757393f..afdbea9 100644 --- a/docs/MultiRepayResp.md +++ b/docs/MultiRepayResp.md @@ -1,7 +1,7 @@ # MultiRepayResp -Repay Multi-Collateral Loan +Multi-currency collateral repayment ## Properties diff --git a/docs/MyFuturesTrade.md b/docs/MyFuturesTrade.md index 8b9750a..6ba2205 100644 --- a/docs/MyFuturesTrade.md +++ b/docs/MyFuturesTrade.md @@ -5,17 +5,17 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Long** | Trade ID | [optional] -**createTime** | **Double** | Trading time | [optional] +**id** | **Long** | Fill ID | [optional] +**createTime** | **Double** | Fill Time | [optional] **contract** | **String** | Futures contract | [optional] -**orderId** | **String** | Order ID related | [optional] +**orderId** | **String** | Related order ID | [optional] **size** | **Long** | Trading size | [optional] -**closeSize** | **Long** | Number of closed positions: close_size=0 && size＞0 Open long position close_size=0 && size＜0 Open short position close_size>0 && size>0 && size <= close_size Close short postion close_size>0 && size>0 && size > close_size Close short position and open long position close_size<0 && size<0 && size >= close_size Close long postion close_size<0 && size<0 && size < close_size Close long position and open short position | [optional] -**price** | **String** | Trading price | [optional] -**role** | [**RoleEnum**](#RoleEnum) | Trade role. Available values are `taker` and `maker` | [optional] -**text** | **String** | User defined information | [optional] -**fee** | **String** | Fee deducted | [optional] -**pointFee** | **String** | Points used to deduct fee | [optional] +**closeSize** | **Long** | 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** | **String** | Fill Price | [optional] +**role** | [**RoleEnum**](#RoleEnum) | Trade role. taker - taker, maker - maker | [optional] +**text** | **String** | Order custom information | [optional] +**fee** | **String** | Trade fee | [optional] +**pointFee** | **String** | Points used to deduct trade fee | [optional] ## Enum: RoleEnum diff --git a/docs/MyFuturesTradeTimeRange.md b/docs/MyFuturesTradeTimeRange.md index b6eda6a..c9a11be 100644 --- a/docs/MyFuturesTradeTimeRange.md +++ b/docs/MyFuturesTradeTimeRange.md @@ -5,17 +5,17 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**tradeId** | **String** | Trade ID | [optional] -**createTime** | **Double** | Trading time | [optional] +**tradeId** | **String** | Fill ID | [optional] +**createTime** | **Double** | Fill Time | [optional] **contract** | **String** | Futures contract | [optional] -**orderId** | **String** | Order ID related | [optional] +**orderId** | **String** | Related order ID | [optional] **size** | **Long** | Trading size | [optional] -**closeSize** | **Long** | Number of closed positions: close_size=0 && size＞0 Open long position close_size=0 && size＜0 Open short position close_size>0 && size>0 && size <= close_size Close short postion close_size>0 && size>0 && size > close_size Close short position and open long position close_size<0 && size<0 && size >= close_size Close long postion close_size<0 && size<0 && size < close_size Close long position and open short position | [optional] -**price** | **String** | Trading price | [optional] -**role** | [**RoleEnum**](#RoleEnum) | Trade role. Available values are `taker` and `maker` | [optional] -**text** | **String** | User defined information | [optional] -**fee** | **String** | Fee deducted | [optional] -**pointFee** | **String** | Points used to deduct fee | [optional] +**closeSize** | **Long** | 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** | **String** | Fill Price | [optional] +**role** | [**RoleEnum**](#RoleEnum) | Trade role. taker - taker, maker - maker | [optional] +**text** | **String** | Order custom information | [optional] +**fee** | **String** | Trade fee | [optional] +**pointFee** | **String** | Points used to deduct trade fee | [optional] ## Enum: RoleEnum diff --git a/docs/OpenOrders.md b/docs/OpenOrders.md index 9607bc9..75b0f2e 100644 --- a/docs/OpenOrders.md +++ b/docs/OpenOrders.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currencyPair** | **String** | Currency pair | [optional] -**total** | **Integer** | The total number of pending orders for this trading pair on the current page | [optional] +**total** | **Integer** | Total number of open orders for this trading pair on the current page | [optional] **orders** | [**List<Order>**](Order.md) | | [optional] diff --git a/docs/OptionsAccount.md b/docs/OptionsAccount.md index 8b62cbd..df62861 100644 --- a/docs/OptionsAccount.md +++ b/docs/OptionsAccount.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **user** | **Long** | User ID | [optional] -**total** | **String** | Account balance | [optional] +**total** | **String** | Account Balance | [optional] **positionValue** | **String** | Position value, long position value is positive, short position value is negative | [optional] **equity** | **String** | Account equity, the sum of account balance and position value | [optional] **shortEnabled** | **Boolean** | If the account is allowed to short | [optional] @@ -20,8 +20,8 @@ Name | Type | Description | Notes **askOrderMargin** | **String** | Margin for outstanding sell orders | [optional] **bidOrderMargin** | **String** | Margin for outstanding buy orders | [optional] **available** | **String** | Available balance to transfer out or trade | [optional] -**point** | **String** | POINT amount | [optional] -**currency** | **String** | Settle currency | [optional] +**point** | **String** | Point card amount | [optional] +**currency** | **String** | Settlement currency | [optional] **ordersLimit** | **Integer** | Maximum number of outstanding orders | [optional] **positionNotionalLimit** | **Long** | Notional value upper limit, including the nominal value of positions and outstanding orders | [optional] diff --git a/docs/OptionsAccountBook.md b/docs/OptionsAccountBook.md index 4525438..7c12eb6 100644 --- a/docs/OptionsAccountBook.md +++ b/docs/OptionsAccountBook.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **time** | **Double** | Change time | [optional] **change** | **String** | Amount changed (USDT) | [optional] **balance** | **String** | Account total balance after change (USDT) | [optional] -**type** | **String** | Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate | [optional] -**text** | **String** | custom text | [optional] +**type** | **String** | 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** | **String** | Remark | [optional] diff --git a/docs/OptionsApi.md b/docs/OptionsApi.md index 4ad94e4..a55b055 100644 --- a/docs/OptionsApi.md +++ b/docs/OptionsApi.md @@ -4,32 +4,32 @@ All URIs are relative to *https://api.gateio.ws/api/v4* Method | HTTP request | Description ------------- | ------------- | ------------- -[**listOptionsUnderlyings**](OptionsApi.md#listOptionsUnderlyings) | **GET** /options/underlyings | List all underlyings -[**listOptionsExpirations**](OptionsApi.md#listOptionsExpirations) | **GET** /options/expirations | List all expiration times -[**listOptionsContracts**](OptionsApi.md#listOptionsContracts) | **GET** /options/contracts | List all the contracts with specified underlying and expiration time -[**getOptionsContract**](OptionsApi.md#getOptionsContract) | **GET** /options/contracts/{contract} | Query specified contract detail +[**listOptionsUnderlyings**](OptionsApi.md#listOptionsUnderlyings) | **GET** /options/underlyings | List all underlying assets +[**listOptionsExpirations**](OptionsApi.md#listOptionsExpirations) | **GET** /options/expirations | List all expiration dates +[**listOptionsContracts**](OptionsApi.md#listOptionsContracts) | **GET** /options/contracts | List all contracts for specified underlying and expiration date +[**getOptionsContract**](OptionsApi.md#getOptionsContract) | **GET** /options/contracts/{contract} | Query specified contract details [**listOptionsSettlements**](OptionsApi.md#listOptionsSettlements) | **GET** /options/settlements | List settlement history -[**getOptionsSettlement**](OptionsApi.md#getOptionsSettlement) | **GET** /options/settlements/{contract} | Get specified contract's settlement -[**listMyOptionsSettlements**](OptionsApi.md#listMyOptionsSettlements) | **GET** /options/my_settlements | List my options settlements -[**listOptionsOrderBook**](OptionsApi.md#listOptionsOrderBook) | **GET** /options/order_book | Options order book -[**listOptionsTickers**](OptionsApi.md#listOptionsTickers) | **GET** /options/tickers | List tickers of options contracts -[**listOptionsUnderlyingTickers**](OptionsApi.md#listOptionsUnderlyingTickers) | **GET** /options/underlying/tickers/{underlying} | Get underlying ticker -[**listOptionsCandlesticks**](OptionsApi.md#listOptionsCandlesticks) | **GET** /options/candlesticks | Get options candlesticks -[**listOptionsUnderlyingCandlesticks**](OptionsApi.md#listOptionsUnderlyingCandlesticks) | **GET** /options/underlying/candlesticks | Mark price candlesticks of an underlying -[**listOptionsTrades**](OptionsApi.md#listOptionsTrades) | **GET** /options/trades | Options trade history -[**listOptionsAccount**](OptionsApi.md#listOptionsAccount) | **GET** /options/accounts | List options account -[**listOptionsAccountBook**](OptionsApi.md#listOptionsAccountBook) | **GET** /options/account_book | List account changing history +[**getOptionsSettlement**](OptionsApi.md#getOptionsSettlement) | **GET** /options/settlements/{contract} | Get specified contract settlement information +[**listMyOptionsSettlements**](OptionsApi.md#listMyOptionsSettlements) | **GET** /options/my_settlements | Query personal settlement records +[**listOptionsOrderBook**](OptionsApi.md#listOptionsOrderBook) | **GET** /options/order_book | Query options contract order book +[**listOptionsTickers**](OptionsApi.md#listOptionsTickers) | **GET** /options/tickers | Query options market ticker information +[**listOptionsUnderlyingTickers**](OptionsApi.md#listOptionsUnderlyingTickers) | **GET** /options/underlying/tickers/{underlying} | Query underlying ticker information +[**listOptionsCandlesticks**](OptionsApi.md#listOptionsCandlesticks) | **GET** /options/candlesticks | Options contract market candlestick chart +[**listOptionsUnderlyingCandlesticks**](OptionsApi.md#listOptionsUnderlyingCandlesticks) | **GET** /options/underlying/candlesticks | Underlying index price candlestick chart +[**listOptionsTrades**](OptionsApi.md#listOptionsTrades) | **GET** /options/trades | Market trade records +[**listOptionsAccount**](OptionsApi.md#listOptionsAccount) | **GET** /options/accounts | Query account information +[**listOptionsAccountBook**](OptionsApi.md#listOptionsAccountBook) | **GET** /options/account_book | Query account change history [**listOptionsPositions**](OptionsApi.md#listOptionsPositions) | **GET** /options/positions | List user's positions of specified underlying [**getOptionsPosition**](OptionsApi.md#getOptionsPosition) | **GET** /options/positions/{contract} | Get specified contract position [**listOptionsPositionClose**](OptionsApi.md#listOptionsPositionClose) | **GET** /options/position_close | List user's liquidation history of specified underlying [**listOptionsOrders**](OptionsApi.md#listOptionsOrders) | **GET** /options/orders | List options orders [**createOptionsOrder**](OptionsApi.md#createOptionsOrder) | **POST** /options/orders | Create an options order -[**cancelOptionsOrders**](OptionsApi.md#cancelOptionsOrders) | **DELETE** /options/orders | Cancel all `open` orders matched -[**getOptionsOrder**](OptionsApi.md#getOptionsOrder) | **GET** /options/orders/{order_id} | Get a single order -[**cancelOptionsOrder**](OptionsApi.md#cancelOptionsOrder) | **DELETE** /options/orders/{order_id} | Cancel a single order +[**cancelOptionsOrders**](OptionsApi.md#cancelOptionsOrders) | **DELETE** /options/orders | Cancel all orders with 'open' status +[**getOptionsOrder**](OptionsApi.md#getOptionsOrder) | **GET** /options/orders/{order_id} | Query single order details +[**cancelOptionsOrder**](OptionsApi.md#cancelOptionsOrder) | **DELETE** /options/orders/{order_id} | Cancel single order [**countdownCancelAllOptions**](OptionsApi.md#countdownCancelAllOptions) | **POST** /options/countdown_cancel_all | Countdown cancel orders -[**listMyOptionsTrades**](OptionsApi.md#listMyOptionsTrades) | **GET** /options/my_trades | List personal trading history -[**getOptionsMMP**](OptionsApi.md#getOptionsMMP) | **GET** /options/mmp | MMP Query +[**listMyOptionsTrades**](OptionsApi.md#listMyOptionsTrades) | **GET** /options/my_trades | Query personal trading records +[**getOptionsMMP**](OptionsApi.md#getOptionsMMP) | **GET** /options/mmp | MMP Query. [**setOptionsMMP**](OptionsApi.md#setOptionsMMP) | **POST** /options/mmp | MMP Settings [**resetOptionsMMP**](OptionsApi.md#resetOptionsMMP) | **POST** /options/mmp/reset | MMP Reset @@ -38,7 +38,7 @@ Method | HTTP request | Description # **listOptionsUnderlyings** > List<OptionsUnderlying> listOptionsUnderlyings() -List all underlyings +List all underlying assets ### Example @@ -92,13 +92,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listOptionsExpirations** > List<Long> listOptionsExpirations(underlying) -List all expiration times +List all expiration dates ### Example @@ -156,13 +156,13 @@ 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 | - | # **listOptionsContracts** > List<OptionsContract> listOptionsContracts(underlying).expiration(expiration).execute(); -List all the contracts with specified underlying and expiration time +List all contracts for specified underlying and expiration date ### Example @@ -182,7 +182,7 @@ public class Example { OptionsApi apiInstance = new OptionsApi(defaultClient); String underlying = "BTC_USDT"; // String | Underlying (Obtained by listing underlying endpoint) - Long expiration = 1636588800L; // Long | Unix timestamp of the expiration time + Long expiration = 1636588800L; // Long | Unix timestamp of expiration date try { List result = apiInstance.listOptionsContracts(underlying) .expiration(expiration) @@ -206,7 +206,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **underlying** | **String**| Underlying (Obtained by listing underlying endpoint) | - **expiration** | **Long**| Unix timestamp of the expiration time | [optional] + **expiration** | **Long**| Unix timestamp of expiration date | [optional] ### Return type @@ -224,13 +224,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **getOptionsContract** > OptionsContract getOptionsContract(contract) -Query specified contract detail +Query specified contract details ### Example @@ -288,7 +288,7 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listOptionsSettlements** @@ -314,10 +314,10 @@ public class Example { OptionsApi apiInstance = new OptionsApi(defaultClient); String underlying = "BTC_USDT"; // String | Underlying (Obtained by listing underlying endpoint) - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 - Long from = 1547706332L; // Long | Start timestamp - Long to = 1547706332L; // Long | End timestamp + Long from = 1547706332L; // Long | 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) + Long to = 1547706332L; // Long | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp try { List result = apiInstance.listOptionsSettlements(underlying) .limit(limit) @@ -344,10 +344,10 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **underlying** | **String**| Underlying (Obtained by listing underlying endpoint) | - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] - **from** | **Long**| Start timestamp | [optional] - **to** | **Long**| End timestamp | [optional] + **from** | **Long**| 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** | **Long**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional] ### Return type @@ -365,13 +365,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **getOptionsSettlement** > OptionsSettlement getOptionsSettlement(contract, underlying, at) -Get specified contract's settlement +Get specified contract settlement information ### Example @@ -433,13 +433,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listMyOptionsSettlements** > List<OptionsMySettlements> listMyOptionsSettlements(underlying).contract(contract).limit(limit).offset(offset).from(from).to(to).execute(); -List my options settlements +Query personal settlement records ### Example @@ -464,10 +464,10 @@ public class Example { OptionsApi apiInstance = new OptionsApi(defaultClient); String underlying = "BTC_USDT"; // String | Underlying (Obtained by listing underlying endpoint) String contract = "BTC_USDT-20210916-5000-C"; // String | Options contract name - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 - Long from = 1547706332L; // Long | Start timestamp - Long to = 1547706332L; // Long | End timestamp + Long from = 1547706332L; // Long | 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) + Long to = 1547706332L; // Long | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp try { List result = apiInstance.listMyOptionsSettlements(underlying) .contract(contract) @@ -496,10 +496,10 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **underlying** | **String**| Underlying (Obtained by listing underlying endpoint) | **contract** | **String**| Options contract name | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] - **from** | **Long**| Start timestamp | [optional] - **to** | **Long**| End timestamp | [optional] + **from** | **Long**| 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** | **Long**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional] ### Return type @@ -517,13 +517,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listOptionsOrderBook** > FuturesOrderBook listOptionsOrderBook(contract).interval(interval).limit(limit).withId(withId).execute(); -Options order book +Query options contract order book Bids will be sorted by price from high to low, while asks sorted reversely @@ -545,9 +545,9 @@ public class Example { OptionsApi apiInstance = new OptionsApi(defaultClient); String contract = "BTC_USDT-20210916-5000-C"; // String | Options contract name - String interval = "0"; // String | Order depth. 0 means no aggregation is applied. default to 0 - Integer limit = 10; // Integer | Maximum number of order depth data in asks or bids - Boolean withId = false; // Boolean | Whether the order book update ID will be returned. This ID increases by 1 on every order book update + String interval = "0"; // String | Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified + Integer limit = 10; // Integer | Number of depth levels + Boolean withId = false; // Boolean | Whether to return depth update ID. This ID increments by 1 each time depth changes try { FuturesOrderBook result = apiInstance.listOptionsOrderBook(contract) .interval(interval) @@ -573,9 +573,9 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **contract** | **String**| Options contract name | - **interval** | **String**| Order depth. 0 means no aggregation is applied. default to 0 | [optional] [default to 0] [enum: 0, 0.1, 0.01] - **limit** | **Integer**| Maximum number of order depth data in asks or bids | [optional] [default to 10] - **withId** | **Boolean**| Whether the order book update ID will be returned. This ID increases by 1 on every order book update | [optional] [default to false] + **interval** | **String**| Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified | [optional] [default to 0] [enum: 0, 0.1, 0.01] + **limit** | **Integer**| Number of depth levels | [optional] [default to 10] + **withId** | **Boolean**| Whether to return depth update ID. This ID increments by 1 each time depth changes | [optional] [default to false] ### Return type @@ -593,13 +593,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order book retrieved | - | +**200** | Depth query successful | - | # **listOptionsTickers** > List<OptionsTicker> listOptionsTickers(underlying) -List tickers of options contracts +Query options market ticker information ### Example @@ -657,13 +657,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listOptionsUnderlyingTickers** > OptionsUnderlyingTicker listOptionsUnderlyingTickers(underlying) -Get underlying ticker +Query underlying ticker information ### Example @@ -721,13 +721,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listOptionsCandlesticks** > List<OptionsCandlestick> listOptionsCandlesticks(contract).limit(limit).from(from).to(to).interval(interval).execute(); -Get options candlesticks +Options contract market candlestick chart ### Example @@ -747,10 +747,10 @@ public class Example { OptionsApi apiInstance = new OptionsApi(defaultClient); String contract = "BTC_USDT-20210916-5000-C"; // String | Options contract name - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list - Long from = 1547706332L; // Long | Start timestamp - Long to = 1547706332L; // Long | End timestamp - String interval = "5m"; // String | Interval time between data points + Integer limit = 100; // Integer | Maximum number of records returned in a single list + Long from = 1547706332L; // Long | 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) + Long to = 1547706332L; // Long | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp + String interval = "5m"; // String | Time interval between data points try { List result = apiInstance.listOptionsCandlesticks(contract) .limit(limit) @@ -777,10 +777,10 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **contract** | **String**| Options contract name | - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] - **from** | **Long**| Start timestamp | [optional] - **to** | **Long**| End timestamp | [optional] - **interval** | **String**| Interval time between data points | [optional] [default to 5m] [enum: 1m, 5m, 15m, 30m, 1h] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] + **from** | **Long**| 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** | **Long**| 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** | **String**| Time interval between data points | [optional] [default to 5m] [enum: 1m, 5m, 15m, 30m, 1h] ### Return type @@ -798,13 +798,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listOptionsUnderlyingCandlesticks** > List<FuturesCandlestick> listOptionsUnderlyingCandlesticks(underlying).limit(limit).from(from).to(to).interval(interval).execute(); -Mark price candlesticks of an underlying +Underlying index price candlestick chart ### Example @@ -824,10 +824,10 @@ public class Example { OptionsApi apiInstance = new OptionsApi(defaultClient); String underlying = "BTC_USDT"; // String | Underlying (Obtained by listing underlying endpoint) - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list - Long from = 1547706332L; // Long | Start timestamp - Long to = 1547706332L; // Long | End timestamp - String interval = "5m"; // String | Interval time between data points + Integer limit = 100; // Integer | Maximum number of records returned in a single list + Long from = 1547706332L; // Long | 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) + Long to = 1547706332L; // Long | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp + String interval = "5m"; // String | Time interval between data points try { List result = apiInstance.listOptionsUnderlyingCandlesticks(underlying) .limit(limit) @@ -854,10 +854,10 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **underlying** | **String**| Underlying (Obtained by listing underlying endpoint) | - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] - **from** | **Long**| Start timestamp | [optional] - **to** | **Long**| End timestamp | [optional] - **interval** | **String**| Interval time between data points | [optional] [default to 5m] [enum: 1m, 5m, 15m, 30m, 1h] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] + **from** | **Long**| 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** | **Long**| 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** | **String**| Time interval between data points | [optional] [default to 5m] [enum: 1m, 5m, 15m, 30m, 1h] ### Return type @@ -875,13 +875,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listOptionsTrades** > List<FuturesTrade> listOptionsTrades().contract(contract).type(type).limit(limit).offset(offset).from(from).to(to).execute(); -Options trade history +Market trade records ### Example @@ -901,11 +901,11 @@ public class Example { OptionsApi apiInstance = new OptionsApi(defaultClient); String contract = "BTC_USDT-20210916-5000-C"; // String | Options contract name - String type = "1546935600"; // String | `C` is call, while `P` is put - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + String type = "1546935600"; // String | `C` for call, `P` for put + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 - Long from = 1547706332L; // Long | Start timestamp - Long to = 1547706332L; // Long | End timestamp + Long from = 1547706332L; // Long | 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) + Long to = 1547706332L; // Long | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp try { List result = apiInstance.listOptionsTrades() .contract(contract) @@ -934,11 +934,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **contract** | **String**| Options contract name | [optional] - **type** | **String**| `C` is call, while `P` is put | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **type** | **String**| `C` for call, `P` for put | [optional] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] - **from** | **Long**| Start timestamp | [optional] - **to** | **Long**| End timestamp | [optional] + **from** | **Long**| 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** | **Long**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional] ### Return type @@ -956,13 +956,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listOptionsAccount** > OptionsAccount listOptionsAccount() -List options account +Query account information ### Example @@ -1020,13 +1020,13 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listOptionsAccountBook** > List<OptionsAccountBook> listOptionsAccountBook().limit(limit).offset(offset).from(from).to(to).type(type).execute(); -List account changing history +Query account change history ### Example @@ -1049,11 +1049,11 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); OptionsApi apiInstance = new OptionsApi(defaultClient); - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 - Long from = 1547706332L; // Long | Start timestamp - Long to = 1547706332L; // Long | End timestamp - String type = "dnw"; // String | Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - set: settlement PNL + Long from = 1547706332L; // Long | 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) + Long to = 1547706332L; // Long | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp + String type = "dnw"; // String | Change types: - dnw: Deposit & Withdrawal - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - set: Settlement P&L try { List result = apiInstance.listOptionsAccountBook() .limit(limit) @@ -1080,11 +1080,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] - **from** | **Long**| Start timestamp | [optional] - **to** | **Long**| End timestamp | [optional] - **type** | **String**| Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - set: settlement PNL | [optional] [enum: dnw, prem, fee, refr, set] + **from** | **Long**| 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** | **Long**| 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** | **String**| Change types: - dnw: Deposit & Withdrawal - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - set: Settlement P&L | [optional] [enum: dnw, prem, fee, refr, set] ### Return type @@ -1102,7 +1102,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listOptionsPositions** @@ -1172,7 +1172,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **getOptionsPosition** @@ -1240,7 +1240,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listOptionsPositionClose** @@ -1312,7 +1312,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listOptionsOrders** @@ -1341,13 +1341,13 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); OptionsApi apiInstance = new OptionsApi(defaultClient); - String status = "open"; // String | Only list the orders with this status + String status = "open"; // String | Query order list based on status String contract = "BTC_USDT-20210916-5000-C"; // String | Options contract name String underlying = "BTC_USDT"; // String | Underlying - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 - Long from = 1547706332L; // Long | Start timestamp - Long to = 1547706332L; // Long | End timestamp + Long from = 1547706332L; // Long | 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) + Long to = 1547706332L; // Long | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp try { List result = apiInstance.listOptionsOrders(status) .contract(contract) @@ -1375,13 +1375,13 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **status** | **String**| Only list the orders with this status | [enum: open, finished] + **status** | **String**| Query order list based on status | [enum: open, finished] **contract** | **String**| Options contract name | [optional] **underlying** | **String**| Underlying | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] - **from** | **Long**| Start timestamp | [optional] - **to** | **Long**| End timestamp | [optional] + **from** | **Long**| 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** | **Long**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional] ### Return type @@ -1399,7 +1399,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **createOptionsOrder** @@ -1473,7 +1473,7 @@ Name | Type | Description | Notes # **cancelOptionsOrders** > List<OptionsOrder> cancelOptionsOrders(contract, underlying, side) -Cancel all `open` orders matched +Cancel all orders with 'open' status ### Example @@ -1498,7 +1498,7 @@ public class Example { OptionsApi apiInstance = new OptionsApi(defaultClient); String contract = "BTC_USDT-20210916-5000-C"; // String | Options contract name String underlying = "BTC_USDT"; // String | Underlying - String side = "ask"; // String | All bids or asks. Both included if not specified + String side = "ask"; // String | Specify all bids or all asks, both included if not specified try { List result = apiInstance.cancelOptionsOrders(contract, underlying, side); System.out.println(result); @@ -1521,7 +1521,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **contract** | **String**| Options contract name | [optional] **underlying** | **String**| Underlying | [optional] - **side** | **String**| All bids or asks. Both included if not specified | [optional] [enum: ask, bid] + **side** | **String**| Specify all bids or all asks, both included if not specified | [optional] [enum: ask, bid] ### Return type @@ -1539,13 +1539,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | All orders matched cancelled | - | +**200** | Batch cancellation successful | - | # **getOptionsOrder** > OptionsOrder getOptionsOrder(orderId) -Get a single order +Query single order details ### Example @@ -1568,7 +1568,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); OptionsApi apiInstance = new OptionsApi(defaultClient); - Long orderId = 12345L; // Long | Order ID returned on successful order creation + Long orderId = 12345L; // Long | Order ID returned when order is successfully created try { OptionsOrder result = apiInstance.getOptionsOrder(orderId); System.out.println(result); @@ -1589,7 +1589,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **orderId** | **Long**| Order ID returned on successful order creation | + **orderId** | **Long**| Order ID returned when order is successfully created | ### Return type @@ -1613,7 +1613,7 @@ Name | Type | Description | Notes # **cancelOptionsOrder** > OptionsOrder cancelOptionsOrder(orderId) -Cancel a single order +Cancel single order ### Example @@ -1636,7 +1636,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); OptionsApi apiInstance = new OptionsApi(defaultClient); - Long orderId = 12345L; // Long | Order ID returned on successful order creation + Long orderId = 12345L; // Long | Order ID returned when order is successfully created try { OptionsOrder result = apiInstance.cancelOptionsOrder(orderId); System.out.println(result); @@ -1657,7 +1657,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **orderId** | **Long**| Order ID returned on successful order creation | + **orderId** | **Long**| Order ID returned when order is successfully created | ### Return type @@ -1683,7 +1683,7 @@ Name | Type | Description | Notes Countdown cancel orders -Option order heartbeat detection, when the `timeout` time set by the user is reached, if the existing countdown is not canceled or a new countdown is set, the related `option pending order` will be automatically canceled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at intervals of 30 seconds, with each countdown `timeout` set to 30 (seconds). If this interface is not called again within 30 seconds, all pending orders on the `underlying` `contract` you specified will be automatically cancelled. If `underlying` `contract` is not specified, all pending orders of the user will be automatically cancelled If `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the automatic order cancellation function will be cancelled. +Option order heartbeat detection, when the `timeout` time set by the user is reached, if the existing countdown is not canceled or a new countdown is set, the related `option pending order` will be automatically canceled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at intervals of 30 seconds, with each countdown `timeout` set to 30 (seconds). If this interface is not called again within 30 seconds, all pending orders on the `underlying` `contract` you specified will be automatically cancelled. If `underlying` `contract` is not specified, user will be automatically cancelled If `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the automatic order cancellation function will be cancelled. ### Example @@ -1745,13 +1745,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Set countdown successfully | - | +**200** | Countdown set successfully | - | # **listMyOptionsTrades** > List<OptionsMyTrade> listMyOptionsTrades(underlying).contract(contract).limit(limit).offset(offset).from(from).to(to).execute(); -List personal trading history +Query personal trading records ### Example @@ -1776,10 +1776,10 @@ public class Example { OptionsApi apiInstance = new OptionsApi(defaultClient); String underlying = "BTC_USDT"; // String | Underlying (Obtained by listing underlying endpoint) String contract = "BTC_USDT-20210916-5000-C"; // String | Options contract name - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 - Long from = 1547706332L; // Long | Start timestamp - Long to = 1547706332L; // Long | End timestamp + Long from = 1547706332L; // Long | 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) + Long to = 1547706332L; // Long | Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp try { List result = apiInstance.listMyOptionsTrades(underlying) .contract(contract) @@ -1808,10 +1808,10 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **underlying** | **String**| Underlying (Obtained by listing underlying endpoint) | **contract** | **String**| Options contract name | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] - **from** | **Long**| Start timestamp | [optional] - **to** | **Long**| End timestamp | [optional] + **from** | **Long**| 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** | **Long**| Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp | [optional] ### Return type @@ -1829,13 +1829,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **getOptionsMMP** > List<OptionsMMP> getOptionsMMP().underlying(underlying).execute(); -MMP Query +MMP Query. ### Example @@ -1899,7 +1899,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **setOptionsMMP** diff --git a/docs/OptionsContract.md b/docs/OptionsContract.md index 837e3f0..c0943d3 100644 --- a/docs/OptionsContract.md +++ b/docs/OptionsContract.md @@ -1,35 +1,35 @@ # OptionsContract -Options contract detail +Options contract details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | Options contract name | [optional] -**tag** | **String** | tag | [optional] -**createTime** | **Double** | Creation time | [optional] +**tag** | **String** | Tag | [optional] +**createTime** | **Double** | Created time | [optional] **expirationTime** | **Double** | Expiration time | [optional] -**isCall** | **Boolean** | `true` means call options, while `false` is put options | [optional] +**isCall** | **Boolean** | `true` means call options, `false` means put options | [optional] **multiplier** | **String** | Multiplier used in converting from invoicing to settlement currency | [optional] **underlying** | **String** | Underlying | [optional] **underlyingPrice** | **String** | Underlying price (quote currency) | [optional] **lastPrice** | **String** | Last trading price | [optional] **markPrice** | **String** | Current mark price (quote currency) | [optional] **indexPrice** | **String** | Current index price (quote currency) | [optional] -**makerFeeRate** | **String** | Maker fee rate, where negative means rebate | [optional] +**makerFeeRate** | **String** | Maker fee rate, negative values indicate rebates | [optional] **takerFeeRate** | **String** | Taker fee rate | [optional] **orderPriceRound** | **String** | Minimum order price increment | [optional] **markPriceRound** | **String** | Minimum mark price increment | [optional] -**orderSizeMin** | **Long** | Minimum order size the contract allowed | [optional] -**orderSizeMax** | **Long** | Maximum order size the contract allowed | [optional] -**orderPriceDeviate** | **String** | The positive and negative offset allowed between the order price and the current mark price, that is, the order price `order_price` must meet the following conditions: order_price is within the range of mark_price +/- order_price_deviate * underlying_price and does not distinguish between buy and sell orders | [optional] -**refDiscountRate** | **String** | Referral fee rate discount | [optional] -**refRebateRate** | **String** | Referrer commission rate | [optional] -**orderbookId** | **Long** | Current orderbook ID | [optional] +**orderSizeMin** | **Long** | Minimum order size allowed by the contract | [optional] +**orderSizeMax** | **Long** | Maximum order size allowed by the contract | [optional] +**orderPriceDeviate** | **String** | 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] +**refDiscountRate** | **String** | Trading fee discount for referred users | [optional] +**refRebateRate** | **String** | Commission rate for referrers | [optional] +**orderbookId** | **Long** | Orderbook update ID | [optional] **tradeId** | **Long** | Current trade ID | [optional] -**tradeSize** | **Long** | Historical accumulated trade size | [optional] +**tradeSize** | **Long** | Historical cumulative trading volume | [optional] **positionSize** | **Long** | Current total long position size | [optional] -**ordersLimit** | **Integer** | Maximum number of open orders | [optional] +**ordersLimit** | **Integer** | Maximum number of pending orders | [optional] diff --git a/docs/OptionsMMP.md b/docs/OptionsMMP.md index 48c4d34..2465f3a 100644 --- a/docs/OptionsMMP.md +++ b/docs/OptionsMMP.md @@ -8,10 +8,10 @@ MMP Settings Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **underlying** | **String** | Underlying | -**window** | **Integer** | Time window (milliseconds), between 1-5000, 0 means disabling MMP | +**window** | **Integer** | Time window (milliseconds), between 1-5000, 0 means disable MMP | **frozenPeriod** | **Integer** | Freeze duration (milliseconds), 0 means always frozen, need to call reset API to unfreeze | **qtyLimit** | **String** | Trading volume upper limit (positive number, up to 2 decimal places) | **deltaLimit** | **String** | Upper limit of net delta value (positive number, up to 2 decimal places) | **triggerTimeMs** | **Long** | Trigger freeze time (milliseconds), 0 means no freeze is triggered | [optional] [readonly] -**frozenUntilMs** | **Long** | Unfreeze time (milliseconds). If the freeze duration is not configured, there will be no unfreeze time after the freeze is triggered. | [optional] [readonly] +**frozenUntilMs** | **Long** | Unfreeze time (milliseconds). If the freeze duration is not configured, there will be no unfreeze time after the freeze is triggered | [optional] [readonly] diff --git a/docs/OptionsMMPReset.md b/docs/OptionsMMPReset.md index c79f10d..8f90a9c 100644 --- a/docs/OptionsMMPReset.md +++ b/docs/OptionsMMPReset.md @@ -8,10 +8,10 @@ MMP Reset Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **underlying** | **String** | Underlying | -**window** | **Integer** | Time window (milliseconds), between 1-5000, 0 means disabling MMP | [optional] [readonly] +**window** | **Integer** | Time window (milliseconds), between 1-5000, 0 means disable MMP | [optional] [readonly] **frozenPeriod** | **Integer** | Freeze duration (milliseconds), 0 means always frozen, need to call reset API to unfreeze | [optional] [readonly] **qtyLimit** | **String** | Trading volume upper limit (positive number, up to 2 decimal places) | [optional] [readonly] **deltaLimit** | **String** | Upper limit of net delta value (positive number, up to 2 decimal places) | [optional] [readonly] **triggerTimeMs** | **Long** | Trigger freeze time (milliseconds), 0 means no freeze is triggered | [optional] [readonly] -**frozenUntilMs** | **Long** | Unfreeze time (milliseconds). If the freeze duration is not configured, there will be no unfreeze time after the freeze is triggered. | [optional] [readonly] +**frozenUntilMs** | **Long** | Unfreeze time (milliseconds). If the freeze duration is not configured, there will be no unfreeze time after the freeze is triggered | [optional] [readonly] diff --git a/docs/OptionsMySettlements.md b/docs/OptionsMySettlements.md index 67cce53..1bf8c76 100644 --- a/docs/OptionsMySettlements.md +++ b/docs/OptionsMySettlements.md @@ -10,8 +10,8 @@ Name | Type | Description | Notes **contract** | **String** | Options contract name | [optional] **strikePrice** | **String** | Strike price (quote currency) | [optional] **settlePrice** | **String** | Settlement price (quote currency) | [optional] -**size** | **Long** | Size | [optional] +**size** | **Long** | Settlement size | [optional] **settleProfit** | **String** | Settlement profit (quote currency) | [optional] -**fee** | **String** | Fee (quote currency) | [optional] -**realisedPnl** | **String** | The accumulated profit and loss of opening a position, including premium, fee, settlement profit, etc. (quote currency) | [optional] +**fee** | **String** | Settlement fee (quote currency) | [optional] +**realisedPnl** | **String** | Accumulated profit and loss from opening positions, including premium, fees, settlement profit, etc. (quote currency) | [optional] diff --git a/docs/OptionsMyTrade.md b/docs/OptionsMyTrade.md index f4a6aa5..a8228ae 100644 --- a/docs/OptionsMyTrade.md +++ b/docs/OptionsMyTrade.md @@ -5,14 +5,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Long** | Trade ID | [optional] -**createTime** | **Double** | Trading time | [optional] +**id** | **Long** | Fill ID | [optional] +**createTime** | **Double** | Fill Time | [optional] **contract** | **String** | Options contract name | [optional] -**orderId** | **Integer** | Order ID related | [optional] +**orderId** | **Integer** | Related order ID | [optional] **size** | **Long** | Trading size | [optional] -**price** | **String** | Trading price (quote currency) | [optional] +**price** | **String** | Trade price (quote currency) | [optional] **underlyingPrice** | **String** | Underlying price (quote currency) | [optional] -**role** | [**RoleEnum**](#RoleEnum) | Trade role. Available values are `taker` and `maker` | [optional] +**role** | [**RoleEnum**](#RoleEnum) | Trade role. taker - taker, maker - maker | [optional] ## Enum: RoleEnum diff --git a/docs/OptionsOrder.md b/docs/OptionsOrder.md index 25405ed..e35daf6 100644 --- a/docs/OptionsOrder.md +++ b/docs/OptionsOrder.md @@ -1,7 +1,7 @@ # OptionsOrder -Options order detail +Options order details ## Properties @@ -11,26 +11,26 @@ Name | Type | Description | Notes **user** | **Integer** | User ID | [optional] [readonly] **createTime** | **Double** | Creation time of order | [optional] [readonly] **finishTime** | **Double** | Order finished time. Not returned if order is open | [optional] [readonly] -**finishAs** | [**FinishAsEnum**](#FinishAsEnum) | 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, because reduce_only is set 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** | [**StatusEnum**](#StatusEnum) | Order status - `open`: waiting to be traded - `finished`: finished | [optional] [readonly] -**contract** | **String** | Contract name | -**size** | **Long** | Order size. Specify positive number to make a bid, and negative number to ask | -**iceberg** | **Long** | 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** | **String** | Order price. 0 for market order with `tif` set as `ioc` (USDT) | [optional] +**finishAs** | [**FinishAsEnum**](#FinishAsEnum) | 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** | [**StatusEnum**](#StatusEnum) | Order status - `open`: Pending - `finished`: Completed | [optional] [readonly] +**contract** | **String** | Options identifier | +**size** | **Long** | Required. Trading quantity. Positive for buy, negative for sell. Set to 0 for close position orders. | +**iceberg** | **Long** | Display size for iceberg orders. 0 for non-iceberg orders. Note that hidden portions are charged taker fees. | [optional] +**price** | **String** | Order price. Price of 0 with `tif` set as `ioc` represents market order (quote currency) | [optional] **close** | **Boolean** | Set as `true` to close the position, with `size` set to 0 | [optional] **isClose** | **Boolean** | Is the order to close position | [optional] [readonly] **reduceOnly** | **Boolean** | Set as `true` to be reduce-only order | [optional] **isReduceOnly** | **Boolean** | Is the order reduce-only | [optional] [readonly] **isLiq** | **Boolean** | Is the order for liquidation | [optional] [readonly] -**mmp** | **Boolean** | When set to true, delegate to MMP | [optional] -**isMmp** | **Boolean** | Whether it is MMP delegation. Corresponds to `mmp` in the request. | [optional] [readonly] -**tif** | [**TifEnum**](#TifEnum) | Time in force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only - poc: PendingOrCancelled, makes a post-only order that always enjoys a maker fee | [optional] -**left** | **Long** | Size left to be traded | [optional] [readonly] -**fillPrice** | **String** | Fill price of the order | [optional] [readonly] +**mmp** | **Boolean** | When set to true, it is an MMP order | [optional] +**isMmp** | **Boolean** | Whether it is an MMP order. Corresponds to `mmp` in the request | [optional] [readonly] +**tif** | [**TifEnum**](#TifEnum) | 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] +**left** | **Long** | Unfilled quantity | [optional] [readonly] +**fillPrice** | **String** | Fill price | [optional] [readonly] **text** | **String** | 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** | **String** | Taker fee | [optional] [readonly] **mkfr** | **String** | Maker fee | [optional] [readonly] -**refu** | **Integer** | Reference user ID | [optional] [readonly] +**refu** | **Integer** | Referrer user ID | [optional] [readonly] **refr** | **String** | Referrer rebate | [optional] [readonly] ## Enum: FinishAsEnum diff --git a/docs/OptionsPosition.md b/docs/OptionsPosition.md index 5488cc8..958bf5c 100644 --- a/docs/OptionsPosition.md +++ b/docs/OptionsPosition.md @@ -1,7 +1,7 @@ # OptionsPosition -Options position information +Options contract position details ## Properties @@ -11,16 +11,16 @@ Name | Type | Description | Notes **underlying** | **String** | Underlying | [optional] [readonly] **underlyingPrice** | **String** | Underlying price (quote currency) | [optional] [readonly] **contract** | **String** | Options contract name | [optional] [readonly] -**size** | **Long** | Position size (contract size) | [optional] [readonly] +**size** | **Long** | Position size (contract quantity) | [optional] [readonly] **entryPrice** | **String** | Entry size (quote currency) | [optional] [readonly] **markPrice** | **String** | Current mark price (quote currency) | [optional] [readonly] **markIv** | **String** | Implied volatility | [optional] [readonly] -**realisedPnl** | **String** | Realized PNL | [optional] [readonly] +**realisedPnl** | **String** | Realized PnL | [optional] [readonly] **unrealisedPnl** | **String** | Unrealized PNL | [optional] [readonly] -**pendingOrders** | **Integer** | Current open orders | [optional] [readonly] +**pendingOrders** | **Integer** | Current pending order quantity | [optional] [readonly] **closeOrder** | [**OptionsPositionCloseOrder**](OptionsPositionCloseOrder.md) | | [optional] -**delta** | **String** | Delta | [optional] [readonly] -**gamma** | **String** | Gamma | [optional] [readonly] -**vega** | **String** | Vega | [optional] [readonly] -**theta** | **String** | Theta | [optional] [readonly] +**delta** | **String** | Greek letter delta | [optional] [readonly] +**gamma** | **String** | Greek letter gamma | [optional] [readonly] +**vega** | **String** | Greek letter vega | [optional] [readonly] +**theta** | **String** | Greek letter theta | [optional] [readonly] diff --git a/docs/OptionsPositionClose.md b/docs/OptionsPositionClose.md index 5cd293b..7f241db 100644 --- a/docs/OptionsPositionClose.md +++ b/docs/OptionsPositionClose.md @@ -7,10 +7,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **time** | **Double** | Position close time | [optional] [readonly] **contract** | **String** | Options contract name | [optional] [readonly] -**side** | [**SideEnum**](#SideEnum) | Position side, long or short | [optional] [readonly] -**pnl** | **String** | PNL | [optional] [readonly] -**text** | **String** | Text of close order | [optional] [readonly] -**settleSize** | **String** | settlement size | [optional] [readonly] +**side** | [**SideEnum**](#SideEnum) | Position side - `long`: Long position - `short`: Short position | [optional] [readonly] +**pnl** | **String** | PnL | [optional] [readonly] +**text** | **String** | Source of close order. See `order.text` field for specific values | [optional] [readonly] +**settleSize** | **String** | Settlement size | [optional] [readonly] ## Enum: SideEnum diff --git a/docs/OptionsPositionCloseOrder.md b/docs/OptionsPositionCloseOrder.md index 720920b..8cc7bdc 100644 --- a/docs/OptionsPositionCloseOrder.md +++ b/docs/OptionsPositionCloseOrder.md @@ -1,13 +1,13 @@ # OptionsPositionCloseOrder -Current close order if any, or `null` +Current close order information, or `null` if no close order ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Long** | Close order ID | [optional] -**price** | **String** | Close order price （quote currency) | [optional] -**isLiq** | **Boolean** | Is the close order from liquidation | [optional] +**id** | **Long** | Order ID | [optional] +**price** | **String** | Order price (quote currency) | [optional] +**isLiq** | **Boolean** | Whether the close order is from liquidation | [optional] diff --git a/docs/OptionsSettlement.md b/docs/OptionsSettlement.md index 7504cdc..b13aa6a 100644 --- a/docs/OptionsSettlement.md +++ b/docs/OptionsSettlement.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**time** | **Double** | Last changed time of configuration | [optional] +**time** | **Double** | Last configuration update time | [optional] **contract** | **String** | Options contract name | [optional] -**profit** | **String** | Settlement profit per size (quote currency) | [optional] -**fee** | **String** | Settlement fee per size (quote currency) | [optional] +**profit** | **String** | Settlement profit per contract (quote currency) | [optional] +**fee** | **String** | Settlement fee per contract (quote currency) | [optional] **strikePrice** | **String** | Strike price (quote currency) | [optional] **settlePrice** | **String** | Settlement price (quote currency) | [optional] diff --git a/docs/OptionsTicker.md b/docs/OptionsTicker.md index 3688459..4f01c27 100644 --- a/docs/OptionsTicker.md +++ b/docs/OptionsTicker.md @@ -1,14 +1,14 @@ # OptionsTicker -Options contract detail +Options contract details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | Options contract name | [optional] -**lastPrice** | **String** | Last trading price (quote currency) | [optional] +**lastPrice** | **String** | Last trade price (quote currency) | [optional] **markPrice** | **String** | Current mark price (quote currency) | [optional] **indexPrice** | **String** | Current index price (quote currency) | [optional] **ask1Size** | **Long** | Best ask size | [optional] @@ -20,9 +20,9 @@ Name | Type | Description | Notes **bidIv** | **String** | Bid side implied volatility | [optional] **askIv** | **String** | Ask side implied volatility | [optional] **leverage** | **String** | Current leverage. Formula: underlying_price / mark_price * delta | [optional] -**delta** | **String** | Delta | [optional] -**gamma** | **String** | Gamma | [optional] -**vega** | **String** | Vega | [optional] -**theta** | **String** | Theta | [optional] +**delta** | **String** | Greek letter delta | [optional] +**gamma** | **String** | Greek letter gamma | [optional] +**vega** | **String** | Greek letter vega | [optional] +**theta** | **String** | Greek letter theta | [optional] **rho** | **String** | Rho | [optional] diff --git a/docs/Order.md b/docs/Order.md index b23d699..d1ae44c 100644 --- a/docs/Order.md +++ b/docs/Order.md @@ -16,17 +16,17 @@ Name | Type | Description | Notes **updateTimeMs** | **Long** | Last modification time of order (in milliseconds) | [optional] [readonly] **status** | [**StatusEnum**](#StatusEnum) | Order status - `open`: to be filled - `closed`: filled - `cancelled`: cancelled | [optional] [readonly] **currencyPair** | **String** | Currency pair | -**type** | [**TypeEnum**](#TypeEnum) | Order Type - limit : Limit Order - market : Market Order | [optional] +**type** | [**TypeEnum**](#TypeEnum) | Order Type - limit : Limit Order - market : Market Order | [optional] **account** | **String** | Account type, spot - spot account, margin - leveraged account, unified - unified account | [optional] -**side** | [**SideEnum**](#SideEnum) | Order side | -**amount** | **String** | When `type` is limit, it refers to base currency. For instance, `BTC_USDT` means `BTC` When `type` is `market`, it refers to different currency according to `side` - `side` : `buy` means quote currency, `BTC_USDT` means `USDT` - `side` : `sell` means base currency，`BTC_USDT` means `BTC` | -**price** | **String** | Price can't be empty when `type`= `limit` | [optional] +**side** | [**SideEnum**](#SideEnum) | Buy or sell order | +**amount** | **String** | 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** | **String** | Trading price, required when `type`=`limit` | [optional] **timeInForce** | [**TimeInForceEnum**](#TimeInForceEnum) | 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] -**iceberg** | **String** | Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported. | [optional] -**autoBorrow** | **Boolean** | Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough. | [optional] -**autoRepay** | **Boolean** | Enable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order. | [optional] +**iceberg** | **String** | Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported | [optional] +**autoBorrow** | **Boolean** | Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough | [optional] +**autoRepay** | **Boolean** | 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** | **String** | Amount left to fill | [optional] [readonly] -**filledAmount** | **String** | Amount traded to fill | [optional] [readonly] +**filledAmount** | **String** | Amount filled | [optional] [readonly] **fillPrice** | **String** | Total filled in quote currency. Deprecated in favor of `filled_total` | [optional] [readonly] **filledTotal** | **String** | Total filled in quote currency | [optional] [readonly] **avgDealPrice** | **String** | Average fill price | [optional] [readonly] @@ -34,14 +34,14 @@ Name | Type | Description | Notes **feeCurrency** | **String** | Fee currency unit | [optional] [readonly] **pointFee** | **String** | Points used to deduct fee | [optional] [readonly] **gtFee** | **String** | GT used to deduct fee | [optional] [readonly] -**gtMakerFee** | **String** | GT used to deduct maker fee | [optional] [readonly] -**gtTakerFee** | **String** | GT used to deduct taker fee | [optional] [readonly] -**gtDiscount** | **Boolean** | Whether GT fee discount is used | [optional] [readonly] +**gtMakerFee** | **String** | GT amount used to deduct maker fee | [optional] [readonly] +**gtTakerFee** | **String** | GT amount used to deduct taker fee | [optional] [readonly] +**gtDiscount** | **Boolean** | Whether GT fee deduction is enabled | [optional] [readonly] **rebatedFee** | **String** | Rebated fee | [optional] [readonly] **rebatedFeeCurrency** | **String** | Rebated fee currency unit | [optional] [readonly] **stpId** | **Integer** | 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] -**stpAct** | [**StpActEnum**](#StpActEnum) | Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled | [optional] -**finishAs** | [**FinishAsEnum**](#FinishAsEnum) | Order completion statuses include: - open: Awaiting processing - filled: Fully filled - cancelled: Cancelled by user - liquidate_cancelled: Cancelled due to liquidation - small: Order quantity too small - depth_not_enough: Cancelled due to insufficient market depth - trader_not_enough: Cancelled due to insufficient counterparty - ioc: Not immediately filled because tif is set to ioc - poc: Not met the order strategy because tif is set to poc - fok: Not fully filled immediately because tif is set to fok - stp: Cancelled due to self-trade prevention - unknown: Unknown | [optional] [readonly] +**stpAct** | [**StpActEnum**](#StpActEnum) | 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] +**finishAs** | [**FinishAsEnum**](#FinishAsEnum) | 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] **actionMode** | **String** | 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] ## Enum: StatusEnum diff --git a/docs/OrderBook.md b/docs/OrderBook.md index ce9ec36..c3389ed 100644 --- a/docs/OrderBook.md +++ b/docs/OrderBook.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **id** | **Long** | Order book ID, which is updated whenever the order book is changed. Valid only when `with_id` is set to `true` | [optional] **current** | **Long** | The timestamp of the response data being generated (in milliseconds) | [optional] **update** | **Long** | The timestamp of when the orderbook last changed (in milliseconds) | [optional] -**asks** | [**List<List<String>>**](List.md) | Asks order depth | -**bids** | [**List<List<String>>**](List.md) | Bids order depth | +**asks** | [**List<List<String>>**](List.md) | Ask Depth | +**bids** | [**List<List<String>>**](List.md) | Bid Depth | diff --git a/docs/OrderCancel.md b/docs/OrderCancel.md index 0f53c85..02edb7c 100644 --- a/docs/OrderCancel.md +++ b/docs/OrderCancel.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **id** | **String** | Order ID | [optional] [readonly] **text** | **String** | 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] **amendText** | **String** | The custom data that the user remarked when amending the order | [optional] [readonly] -**succeeded** | **Boolean** | Whether the batch of orders succeeded | [optional] +**succeeded** | **Boolean** | Request execution result | [optional] **label** | **String** | Error label, if any, otherwise an empty string | [optional] **message** | **String** | Detailed error message, if any, otherwise an empty string | [optional] **createTime** | **String** | Creation time of order | [optional] [readonly] @@ -19,17 +19,17 @@ Name | Type | Description | Notes **updateTimeMs** | **Long** | Last modification time of order (in milliseconds) | [optional] [readonly] **status** | [**StatusEnum**](#StatusEnum) | Order status - `open`: to be filled - `closed`: filled - `cancelled`: cancelled | [optional] [readonly] **currencyPair** | **String** | Currency pair | -**type** | [**TypeEnum**](#TypeEnum) | Order Type - limit : Limit Order - market : Market Order | [optional] +**type** | [**TypeEnum**](#TypeEnum) | Order Type - limit : Limit Order - market : Market Order | [optional] **account** | **String** | Account type, spot - spot account, margin - leveraged account, unified - unified account | [optional] -**side** | [**SideEnum**](#SideEnum) | Order side | -**amount** | **String** | When `type` is limit, it refers to base currency. For instance, `BTC_USDT` means `BTC` When `type` is `market`, it refers to different currency according to `side` - `side` : `buy` means quote currency, `BTC_USDT` means `USDT` - `side` : `sell` means base currency，`BTC_USDT` means `BTC` | -**price** | **String** | Price can't be empty when `type`= `limit` | [optional] +**side** | [**SideEnum**](#SideEnum) | Buy or sell order | +**amount** | **String** | 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** | **String** | Trading price, required when `type`=`limit` | [optional] **timeInForce** | [**TimeInForceEnum**](#TimeInForceEnum) | 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] -**iceberg** | **String** | Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported. | [optional] -**autoBorrow** | **Boolean** | Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough. | [optional] -**autoRepay** | **Boolean** | Enable or disable automatic repayment for automatic borrow loan generated by cross margin order. Default is disabled. Note that: 1. This field is only effective for cross margin orders. Margin account does not support setting auto repayment for orders. 2. `auto_borrow` and `auto_repay` can be both set to true in one order. | [optional] +**iceberg** | **String** | Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported | [optional] +**autoBorrow** | **Boolean** | Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough | [optional] +**autoRepay** | **Boolean** | 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** | **String** | Amount left to fill | [optional] [readonly] -**filledAmount** | **String** | Amount traded to fill | [optional] [readonly] +**filledAmount** | **String** | Amount filled | [optional] [readonly] **fillPrice** | **String** | Total filled in quote currency. Deprecated in favor of `filled_total` | [optional] [readonly] **filledTotal** | **String** | Total filled in quote currency | [optional] [readonly] **avgDealPrice** | **String** | Average fill price | [optional] [readonly] @@ -37,13 +37,13 @@ Name | Type | Description | Notes **feeCurrency** | **String** | Fee currency unit | [optional] [readonly] **pointFee** | **String** | Points used to deduct fee | [optional] [readonly] **gtFee** | **String** | GT used to deduct fee | [optional] [readonly] -**gtMakerFee** | **String** | GT used to deduct maker fee | [optional] [readonly] -**gtTakerFee** | **String** | GT used to deduct taker fee | [optional] [readonly] -**gtDiscount** | **Boolean** | Whether GT fee discount is used | [optional] [readonly] +**gtMakerFee** | **String** | GT amount used to deduct maker fee | [optional] [readonly] +**gtTakerFee** | **String** | GT amount used to deduct taker fee | [optional] [readonly] +**gtDiscount** | **Boolean** | Whether GT fee deduction is enabled | [optional] [readonly] **rebatedFee** | **String** | Rebated fee | [optional] [readonly] **rebatedFeeCurrency** | **String** | Rebated fee currency unit | [optional] [readonly] **stpId** | **Integer** | 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] -**stpAct** | [**StpActEnum**](#StpActEnum) | Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled | [optional] +**stpAct** | [**StpActEnum**](#StpActEnum) | 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] **finishAs** | [**FinishAsEnum**](#FinishAsEnum) | 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] **actionMode** | **String** | 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 68d10c6..88d1655 100644 --- a/docs/OrderPatch.md +++ b/docs/OrderPatch.md @@ -8,9 +8,9 @@ Spot order details Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currencyPair** | **String** | Currency pair | [optional] -**account** | **String** | Specify query account. | [optional] -**amount** | **String** | New order amount. `amount` and `price` must specify one of them | [optional] -**price** | **String** | New order price. `amount` and `Price` must specify one of them\" | [optional] -**amendText** | **String** | Custom info during amending order | [optional] +**account** | **String** | Specify query account | [optional] +**amount** | **String** | Trading quantity. Either `amount` or `price` must be specified | [optional] +**price** | **String** | Trading price. Either `amount` or `price` must be specified | [optional] +**amendText** | **String** | Custom info during order amendment | [optional] **actionMode** | **String** | 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/PartnerCommissionHistory.md b/docs/PartnerCommissionHistory.md index 08991e5..aa64c35 100644 --- a/docs/PartnerCommissionHistory.md +++ b/docs/PartnerCommissionHistory.md @@ -6,5 +6,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **total** | **Long** | Total | [optional] -**list** | [**List<AgencyCommission>**](AgencyCommission.md) | List of comission history | [optional] +**list** | [**List<AgencyCommission>**](AgencyCommission.md) | List of commission history | [optional] diff --git a/docs/PartnerSub.md b/docs/PartnerSub.md index 6d73faf..52b0f25 100644 --- a/docs/PartnerSub.md +++ b/docs/PartnerSub.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **userId** | **Long** | User ID | [optional] -**userJoinTime** | **Long** | The time when the user joined the system, in seconds Unix timestamp | [optional] -**type** | **Long** | Type (1-Sub-agent 2-Indirect Customer 3-Direct Customer) | [optional] +**userJoinTime** | **Long** | Time when user joined the system, Unix timestamp in seconds | [optional] +**type** | **Long** | Type (1-Sub-agent 2-Indirect direct customer 3-Direct direct customer) | [optional] diff --git a/docs/PlaceDualInvestmentOrder.md b/docs/PlaceDualInvestmentOrder.md index d1e4985..2607a54 100644 --- a/docs/PlaceDualInvestmentOrder.md +++ b/docs/PlaceDualInvestmentOrder.md @@ -1,13 +1,13 @@ # PlaceDualInvestmentOrder -Dual Investment order +Dual Investment Order ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**planId** | **String** | Plan ID | -**amount** | **String** | Subscription amount, mutually exclusive with the copies field | -**text** | **String** | 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] +**planId** | **String** | Product ID | +**amount** | **String** | Subscription amount, mutually exclusive with copies field | +**text** | **String** | 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] diff --git a/docs/Position.md b/docs/Position.md index e39a338..eb133ef 100644 --- a/docs/Position.md +++ b/docs/Position.md @@ -22,22 +22,25 @@ Name | Type | Description | Notes **initialMargin** | **String** | The initial margin occupied by the position, applicable to the portfolio margin account | [optional] [readonly] **maintenanceMargin** | **String** | Maintenance margin required for the position, applicable to portfolio margin account | [optional] [readonly] **unrealisedPnl** | **String** | Unrealized PNL | [optional] [readonly] -**realisedPnl** | **String** | Realized PNL | [optional] [readonly] +**realisedPnl** | **String** | Realized PnL | [optional] [readonly] **pnlPnl** | **String** | Realized PNL - Position P/L | [optional] [readonly] -**pnlFund** | **String** | Realized PNL - Funding Fees | [optional] [readonly] +**pnlFund** | **String** | Realized PNL - Funding Fees | [optional] [readonly] **pnlFee** | **String** | Realized PNL - Transaction Fees | [optional] [readonly] -**historyPnl** | **String** | History realized PNL | [optional] [readonly] +**historyPnl** | **String** | Total realized PnL from closed positions | [optional] [readonly] **lastClosePnl** | **String** | PNL of last position close | [optional] [readonly] **realisedPoint** | **String** | Realized POINT PNL | [optional] [readonly] **historyPoint** | **String** | History realized POINT PNL | [optional] [readonly] **adlRanking** | **Integer** | 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] -**pendingOrders** | **Integer** | Current open orders | [optional] [readonly] +**pendingOrders** | **Integer** | Current pending order quantity | [optional] [readonly] **closeOrder** | [**PositionCloseOrder**](PositionCloseOrder.md) | | [optional] -**mode** | [**ModeEnum**](#ModeEnum) | Position mode, including: - `single`: dual mode is not enabled- `dual_long`: long position in dual mode- `dual_short`: short position in dual mode | [optional] -**crossLeverageLimit** | **String** | Cross margin leverage(valid only when `leverage` is 0) | [optional] +**mode** | [**ModeEnum**](#ModeEnum) | Position mode, including: - `single`: Single position mode - `dual_long`: Long position in dual position mode - `dual_short`: Short position in dual position mode | [optional] +**crossLeverageLimit** | **String** | Cross margin leverage (valid only when `leverage` is 0) | [optional] **updateTime** | **Long** | Last update time | [optional] [readonly] -**updateId** | **Long** | Update id. Each time the position is updated, the value will be +1. | [optional] [readonly] +**updateId** | **Long** | Update ID. The value increments by 1 each time the position is updated | [optional] [readonly] **openTime** | **Long** | First Open Time | [optional] +**riskLimitTable** | **String** | Risk limit table ID | [optional] [readonly] +**averageMaintenanceRate** | **String** | Average maintenance margin rate | [optional] [readonly] +**pid** | **Long** | Sub-account position ID | [optional] [readonly] ## Enum: ModeEnum diff --git a/docs/PositionClose.md b/docs/PositionClose.md index 9ed136a..def9d71 100644 --- a/docs/PositionClose.md +++ b/docs/PositionClose.md @@ -7,17 +7,17 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **time** | **Double** | Position close time | [optional] [readonly] **contract** | **String** | Futures contract | [optional] [readonly] -**side** | [**SideEnum**](#SideEnum) | Position side, long or short | [optional] [readonly] -**pnl** | **String** | PNL | [optional] [readonly] +**side** | [**SideEnum**](#SideEnum) | Position side - `long`: Long position - `short`: Short position | [optional] [readonly] +**pnl** | **String** | PnL | [optional] [readonly] **pnlPnl** | **String** | PNL - Position P/L | [optional] [readonly] **pnlFund** | **String** | PNL - Funding Fees | [optional] [readonly] **pnlFee** | **String** | PNL - Transaction Fees | [optional] [readonly] -**text** | **String** | Text of close order | [optional] [readonly] +**text** | **String** | Source of close order. See `order.text` field for specific values | [optional] [readonly] **maxSize** | **String** | Max Trade Size | [optional] [readonly] **accumSize** | **String** | Cumulative closed position volume | [optional] [readonly] **firstOpenTime** | **Long** | First Open Time | [optional] [readonly] -**longPrice** | **String** | When 'side' is 'long,' it indicates the opening average price; when 'side' is 'short,' it indicates the closing average price. | [optional] [readonly] -**shortPrice** | **String** | When 'side' is 'long,' it indicates the opening average price; when 'side' is 'short,' it indicates the closing average price | [optional] [readonly] +**longPrice** | **String** | When side is 'long', it indicates the opening average price; when side is 'short', it indicates the closing average price | [optional] [readonly] +**shortPrice** | **String** | When side is 'long', it indicates the closing average price; when side is 'short', it indicates the opening average price | [optional] [readonly] ## Enum: SideEnum diff --git a/docs/PositionCloseOrder.md b/docs/PositionCloseOrder.md index 13c6ad6..72d4929 100644 --- a/docs/PositionCloseOrder.md +++ b/docs/PositionCloseOrder.md @@ -1,13 +1,13 @@ # PositionCloseOrder -Current close order if any, or `null` +Current close order information, or `null` if no close order ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Long** | Close order ID | [optional] -**price** | **String** | Close order price | [optional] -**isLiq** | **Boolean** | Is the close order from liquidation | [optional] +**id** | **Long** | Order ID | [optional] +**price** | **String** | Order price | [optional] +**isLiq** | **Boolean** | Whether the close order is from liquidation | [optional] diff --git a/docs/ProfitLossRange.md b/docs/ProfitLossRange.md index 7eb15f6..8c95b59 100644 --- a/docs/ProfitLossRange.md +++ b/docs/ProfitLossRange.md @@ -9,5 +9,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pricePercentage** | **String** | Percentage change in price | [optional] **impliedVolatilityPercentage** | **String** | Percentage change in implied volatility | [optional] -**profitLoss** | **String** | PNL | [optional] +**profitLoss** | **String** | PnL | [optional] diff --git a/docs/RebateApi.md b/docs/RebateApi.md index b79996d..333e137 100644 --- a/docs/RebateApi.md +++ b/docs/RebateApi.md @@ -4,24 +4,24 @@ All URIs are relative to *https://api.gateio.ws/api/v4* Method | HTTP request | Description ------------- | ------------- | ------------- -[**agencyTransactionHistory**](RebateApi.md#agencyTransactionHistory) | **GET** /rebate/agency/transaction_history | The agency obtains the transaction history of the recommended user -[**agencyCommissionsHistory**](RebateApi.md#agencyCommissionsHistory) | **GET** /rebate/agency/commission_history | The agency obtains the commission history of the recommended user -[**partnerTransactionHistory**](RebateApi.md#partnerTransactionHistory) | **GET** /rebate/partner/transaction_history | Partner obtains transaction records of recommended users -[**partnerCommissionsHistory**](RebateApi.md#partnerCommissionsHistory) | **GET** /rebate/partner/commission_history | Partner obtains commission records of recommended users +[**agencyTransactionHistory**](RebateApi.md#agencyTransactionHistory) | **GET** /rebate/agency/transaction_history | Broker obtains transaction history of recommended users +[**agencyCommissionsHistory**](RebateApi.md#agencyCommissionsHistory) | **GET** /rebate/agency/commission_history | Broker obtains rebate history of recommended users +[**partnerTransactionHistory**](RebateApi.md#partnerTransactionHistory) | **GET** /rebate/partner/transaction_history | Partner obtains transaction history of recommended users +[**partnerCommissionsHistory**](RebateApi.md#partnerCommissionsHistory) | **GET** /rebate/partner/commission_history | Partner obtains rebate records of recommended users [**partnerSubList**](RebateApi.md#partnerSubList) | **GET** /rebate/partner/sub_list | Partner subordinate list -[**rebateBrokerCommissionHistory**](RebateApi.md#rebateBrokerCommissionHistory) | **GET** /rebate/broker/commission_history | The broker obtains the user's commission rebate records -[**rebateBrokerTransactionHistory**](RebateApi.md#rebateBrokerTransactionHistory) | **GET** /rebate/broker/transaction_history | The broker obtains the user's trading history -[**rebateUserInfo**](RebateApi.md#rebateUserInfo) | **GET** /rebate/user/info | User retrieves rebate information -[**userSubRelation**](RebateApi.md#userSubRelation) | **GET** /rebate/user/sub_relation | User-subordinate relationship +[**rebateBrokerCommissionHistory**](RebateApi.md#rebateBrokerCommissionHistory) | **GET** /rebate/broker/commission_history | Broker obtains user's rebate records +[**rebateBrokerTransactionHistory**](RebateApi.md#rebateBrokerTransactionHistory) | **GET** /rebate/broker/transaction_history | Broker obtains user's trading history +[**rebateUserInfo**](RebateApi.md#rebateUserInfo) | **GET** /rebate/user/info | User obtains rebate information +[**userSubRelation**](RebateApi.md#userSubRelation) | **GET** /rebate/user/sub_relation | User subordinate relationship # **agencyTransactionHistory** > List<AgencyTransactionHistory> agencyTransactionHistory().currencyPair(currencyPair).userId(userId).from(from).to(to).limit(limit).offset(offset).execute(); -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 @@ -44,11 +44,11 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); RebateApi apiInstance = new RebateApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Specify the currency pair, if not specified, return all currency pairs + String currencyPair = "BTC_USDT"; // String | Specify the trading pair. If not specified, returns all trading pairs Long userId = 10003L; // Long | User ID. If not specified, all user records will be returned - Long from = 1602120000L; // Long | Time range beginning, default to 7 days before current time - Long to = 1602123600L; // Long | Time range ending, default to current time - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Long from = 1602120000L; // Long | Start time for querying records, defaults to 7 days before current time if not specified + Long to = 1602123600L; // Long | End timestamp for the query, defaults to current time if not specified + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 try { List result = apiInstance.agencyTransactionHistory() @@ -77,11 +77,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Specify the currency pair, if not specified, return all currency pairs | [optional] + **currencyPair** | **String**| Specify the trading pair. If not specified, returns all trading pairs | [optional] **userId** | **Long**| User ID. If not specified, all user records will be returned | [optional] - **from** | **Long**| Time range beginning, default to 7 days before current time | [optional] - **to** | **Long**| Time range ending, default to current time | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **from** | **Long**| Start time for querying records, defaults to 7 days before current time if not specified | [optional] + **to** | **Long**| End timestamp for the query, defaults to current time if not specified | [optional] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] ### Return type @@ -100,15 +100,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **agencyCommissionsHistory** -> List<AgencyCommissionHistory> agencyCommissionsHistory().currency(currency).userId(userId).from(from).to(to).limit(limit).offset(offset).execute(); +> List<AgencyCommissionHistory> agencyCommissionsHistory().currency(currency).commissionType(commissionType).userId(userId).from(from).to(to).limit(limit).offset(offset).execute(); -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 @@ -131,15 +131,17 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); RebateApi apiInstance = new RebateApi(defaultClient); - String currency = "BTC"; // String | Filter by currency. Return all currency records if not specified + String currency = "BTC"; // String | Specify the currency. If not specified, returns all currencies + Integer commissionType = 1; // Integer | Rebate type: 1 - Direct rebate, 2 - Indirect rebate, 3 - Self rebate Long userId = 10003L; // Long | User ID. If not specified, all user records will be returned - Long from = 1602120000L; // Long | Time range beginning, default to 7 days before current time - Long to = 1602123600L; // Long | Time range ending, default to current time - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Long from = 1602120000L; // Long | Start time for querying records, defaults to 7 days before current time if not specified + Long to = 1602123600L; // Long | End timestamp for the query, defaults to current time if not specified + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 try { List result = apiInstance.agencyCommissionsHistory() .currency(currency) + .commissionType(commissionType) .userId(userId) .from(from) .to(to) @@ -164,11 +166,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Filter by currency. Return all currency records if not specified | [optional] + **currency** | **String**| Specify the currency. If not specified, returns all currencies | [optional] + **commissionType** | **Integer**| Rebate type: 1 - Direct rebate, 2 - Indirect rebate, 3 - Self rebate | [optional] **userId** | **Long**| User ID. If not specified, all user records will be returned | [optional] - **from** | **Long**| Time range beginning, default to 7 days before current time | [optional] - **to** | **Long**| Time range ending, default to current time | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **from** | **Long**| Start time for querying records, defaults to 7 days before current time if not specified | [optional] + **to** | **Long**| End timestamp for the query, defaults to current time if not specified | [optional] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] ### Return type @@ -187,15 +190,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **partnerTransactionHistory** > PartnerTransactionHistory partnerTransactionHistory().currencyPair(currencyPair).userId(userId).from(from).to(to).limit(limit).offset(offset).execute(); -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 @@ -218,11 +221,11 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); RebateApi apiInstance = new RebateApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Specify the currency pair, if not specified, return all currency pairs + String currencyPair = "BTC_USDT"; // String | Specify the trading pair. If not specified, returns all trading pairs Long userId = 10003L; // Long | User ID. If not specified, all user records will be returned - Long from = 1602120000L; // Long | Time range beginning, default to 7 days before current time - Long to = 1602123600L; // Long | Time range ending, default to current time - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Long from = 1602120000L; // Long | Start time for querying records, defaults to 7 days before current time if not specified + Long to = 1602123600L; // Long | End timestamp for the query, defaults to current time if not specified + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 try { PartnerTransactionHistory result = apiInstance.partnerTransactionHistory() @@ -251,11 +254,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Specify the currency pair, if not specified, return all currency pairs | [optional] + **currencyPair** | **String**| Specify the trading pair. If not specified, returns all trading pairs | [optional] **userId** | **Long**| User ID. If not specified, all user records will be returned | [optional] - **from** | **Long**| Time range beginning, default to 7 days before current time | [optional] - **to** | **Long**| Time range ending, default to current time | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **from** | **Long**| Start time for querying records, defaults to 7 days before current time if not specified | [optional] + **to** | **Long**| End timestamp for the query, defaults to current time if not specified | [optional] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] ### Return type @@ -274,15 +277,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **partnerCommissionsHistory** > PartnerCommissionHistory partnerCommissionsHistory().currency(currency).userId(userId).from(from).to(to).limit(limit).offset(offset).execute(); -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 @@ -305,11 +308,11 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); RebateApi apiInstance = new RebateApi(defaultClient); - String currency = "BTC"; // String | Filter by currency. Return all currency records if not specified + String currency = "BTC"; // String | Specify the currency. If not specified, returns all currencies Long userId = 10003L; // Long | User ID. If not specified, all user records will be returned - Long from = 1602120000L; // Long | Time range beginning, default to 7 days before current time - Long to = 1602123600L; // Long | Time range ending, default to current time - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Long from = 1602120000L; // Long | Start time for querying records, defaults to 7 days before current time if not specified + Long to = 1602123600L; // Long | End timestamp for the query, defaults to current time if not specified + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 try { PartnerCommissionHistory result = apiInstance.partnerCommissionsHistory() @@ -338,11 +341,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Filter by currency. Return all currency records if not specified | [optional] + **currency** | **String**| Specify the currency. If not specified, returns all currencies | [optional] **userId** | **Long**| User ID. If not specified, all user records will be returned | [optional] - **from** | **Long**| Time range beginning, default to 7 days before current time | [optional] - **to** | **Long**| Time range ending, default to current time | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **from** | **Long**| Start time for querying records, defaults to 7 days before current time if not specified | [optional] + **to** | **Long**| End timestamp for the query, defaults to current time if not specified | [optional] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] ### Return type @@ -361,7 +364,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **partnerSubList** @@ -369,7 +372,7 @@ Name | Type | Description | Notes Partner subordinate list -Including sub-agents, direct customers, indirect customers +Including sub-agents, direct customers, and indirect customers ### Example @@ -393,7 +396,7 @@ public class Example { RebateApi apiInstance = new RebateApi(defaultClient); Long userId = 10003L; // Long | User ID. If not specified, all user records will be returned - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 try { PartnerSubList result = apiInstance.partnerSubList() @@ -420,7 +423,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **userId** | **Long**| User ID. If not specified, all user records will be returned | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] ### Return type @@ -439,15 +442,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **rebateBrokerCommissionHistory** > List<BrokerCommission> rebateBrokerCommissionHistory().limit(limit).offset(offset).userId(userId).from(from).to(to).execute(); -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 @@ -470,11 +473,11 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); RebateApi apiInstance = new RebateApi(defaultClient); - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 Long userId = 10003L; // Long | User ID. If not specified, all user records will be returned - Long from = 1711929600L; // Long | The start time of the query record. If not specified, the default is to push forward 30 days from the current time. - Long to = 1714521600L; // Long | Time range ending, default to current time + Long from = 1711929600L; // Long | Start time of the query record. If not specified, defaults to 30 days before the current time + Long to = 1714521600L; // Long | End timestamp for the query, defaults to current time if not specified try { List result = apiInstance.rebateBrokerCommissionHistory() .limit(limit) @@ -501,11 +504,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] **userId** | **Long**| User ID. If not specified, all user records will be returned | [optional] - **from** | **Long**| The start time of the query record. If not specified, the default is to push forward 30 days from the current time. | [optional] - **to** | **Long**| Time range ending, default to current time | [optional] + **from** | **Long**| Start time of the query record. If not specified, defaults to 30 days before the current time | [optional] + **to** | **Long**| End timestamp for the query, defaults to current time if not specified | [optional] ### Return type @@ -523,15 +526,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **rebateBrokerTransactionHistory** > List<BrokerTransaction> rebateBrokerTransactionHistory().limit(limit).offset(offset).userId(userId).from(from).to(to).execute(); -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 @@ -554,11 +557,11 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); RebateApi apiInstance = new RebateApi(defaultClient); - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 Long userId = 10003L; // Long | User ID. If not specified, all user records will be returned - Long from = 1711929600L; // Long | The start time of the query record. If not specified, the default is to push forward 30 days from the current time. - Long to = 1714521600L; // Long | Time range ending, default to current time + Long from = 1711929600L; // Long | Start time of the query record. If not specified, defaults to 30 days before the current time + Long to = 1714521600L; // Long | End timestamp for the query, defaults to current time if not specified try { List result = apiInstance.rebateBrokerTransactionHistory() .limit(limit) @@ -585,11 +588,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] **userId** | **Long**| User ID. If not specified, all user records will be returned | [optional] - **from** | **Long**| The start time of the query record. If not specified, the default is to push forward 30 days from the current time. | [optional] - **to** | **Long**| Time range ending, default to current time | [optional] + **from** | **Long**| Start time of the query record. If not specified, defaults to 30 days before the current time | [optional] + **to** | **Long**| End timestamp for the query, defaults to current time if not specified | [optional] ### Return type @@ -607,13 +610,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **rebateUserInfo** > List<RebateUserInfo> rebateUserInfo() -User retrieves rebate information +User obtains rebate information ### Example @@ -671,15 +674,15 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **userSubRelation** > UserSubRelation userSubRelation(userIdList) -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 @@ -702,7 +705,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); RebateApi apiInstance = new RebateApi(defaultClient); - String userIdList = "1, 2, 3"; // String | Query the user's ID list, split by,, if there are more than 100, take 100 + String userIdList = "1, 2, 3"; // String | Query user ID list, separated by commas. If more than 100, only 100 will be returned try { UserSubRelation result = apiInstance.userSubRelation(userIdList); System.out.println(result); @@ -723,7 +726,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **userIdList** | **String**| Query the user's ID list, split by,, if there are more than 100, take 100 | + **userIdList** | **String**| Query user ID list, separated by commas. If more than 100, only 100 will be returned | ### Return type @@ -741,5 +744,5 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | diff --git a/docs/RepayCurrencyRes.md b/docs/RepayCurrencyRes.md index 7dcc745..ad7ad8b 100644 --- a/docs/RepayCurrencyRes.md +++ b/docs/RepayCurrencyRes.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**succeeded** | **Boolean** | Has the repayment been successful | [optional] -**label** | **String** | Error identifier for unsuccessful operations; empty for successful. | [optional] -**message** | **String** | Error description in case of operation failure; empty when successful. | [optional] +**succeeded** | **Boolean** | Whether the repayment was successful | [optional] +**label** | **String** | Error identifier for failed operations; empty when successful | [optional] +**message** | **String** | Error description for failed operations; empty when successful | [optional] **currency** | **String** | Repayment currency | [optional] **repaidPrincipal** | **String** | Principal | [optional] **repaidInterest** | **String** | Principal | [optional] diff --git a/docs/RepayLoan.md b/docs/RepayLoan.md index 3d34e78..8ecfaaf 100644 --- a/docs/RepayLoan.md +++ b/docs/RepayLoan.md @@ -9,5 +9,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **orderId** | **Long** | Order ID | **repayAmount** | **String** | Repayment amount, it is mandatory when making partial repayments | -**repaidAll** | **Boolean** | Repayment method, set to `true` for full repayment, and `false` for partial repayment; When set to false for partial repayment, the repay_amount parameter cannot be greater than the remaining amount to be repaid by the user. | +**repaidAll** | **Boolean** | 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. | diff --git a/docs/RepayMultiLoan.md b/docs/RepayMultiLoan.md index d34332f..835ffdd 100644 --- a/docs/RepayMultiLoan.md +++ b/docs/RepayMultiLoan.md @@ -1,7 +1,7 @@ # RepayMultiLoan -Repay Multi-Collateral Loan +Multi-currency collateral repayment ## Properties diff --git a/docs/RepayRecord.md b/docs/RepayRecord.md index e291510..8082201 100644 --- a/docs/RepayRecord.md +++ b/docs/RepayRecord.md @@ -11,13 +11,13 @@ Name | Type | Description | Notes **recordId** | **Long** | Repayment record ID | [optional] **repaidAmount** | **String** | Repayment amount | [optional] **borrowCurrency** | **String** | Borrowed currency | [optional] -**collateralCurrency** | **String** | Collateral | [optional] -**initLtv** | **String** | The initial collateralization rate | [optional] +**collateralCurrency** | **String** | Collateral currency | [optional] +**initLtv** | **String** | Initial collateralization rate | [optional] **borrowTime** | **Long** | Borrowing time, timestamp | [optional] **repayTime** | **Long** | Repayment time, timestamp | [optional] **totalInterest** | **String** | Total interest | [optional] **beforeLeftPrincipal** | **String** | Principal to be repaid before repayment | [optional] **afterLeftPrincipal** | **String** | Principal to be repaid after repayment | [optional] -**beforeLeftCollateral** | **String** | Collateral quantity before repayment | [optional] -**afterLeftCollateral** | **String** | Collateral quantity after repayment | [optional] +**beforeLeftCollateral** | **String** | Collateral amount before repayment | [optional] +**afterLeftCollateral** | **String** | Collateral amount after repayment | [optional] diff --git a/docs/RepayRecordCurrency.md b/docs/RepayRecordCurrency.md index d1b9e46..b597b39 100644 --- a/docs/RepayRecordCurrency.md +++ b/docs/RepayRecordCurrency.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **currency** | **String** | Currency | [optional] **indexPrice** | **String** | Currency Index Price | [optional] **beforeAmount** | **String** | Amount before the operation | [optional] -**beforeAmountUsdt** | **String** | USDT Amount before the operation. | [optional] -**afterAmount** | **String** | Amount after the operation. | [optional] -**afterAmountUsdt** | **String** | USDT Amount after the operation. | [optional] +**beforeAmountUsdt** | **String** | USDT Amount before the operation | [optional] +**afterAmount** | **String** | Amount after the operation | [optional] +**afterAmountUsdt** | **String** | USDT Amount after the operation | [optional] diff --git a/docs/RepayRecordRepaidCurrency.md b/docs/RepayRecordRepaidCurrency.md index 346f893..60256f0 100644 --- a/docs/RepayRecordRepaidCurrency.md +++ b/docs/RepayRecordRepaidCurrency.md @@ -10,5 +10,5 @@ Name | Type | Description | Notes **repaidAmount** | **String** | Repayment amount | [optional] **repaidPrincipal** | **String** | Principal | [optional] **repaidInterest** | **String** | Interest | [optional] -**repaidAmountUsdt** | **String** | Value of the repayment amount in USDT | [optional] +**repaidAmountUsdt** | **String** | Repayment amount converted to USDT | [optional] diff --git a/docs/RiskUnits.md b/docs/RiskUnits.md index 1dc90c7..ffbb7d1 100644 --- a/docs/RiskUnits.md +++ b/docs/RiskUnits.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **symbol** | **String** | Risk unit flag | [optional] -**spotInUse** | **String** | Spot hedging utilization | [optional] +**spotInUse** | **String** | Spot hedging occupied amount | [optional] **maintainMargin** | **String** | Maintenance margin for risk unit | [optional] **initialMargin** | **String** | Initial margin for risk unit | [optional] **delta** | **String** | Total Delta of risk unit | [optional] diff --git a/docs/SmallBalance.md b/docs/SmallBalance.md index 6c9da17..574983d 100644 --- a/docs/SmallBalance.md +++ b/docs/SmallBalance.md @@ -1,7 +1,7 @@ # SmallBalance -Convert Small Balance +Small Balance Conversion ## Properties diff --git a/docs/SmallBalanceHistory.md b/docs/SmallBalanceHistory.md index 7e07d95..3471863 100644 --- a/docs/SmallBalanceHistory.md +++ b/docs/SmallBalanceHistory.md @@ -1,7 +1,7 @@ # SmallBalanceHistory -Convert Small Balance +Small Balance Conversion ## Properties @@ -9,7 +9,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | Order ID | [optional] [readonly] **currency** | **String** | Currency | [optional] [readonly] -**amount** | **String** | amount | [optional] [readonly] +**amount** | **String** | Swap Amount | [optional] [readonly] **gtAmount** | **String** | GT amount | [optional] [readonly] **createTime** | **Long** | Exchange time (in seconds) | [optional] [readonly] diff --git a/docs/SpotAccountBook.md b/docs/SpotAccountBook.md index 9052b55..9e7096f 100644 --- a/docs/SpotAccountBook.md +++ b/docs/SpotAccountBook.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **currency** | **String** | Currency changed | [optional] **change** | **String** | Amount changed. Positive value means transferring in, while negative out | [optional] **balance** | **String** | Balance after change | [optional] -**type** | **String** | Account book type. Please refer to [account book type](#accountbook-type) for more detail | [optional] +**type** | **String** | Account book type. Please refer to [account book type](#accountbook-type) for more detail | [optional] **code** | **String** | Account change code, see [Asset Record Code] (Asset Record Code) | [optional] **text** | **String** | Additional information | [optional] diff --git a/docs/SpotApi.md b/docs/SpotApi.md index 850b617..a77f802 100644 --- a/docs/SpotApi.md +++ b/docs/SpotApi.md @@ -4,47 +4,47 @@ All URIs are relative to *https://api.gateio.ws/api/v4* Method | HTTP request | Description ------------- | ------------- | ------------- -[**listCurrencies**](SpotApi.md#listCurrencies) | **GET** /spot/currencies | List all currencies' details -[**getCurrency**](SpotApi.md#getCurrency) | **GET** /spot/currencies/{currency} | Get details of a specific currency -[**listCurrencyPairs**](SpotApi.md#listCurrencyPairs) | **GET** /spot/currency_pairs | List all currency pairs supported -[**getCurrencyPair**](SpotApi.md#getCurrencyPair) | **GET** /spot/currency_pairs/{currency_pair} | Get details of a specifc currency pair -[**listTickers**](SpotApi.md#listTickers) | **GET** /spot/tickers | Retrieve ticker information -[**listOrderBook**](SpotApi.md#listOrderBook) | **GET** /spot/order_book | Retrieve order book -[**listTrades**](SpotApi.md#listTrades) | **GET** /spot/trades | Retrieve market trades -[**listCandlesticks**](SpotApi.md#listCandlesticks) | **GET** /spot/candlesticks | Market candlesticks -[**getFee**](SpotApi.md#getFee) | **GET** /spot/fee | Query user trading fee rates -[**getBatchSpotFee**](SpotApi.md#getBatchSpotFee) | **GET** /spot/batch_fee | Query a batch of user trading fee rates -[**listSpotAccounts**](SpotApi.md#listSpotAccounts) | **GET** /spot/accounts | List spot accounts -[**listSpotAccountBook**](SpotApi.md#listSpotAccountBook) | **GET** /spot/account_book | Query account book -[**createBatchOrders**](SpotApi.md#createBatchOrders) | **POST** /spot/batch_orders | Create a batch of orders +[**listCurrencies**](SpotApi.md#listCurrencies) | **GET** /spot/currencies | Query all currency information +[**getCurrency**](SpotApi.md#getCurrency) | **GET** /spot/currencies/{currency} | Query single currency information +[**listCurrencyPairs**](SpotApi.md#listCurrencyPairs) | **GET** /spot/currency_pairs | Query all supported currency pairs +[**getCurrencyPair**](SpotApi.md#getCurrencyPair) | **GET** /spot/currency_pairs/{currency_pair} | Query single currency pair details +[**listTickers**](SpotApi.md#listTickers) | **GET** /spot/tickers | Get currency pair ticker information +[**listOrderBook**](SpotApi.md#listOrderBook) | **GET** /spot/order_book | Get market depth information +[**listTrades**](SpotApi.md#listTrades) | **GET** /spot/trades | Query market transaction records +[**listCandlesticks**](SpotApi.md#listCandlesticks) | **GET** /spot/candlesticks | Market K-line chart +[**getFee**](SpotApi.md#getFee) | **GET** /spot/fee | Query account fee rates +[**getBatchSpotFee**](SpotApi.md#getBatchSpotFee) | **GET** /spot/batch_fee | Batch query account fee rates +[**listSpotAccounts**](SpotApi.md#listSpotAccounts) | **GET** /spot/accounts | List spot trading accounts +[**listSpotAccountBook**](SpotApi.md#listSpotAccountBook) | **GET** /spot/account_book | Query spot account transaction history +[**createBatchOrders**](SpotApi.md#createBatchOrders) | **POST** /spot/batch_orders | Batch place orders [**listAllOpenOrders**](SpotApi.md#listAllOpenOrders) | **GET** /spot/open_orders | List all open orders -[**createCrossLiquidateOrder**](SpotApi.md#createCrossLiquidateOrder) | **POST** /spot/cross_liquidate_orders | close position when cross-currency is disabled +[**createCrossLiquidateOrder**](SpotApi.md#createCrossLiquidateOrder) | **POST** /spot/cross_liquidate_orders | Close position when cross-currency is disabled [**listOrders**](SpotApi.md#listOrders) | **GET** /spot/orders | List orders [**createOrder**](SpotApi.md#createOrder) | **POST** /spot/orders | Create an order [**cancelOrders**](SpotApi.md#cancelOrders) | **DELETE** /spot/orders | Cancel all `open` orders in specified currency pair -[**cancelBatchOrders**](SpotApi.md#cancelBatchOrders) | **POST** /spot/cancel_batch_orders | Cancel a batch of orders with an ID list -[**getOrder**](SpotApi.md#getOrder) | **GET** /spot/orders/{order_id} | Get a single order -[**cancelOrder**](SpotApi.md#cancelOrder) | **DELETE** /spot/orders/{order_id} | Cancel a single order -[**amendOrder**](SpotApi.md#amendOrder) | **PATCH** /spot/orders/{order_id} | Amend an order -[**listMyTrades**](SpotApi.md#listMyTrades) | **GET** /spot/my_trades | List personal trading history +[**cancelBatchOrders**](SpotApi.md#cancelBatchOrders) | **POST** /spot/cancel_batch_orders | Cancel batch orders by specified ID list +[**getOrder**](SpotApi.md#getOrder) | **GET** /spot/orders/{order_id} | Query single order details +[**cancelOrder**](SpotApi.md#cancelOrder) | **DELETE** /spot/orders/{order_id} | Cancel single order +[**amendOrder**](SpotApi.md#amendOrder) | **PATCH** /spot/orders/{order_id} | Amend single order +[**listMyTrades**](SpotApi.md#listMyTrades) | **GET** /spot/my_trades | Query personal trading records [**getSystemTime**](SpotApi.md#getSystemTime) | **GET** /spot/time | Get server current time [**countdownCancelAllSpot**](SpotApi.md#countdownCancelAllSpot) | **POST** /spot/countdown_cancel_all | Countdown cancel orders [**amendBatchOrders**](SpotApi.md#amendBatchOrders) | **POST** /spot/amend_batch_orders | Batch modification of orders [**getSpotInsuranceHistory**](SpotApi.md#getSpotInsuranceHistory) | **GET** /spot/insurance_history | Query spot insurance fund historical data -[**listSpotPriceTriggeredOrders**](SpotApi.md#listSpotPriceTriggeredOrders) | **GET** /spot/price_orders | Retrieve running auto order list -[**createSpotPriceTriggeredOrder**](SpotApi.md#createSpotPriceTriggeredOrder) | **POST** /spot/price_orders | Create a price-triggered order -[**cancelSpotPriceTriggeredOrderList**](SpotApi.md#cancelSpotPriceTriggeredOrderList) | **DELETE** /spot/price_orders | Cancel All Price-triggered Orders -[**getSpotPriceTriggeredOrder**](SpotApi.md#getSpotPriceTriggeredOrder) | **GET** /spot/price_orders/{order_id} | Get a price-triggered order -[**cancelSpotPriceTriggeredOrder**](SpotApi.md#cancelSpotPriceTriggeredOrder) | **DELETE** /spot/price_orders/{order_id} | cancel a price-triggered order +[**listSpotPriceTriggeredOrders**](SpotApi.md#listSpotPriceTriggeredOrders) | **GET** /spot/price_orders | Query running auto order list +[**createSpotPriceTriggeredOrder**](SpotApi.md#createSpotPriceTriggeredOrder) | **POST** /spot/price_orders | Create price-triggered order +[**cancelSpotPriceTriggeredOrderList**](SpotApi.md#cancelSpotPriceTriggeredOrderList) | **DELETE** /spot/price_orders | Cancel all auto orders +[**getSpotPriceTriggeredOrder**](SpotApi.md#getSpotPriceTriggeredOrder) | **GET** /spot/price_orders/{order_id} | Query single auto order details +[**cancelSpotPriceTriggeredOrder**](SpotApi.md#cancelSpotPriceTriggeredOrder) | **DELETE** /spot/price_orders/{order_id} | Cancel single auto order # **listCurrencies** > List<Currency> listCurrencies() -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 @@ -98,13 +98,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **getCurrency** > Currency getCurrency(currency) -Get details of a specific currency +Query single currency information ### Example @@ -162,13 +162,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listCurrencyPairs** > List<CurrencyPair> listCurrencyPairs() -List all currency pairs supported +Query all supported currency pairs ### Example @@ -228,7 +228,7 @@ No authorization required # **getCurrencyPair** > CurrencyPair getCurrencyPair(currencyPair) -Get details of a specifc currency pair +Query single currency pair details ### Example @@ -286,15 +286,15 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listTickers** > List<Ticker> listTickers().currencyPair(currencyPair).timezone(timezone).execute(); -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 @@ -357,15 +357,15 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listOrderBook** > OrderBook listOrderBook(currencyPair).interval(interval).limit(limit).withId(withId).execute(); -Retrieve order book +Get market depth information -Order book will be sorted by price from high to low on bids; low to high on asks +Market depth buy orders are sorted by price from high to low, sell orders are sorted from low to high ### Example @@ -385,9 +385,9 @@ public class Example { SpotApi apiInstance = new SpotApi(defaultClient); String currencyPair = "BTC_USDT"; // String | Currency pair - String interval = "\"0\""; // String | Order depth. 0 means no aggregation is applied. default to 0 - Integer limit = 10; // Integer | Maximum number of order depth data in asks or bids - Boolean withId = false; // Boolean | Return order book ID + String interval = "\"0\""; // String | Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified + Integer limit = 10; // Integer | Number of depth levels + Boolean withId = false; // Boolean | Return order book update ID try { OrderBook result = apiInstance.listOrderBook(currencyPair) .interval(interval) @@ -413,9 +413,9 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **currencyPair** | **String**| Currency pair | - **interval** | **String**| Order depth. 0 means no aggregation is applied. default to 0 | [optional] [default to "0"] - **limit** | **Integer**| Maximum number of order depth data in asks or bids | [optional] [default to 10] - **withId** | **Boolean**| Return order book ID | [optional] [default to false] + **interval** | **String**| Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified | [optional] [default to "0"] + **limit** | **Integer**| Number of depth levels | [optional] [default to 10] + **withId** | **Boolean**| Return order book update ID | [optional] [default to false] ### Return type @@ -433,15 +433,15 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listTrades** > List<Trade> listTrades(currencyPair).limit(limit).lastId(lastId).reverse(reverse).from(from).to(to).page(page).execute(); -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, query by time range 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,000, that is, limit * (page - 1) <= 100,000. +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 @@ -461,11 +461,11 @@ public class Example { SpotApi apiInstance = new SpotApi(defaultClient); String currencyPair = "BTC_USDT"; // String | Currency pair - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list. Default: 100, Minimum: 1, Maximum: 1000 - String lastId = "12345"; // String | Specify list staring point using the `id` of last record in previous list-query results - Boolean reverse = false; // Boolean | 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. - Long from = 1627706330L; // Long | Start timestamp of the query - Long to = 1635329650L; // Long | Time range ending, default to current time + Integer limit = 100; // Integer | Maximum number of items returned in list. Default: 100, minimum: 1, maximum: 1000 + String lastId = "12345"; // String | 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 + Boolean reverse = false; // Boolean | 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. + Long from = 1627706330L; // Long | Start timestamp for the query + Long to = 1635329650L; // Long | End timestamp for the query, defaults to current time if not specified Integer page = 1; // Integer | Page number try { List result = apiInstance.listTrades(currencyPair) @@ -495,11 +495,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **currencyPair** | **String**| Currency pair | - **limit** | **Integer**| Maximum number of records to be returned in a single list. Default: 100, Minimum: 1, Maximum: 1000 | [optional] [default to 100] - **lastId** | **String**| Specify list staring point using the `id` of last record in previous list-query results | [optional] - **reverse** | **Boolean**| 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** | **Long**| Start timestamp of the query | [optional] - **to** | **Long**| Time range ending, default to current time | [optional] + **limit** | **Integer**| Maximum number of items returned in list. Default: 100, minimum: 1, maximum: 1000 | [optional] [default to 100] + **lastId** | **String**| 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** | **Boolean**| 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** | **Long**| Start timestamp for the query | [optional] + **to** | **Long**| End timestamp for the query, defaults to current time if not specified | [optional] **page** | **Integer**| Page number | [optional] [default to 1] ### Return type @@ -518,13 +518,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listCandlesticks** > List<List<String>> listCandlesticks(currencyPair).limit(limit).from(from).to(to).interval(interval).execute(); -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 @@ -546,10 +546,10 @@ public class Example { SpotApi apiInstance = new SpotApi(defaultClient); String currencyPair = "BTC_USDT"; // String | Currency pair - Integer limit = 100; // Integer | Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected. + Integer limit = 100; // Integer | 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. Long from = 1546905600L; // Long | Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified - Long to = 1546935600L; // Long | End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time - String interval = "30m"; // String | Interval time between data points. Note that `30d` means 1 natual month, not 30 days + Long to = 1546935600L; // Long | 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 + String interval = "30m"; // String | Time interval between data points. Note that `30d` represents a calendar month, not aligned to 30 days try { List> result = apiInstance.listCandlesticks(currencyPair) .limit(limit) @@ -576,10 +576,10 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **currencyPair** | **String**| Currency pair | - **limit** | **Integer**| Maximum recent data points to return. `limit` is conflicted with `from` and `to`. If either `from` or `to` is specified, request will be rejected. | [optional] [default to 100] + **limit** | **Integer**| 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** | **Long**| Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified | [optional] - **to** | **Long**| End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time | [optional] - **interval** | **String**| Interval time between data points. Note that `30d` means 1 natual month, not 30 days | [optional] [default to 30m] [enum: 1s, 10s, 1m, 5m, 15m, 30m, 1h, 4h, 8h, 1d, 7d, 30d] + **to** | **Long**| 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** | **String**| Time interval between data points. Note that `30d` represents a calendar month, not aligned to 30 days | [optional] [default to 30m] [enum: 1s, 10s, 1m, 5m, 15m, 30m, 1h, 4h, 8h, 1d, 7d, 30d] ### Return type @@ -597,15 +597,15 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **getFee** > SpotFee getFee().currencyPair(currencyPair).execute(); -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 @@ -628,7 +628,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); SpotApi apiInstance = new SpotApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | 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 + String currencyPair = "BTC_USDT"; // String | Specify currency pair to get more accurate fee settings. This field is optional. Usually fee settings are the same for all currency pairs. try { SpotFee result = apiInstance.getFee() .currencyPair(currencyPair) @@ -651,7 +651,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| 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] + **currencyPair** | **String**| 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 @@ -669,13 +669,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **getBatchSpotFee** > Map<String, SpotFee> getBatchSpotFee(currencyPairs) -Query a batch of user trading fee rates +Batch query account fee rates ### Example @@ -698,7 +698,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); SpotApi apiInstance = new SpotApi(defaultClient); - String currencyPairs = "BTC_USDT,ETH_USDT"; // String | A request can only query up to 50 currency pairs + String currencyPairs = "BTC_USDT,ETH_USDT"; // String | Maximum 50 currency pairs per request try { Map result = apiInstance.getBatchSpotFee(currencyPairs); System.out.println(result); @@ -719,7 +719,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPairs** | **String**| A request can only query up to 50 currency pairs | + **currencyPairs** | **String**| Maximum 50 currency pairs per request | ### Return type @@ -737,13 +737,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listSpotAccounts** > List<SpotAccount> listSpotAccounts().currency(currency).execute(); -List spot accounts +List spot trading accounts ### Example @@ -766,7 +766,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); SpotApi apiInstance = new SpotApi(defaultClient); - String currency = "BTC"; // String | Retrieve data of the specified currency + String currency = "BTC"; // String | Query by specified currency name try { List result = apiInstance.listSpotAccounts() .currency(currency) @@ -789,7 +789,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | [optional] + **currency** | **String**| Query by specified currency name | [optional] ### Return type @@ -807,15 +807,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listSpotAccountBook** > List<SpotAccountBook> listSpotAccountBook().currency(currency).from(from).to(to).page(page).limit(limit).type(type).code(code).execute(); -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,000, that is, limit * (page - 1) <= 100,000. +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 @@ -838,13 +838,13 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); SpotApi apiInstance = new SpotApi(defaultClient); - String currency = "BTC"; // String | Retrieve data of the specified currency - Long from = 1627706330L; // Long | Start timestamp of the query - Long to = 1635329650L; // Long | Time range ending, default to current time + String currency = "BTC"; // String | Query by specified currency name + Long from = 1627706330L; // Long | Start timestamp for the query + Long to = 1635329650L; // Long | End timestamp for the query, defaults to current time if not specified Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list - String type = "lend"; // String | Only retrieve changes of the specified type. All types will be returned if not specified. - String code = "code_example"; // String | Specify account change code query, if not specified, all change types are included, and the priority is higher than `type` + Integer limit = 100; // Integer | Maximum number of records returned in a single list + String type = "lend"; // String | Query by specified account change type. If not specified, all change types will be included. + String code = "code_example"; // String | Specify account change code for query. If not specified, all change types are included. This parameter has higher priority than `type` try { List result = apiInstance.listSpotAccountBook() .currency(currency) @@ -873,13 +873,13 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | [optional] - **from** | **Long**| Start timestamp of the query | [optional] - **to** | **Long**| Time range ending, default to current time | [optional] + **currency** | **String**| Query by specified currency name | [optional] + **from** | **Long**| Start timestamp for the query | [optional] + **to** | **Long**| End timestamp for the query, defaults to current time if not specified | [optional] **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] - **type** | **String**| Only retrieve changes of the specified type. All types will be returned if not specified. | [optional] - **code** | **String**| Specify account change code query, if not specified, all change types are included, and the priority is higher than `type` | [optional] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] + **type** | **String**| Query by specified account change type. If not specified, all change types will be included. | [optional] + **code** | **String**| Specify account change code for query. If not specified, all change types are included. This parameter has higher priority than `type` | [optional] ### Return type @@ -897,15 +897,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **createBatchOrders** > List<BatchOrder> createBatchOrders(order, xGateExptime) -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 @@ -969,7 +969,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Request is completed | - | +**200** | Request execution completed | - | # **listAllOpenOrders** @@ -977,7 +977,7 @@ Name | Type | Description | Notes 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 for the number of trading pairs. All trading pairs with pending orders will be returned. +Query the current order list of all trading pairs. Please note that the paging parameter controls the number of pending orders in each trading pair. There is no paging control trading pairs. All trading pairs with pending orders will be returned. ### Example @@ -1002,7 +1002,7 @@ public class Example { SpotApi apiInstance = new SpotApi(defaultClient); Integer page = 1; // Integer | Page number Integer limit = 100; // Integer | Maximum number of records returned in one page in each currency pair - String account = "spot"; // String | Specify query account. + String account = "spot"; // String | Specify query account try { List result = apiInstance.listAllOpenOrders() .page(page) @@ -1029,7 +1029,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page** | **Integer**| Page number | [optional] [default to 1] **limit** | **Integer**| Maximum number of records returned in one page in each currency pair | [optional] [default to 100] - **account** | **String**| Specify query account. | [optional] + **account** | **String**| Specify query account | [optional] ### Return type @@ -1047,15 +1047,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **createCrossLiquidateOrder** > Order createCrossLiquidateOrder(liquidateOrder) -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 @@ -1117,7 +1117,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | order created | - | +**201** | Order created successfully | - | # **listOrders** @@ -1125,7 +1125,7 @@ Name | Type | Description | Notes 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` is set to `finished`, that is, 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 @@ -1148,14 +1148,14 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); SpotApi apiInstance = new SpotApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Retrieve results with specified currency pair. It is required for open orders, but optional for finished ones. + String currencyPair = "BTC_USDT"; // String | Query by specified currency pair. Required for open orders, optional for filled orders String status = "open"; // String | List orders based on status `open` - order is waiting to be filled `finished` - order has been filled or cancelled Integer page = 1; // Integer | Page number Integer limit = 100; // Integer | Maximum number of records to be returned. If `status` is `open`, maximum of `limit` is 100 - String account = "spot"; // String | Specify query account. - Long from = 1627706330L; // Long | Start timestamp of the query - Long to = 1635329650L; // Long | Time range ending, default to current time - String side = "sell"; // String | All bids or asks. Both included if not specified + String account = "spot"; // String | Specify query account + Long from = 1627706330L; // Long | Start timestamp for the query + Long to = 1635329650L; // Long | End timestamp for the query, defaults to current time if not specified + String side = "sell"; // String | Specify all bids or all asks, both included if not specified try { List result = apiInstance.listOrders(currencyPair, status) .page(page) @@ -1183,14 +1183,14 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Retrieve results with specified currency pair. It is required for open orders, but optional for finished ones. | + **currencyPair** | **String**| Query by specified currency pair. Required for open orders, optional for filled orders | **status** | **String**| List orders based on status `open` - order is waiting to be filled `finished` - order has been filled or cancelled | **page** | **Integer**| Page number | [optional] [default to 1] **limit** | **Integer**| Maximum number of records to be returned. If `status` is `open`, maximum of `limit` is 100 | [optional] [default to 100] - **account** | **String**| Specify query account. | [optional] - **from** | **Long**| Start timestamp of the query | [optional] - **to** | **Long**| Time range ending, default to current time | [optional] - **side** | **String**| All bids or asks. Both included if not specified | [optional] + **account** | **String**| Specify query account | [optional] + **from** | **Long**| Start timestamp for the query | [optional] + **to** | **Long**| End timestamp for the query, defaults to current time if not specified | [optional] + **side** | **String**| Specify all bids or all asks, both included if not specified | [optional] ### Return type @@ -1208,7 +1208,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **createOrder** @@ -1216,7 +1216,7 @@ Name | Type | Description | Notes 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 account transactions, that is, when `account` 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 @@ -1280,7 +1280,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Order created. | - | +**201** | Order created | - | # **cancelOrders** @@ -1288,7 +1288,7 @@ Name | Type | Description | Notes 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 `currency_pair` is not specified, all 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 @@ -1312,9 +1312,9 @@ public class Example { SpotApi apiInstance = new SpotApi(defaultClient); String currencyPair = "BTC_USDT"; // String | Currency pair - String side = "sell"; // String | All bids or asks. Both included if not specified - String account = "spot"; // String | Specify Account Type - Classic Account: If not specified, all include - Unified Account: Specify `unified` - String actionMode = "ACK"; // String | 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) + String side = "sell"; // String | Specify all bids or all asks, both included if not specified + String account = "spot"; // String | Specify account type Classic account: All are included if not specified Unified account: Specify `unified` + String actionMode = "ACK"; // String | 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) String xGateExptime = "1689560679123"; // String | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected try { List result = apiInstance.cancelOrders(currencyPair, side, account, actionMode, xGateExptime); @@ -1337,9 +1337,9 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **currencyPair** | **String**| Currency pair | [optional] - **side** | **String**| All bids or asks. Both included if not specified | [optional] - **account** | **String**| Specify Account Type - Classic Account: If not specified, all include - Unified Account: Specify `unified` | [optional] - **actionMode** | **String**| 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] + **side** | **String**| Specify all bids or all asks, both included if not specified | [optional] + **account** | **String**| Specify account type Classic account: All are included if not specified Unified account: Specify `unified` | [optional] + **actionMode** | **String**| 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] **xGateExptime** | **String**| 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 @@ -1358,13 +1358,13 @@ 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 | - | # **cancelBatchOrders** > List<CancelOrderResult> cancelBatchOrders(cancelBatchOrder, xGateExptime) -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 @@ -1436,9 +1436,9 @@ Name | Type | Description | Notes # **getOrder** > Order getOrder(orderId, currencyPair, 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 @@ -1462,8 +1462,8 @@ public class Example { SpotApi apiInstance = new SpotApi(defaultClient); String orderId = "12345"; // String | 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) - String currencyPair = "BTC_USDT"; // String | Specify the transaction pair to query. If you are querying pending order records, this field is required. If you are querying traded records, this field can be left blank. - String account = "spot"; // String | Specify query account. + String currencyPair = "BTC_USDT"; // String | 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. + String account = "spot"; // String | Specify query account try { Order result = apiInstance.getOrder(orderId, currencyPair, account); System.out.println(result); @@ -1485,8 +1485,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **String**| 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) | - **currencyPair** | **String**| Specify the transaction pair to query. If you are querying pending order records, this field is required. If you are querying traded records, this field can be left blank. | - **account** | **String**| Specify query account. | [optional] + **currencyPair** | **String**| 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** | **String**| Specify query account | [optional] ### Return type @@ -1510,7 +1510,7 @@ Name | Type | Description | Notes # **cancelOrder** > Order cancelOrder(orderId, currencyPair, account, actionMode, xGateExptime) -Cancel a single order +Cancel single order By default, orders for spot, unified accounts and leveraged accounts are revoked. @@ -1537,8 +1537,8 @@ public class Example { SpotApi apiInstance = new SpotApi(defaultClient); String orderId = "12345"; // String | 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) String currencyPair = "BTC_USDT"; // String | Currency pair - String account = "spot"; // String | Specify query account. - String actionMode = "ACK"; // String | 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) + String account = "spot"; // String | Specify query account + String actionMode = "ACK"; // String | 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) String xGateExptime = "1689560679123"; // String | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected try { Order result = apiInstance.cancelOrder(orderId, currencyPair, account, actionMode, xGateExptime); @@ -1562,8 +1562,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **String**| 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) | **currencyPair** | **String**| Currency pair | - **account** | **String**| Specify query account. | [optional] - **actionMode** | **String**| 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] + **account** | **String**| Specify query account | [optional] + **actionMode** | **String**| 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] **xGateExptime** | **String**| 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 @@ -1588,9 +1588,9 @@ Name | Type | Description | Notes # **amendOrder** > Order amendOrder(orderId, orderPatch, currencyPair, account, xGateExptime) -Amend an order +Amend single order -By default modify orders for spot, unified account and leverage account. At present, both the request body and query support currency_pair and account parameters, but the request body has higher priority currency_pair must be filled in the request body or query Currently, only the price or quantity modification (choose one of two) About speed limit: Modify orders and create orders to share speed limit rules About matching priority: Only modifying the quantity will become smaller and will not affect the priority of matching. If the price is modified or the quantity is modified, the priority will be adjusted to the end of the new price Precautions: Modification quantity is less than the transaction quantity will trigger the order cancellation operation +Modify orders in spot, unified account and isolated margin account by default. Currently both request body and query support currency_pair and account parameters, but request body has higher priority. currency_pair must be filled in one of the request body or query parameters. About rate limit: Order modification and order creation share the same rate limit rules. About matching priority: Only reducing the quantity does not affect the matching priority. Modifying the price or increasing the quantity will adjust the priority to the end of the new price level. Note: Modifying the quantity to be less than the filled quantity will trigger a cancellation and isolated margin account by default. Currently both request body and query support currency_pair and account parameters, but request body has higher priority. currency_pair must be filled in one of the request body or query parameters. About rate limit: Order modification and order creation share the same rate limit rules. About matching priority: Only reducing the quantity does not affect the matching priority. Modifying the price or increasing the quantity will adjust the priority to the end of the new price level. Note: Modifying the quantity to be less than the filled quantity will trigger a cancellation operation. ### Example @@ -1616,7 +1616,7 @@ public class Example { String orderId = "12345"; // String | 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) OrderPatch orderPatch = new OrderPatch(); // OrderPatch | String currencyPair = "BTC_USDT"; // String | Currency pair - String account = "spot"; // String | Specify query account. + String account = "spot"; // String | Specify query account String xGateExptime = "1689560679123"; // String | Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected try { Order result = apiInstance.amendOrder(orderId, orderPatch, currencyPair, account, xGateExptime); @@ -1641,7 +1641,7 @@ Name | Type | Description | Notes **orderId** | **String**| 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) | **orderPatch** | [**OrderPatch**](OrderPatch.md)| | **currencyPair** | **String**| Currency pair | [optional] - **account** | **String**| Specify query account. | [optional] + **account** | **String**| Specify query account | [optional] **xGateExptime** | **String**| 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 @@ -1660,15 +1660,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Updated | - | +**200** | Updated successfully | - | # **listMyTrades** > List<Trade> listMyTrades().currencyPair(currencyPair).limit(limit).page(page).orderId(orderId).account(account).from(from).to(to).execute(); -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 of `from` and `to` is 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,000, that is, limit * (page - 1) <= 100,000. +By default query of transaction records for spot, unified account and warehouse-by-site leverage accounts. The history within a specified time range can be queried by specifying `from` or (and) `to`. - If no time parameters are specified, only data for the last 7 days can be obtained. - If only any parameter of `from` or `to` is specified, only 7-day data from the start (or end) of the specified time is returned. - The range not allowed to exceed 30 days. The parameters of the time range filter are processed according to the order end time. The maximum number of pages when searching data using limit&page paging function is 100,0, that is, limit * (page - 1) <= 100,0. ### Example @@ -1692,12 +1692,12 @@ public class Example { SpotApi apiInstance = new SpotApi(defaultClient); String currencyPair = "BTC_USDT"; // String | Retrieve results with specified currency pair - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list. Default: 100, Minimum: 1, Maximum: 1000 + Integer limit = 100; // Integer | Maximum number of items returned in list. Default: 100, minimum: 1, maximum: 1000 Integer page = 1; // Integer | Page number String orderId = "12345"; // String | Filter trades with specified order ID. `currency_pair` is also required if this field is present - String account = "spot"; // String | Specify query account. - Long from = 1627706330L; // Long | Start timestamp of the query - Long to = 1635329650L; // Long | Time range ending, default to current time + String account = "spot"; // String | Specify query account + Long from = 1627706330L; // Long | Start timestamp for the query + Long to = 1635329650L; // Long | End timestamp for the query, defaults to current time if not specified try { List result = apiInstance.listMyTrades() .currencyPair(currencyPair) @@ -1727,12 +1727,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **currencyPair** | **String**| Retrieve results with specified currency pair | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list. Default: 100, Minimum: 1, Maximum: 1000 | [optional] [default to 100] + **limit** | **Integer**| Maximum number of items returned in list. Default: 100, minimum: 1, maximum: 1000 | [optional] [default to 100] **page** | **Integer**| Page number | [optional] [default to 1] **orderId** | **String**| Filter trades with specified order ID. `currency_pair` is also required if this field is present | [optional] - **account** | **String**| Specify query account. | [optional] - **from** | **Long**| Start timestamp of the query | [optional] - **to** | **Long**| Time range ending, default to current time | [optional] + **account** | **String**| Specify query account | [optional] + **from** | **Long**| Start timestamp for the query | [optional] + **to** | **Long**| End timestamp for the query, defaults to current time if not specified | [optional] ### Return type @@ -1750,7 +1750,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **getSystemTime** @@ -1810,7 +1810,7 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **countdownCancelAllSpot** @@ -1818,7 +1818,7 @@ No authorization required Countdown cancel orders -When the timeout set by the user is reached, if there is no cancel or set a new countdown, the related pending orders will be automatically cancelled. This endpoint can be called repeatedly to set a new countdown or cancel the countdown. For example, call this endpoint at 30s intervals, each countdown`timeout` is set to 30s. If this endpoint is not called again within 30 seconds, all pending orders on the specified `market` will be automatically cancelled, if no `market` is specified, all market pending orders will be cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the cacnel function will be cancelled. +Spot order heartbeat detection. If there is no \"cancel existing countdown\" or \"set new countdown\" when the user-set `timeout` time is reached, the related `spot pending orders` will be automatically cancelled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at 30s intervals, setting the countdown `timeout` to `30 (seconds)` each time. If this interface is not called again within 30 seconds, all pending orders on the `market` you specified will be automatically cancelled. If no `market` is specified, all market cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will be terminated and the automatic order cancellation function will be cancelled. ### Example @@ -1880,7 +1880,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Set countdown successfully | - | +**200** | Countdown set successfully | - | # **amendBatchOrders** @@ -1888,7 +1888,7 @@ Name | Type | Description | Notes Batch modification of orders -By default modify orders for spot, unified account and leverage account. Currently, only the price or quantity modification (choose one of two) Modify unfinished orders, up to 5 orders can be modified in batches at a time. The request parameters should be passed in array format. When the order modification fails during batch modification, the modification of the order will continue to be executed. After execution, the failure information of the corresponding order will be carried The order of calling the batch modification order is consistent with the order list The order of return content of batch modification orders is consistent with the order list +Modify orders in spot, unified account and isolated margin account by default. Modify uncompleted orders, up to 5 orders can be modified at a time. Request parameters should be passed in array format. If there are order modification failures during the batch modification process, the modification of the next order will continue to be executed, and the execution will return with the corresponding order failure information. The call order of batch modification orders is consistent with the order list order. The return content order of batch modification orders is consistent with the order list order. ### Example @@ -1979,8 +1979,8 @@ public class Example { SpotApi apiInstance = new SpotApi(defaultClient); String business = "margin"; // String | Leverage business, margin - position by position; unified - unified account String currency = "BTC"; // String | Currency - Long from = 1547706332L; // Long | Start timestamp, seconds - Long to = 1547706332L; // Long | End timestamp, in seconds + Long from = 1547706332L; // Long | Start timestamp in seconds + Long to = 1547706332L; // Long | End timestamp in seconds Integer page = 1; // Integer | Page number Integer limit = 30; // Integer | The maximum number of items returned in the list, the default value is 30 try { @@ -2008,8 +2008,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **business** | **String**| Leverage business, margin - position by position; unified - unified account | **currency** | **String**| Currency | - **from** | **Long**| Start timestamp, seconds | - **to** | **Long**| End timestamp, in seconds | + **from** | **Long**| Start timestamp in seconds | + **to** | **Long**| End timestamp in seconds | **page** | **Integer**| Page number | [optional] [default to 1] **limit** | **Integer**| The maximum number of items returned in the list, the default value is 30 | [optional] [default to 30] @@ -2029,13 +2029,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listSpotPriceTriggeredOrders** > List<SpotPriceTriggeredOrder> listSpotPriceTriggeredOrders(status).market(market).account(account).limit(limit).offset(offset).execute(); -Retrieve running auto order list +Query running auto order list ### Example @@ -2058,10 +2058,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); SpotApi apiInstance = new SpotApi(defaultClient); - String status = "status_example"; // String | Only list the orders with this status - String market = "BTC_USDT"; // String | Currency pair - String account = "account_example"; // String | Trading account type. Portfolio margin account must set to `unified` - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + String status = "status_example"; // String | Query order list based on status + String market = "BTC_USDT"; // String | Trading market + String account = "account_example"; // String | Trading account type. Unified account must be set to `unified` + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 try { List result = apiInstance.listSpotPriceTriggeredOrders(status) @@ -2088,10 +2088,10 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **status** | **String**| Only list the orders with this status | [enum: open, finished] - **market** | **String**| Currency pair | [optional] - **account** | **String**| Trading account type. Portfolio margin account must set to `unified` | [optional] [enum: normal, margin, unified] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **status** | **String**| Query order list based on status | [enum: open, finished] + **market** | **String**| Trading market | [optional] + **account** | **String**| Trading account type. Unified account must be set to `unified` | [optional] [enum: normal, margin, unified] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] ### Return type @@ -2110,13 +2110,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **createSpotPriceTriggeredOrder** > TriggerOrderResponse createSpotPriceTriggeredOrder(spotPriceTriggeredOrder) -Create a price-triggered order +Create price-triggered order ### Example @@ -2178,13 +2178,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Order created | - | +**201** | Order created successfully | - | # **cancelSpotPriceTriggeredOrderList** > List<SpotPriceTriggeredOrder> cancelSpotPriceTriggeredOrderList(market, account) -Cancel All Price-triggered Orders +Cancel all auto orders ### Example @@ -2207,8 +2207,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); SpotApi apiInstance = new SpotApi(defaultClient); - String market = "BTC_USDT"; // String | Currency pair - String account = "account_example"; // String | Trading account type. Portfolio margin account must set to `unified` + String market = "BTC_USDT"; // String | Trading market + String account = "account_example"; // String | Trading account type. Unified account must be set to `unified` try { List result = apiInstance.cancelSpotPriceTriggeredOrderList(market, account); System.out.println(result); @@ -2229,8 +2229,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **market** | **String**| Currency pair | [optional] - **account** | **String**| Trading account type. Portfolio margin account must set to `unified` | [optional] [enum: normal, margin, unified] + **market** | **String**| Trading market | [optional] + **account** | **String**| Trading account type. Unified account must be set to `unified` | [optional] [enum: normal, margin, unified] ### Return type @@ -2248,13 +2248,13 @@ 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 | - | # **getSpotPriceTriggeredOrder** > SpotPriceTriggeredOrder getSpotPriceTriggeredOrder(orderId) -Get a price-triggered order +Query single auto order details ### Example @@ -2277,7 +2277,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); SpotApi apiInstance = new SpotApi(defaultClient); - String orderId = "orderId_example"; // String | Retrieve the data of the order with the specified ID + String orderId = "orderId_example"; // String | ID returned when order is successfully created try { SpotPriceTriggeredOrder result = apiInstance.getSpotPriceTriggeredOrder(orderId); System.out.println(result); @@ -2298,7 +2298,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **orderId** | **String**| Retrieve the data of the order with the specified ID | + **orderId** | **String**| ID returned when order is successfully created | ### Return type @@ -2316,13 +2316,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Auto order detail | - | +**200** | Auto order details | - | # **cancelSpotPriceTriggeredOrder** > SpotPriceTriggeredOrder cancelSpotPriceTriggeredOrder(orderId) -cancel a price-triggered order +Cancel single auto order ### Example @@ -2345,7 +2345,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); SpotApi apiInstance = new SpotApi(defaultClient); - String orderId = "orderId_example"; // String | Retrieve the data of the order with the specified ID + String orderId = "orderId_example"; // String | ID returned when order is successfully created try { SpotPriceTriggeredOrder result = apiInstance.cancelSpotPriceTriggeredOrder(orderId); System.out.println(result); @@ -2366,7 +2366,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **orderId** | **String**| Retrieve the data of the order with the specified ID | + **orderId** | **String**| ID returned when order is successfully created | ### Return type @@ -2384,5 +2384,5 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Auto order detail | - | +**200** | Auto order details | - | diff --git a/docs/SpotCurrencyChain.md b/docs/SpotCurrencyChain.md index d0bba74..a5b9ee0 100644 --- a/docs/SpotCurrencyChain.md +++ b/docs/SpotCurrencyChain.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | Chain name | [optional] +**name** | **String** | Blockchain name | [optional] **addr** | **String** | token address | [optional] **withdrawDisabled** | **Boolean** | Whether currency's withdrawal is disabled | [optional] **withdrawDelayed** | **Boolean** | Whether currency's withdrawal is delayed | [optional] diff --git a/docs/SpotFee.md b/docs/SpotFee.md index a979aae..4af52ff 100644 --- a/docs/SpotFee.md +++ b/docs/SpotFee.md @@ -8,11 +8,11 @@ Name | Type | Description | Notes **userId** | **Long** | User ID | [optional] **takerFee** | **String** | taker fee rate | [optional] **makerFee** | **String** | maker fee rate | [optional] -**gtDiscount** | **Boolean** | If GT deduction is enabled | [optional] +**gtDiscount** | **Boolean** | Whether GT deduction discount is enabled | [optional] **gtTakerFee** | **String** | Taker fee rate if using GT deduction. It will be 0 if GT deduction is disabled | [optional] -**gtMakerFee** | **String** | Maker fee rate if using GT deduction. It will be 0 if GT deduction is disabled | [optional] +**gtMakerFee** | **String** | Maker fee rate with GT deduction. Returns 0 if GT deduction is disabled | [optional] **loanFee** | **String** | Loan fee rate of margin lending | [optional] -**pointType** | **String** | Point type. 0 - Initial version. 1 - new version since 202009 | [optional] +**pointType** | **String** | Point card type: 0 - Original version, 1 - New version since 202009 | [optional] **currencyPair** | **String** | Currency pair | [optional] **debitFee** | **Integer** | Deduction types for rates, 1 - GT deduction, 2 - Point card deduction, 3 - VIP rates | [optional] diff --git a/docs/SpotInsuranceHistory.md b/docs/SpotInsuranceHistory.md index 5744744..9a5427d 100644 --- a/docs/SpotInsuranceHistory.md +++ b/docs/SpotInsuranceHistory.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | Currency | [optional] -**balance** | **String** | balance | [optional] +**balance** | **String** | Balance | [optional] **time** | **Long** | Creation time, timestamp, milliseconds | [optional] diff --git a/docs/SpotPricePutOrder.md b/docs/SpotPricePutOrder.md index 62281ee..96165ab 100644 --- a/docs/SpotPricePutOrder.md +++ b/docs/SpotPricePutOrder.md @@ -8,12 +8,12 @@ Name | Type | Description | Notes **type** | [**TypeEnum**](#TypeEnum) | Order type，default to `limit` - limit : Limit Order - market : Market Order | [optional] **side** | [**SideEnum**](#SideEnum) | Order side - buy: buy side - sell: sell side | **price** | **String** | Order price | -**amount** | **String** | When `type` is limit, it refers to base currency. For instance, `BTC_USDT` means `BTC` When `type` is `market`, it refers to different currency according to `side` - `side` : `buy` means quote currency, `BTC_USDT` means `USDT` - `side` : `sell` means base currency，`BTC_USDT` means `BTC` | -**account** | [**AccountEnum**](#AccountEnum) | Trading account type. Portfolio margin account must set to `unified` - normal: spot trading - margin: margin trading - unified: unified trading | +**amount** | **String** | 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** | [**AccountEnum**](#AccountEnum) | Trading account type. Unified account must be set to `unified` - normal: spot trading - margin: margin trading - unified: unified account | **timeInForce** | [**TimeInForceEnum**](#TimeInForceEnum) | time_in_force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only | [optional] **autoBorrow** | **Boolean** | Whether to borrow coins automatically | [optional] **autoRepay** | **Boolean** | Whether to repay the loan automatically | [optional] -**text** | **String** | The source of the order, including: - web: web - api: api - app: app | [optional] +**text** | **String** | The source of the order, including: - web: Web - api: API call - app: Mobile app | [optional] ## Enum: TypeEnum diff --git a/docs/SpotPriceTrigger.md b/docs/SpotPriceTrigger.md index 2da8bfc..cc6f694 100644 --- a/docs/SpotPriceTrigger.md +++ b/docs/SpotPriceTrigger.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **price** | **String** | Trigger price | -**rule** | [**RuleEnum**](#RuleEnum) | Price trigger condition - >=: triggered when market price larger than or equal to `price` field - <=: triggered when market price less than or equal to `price` field | -**expiration** | **Integer** | How long (in seconds) to wait for the condition to be triggered before cancelling the order. | +**rule** | [**RuleEnum**](#RuleEnum) | 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** | **Integer** | Maximum wait time for trigger condition (in seconds). Order will be cancelled if timeout | ## Enum: RuleEnum diff --git a/docs/SpotPriceTriggeredOrder.md b/docs/SpotPriceTriggeredOrder.md index 818c34d..d7ba163 100644 --- a/docs/SpotPriceTriggeredOrder.md +++ b/docs/SpotPriceTriggeredOrder.md @@ -1,7 +1,7 @@ # SpotPriceTriggeredOrder -Spot order detail +Spot price order details ## Properties @@ -11,10 +11,10 @@ Name | Type | Description | Notes **put** | [**SpotPricePutOrder**](SpotPricePutOrder.md) | | **id** | **Long** | Auto order ID | [optional] [readonly] **user** | **Integer** | User ID | [optional] [readonly] -**market** | **String** | Currency pair | -**ctime** | **Long** | Creation time | [optional] [readonly] -**ftime** | **Long** | Finished time | [optional] [readonly] -**firedOrderId** | **Long** | ID of the newly created order on condition triggered | [optional] [readonly] -**status** | **String** | Status - open: open - cancelled: being manually cancelled - finish: successfully executed - failed: failed to execute - expired - expired | [optional] [readonly] -**reason** | **String** | Additional remarks on how the order was finished | [optional] [readonly] +**market** | **String** | Market | +**ctime** | **Long** | Created time | [optional] [readonly] +**ftime** | **Long** | End time | [optional] [readonly] +**firedOrderId** | **Long** | ID of the order created after trigger | [optional] [readonly] +**status** | **String** | Status - open: Running - cancelled: Manually cancelled - finish: Successfully completed - failed: Failed to execute - expired: Expired | [optional] [readonly] +**reason** | **String** | Additional description of how the order was completed | [optional] [readonly] diff --git a/docs/StpGroup.md b/docs/StpGroup.md index 42eaa7b..732f17c 100644 --- a/docs/StpGroup.md +++ b/docs/StpGroup.md @@ -8,5 +8,5 @@ Name | Type | Description | Notes **id** | **Long** | STP Group ID | [optional] **name** | **String** | STP Group name | **creatorId** | **Long** | Creator ID | [optional] -**createTime** | **Long** | Creation time | [optional] +**createTime** | **Long** | Created time | [optional] diff --git a/docs/StpGroupUser.md b/docs/StpGroupUser.md index fc9787d..b873a7c 100644 --- a/docs/StpGroupUser.md +++ b/docs/StpGroupUser.md @@ -7,5 +7,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **userId** | **Long** | User ID | [optional] **stpId** | **Long** | STP Group ID | [optional] -**createTime** | **Long** | Creation time | [optional] +**createTime** | **Long** | Created time | [optional] diff --git a/docs/StructuredBuy.md b/docs/StructuredBuy.md index a587bb8..3a10b82 100644 --- a/docs/StructuredBuy.md +++ b/docs/StructuredBuy.md @@ -1,12 +1,12 @@ # StructuredBuy -Dual Investment Purchase +Dual Investment Buy ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**pid** | **String** | Plan ID | [optional] -**amount** | **String** | Purchase Amount | [optional] +**pid** | **String** | Product ID | [optional] +**amount** | **String** | Buy Quantity | [optional] diff --git a/docs/StructuredGetProjectList.md b/docs/StructuredGetProjectList.md index d53b404..78a37ac 100644 --- a/docs/StructuredGetProjectList.md +++ b/docs/StructuredGetProjectList.md @@ -1,22 +1,22 @@ # StructuredGetProjectList -Structured Products +Structured Investment ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Integer** | Plan ID | [optional] -**type** | **String** | 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] -**nameEn** | **String** | name | [optional] -**investmentCoin** | **String** | Investment Currency | [optional] -**investmentPeriod** | **String** | Investment term | [optional] -**minAnnualRate** | **String** | Minimum annual rate | [optional] -**midAnnualRate** | **String** | Intermediate annual rate | [optional] -**maxAnnualRate** | **String** | Maximum annual rate | [optional] -**watchMarket** | **String** | Watch market | [optional] -**startTime** | **Integer** | start time | [optional] -**endTime** | **Integer** | Finished time | [optional] +**id** | **Integer** | Product ID | [optional] +**type** | **String** | 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] +**nameEn** | **String** | Product Name | [optional] +**investmentCoin** | **String** | Investment Token | [optional] +**investmentPeriod** | **String** | Investment Period | [optional] +**minAnnualRate** | **String** | Minimum Annual Rate | [optional] +**midAnnualRate** | **String** | Intermediate Annual Rate | [optional] +**maxAnnualRate** | **String** | Maximum Annual Rate | [optional] +**watchMarket** | **String** | Underlying Market | [optional] +**startTime** | **Integer** | Start Time | [optional] +**endTime** | **Integer** | End time | [optional] **status** | **String** | Status: `in_process`-in progress `will_begin`-will begin `wait_settlement`-waiting for settlement `done`-done | [optional] diff --git a/docs/StructuredOrderList.md b/docs/StructuredOrderList.md index 579385c..5b25dc7 100644 --- a/docs/StructuredOrderList.md +++ b/docs/StructuredOrderList.md @@ -8,7 +8,7 @@ Structured order Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Integer** | Order ID | [optional] -**pid** | **String** | Plan ID | [optional] +**pid** | **String** | Product ID | [optional] **lockCoin** | **String** | Locked coin | [optional] **amount** | **String** | Locked amount | [optional] **status** | **String** | Status: SUCCESS - SUCCESS FAILED - FAILED DONE - DONE | [optional] diff --git a/docs/SubAccount.md b/docs/SubAccount.md index b0ab679..277844e 100644 --- a/docs/SubAccount.md +++ b/docs/SubAccount.md @@ -5,12 +5,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**remark** | **String** | custom text | [optional] -**loginName** | **String** | Sub-account login name: Only letters, numbers and underscores are supported, and cannot contain other illegal characters | +**remark** | **String** | Remark | [optional] +**loginName** | **String** | Sub-account login name: Only letters, numbers and underscores are supported, cannot contain other invalid characters | **password** | **String** | The sub-account's password. (Default: the same as main account's password) | [optional] **email** | **String** | The sub-account's email address. (Default: the same as main account's email address) | [optional] -**state** | **Integer** | State: 1-normal, 2-locked\" | [optional] [readonly] -**type** | **Integer** | \"Sub-account type: 1 - sub-account, 3 - cross margin account | [optional] [readonly] -**userId** | **Long** | The user id of the sub-account | [optional] [readonly] +**state** | **Integer** | Sub-account status: 1-normal, 2-locked | [optional] [readonly] +**type** | **Integer** | Sub-account type: 1-Regular sub-account, 3-Cross margin sub-account | [optional] [readonly] +**userId** | **Long** | Sub-account user ID | [optional] [readonly] **createTime** | **Long** | Created time | [optional] [readonly] diff --git a/docs/SubAccountApi.md b/docs/SubAccountApi.md index 9f6c998..439800d 100644 --- a/docs/SubAccountApi.md +++ b/docs/SubAccountApi.md @@ -6,14 +6,14 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**listSubAccounts**](SubAccountApi.md#listSubAccounts) | **GET** /sub_accounts | List sub-accounts [**createSubAccounts**](SubAccountApi.md#createSubAccounts) | **POST** /sub_accounts | Create a new sub-account -[**getSubAccount**](SubAccountApi.md#getSubAccount) | **GET** /sub_accounts/{user_id} | Get the sub-account -[**listSubAccountKeys**](SubAccountApi.md#listSubAccountKeys) | **GET** /sub_accounts/{user_id}/keys | List all API Key of the sub-account -[**createSubAccountKeys**](SubAccountApi.md#createSubAccountKeys) | **POST** /sub_accounts/{user_id}/keys | Create API Key of the sub-account -[**getSubAccountKey**](SubAccountApi.md#getSubAccountKey) | **GET** /sub_accounts/{user_id}/keys/{key} | Get the API Key of the sub-account -[**updateSubAccountKeys**](SubAccountApi.md#updateSubAccountKeys) | **PUT** /sub_accounts/{user_id}/keys/{key} | Update API key of the sub-account -[**deleteSubAccountKeys**](SubAccountApi.md#deleteSubAccountKeys) | **DELETE** /sub_accounts/{user_id}/keys/{key} | Delete API key of the sub-account -[**lockSubAccount**](SubAccountApi.md#lockSubAccount) | **POST** /sub_accounts/{user_id}/lock | Lock the sub-account -[**unlockSubAccount**](SubAccountApi.md#unlockSubAccount) | **POST** /sub_accounts/{user_id}/unlock | Unlock the sub-account +[**getSubAccount**](SubAccountApi.md#getSubAccount) | **GET** /sub_accounts/{user_id} | Get sub-account +[**listSubAccountKeys**](SubAccountApi.md#listSubAccountKeys) | **GET** /sub_accounts/{user_id}/keys | List all API key pairs of the sub-account +[**createSubAccountKeys**](SubAccountApi.md#createSubAccountKeys) | **POST** /sub_accounts/{user_id}/keys | Create new sub-account API key pair +[**getSubAccountKey**](SubAccountApi.md#getSubAccountKey) | **GET** /sub_accounts/{user_id}/keys/{key} | Get specific API key pair of the sub-account +[**updateSubAccountKeys**](SubAccountApi.md#updateSubAccountKeys) | **PUT** /sub_accounts/{user_id}/keys/{key} | Update sub-account API key pair +[**deleteSubAccountKeys**](SubAccountApi.md#deleteSubAccountKeys) | **DELETE** /sub_accounts/{user_id}/keys/{key} | Delete sub-account API key pair +[**lockSubAccount**](SubAccountApi.md#lockSubAccount) | **POST** /sub_accounts/{user_id}/lock | Lock sub-account +[**unlockSubAccount**](SubAccountApi.md#unlockSubAccount) | **POST** /sub_accounts/{user_id}/unlock | Unlock sub-account [**listUnifiedMode**](SubAccountApi.md#listUnifiedMode) | **GET** /sub_accounts/unified_mode | Get sub-account mode @@ -44,7 +44,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); SubAccountApi apiInstance = new SubAccountApi(defaultClient); - String type = "0"; // String | `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. + String type = "0"; // String | 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. try { List result = apiInstance.listSubAccounts() .type(type) @@ -67,7 +67,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **type** | **String**| `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** | **String**| 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 @@ -85,7 +85,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **createSubAccounts** @@ -153,13 +153,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Created Successfully | - | +**201** | Created successfully | - | # **getSubAccount** > SubAccount getSubAccount(userId) -Get the sub-account +Get sub-account ### Example @@ -182,7 +182,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); SubAccountApi apiInstance = new SubAccountApi(defaultClient); - Long userId = 56L; // Long | Sub-account user id + Long userId = 56L; // Long | Sub-account user ID try { SubAccount result = apiInstance.getSubAccount(userId); System.out.println(result); @@ -203,7 +203,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **userId** | **Long**| Sub-account user id | + **userId** | **Long**| Sub-account user ID | ### Return type @@ -221,13 +221,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful | - | +**200** | Successfully retrieved | - | # **listSubAccountKeys** > List<SubAccountKey> listSubAccountKeys(userId) -List all API Key of the sub-account +List all API key pairs of the sub-account ### Example @@ -250,7 +250,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); SubAccountApi apiInstance = new SubAccountApi(defaultClient); - Integer userId = 56; // Integer | Sub-account user id + Integer userId = 56; // Integer | Sub-account user ID try { List result = apiInstance.listSubAccountKeys(userId); System.out.println(result); @@ -271,7 +271,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **userId** | **Integer**| Sub-account user id | + **userId** | **Integer**| Sub-account user ID | ### Return type @@ -289,13 +289,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **createSubAccountKeys** -> List<SubAccountKey> createSubAccountKeys(userId, subAccountKey) +> SubAccountKey createSubAccountKeys(userId, subAccountKey) -Create API Key of the sub-account +Create new sub-account API key pair ### Example @@ -318,10 +318,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); SubAccountApi apiInstance = new SubAccountApi(defaultClient); - Long userId = 56L; // Long | Sub-account user id + Long userId = 56L; // Long | Sub-account user ID SubAccountKey subAccountKey = new SubAccountKey(); // SubAccountKey | try { - List result = apiInstance.createSubAccountKeys(userId, subAccountKey); + SubAccountKey result = apiInstance.createSubAccountKeys(userId, subAccountKey); System.out.println(result); } catch (GateApiException e) { System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage())); @@ -340,12 +340,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **userId** | **Long**| Sub-account user id | + **userId** | **Long**| Sub-account user ID | **subAccountKey** | [**SubAccountKey**](SubAccountKey.md)| | ### Return type -[**List<SubAccountKey>**](SubAccountKey.md) +[**SubAccountKey**](SubAccountKey.md) ### Authorization @@ -359,13 +359,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Created Successfully | - | +**200** | Created successfully | - | # **getSubAccountKey** > SubAccountKey getSubAccountKey(userId, key) -Get the API Key of the sub-account +Get specific API key pair of the sub-account ### Example @@ -388,8 +388,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); SubAccountApi apiInstance = new SubAccountApi(defaultClient); - Integer userId = 56; // Integer | Sub-account user id - String key = "key_example"; // String | The API Key of the sub-account + Integer userId = 56; // Integer | Sub-account user ID + String key = "key_example"; // String | Sub-account API key try { SubAccountKey result = apiInstance.getSubAccountKey(userId, key); System.out.println(result); @@ -410,8 +410,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **userId** | **Integer**| Sub-account user id | - **key** | **String**| The API Key of the sub-account | + **userId** | **Integer**| Sub-account user ID | + **key** | **String**| Sub-account API key | ### Return type @@ -429,13 +429,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful | - | +**200** | Successfully retrieved | - | # **updateSubAccountKeys** > updateSubAccountKeys(userId, key, subAccountKey) -Update API key of the sub-account +Update sub-account API key pair ### Example @@ -458,8 +458,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); SubAccountApi apiInstance = new SubAccountApi(defaultClient); - Integer userId = 56; // Integer | Sub-account user id - String key = "key_example"; // String | The API Key of the sub-account + Integer userId = 56; // Integer | Sub-account user ID + String key = "key_example"; // String | Sub-account API key SubAccountKey subAccountKey = new SubAccountKey(); // SubAccountKey | try { apiInstance.updateSubAccountKeys(userId, key, subAccountKey); @@ -480,8 +480,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **userId** | **Integer**| Sub-account user id | - **key** | **String**| The API Key of the sub-account | + **userId** | **Integer**| Sub-account user ID | + **key** | **String**| Sub-account API key | **subAccountKey** | [**SubAccountKey**](SubAccountKey.md)| | ### Return type @@ -500,13 +500,13 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Updated | - | +**204** | Updated successfully | - | # **deleteSubAccountKeys** > deleteSubAccountKeys(userId, key) -Delete API key of the sub-account +Delete sub-account API key pair ### Example @@ -529,8 +529,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); SubAccountApi apiInstance = new SubAccountApi(defaultClient); - Integer userId = 56; // Integer | Sub-account user id - String key = "key_example"; // String | The API Key of the sub-account + Integer userId = 56; // Integer | Sub-account user ID + String key = "key_example"; // String | Sub-account API key try { apiInstance.deleteSubAccountKeys(userId, key); } catch (GateApiException e) { @@ -550,8 +550,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **userId** | **Integer**| Sub-account user id | - **key** | **String**| The API Key of the sub-account | + **userId** | **Integer**| Sub-account user ID | + **key** | **String**| Sub-account API key | ### Return type @@ -569,13 +569,13 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Delete successfully | - | +**204** | Deleted successfully | - | # **lockSubAccount** > lockSubAccount(userId) -Lock the sub-account +Lock sub-account ### Example @@ -598,7 +598,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); SubAccountApi apiInstance = new SubAccountApi(defaultClient); - Long userId = 56L; // Long | The user id of the sub-account + Long userId = 56L; // Long | Sub-account user ID try { apiInstance.lockSubAccount(userId); } catch (GateApiException e) { @@ -618,7 +618,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **userId** | **Long**| The user id of the sub-account | + **userId** | **Long**| Sub-account user ID | ### Return type @@ -636,13 +636,13 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Lock successfully | - | +**204** | Locked successfully | - | # **unlockSubAccount** > unlockSubAccount(userId) -Unlock the sub-account +Unlock sub-account ### Example @@ -665,7 +665,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); SubAccountApi apiInstance = new SubAccountApi(defaultClient); - Long userId = 56L; // Long | The user id of the sub-account + Long userId = 56L; // Long | Sub-account user ID try { apiInstance.unlockSubAccount(userId); } catch (GateApiException e) { @@ -685,7 +685,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **userId** | **Long**| The user id of the sub-account | + **userId** | **Long**| Sub-account user ID | ### Return type @@ -703,7 +703,7 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Unlock successfully | - | +**204** | Unlocked successfully | - | # **listUnifiedMode** @@ -711,7 +711,7 @@ null (empty response body) Get sub-account mode -Unified account mode： - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode +Unified account mode: - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode ### Example @@ -769,5 +769,5 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | diff --git a/docs/SubAccountKey.md b/docs/SubAccountKey.md index 7f3e84a..a9700da 100644 --- a/docs/SubAccountKey.md +++ b/docs/SubAccountKey.md @@ -5,14 +5,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **String** | User ID | [optional] [readonly] +**userId** | **Long** | User ID | [optional] [readonly] **mode** | **Integer** | Mode: 1 - classic 2 - portfolio account | [optional] -**name** | **String** | API key name | [optional] +**name** | **String** | API Key Name | [optional] **perms** | [**List<SubAccountKeyPerms>**](SubAccountKeyPerms.md) | | [optional] -**ipWhitelist** | **List<String>** | ip white list (list will be removed if no value is passed) | [optional] +**ipWhitelist** | **List<String>** | IP whitelist (list will be cleared if no value is passed) | [optional] **key** | **String** | API Key | [optional] [readonly] -**state** | **Integer** | State 1 - normal 2 - locked 3 - frozen | [optional] [readonly] -**createdAt** | **Long** | Creation time | [optional] [readonly] -**updatedAt** | **Long** | Last update time | [optional] [readonly] -**lastAccess** | **Long** | Last access time | [optional] [readonly] +**state** | **Integer** | Status: 1-Normal 2-Frozen 3-Locked | [optional] [readonly] +**createdAt** | **Long** | Created time | [optional] [readonly] +**updatedAt** | **Long** | Last Update Time | [optional] [readonly] +**lastAccess** | **Long** | Last Access Time | [optional] [readonly] diff --git a/docs/SubAccountKeyPerms.md b/docs/SubAccountKeyPerms.md index dc7aad2..78f1a2a 100644 --- a/docs/SubAccountKeyPerms.md +++ b/docs/SubAccountKeyPerms.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | 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] -**readOnly** | **Boolean** | read only | [optional] +**name** | **String** | 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] +**readOnly** | **Boolean** | Read Only | [optional] diff --git a/docs/SubAccountToSubAccount.md b/docs/SubAccountToSubAccount.md index 7c57b16..c15d433 100644 --- a/docs/SubAccountToSubAccount.md +++ b/docs/SubAccountToSubAccount.md @@ -6,10 +6,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | Transfer currency name | -**subAccountType** | **String** | Transfer from the account. (deprecate, use `sub_account_from_type` and `sub_account_to_type` instead) | [optional] +**subAccountType** | **String** | Transfer from account (deprecated, use `sub_account_from_type` and `sub_account_to_type` instead) | [optional] **subAccountFrom** | **String** | Transfer from the user id of the sub-account | -**subAccountFromType** | **String** | The sub-account's outgoing trading account, spot - spot account, futures - perpetual contract account, delivery - delivery contract account. | +**subAccountFromType** | **String** | Source sub-account trading account: spot - spot account, futures - perpetual contract account, delivery - delivery contract account | **subAccountTo** | **String** | Transfer to the user id of the sub-account | -**subAccountToType** | **String** | The sub-account's incoming trading account, spot - spot account, futures - perpetual contract account, delivery - delivery contract account | +**subAccountToType** | **String** | Target sub-account trading account: spot - spot account, futures - perpetual contract account, delivery - delivery contract account | **amount** | **String** | Transfer amount | diff --git a/docs/SubAccountTransfer.md b/docs/SubAccountTransfer.md index 02e08fb..dca8285 100644 --- a/docs/SubAccountTransfer.md +++ b/docs/SubAccountTransfer.md @@ -5,14 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**timest** | **String** | Transfer timestamp | [optional] [readonly] -**uid** | **String** | Main account user ID | [optional] [readonly] **subAccount** | **String** | Sub account user ID | -**subAccountType** | **String** | Target sub user's account. `spot` - spot account, `futures` - perpetual contract account, `delivery` - delivery account | [optional] +**subAccountType** | **String** | Target sub-account trading account: spot - spot account, futures - perpetual contract account, delivery - delivery contract account, options - options account | [optional] **currency** | **String** | Transfer currency name | **amount** | **String** | Transfer amount | -**direction** | **String** | Transfer direction. to - transfer into sub account; from - transfer out from sub account | -**source** | **String** | Where the operation is initiated from | [optional] [readonly] -**clientOrderId** | **String** | 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** | **String** | Sub-account transfer record status, currently only success | [optional] +**direction** | **String** | Transfer direction: to - transfer into sub-account, from - transfer out from sub-account | +**clientOrderId** | **String** | 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] diff --git a/docs/SubAccountTransferRecordItem.md b/docs/SubAccountTransferRecordItem.md new file mode 100644 index 0000000..5b5a70c --- /dev/null +++ b/docs/SubAccountTransferRecordItem.md @@ -0,0 +1,18 @@ + +# SubAccountTransferRecordItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**timest** | **String** | Transfer timestamp | [optional] [readonly] +**uid** | **String** | Main account user ID | [optional] [readonly] +**subAccount** | **String** | Sub account user ID | +**subAccountType** | **String** | Target sub-account trading account: spot - spot account, futures - perpetual contract account, delivery - delivery contract account, options - options account | [optional] +**currency** | **String** | Transfer currency name | +**amount** | **String** | Transfer amount | +**direction** | **String** | Transfer direction: to - transfer into sub-account, from - transfer out from sub-account | +**source** | **String** | Source of the transfer operation | [optional] [readonly] +**clientOrderId** | **String** | 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** | **String** | Sub-account transfer record status, currently only 'success' | [optional] + diff --git a/docs/SubCrossMarginAccount.md b/docs/SubCrossMarginAccount.md index 5c63978..d8c4f02 100644 --- a/docs/SubCrossMarginAccount.md +++ b/docs/SubCrossMarginAccount.md @@ -5,16 +5,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Long** | User ID of the cross margin account. 0 means that the subaccount has not yet opened a cross margin account | [optional] -**locked** | **Boolean** | Whether account is locked | [optional] -**balances** | [**Map<String, CrossMarginBalance1>**](CrossMarginBalance1.md) | | [optional] +**userId** | **Long** | Cross margin account user ID. 0 means this sub-account has not yet opened a cross margin account | [optional] +**locked** | **Boolean** | Whether the account is locked | [optional] +**balances** | [**Map<String, CrossMarginBalance>**](CrossMarginBalance.md) | | [optional] **total** | **String** | Total account value in USDT, i.e., the sum of all currencies' `(available+freeze)*price*discount` | [optional] **borrowed** | **String** | Total borrowed value in USDT, i.e., the sum of all currencies' `borrowed*price*discount` | [optional] -**borrowedNet** | **String** | Total borrowed value in USDT * borrowed factor | [optional] +**borrowedNet** | **String** | Total borrowed value in USDT * leverage factor | [optional] **net** | **String** | Total net assets in USDT | [optional] **leverage** | **String** | Position leverage | [optional] -**interest** | **String** | Total unpaid interests in USDT, i.e., the sum of all currencies' `interest*price*discount` | [optional] -**risk** | **String** | Risk rate. When it belows 110%, liquidation will be triggered. Calculation formula: `total / (borrowed+interest)` | [optional] +**interest** | **String** | Total unpaid interest in USDT, i.e., the sum of all currencies' `interest*price*discount` | [optional] +**risk** | **String** | Risk rate. When it falls below 110%, liquidation will be triggered. Calculation formula: `total / (borrowed+interest)` | [optional] **totalInitialMargin** | **String** | Total initial margin | [optional] **totalMarginBalance** | **String** | Total margin balance | [optional] **totalMaintenanceMargin** | **String** | Total maintenance margin | [optional] diff --git a/docs/SubUserMode.md b/docs/SubUserMode.md index 3e49522..68bb280 100644 --- a/docs/SubUserMode.md +++ b/docs/SubUserMode.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **userId** | **Long** | User ID | [optional] -**isUnified** | **Boolean** | Is it a unified account? | [optional] -**mode** | **String** | Unified account mode： - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode | [optional] +**isUnified** | **Boolean** | Whether it is a unified account | [optional] +**mode** | **String** | Unified account mode: - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode | [optional] diff --git a/docs/SwapCoin.md b/docs/SwapCoin.md new file mode 100644 index 0000000..13f5657 --- /dev/null +++ b/docs/SwapCoin.md @@ -0,0 +1,14 @@ + +# SwapCoin + +Blockchain Mining + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**coin** | **String** | Currency | +**side** | **String** | 0 - Stake 1 - Redeem | +**amount** | **String** | Size | +**pid** | **Integer** | DeFi-type Mining Protocol Identifier | [optional] + diff --git a/docs/SwapCoinStruct.md b/docs/SwapCoinStruct.md new file mode 100644 index 0000000..2fc1966 --- /dev/null +++ b/docs/SwapCoinStruct.md @@ -0,0 +1,23 @@ + +# SwapCoinStruct + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Integer** | Order ID | [optional] +**pid** | **Integer** | Product ID | [optional] +**uid** | **Integer** | User ID | [optional] +**coin** | **String** | Currency | [optional] +**type** | **Integer** | Type 0-Staking 1-Redemption | [optional] +**subtype** | **String** | SubType | [optional] +**amount** | **String** | Amount | [optional] +**exchangeRate** | **String** | Exchange ratio | [optional] +**exchangeAmount** | **String** | Redemption Amount | [optional] +**updateStamp** | **Integer** | UpdateTimestamp | [optional] +**createStamp** | **Integer** | Transaction timestamp | [optional] +**status** | **Integer** | status 1-success | [optional] +**protocolType** | **Integer** | DEFI Protocol Type | [optional] +**clientOrderId** | **String** | Reference ID | [optional] +**source** | **String** | Order Origin | [optional] + diff --git a/docs/Ticker.md b/docs/Ticker.md index da13bfd..77c5da5 100644 --- a/docs/Ticker.md +++ b/docs/Ticker.md @@ -8,18 +8,18 @@ Name | Type | Description | Notes **currencyPair** | **String** | Currency pair | [optional] **last** | **String** | Last trading price | [optional] **lowestAsk** | **String** | Recent lowest ask | [optional] -**lowestSize** | **String** | 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] +**lowestSize** | **String** | Latest seller's lowest price quantity; not available for batch queries; available for single queries, empty if no data | [optional] **highestBid** | **String** | Recent highest bid | [optional] -**highestSize** | **String** | 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] -**changePercentage** | **String** | Change percentage in the last 24h | [optional] -**changeUtc0** | **String** | utc0 timezone, the percentage change in the last 24 hours | [optional] -**changeUtc8** | **String** | utc8 timezone, the percentage change in the last 24 hours | [optional] -**baseVolume** | **String** | Base currency trade volume in the last 24h | [optional] -**quoteVolume** | **String** | Quote currency trade volume in the last 24h | [optional] -**high24h** | **String** | Highest price in 24h | [optional] -**low24h** | **String** | Lowest price in 24h | [optional] +**highestSize** | **String** | Latest buyer's highest price quantity; not available for batch queries; available for single queries, empty if no data | [optional] +**changePercentage** | **String** | 24h price change percentage (negative for decrease, e.g., -7.45) | [optional] +**changeUtc0** | **String** | UTC+0 timezone, 24h price change percentage, negative for decline (e.g., -7.45) | [optional] +**changeUtc8** | **String** | UTC+8 timezone, 24h price change percentage, negative for decline (e.g., -7.45) | [optional] +**baseVolume** | **String** | Base currency trading volume in the last 24h | [optional] +**quoteVolume** | **String** | Quote currency trading volume in the last 24h | [optional] +**high24h** | **String** | 24h High | [optional] +**low24h** | **String** | 24h Low | [optional] **etfNetValue** | **String** | ETF net value | [optional] -**etfPreNetValue** | **String** | ETF previous net value at re-balancing time | [optional] -**etfPreTimestamp** | **Long** | ETF previous re-balancing time | [optional] +**etfPreNetValue** | **String** | ETF net value at previous rebalancing point | [optional] +**etfPreTimestamp** | **Long** | ETF previous rebalancing time | [optional] **etfLeverage** | **String** | ETF current leverage | [optional] diff --git a/docs/TotalBalance.md b/docs/TotalBalance.md index 5ed79f2..a17191f 100644 --- a/docs/TotalBalance.md +++ b/docs/TotalBalance.md @@ -1,12 +1,12 @@ # TotalBalance -User's balance in all accounts +User's total balance information ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **total** | [**AccountBalance**](AccountBalance.md) | | [optional] -**details** | [**Map<String, 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** | [**Map<String, 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] diff --git a/docs/Trade.md b/docs/Trade.md index b421b47..fb513ba 100644 --- a/docs/Trade.md +++ b/docs/Trade.md @@ -5,22 +5,22 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | Trade ID | [optional] -**createTime** | **String** | Trading time | [optional] +**id** | **String** | Fill ID | [optional] +**createTime** | **String** | Fill Time | [optional] **createTimeMs** | **String** | Trading time, with millisecond precision | [optional] **currencyPair** | **String** | Currency pair | [optional] -**side** | [**SideEnum**](#SideEnum) | Order side | [optional] -**role** | [**RoleEnum**](#RoleEnum) | Trade role. No value in public endpoints | [optional] +**side** | [**SideEnum**](#SideEnum) | Buy or sell order | [optional] +**role** | [**RoleEnum**](#RoleEnum) | Trade role, not returned in public endpoints | [optional] **amount** | **String** | Trade amount | [optional] **price** | **String** | Order price | [optional] -**orderId** | **String** | Related order ID. No value in public endpoints | [optional] -**fee** | **String** | Fee deducted. No value in public endpoints | [optional] -**feeCurrency** | **String** | Fee currency unit. No value in public endpoints | [optional] -**pointFee** | **String** | Points used to deduct fee. No value in public endpoints | [optional] -**gtFee** | **String** | GT used to deduct fee. No value in public endpoints | [optional] +**orderId** | **String** | Related order ID, not returned in public endpoints | [optional] +**fee** | **String** | Fee deducted, not returned in public endpoints | [optional] +**feeCurrency** | **String** | Fee currency unit, not returned in public endpoints | [optional] +**pointFee** | **String** | Points used to deduct fee, not returned in public endpoints | [optional] +**gtFee** | **String** | GT used to deduct fee, not returned in public endpoints | [optional] **amendText** | **String** | The custom data that the user remarked when amending the order | [optional] -**sequenceId** | **String** | 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** | **String** | User defined information. No value in public endpoints | [optional] +**sequenceId** | **String** | Consecutive trade ID within a single market. Used to track and identify trades in the specific market | [optional] +**text** | **String** | User-defined information, not returned in public endpoints | [optional] ## Enum: SideEnum diff --git a/docs/TradeFee.md b/docs/TradeFee.md index 9b6ccb8..cb01b2d 100644 --- a/docs/TradeFee.md +++ b/docs/TradeFee.md @@ -8,14 +8,14 @@ Name | Type | Description | Notes **userId** | **Long** | User ID | [optional] **takerFee** | **String** | taker fee rate | [optional] **makerFee** | **String** | maker fee rate | [optional] -**gtDiscount** | **Boolean** | If GT deduction is enabled | [optional] +**gtDiscount** | **Boolean** | Whether GT deduction discount is enabled | [optional] **gtTakerFee** | **String** | Taker fee rate if using GT deduction. It will be 0 if GT deduction is disabled | [optional] -**gtMakerFee** | **String** | Maker fee rate if using GT deduction. It will be 0 if GT deduction is disabled | [optional] +**gtMakerFee** | **String** | Maker fee rate with GT deduction. Returns 0 if GT deduction is disabled | [optional] **loanFee** | **String** | Loan fee rate of margin lending | [optional] -**pointType** | **String** | Point type. 0 - Initial version. 1 - new version since 202009 | [optional] -**futuresTakerFee** | **String** | Futures trading taker fee | [optional] -**futuresMakerFee** | **String** | Future trading maker fee | [optional] -**deliveryTakerFee** | **String** | Delivery trading taker fee | [optional] -**deliveryMakerFee** | **String** | Delivery trading maker fee | [optional] +**pointType** | **String** | Point card type: 0 - Original version, 1 - New version since 202009 | [optional] +**futuresTakerFee** | **String** | Perpetual contract taker fee rate | [optional] +**futuresMakerFee** | **String** | Perpetual contract maker fee rate | [optional] +**deliveryTakerFee** | **String** | Delivery contract taker fee rate | [optional] +**deliveryMakerFee** | **String** | Delivery contract maker fee rate | [optional] **debitFee** | **Integer** | Deduction types for rates, 1 - GT deduction, 2 - Point card deduction, 3 - VIP rates | [optional] diff --git a/docs/TransactionID.md b/docs/TransactionID.md index 204d2e6..9431f79 100644 --- a/docs/TransactionID.md +++ b/docs/TransactionID.md @@ -5,5 +5,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**txId** | **Long** | Order id | [optional] +**txId** | **Long** | Order ID | [optional] diff --git a/docs/Transfer.md b/docs/Transfer.md index 1d7a2b4..d25d251 100644 --- a/docs/Transfer.md +++ b/docs/Transfer.md @@ -7,12 +7,12 @@ Accounts available to transfer: - `spot`: spot account - `margin`: margin accou Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Transfer currency. For futures account, `currency` can be set to `POINT` or settle currency | +**currency** | **String** | Transfer currency name. For contract accounts, `currency` can be set to `POINT` (points) or supported settlement currencies (e.g., `BTC`, `USDT`) | **from** | [**FromEnum**](#FromEnum) | Account to transfer from | **to** | [**ToEnum**](#ToEnum) | Account to transfer to | **amount** | **String** | Transfer amount | -**currencyPair** | **String** | Margin currency pair. Required if transfer from or to margin account | [optional] -**settle** | **String** | Futures settle currency. Required if transferring from or to futures account | [optional] +**currencyPair** | **String** | Margin trading pair. Required when transferring to or from margin account | [optional] +**settle** | **String** | Contract settlement currency. Required when transferring to or from contract account | [optional] ## Enum: FromEnum diff --git a/docs/TransferOrderStatus.md b/docs/TransferOrderStatus.md index 6e9eda3..85b41b4 100644 --- a/docs/TransferOrderStatus.md +++ b/docs/TransferOrderStatus.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**txId** | **String** | Order id | [optional] -**status** | **String** | 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] +**txId** | **String** | Order ID | [optional] +**status** | **String** | Transfer status: PENDING - Processing, SUCCESS - Transfer successful, FAIL - Transfer failed, PARTIAL_SUCCESS - Partially successful (this status appears when transferring between sub-accounts) | [optional] diff --git a/docs/TransferablesResult.md b/docs/TransferablesResult.md index a013286..53216b6 100644 --- a/docs/TransferablesResult.md +++ b/docs/TransferablesResult.md @@ -1,12 +1,12 @@ # 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** | **String** | Currency detail | [optional] -**amount** | **String** | The maximum amount that can be transferred out | [optional] +**amount** | **String** | Maximum transferable amount | [optional] diff --git a/docs/TriggerTime.md b/docs/TriggerTime.md index 1e8e196..1eb4c55 100644 --- a/docs/TriggerTime.md +++ b/docs/TriggerTime.md @@ -5,5 +5,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**triggerTime** | **Long** | Timestamp of the end of the countdown, in milliseconds | [optional] +**triggerTime** | **Long** | Timestamp when countdown ends, in milliseconds | [optional] diff --git a/docs/UidPushOrder.md b/docs/UidPushOrder.md index 36a2b3d..66934e7 100644 --- a/docs/UidPushOrder.md +++ b/docs/UidPushOrder.md @@ -10,8 +10,8 @@ Name | Type | Description | Notes **receiveUid** | **Long** | Recipient User ID | [optional] **currency** | **String** | Currency name | [optional] **amount** | **String** | Transfer amount | [optional] -**createTime** | **Long** | Creation time | [optional] -**status** | **String** | 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** | **String** | PENDING Reason Tips | [optional] +**createTime** | **Long** | Created time | [optional] +**status** | **String** | 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** | **String** | PENDING reason tips | [optional] **transactionType** | **String** | Order Type | [optional] diff --git a/docs/UniCurrency.md b/docs/UniCurrency.md index 09aac84..0cc1548 100644 --- a/docs/UniCurrency.md +++ b/docs/UniCurrency.md @@ -8,7 +8,7 @@ Currency detail Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | Currency name | [optional] [readonly] -**minLendAmount** | **String** | The minimum lending amount, in the unit of the currency. | [optional] [readonly] +**minLendAmount** | **String** | The minimum lending amount, in the unit of the currency | [optional] [readonly] **maxLendAmount** | **String** | The total maximum lending amount, in USDT | [optional] [readonly] **maxRate** | **String** | Maximum rate (Hourly) | [optional] [readonly] **minRate** | **String** | Minimum rate (Hourly) | [optional] [readonly] diff --git a/docs/UniCurrencyInterest.md b/docs/UniCurrencyInterest.md index 5693395..212afc2 100644 --- a/docs/UniCurrencyInterest.md +++ b/docs/UniCurrencyInterest.md @@ -6,5 +6,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | Currency | [optional] [readonly] -**interestStatus** | **String** | Interest status: interest_dividend - regular dividend, interest_reinvest - interest reinvestment | [optional] [readonly] +**interestStatus** | **String** | Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment | [optional] [readonly] diff --git a/docs/UniInterestMode.md b/docs/UniInterestMode.md deleted file mode 100644 index 510e1cf..0000000 --- a/docs/UniInterestMode.md +++ /dev/null @@ -1,12 +0,0 @@ - -# UniInterestMode - -Lend & Earn interest reinvestment toggle - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**currency** | **String** | Currency | -**status** | **Boolean** | Interest toggle settings, true - interest reinvestment, false - regular dividend | - diff --git a/docs/UniInterestRecord.md b/docs/UniInterestRecord.md index 77d22bf..bd2d474 100644 --- a/docs/UniInterestRecord.md +++ b/docs/UniInterestRecord.md @@ -11,6 +11,6 @@ Name | Type | Description | Notes **currency** | **String** | Currency | [optional] [readonly] **actualRate** | **String** | Actual Rate | [optional] [readonly] **interest** | **String** | Interest | [optional] [readonly] -**interestStatus** | **String** | Interest status: interest_dividend - regular dividend, interest_reinvest - interest reinvestment | [optional] [readonly] +**interestStatus** | **String** | Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment | [optional] [readonly] **createTime** | **Long** | Created time | [optional] [readonly] diff --git a/docs/UniLend.md b/docs/UniLend.md index 51970dd..961d0ab 100644 --- a/docs/UniLend.md +++ b/docs/UniLend.md @@ -9,12 +9,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | Currency | [optional] [readonly] **currentAmount** | **String** | Current amount | [optional] [readonly] -**amount** | **String** | Total amount | [optional] [readonly] -**lentAmount** | **String** | Lent amount | [optional] [readonly] -**frozenAmount** | **String** | Frozen amount | [optional] [readonly] +**amount** | **String** | Total Lending Amount | [optional] [readonly] +**lentAmount** | **String** | Lent Amount | [optional] [readonly] +**frozenAmount** | **String** | Pending Redemption Amount | [optional] [readonly] **minRate** | **String** | Minimum interest rate | [optional] [readonly] -**interestStatus** | **String** | Interest status: interest_dividend - regular dividend, interest_reinvest - interest reinvestment | [optional] [readonly] -**reinvestLeftAmount** | **String** | Amount not reinvested | [optional] [readonly] -**createTime** | **Long** | Created time of the lending order | [optional] [readonly] -**updateTime** | **Long** | Upated time of the lending order | [optional] [readonly] +**interestStatus** | **String** | Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment | [optional] [readonly] +**reinvestLeftAmount** | **String** | Non-reinvested Amount | [optional] [readonly] +**createTime** | **Long** | Lending Order Creation Time | [optional] [readonly] +**updateTime** | **Long** | Lending Order Last Update Time | [optional] [readonly] diff --git a/docs/UniLendInterest.md b/docs/UniLendInterest.md index 005a1d9..feaaf25 100644 --- a/docs/UniLendInterest.md +++ b/docs/UniLendInterest.md @@ -6,5 +6,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | Currency | [optional] [readonly] -**interest** | **String** | Interest | [optional] [readonly] +**interest** | **String** | Interest income | [optional] [readonly] diff --git a/docs/UniLendRecord.md b/docs/UniLendRecord.md index 3f056c5..fef9b1b 100644 --- a/docs/UniLendRecord.md +++ b/docs/UniLendRecord.md @@ -1,17 +1,17 @@ # UniLendRecord -Interest Record +Lending Record ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | Currency name | [optional] [readonly] -**amount** | **String** | current amount | [optional] [readonly] -**lastWalletAmount** | **String** | Last wallet amount | [optional] [readonly] -**lastLentAmount** | **String** | Last lent amount | [optional] [readonly] -**lastFrozenAmount** | **String** | Last frozen amount | [optional] [readonly] -**type** | **String** | Record type: lend - lend, redeem - redeem | [optional] [readonly] +**amount** | **String** | Current Amount | [optional] [readonly] +**lastWalletAmount** | **String** | Previous Available Amount | [optional] [readonly] +**lastLentAmount** | **String** | Previous Lent Amount | [optional] [readonly] +**lastFrozenAmount** | **String** | Previous Frozen Amount | [optional] [readonly] +**type** | **String** | Record Type: lend - Lend, redeem - Redeem | [optional] [readonly] **createTime** | **Long** | Created time | [optional] [readonly] diff --git a/docs/UniLoan.md b/docs/UniLoan.md index 3584e7c..758c1ed 100644 --- a/docs/UniLoan.md +++ b/docs/UniLoan.md @@ -1,7 +1,7 @@ # UniLoan -Loan +Borrowing ## Properties @@ -9,8 +9,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | Currency | [optional] [readonly] **currencyPair** | **String** | Currency pair | [optional] [readonly] -**amount** | **String** | amount | [optional] [readonly] -**type** | **String** | Loan type, platform - platform, margin - margin | [optional] [readonly] +**amount** | **String** | Amount to Repay | [optional] [readonly] +**type** | **String** | Loan type: platform borrowing - platform, margin borrowing - margin | [optional] [readonly] **createTime** | **Long** | Created time | [optional] [readonly] -**updateTime** | **Long** | Updated time | [optional] [readonly] +**updateTime** | **Long** | Last Update Time | [optional] [readonly] diff --git a/docs/UniLoanInterestRecord.md b/docs/UniLoanInterestRecord.md index 65d52f1..31bfe46 100644 --- a/docs/UniLoanInterestRecord.md +++ b/docs/UniLoanInterestRecord.md @@ -1,7 +1,7 @@ # UniLoanInterestRecord -Interest record +Interest Deduction Record ## Properties @@ -9,9 +9,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | Currency name | [optional] [readonly] **currencyPair** | **String** | Currency pair | [optional] [readonly] -**actualRate** | **String** | Actual rate | [optional] [readonly] +**actualRate** | **String** | Actual Rate | [optional] [readonly] **interest** | **String** | Interest | [optional] [readonly] **status** | **Integer** | Status: 0 - fail, 1 - success | [optional] [readonly] -**type** | **String** | Type, platform - platform，margin - margin | [optional] [readonly] +**type** | **String** | Type: platform - Platform borrowing, margin - Margin borrowing | [optional] [readonly] **createTime** | **Long** | Created time | [optional] [readonly] diff --git a/docs/UniLoanRecord.md b/docs/UniLoanRecord.md index 2324db8..9adc6ee 100644 --- a/docs/UniLoanRecord.md +++ b/docs/UniLoanRecord.md @@ -1,15 +1,15 @@ # UniLoanRecord -Loan records +Borrowing Records ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **String** | type: borrow - borrow, repay - repay | [optional] [readonly] +**type** | **String** | Type: `borrow` - borrow, `repay` - repay | [optional] [readonly] **currencyPair** | **String** | Currency pair | [optional] [readonly] **currency** | **String** | Currency | [optional] [readonly] -**amount** | **String** | The amount of lending or repaying | [optional] [readonly] +**amount** | **String** | Borrow or repayment amount | [optional] [readonly] **createTime** | **Long** | Created time | [optional] [readonly] diff --git a/docs/UnifiedAccount.md b/docs/UnifiedAccount.md index 1dcaf5d..67395f9 100644 --- a/docs/UnifiedAccount.md +++ b/docs/UnifiedAccount.md @@ -6,22 +6,23 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **userId** | **Long** | User ID | [optional] -**refreshTime** | **Long** | Time of the most recent refresh | [optional] +**refreshTime** | **Long** | Last refresh time | [optional] **locked** | **Boolean** | 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** | [**Map<String, UnifiedBalance>**](UnifiedBalance.md) | | [optional] -**total** | **String** | 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** | **String** | 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** | **String** | 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** | **String** | 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] **totalInitialMargin** | **String** | Total initial margin, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode | [optional] **totalMarginBalance** | **String** | Total margin balance, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode | [optional] **totalMaintenanceMargin** | **String** | 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] **totalInitialMarginRate** | **String** | Total initial margin rate, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode | [optional] **totalMaintenanceMarginRate** | **String** | Total maintenance margin rate, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode | [optional] **totalAvailableMargin** | **String** | Available margin amount, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode | [optional] -**unifiedAccountTotal** | **String** | Unify the total account assets, valid in single currency margin/cross-currency margin/combined margin mode | [optional] -**unifiedAccountTotalLiab** | **String** | 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] -**unifiedAccountTotalEquity** | **String** | Unify the total account equity, valid in single currency margin/cross-currency margin/combined margin mode | [optional] -**leverage** | **String** | Actual leverage, valid in cross-currency margin/combined margin mode | [optional] [readonly] +**unifiedAccountTotal** | **String** | Total unified account assets, valid in single currency margin/cross-currency margin/combined margin mode | [optional] +**unifiedAccountTotalLiab** | **String** | Total unified account borrowed amount, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode | [optional] +**unifiedAccountTotalEquity** | **String** | Total unified account equity, valid in single currency margin/cross-currency margin/combined margin mode | [optional] +**leverage** | **String** | Actual leverage ratio, valid in cross-currency margin/combined margin mode | [optional] [readonly] **spotOrderLoss** | **String** | 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] -**spotHedge** | **Boolean** | Spot hedging status, true - enabled, false - not enabled. | [optional] -**useFunding** | **Boolean** | Whether to use funds as margin | [optional] +**spotHedge** | **Boolean** | Spot hedging status: true - enabled, false - disabled | [optional] +**useFunding** | **Boolean** | Whether to use Earn funds as margin | [optional] +**isAllCollateral** | **Boolean** | Whether all currencies are used as margin: true - all currencies as margin, false - no | [optional] diff --git a/docs/UnifiedApi.md b/docs/UnifiedApi.md index ed84a98..22186b2 100644 --- a/docs/UnifiedApi.md +++ b/docs/UnifiedApi.md @@ -5,26 +5,27 @@ All URIs are relative to *https://api.gateio.ws/api/v4* Method | HTTP request | Description ------------- | ------------- | ------------- [**listUnifiedAccounts**](UnifiedApi.md#listUnifiedAccounts) | **GET** /unified/accounts | Get unified account information -[**getUnifiedBorrowable**](UnifiedApi.md#getUnifiedBorrowable) | **GET** /unified/borrowable | Query about the maximum borrowing for the unified account -[**getUnifiedTransferable**](UnifiedApi.md#getUnifiedTransferable) | **GET** /unified/transferable | Query about the maximum transferable for the unified account -[**getUnifiedTransferables**](UnifiedApi.md#getUnifiedTransferables) | **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. -[**getUnifiedBorrowableList**](UnifiedApi.md#getUnifiedBorrowableList) | **GET** /unified/batch_borrowable | Batch query unified account can be borrowed up to a maximum -[**listUnifiedLoans**](UnifiedApi.md#listUnifiedLoans) | **GET** /unified/loans | List loans +[**getUnifiedBorrowable**](UnifiedApi.md#getUnifiedBorrowable) | **GET** /unified/borrowable | Query maximum borrowable amount for unified account +[**getUnifiedTransferable**](UnifiedApi.md#getUnifiedTransferable) | **GET** /unified/transferable | Query maximum transferable amount for unified account +[**getUnifiedTransferables**](UnifiedApi.md#getUnifiedTransferables) | **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 +[**getUnifiedBorrowableList**](UnifiedApi.md#getUnifiedBorrowableList) | **GET** /unified/batch_borrowable | Batch query unified account maximum borrowable amount +[**listUnifiedLoans**](UnifiedApi.md#listUnifiedLoans) | **GET** /unified/loans | Query loans [**createUnifiedLoan**](UnifiedApi.md#createUnifiedLoan) | **POST** /unified/loans | Borrow or repay -[**listUnifiedLoanRecords**](UnifiedApi.md#listUnifiedLoanRecords) | **GET** /unified/loan_records | Get load records -[**listUnifiedLoanInterestRecords**](UnifiedApi.md#listUnifiedLoanInterestRecords) | **GET** /unified/interest_records | List interest records +[**listUnifiedLoanRecords**](UnifiedApi.md#listUnifiedLoanRecords) | **GET** /unified/loan_records | Query loan records +[**listUnifiedLoanInterestRecords**](UnifiedApi.md#listUnifiedLoanInterestRecords) | **GET** /unified/interest_records | Query interest deduction records [**getUnifiedRiskUnits**](UnifiedApi.md#getUnifiedRiskUnits) | **GET** /unified/risk_units | Get user risk unit details [**getUnifiedMode**](UnifiedApi.md#getUnifiedMode) | **GET** /unified/unified_mode | Query mode of the unified account -[**setUnifiedMode**](UnifiedApi.md#setUnifiedMode) | **PUT** /unified/unified_mode | Set mode of the unified account -[**getUnifiedEstimateRate**](UnifiedApi.md#getUnifiedEstimateRate) | **GET** /unified/estimate_rate | Get unified estimate rate -[**listCurrencyDiscountTiers**](UnifiedApi.md#listCurrencyDiscountTiers) | **GET** /unified/currency_discount_tiers | List currency discount tiers -[**listLoanMarginTiers**](UnifiedApi.md#listLoanMarginTiers) | **GET** /unified/loan_margin_tiers | List loan margin tiers +[**setUnifiedMode**](UnifiedApi.md#setUnifiedMode) | **PUT** /unified/unified_mode | Set unified account mode +[**getUnifiedEstimateRate**](UnifiedApi.md#getUnifiedEstimateRate) | **GET** /unified/estimate_rate | Query unified account estimated interest rate +[**listCurrencyDiscountTiers**](UnifiedApi.md#listCurrencyDiscountTiers) | **GET** /unified/currency_discount_tiers | Query unified account tiered +[**listLoanMarginTiers**](UnifiedApi.md#listLoanMarginTiers) | **GET** /unified/loan_margin_tiers | Query unified account tiered loan margin [**calculatePortfolioMargin**](UnifiedApi.md#calculatePortfolioMargin) | **POST** /unified/portfolio_calculator | Portfolio margin calculator -[**getUserLeverageCurrencyConfig**](UnifiedApi.md#getUserLeverageCurrencyConfig) | **GET** /unified/leverage/user_currency_config | Minimum currency leverage that can be set -[**getUserLeverageCurrencySetting**](UnifiedApi.md#getUserLeverageCurrencySetting) | **GET** /unified/leverage/user_currency_setting | Get the leverage multiple of the user currency -[**setUserLeverageCurrencySetting**](UnifiedApi.md#setUserLeverageCurrencySetting) | **POST** /unified/leverage/user_currency_setting | Set the loan currency leverage +[**getUserLeverageCurrencyConfig**](UnifiedApi.md#getUserLeverageCurrencyConfig) | **GET** /unified/leverage/user_currency_config | Maximum and minimum currency leverage that can be set +[**getUserLeverageCurrencySetting**](UnifiedApi.md#getUserLeverageCurrencySetting) | **GET** /unified/leverage/user_currency_setting | Get user currency leverage +[**setUserLeverageCurrencySetting**](UnifiedApi.md#setUserLeverageCurrencySetting) | **POST** /unified/leverage/user_currency_setting | Set loan currency leverage [**listUnifiedCurrencies**](UnifiedApi.md#listUnifiedCurrencies) | **GET** /unified/currencies | List of loan currencies supported by unified account -[**getHistoryLoanRate**](UnifiedApi.md#getHistoryLoanRate) | **GET** /unified/history_loan_rate | get historical lending rates +[**getHistoryLoanRate**](UnifiedApi.md#getHistoryLoanRate) | **GET** /unified/history_loan_rate | Get historical lending rates +[**setUnifiedCollateral**](UnifiedApi.md#setUnifiedCollateral) | **POST** /unified/collateral_currencies | Set collateral currency @@ -33,7 +34,7 @@ Method | HTTP request | Description 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 @@ -56,7 +57,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); UnifiedApi apiInstance = new UnifiedApi(defaultClient); - String currency = "BTC"; // String | Retrieve data of the specified currency + String currency = "BTC"; // String | Query by specified currency name String subUid = "10001"; // String | Sub account user ID try { UnifiedAccount result = apiInstance.listUnifiedAccounts() @@ -81,7 +82,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | [optional] + **currency** | **String**| Query by specified currency name | [optional] **subUid** | **String**| Sub account user ID | [optional] ### Return type @@ -100,13 +101,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **getUnifiedBorrowable** > UnifiedBorrowable getUnifiedBorrowable(currency) -Query about the maximum borrowing for the unified account +Query maximum borrowable amount for unified account ### Example @@ -129,7 +130,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); UnifiedApi apiInstance = new UnifiedApi(defaultClient); - String currency = "BTC"; // String | Retrieve data of the specified currency + String currency = "BTC"; // String | Query by specified currency name try { UnifiedBorrowable result = apiInstance.getUnifiedBorrowable(currency); System.out.println(result); @@ -150,7 +151,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | + **currency** | **String**| Query by specified currency name | ### Return type @@ -168,13 +169,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **getUnifiedTransferable** > UnifiedTransferable getUnifiedTransferable(currency) -Query about the maximum transferable for the unified account +Query maximum transferable amount for unified account ### Example @@ -197,7 +198,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); UnifiedApi apiInstance = new UnifiedApi(defaultClient); - String currency = "BTC"; // String | Retrieve data of the specified currency + String currency = "BTC"; // String | Query by specified currency name try { UnifiedTransferable result = apiInstance.getUnifiedTransferable(currency); System.out.println(result); @@ -218,7 +219,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | + **currency** | **String**| Query by specified currency name | ### Return type @@ -236,13 +237,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **getUnifiedTransferables** > List<TransferablesResult> getUnifiedTransferables(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 @@ -265,7 +266,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); UnifiedApi apiInstance = new UnifiedApi(defaultClient); - String currencies = "BTC,ETH"; // String | Specify the currency name to query in batches, and support up to 100 pass parameters at a time. + String currencies = "BTC,ETH"; // String | Specify the currency name to query in batches, and support up to 100 pass parameters at a time try { List result = apiInstance.getUnifiedTransferables(currencies); System.out.println(result); @@ -286,7 +287,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencies** | **String**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time. | + **currencies** | **String**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time | ### Return type @@ -304,13 +305,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **getUnifiedBorrowableList** > List<UnifiedBorrowable1> getUnifiedBorrowableList(currencies) -Batch query unified account can be borrowed up to a maximum +Batch query unified account maximum borrowable amount ### Example @@ -333,7 +334,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); UnifiedApi apiInstance = new UnifiedApi(defaultClient); - List currencies = Arrays.asList(); // List | Specify the currency names for querying in an array, separated by commas, with a maximum of 10 currencies. + List currencies = Arrays.asList(); // List | Specify currency names for querying in an array, separated by commas, maximum 10 currencies try { List result = apiInstance.getUnifiedBorrowableList(currencies); System.out.println(result); @@ -354,7 +355,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencies** | [**List<String>**](String.md)| Specify the currency names for querying in an array, separated by commas, with a maximum of 10 currencies. | + **currencies** | [**List<String>**](String.md)| Specify currency names for querying in an array, separated by commas, maximum 10 currencies | ### Return type @@ -372,13 +373,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listUnifiedLoans** > List<UniLoan> listUnifiedLoans().currency(currency).page(page).limit(limit).type(type).execute(); -List loans +Query loans ### Example @@ -401,10 +402,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); UnifiedApi apiInstance = new UnifiedApi(defaultClient); - String currency = "BTC"; // String | Retrieve data of the specified currency + String currency = "BTC"; // String | Query by specified currency name Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 100 - String type = "platform"; // String | Loan type, platform - platform, margin - margin + Integer limit = 100; // Integer | Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 + String type = "platform"; // String | Loan type: platform borrowing - platform, margin borrowing - margin try { List result = apiInstance.listUnifiedLoans() .currency(currency) @@ -430,10 +431,10 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | [optional] + **currency** | **String**| Query by specified currency name | [optional] **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100] - **type** | **String**| Loan type, platform - platform, margin - margin | [optional] + **limit** | **Integer**| Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100] + **type** | **String**| Loan type: platform borrowing - platform, margin borrowing - margin | [optional] ### Return type @@ -451,7 +452,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **createUnifiedLoan** @@ -459,7 +460,7 @@ Name | Type | Description | Notes Borrow or repay -When borrowing, it is essential to ensure that the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and the user. The interest on the loan will be automatically deducted from the account at regular intervals. It is the user's responsibility to manage the repayment of the borrowed amount. For repayment, the option to repay the entire borrowed amount is available by setting the parameter `repaid_all=true` +When borrowing, ensure the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and user. Loan interest will be automatically deducted from the account at regular intervals. Users are responsible for managing repayment of borrowed amounts. For repayment, use `repaid_all=true` to repay all available amounts ### Example @@ -521,13 +522,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Operated successfully | - | +**200** | Operation successful | - | # **listUnifiedLoanRecords** > List<UnifiedLoanRecord> listUnifiedLoanRecords().type(type).currency(currency).page(page).limit(limit).execute(); -Get load records +Query loan records ### Example @@ -550,10 +551,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); UnifiedApi apiInstance = new UnifiedApi(defaultClient); - String type = "type_example"; // String | The types of lending records, borrow - indicates the action of borrowing funds, repay - indicates the action of repaying the borrowed funds - String currency = "BTC"; // String | Retrieve data of the specified currency + String type = "type_example"; // String | Loan record type: borrow - borrowing, repay - repayment + String currency = "BTC"; // String | Query by specified currency name Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 100 + Integer limit = 100; // Integer | Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 try { List result = apiInstance.listUnifiedLoanRecords() .type(type) @@ -579,10 +580,10 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **type** | **String**| The types of lending records, borrow - indicates the action of borrowing funds, repay - indicates the action of repaying the borrowed funds | [optional] - **currency** | **String**| Retrieve data of the specified currency | [optional] + **type** | **String**| Loan record type: borrow - borrowing, repay - repayment | [optional] + **currency** | **String**| Query by specified currency name | [optional] **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100] + **limit** | **Integer**| Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100] ### Return type @@ -600,13 +601,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listUnifiedLoanInterestRecords** > List<UniLoanInterestRecord> listUnifiedLoanInterestRecords().currency(currency).page(page).limit(limit).from(from).to(to).type(type).execute(); -List interest records +Query interest deduction records ### Example @@ -629,12 +630,12 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); UnifiedApi apiInstance = new UnifiedApi(defaultClient); - String currency = "BTC"; // String | Retrieve data of the specified currency + String currency = "BTC"; // String | Query by specified currency name Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 100 - Long from = 1627706330L; // Long | Start timestamp of the query - Long to = 1635329650L; // Long | Time range ending, default to current time - String type = "platform"; // String | Loan type, platform loan - platform, leverage loan - margin, if not passed, defaults to margin + Integer limit = 100; // Integer | Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 + Long from = 1627706330L; // Long | Start timestamp for the query + Long to = 1635329650L; // Long | End timestamp for the query, defaults to current time if not specified + String type = "platform"; // String | Loan type: platform borrowing - platform, margin borrowing - margin. Defaults to margin if not specified try { List result = apiInstance.listUnifiedLoanInterestRecords() .currency(currency) @@ -662,12 +663,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | [optional] + **currency** | **String**| Query by specified currency name | [optional] **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100] - **from** | **Long**| Start timestamp of the query | [optional] - **to** | **Long**| Time range ending, default to current time | [optional] - **type** | **String**| Loan type, platform loan - platform, leverage loan - margin, if not passed, defaults to margin | [optional] + **limit** | **Integer**| Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100] + **from** | **Long**| Start timestamp for the query | [optional] + **to** | **Long**| End timestamp for the query, defaults to current time if not specified | [optional] + **type** | **String**| Loan type: platform borrowing - platform, margin borrowing - margin. Defaults to margin if not specified | [optional] ### Return type @@ -685,7 +686,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **getUnifiedRiskUnits** @@ -693,7 +694,7 @@ Name | Type | Description | Notes 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 @@ -751,7 +752,7 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **getUnifiedMode** @@ -817,15 +818,15 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **setUnifiedMode** > setUnifiedMode(unifiedModeSet) -Set mode of the unified account +Set unified account mode -Switching each account mode only requires passing the parameters of the corresponding account mode, and supports turning on or off the configuration switch in the corresponding account mode when switching the account mode - When opening the classic account mode, mode=classic ``` PUT /unified/unified_mode { \"mode\": \"classic\" } ``` - Open the cross-currency margin mode, mode=multi_currency ``` PUT /unified/unified_mode { \"mode\": \"multi_currency\", \"settings\": { \"usdt_futures\": true } } ``` - When the portfolio margin mode is enabled, mode=portfolio ``` PUT /unified/unified_mode { \"mode\": \"portfolio\", \"settings\": { \"spot_hedge\": true } } ``` - When opening a single currency margin mode, mode=single_currency ``` PUT /unified/unified_mode { \"mode\": \"single_currency\" } ``` +Each account mode switch only requires passing the corresponding account mode parameter, and also supports turning on or off the configuration switches under the corresponding account mode during the switch. - When enabling the classic account mode, mode=classic ``` PUT /unified/unified_mode { \"mode\": \"classic\" } ``` - When enabling the cross-currency margin \"multi_currency\", \"settings\": { \"usdt_futures\": true } } ``` - When enabling the portfolio margin mode, mode=portfolio ``` PUT /unified/unified_mode { \"mode\": \"portfolio\", \"settings\": { \"spot_hedge\": true } } ``` - When enabling the single-currency margin mode, mode=single_currency ``` PUT /unified/unified_mode { \"mode\": \"single_currency\" } ``` ### Example @@ -886,15 +887,15 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Success | - | +**204** | Set successfully | - | # **getUnifiedEstimateRate** > Map<String, String> getUnifiedEstimateRate(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 @@ -917,7 +918,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); UnifiedApi apiInstance = new UnifiedApi(defaultClient); - List currencies = Arrays.asList(); // List | Specify the currency names for querying in an array, separated by commas, with a maximum of 10 currencies. + List currencies = Arrays.asList(); // List | Specify currency names for querying in an array, separated by commas, maximum 10 currencies try { Map result = apiInstance.getUnifiedEstimateRate(currencies); System.out.println(result); @@ -938,7 +939,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencies** | [**List<String>**](String.md)| Specify the currency names for querying in an array, separated by commas, with a maximum of 10 currencies. | + **currencies** | [**List<String>**](String.md)| Specify currency names for querying in an array, separated by commas, maximum 10 currencies | ### Return type @@ -956,13 +957,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listCurrencyDiscountTiers** > List<UnifiedDiscount> listCurrencyDiscountTiers() -List currency discount tiers +Query unified account tiered ### Example @@ -1016,13 +1017,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **listLoanMarginTiers** > List<UnifiedMarginTiers> listLoanMarginTiers() -List loan margin tiers +Query unified account tiered loan margin ### Example @@ -1076,7 +1077,7 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **calculatePortfolioMargin** @@ -1084,7 +1085,7 @@ No authorization required Portfolio margin calculator -Portfolio Margin Calculator When inputting a simulated position portfolio, each position includes the position name and quantity held, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. When inputting simulated orders, each order includes the market identifier, order price, and order quantity, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. Market orders are not included. +Portfolio Margin Calculator When inputting simulated position portfolios, each position includes the position name and quantity held, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. When inputting simulated orders, each order includes the market identifier, order price, and order quantity, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. Market orders are not included. ### Example @@ -1142,13 +1143,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **getUserLeverageCurrencyConfig** > UnifiedLeverageConfig getUserLeverageCurrencyConfig(currency) -Minimum currency leverage that can be set +Maximum and minimum currency leverage that can be set ### Example @@ -1210,15 +1211,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **getUserLeverageCurrencySetting** -> UnifiedLeverageSetting getUserLeverageCurrencySetting().currency(currency).execute(); +> List<UnifiedLeverageSetting> getUserLeverageCurrencySetting().currency(currency).execute(); -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 @@ -1243,7 +1244,7 @@ public class Example { UnifiedApi apiInstance = new UnifiedApi(defaultClient); String currency = "BTC"; // String | Currency try { - UnifiedLeverageSetting result = apiInstance.getUserLeverageCurrencySetting() + List result = apiInstance.getUserLeverageCurrencySetting() .currency(currency) .execute(); System.out.println(result); @@ -1268,7 +1269,7 @@ Name | Type | Description | Notes ### Return type -[**UnifiedLeverageSetting**](UnifiedLeverageSetting.md) +[**List<UnifiedLeverageSetting>**](UnifiedLeverageSetting.md) ### Authorization @@ -1282,13 +1283,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **setUserLeverageCurrencySetting** > setUserLeverageCurrencySetting(unifiedLeverageSetting) -Set the loan currency leverage +Set loan currency leverage ### Example @@ -1349,7 +1350,7 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Success | - | +**204** | Set successfully | - | # **listUnifiedCurrencies** @@ -1415,13 +1416,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **getHistoryLoanRate** > UnifiedHistoryLoanRate getHistoryLoanRate(currency).tier(tier).page(page).limit(limit).execute(); -get historical lending rates +Get historical lending rates ### Example @@ -1441,9 +1442,9 @@ public class Example { UnifiedApi apiInstance = new UnifiedApi(defaultClient); String currency = "USDT"; // String | Currency - String tier = "1"; // String | The VIP level of the floating rate that needs to be queried + String tier = "1"; // String | VIP level for the floating rate to be queried Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 100 + Integer limit = 100; // Integer | Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 try { UnifiedHistoryLoanRate result = apiInstance.getHistoryLoanRate(currency) .tier(tier) @@ -1469,9 +1470,9 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **currency** | **String**| Currency | - **tier** | **String**| The VIP level of the floating rate that needs to be queried | [optional] + **tier** | **String**| VIP level for the floating rate to be queried | [optional] **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100] + **limit** | **Integer**| Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100] ### Return type @@ -1489,5 +1490,73 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | + + +# **setUnifiedCollateral** +> UnifiedCollateralRes setUnifiedCollateral(unifiedCollateralReq) + +Set collateral currency + +### Example + +```java +// Import classes: +import io.gate.gateapi.ApiClient; +import io.gate.gateapi.ApiException; +import io.gate.gateapi.Configuration; +import io.gate.gateapi.GateApiException; +import io.gate.gateapi.auth.*; +import io.gate.gateapi.models.*; +import io.gate.gateapi.api.UnifiedApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.gateio.ws/api/v4"); + + // Configure APIv4 authorization: apiv4 + defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); + + UnifiedApi apiInstance = new UnifiedApi(defaultClient); + UnifiedCollateralReq unifiedCollateralReq = new UnifiedCollateralReq(); // UnifiedCollateralReq | + try { + UnifiedCollateralRes result = apiInstance.setUnifiedCollateral(unifiedCollateralReq); + System.out.println(result); + } catch (GateApiException e) { + System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage())); + e.printStackTrace(); + } catch (ApiException e) { + System.err.println("Exception when calling UnifiedApi#setUnifiedCollateral"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **unifiedCollateralReq** | [**UnifiedCollateralReq**](UnifiedCollateralReq.md)| | + +### Return type + +[**UnifiedCollateralRes**](UnifiedCollateralRes.md) + +### Authorization + +[apiv4](../README.md#apiv4) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Updated successfully | - | diff --git a/docs/UnifiedBalance.md b/docs/UnifiedBalance.md index 7142311..f19915a 100644 --- a/docs/UnifiedBalance.md +++ b/docs/UnifiedBalance.md @@ -5,23 +5,24 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**available** | **String** | Available amount is valid in single currency margin/cross-currency margin/combined margin mode, and the calculation is different in different modes | [optional] -**freeze** | **String** | The locked amount is valid in single currency margin/cross-currency margin/combined margin mode | [optional] -**borrowed** | **String** | Borrow limit, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode | [optional] -**negativeLiab** | **String** | 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** | **String** | Available balance, valid in single currency margin/cross-currency margin/combined margin mode, calculation varies by mode | [optional] +**freeze** | **String** | Locked balance, valid in single currency margin/cross-currency margin/combined margin mode | [optional] +**borrowed** | **String** | Borrowed amount, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode | [optional] +**negativeLiab** | **String** | Negative balance borrowing, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode | [optional] **futuresPosLiab** | **String** | Contract opening position borrowing currency (abandoned, to be offline field) | [optional] **equity** | **String** | Equity, valid in single currency margin/cross currency margin/combined margin mode | [optional] -**totalFreeze** | **String** | Total occupancy (discarded, to be offline field) | [optional] -**totalLiab** | **String** | Total borrowing, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode | [optional] +**totalFreeze** | **String** | Total frozen (deprecated, to be removed) | [optional] +**totalLiab** | **String** | Total borrowed amount, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode | [optional] **spotInUse** | **String** | 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** | **String** | Uniloan financial management amount, effective when Uniloan financial management is turned on as a unified account margin switch | [optional] +**funding** | **String** | Uniloan financial management amount, effective when turned on as a unified account margin switch | [optional] **fundingVersion** | **String** | Funding version | [optional] **crossBalance** | **String** | 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] **isoBalance** | **String** | 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** | **String** | 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** | **String** | 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** | **String** | Cross margin maintenance margin, valid in single-currency margin mode, 0 in other modes such as cross-currency margin/combined margin mode | [optional] **imr** | **String** | 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** | **String** | 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] **marginBalance** | **String** | 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] -**availableMargin** | **String** | 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] +**availableMargin** | **String** | Cross margin available balance, valid in single currency margin mode, 0 in other modes such as cross-currency margin/combined margin mode | [optional] +**enabledCollateral** | **Boolean** | Currency enabled as margin: true - Enabled, false - Disabled | [optional] diff --git a/docs/UnifiedBorrowable1.md b/docs/UnifiedBorrowable1.md index e099cc2..4401c4d 100644 --- a/docs/UnifiedBorrowable1.md +++ b/docs/UnifiedBorrowable1.md @@ -1,12 +1,12 @@ # 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** | **String** | Currency detail | [optional] -**amount** | **String** | The maximum amount to borrow | [optional] +**amount** | **String** | Maximum borrowable amount | [optional] diff --git a/docs/UnifiedCollateralReq.md b/docs/UnifiedCollateralReq.md new file mode 100644 index 0000000..367f95d --- /dev/null +++ b/docs/UnifiedCollateralReq.md @@ -0,0 +1,18 @@ + +# UnifiedCollateralReq + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**collateralType** | [**CollateralTypeEnum**](#CollateralTypeEnum) | 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] +**enableList** | **List<String>** | Currency list, where collateral_type=1(custom) indicates the addition logic | [optional] +**disableList** | **List<String>** | Disable list, indicating the disable logic | [optional] + +## Enum: CollateralTypeEnum + +Name | Value +---- | ----- +NUMBER_0 | 0 +NUMBER_1 | 1 + diff --git a/docs/UnifiedCollateralRes.md b/docs/UnifiedCollateralRes.md new file mode 100644 index 0000000..23b7c2a --- /dev/null +++ b/docs/UnifiedCollateralRes.md @@ -0,0 +1,11 @@ + +# UnifiedCollateralRes + +Unified account collateral mode settings response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**isSuccess** | **Boolean** | Whether the setting was successful | [optional] + diff --git a/docs/UnifiedCurrency.md b/docs/UnifiedCurrency.md index b8be591..d941bfe 100644 --- a/docs/UnifiedCurrency.md +++ b/docs/UnifiedCurrency.md @@ -7,8 +7,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | Currency name | [optional] **prec** | **String** | Currency precision | [optional] -**minBorrowAmount** | **String** | The minimum debit limit is the unit of currency | [optional] -**userMaxBorrowAmount** | **String** | The minimum debit limit is the unit of currency | [optional] -**totalMaxBorrowAmount** | **String** | The maximum debit limit for the platform is USDT | [optional] -**loanStatus** | **String** | Does the lending status - `disable` : Loans are prohibited - `enable`: Support lending | [optional] +**minBorrowAmount** | **String** | Minimum borrowable limit, in currency units | [optional] +**userMaxBorrowAmount** | **String** | User's maximum borrowable limit, in USDT | [optional] +**totalMaxBorrowAmount** | **String** | Platform's maximum borrowable limit, in USDT | [optional] +**loanStatus** | **String** | Lending status - `disable` : Lending prohibited - `enable` : Lending supported | [optional] diff --git a/docs/UnifiedDiscount.md b/docs/UnifiedDiscount.md index ea821fa..5e9b790 100644 --- a/docs/UnifiedDiscount.md +++ b/docs/UnifiedDiscount.md @@ -1,7 +1,7 @@ # UnifiedDiscount -Currency discount tiers +Unified account tiered discount ## Properties diff --git a/docs/UnifiedDiscountTiers.md b/docs/UnifiedDiscountTiers.md index e48f0f1..ab0ac91 100644 --- a/docs/UnifiedDiscountTiers.md +++ b/docs/UnifiedDiscountTiers.md @@ -8,6 +8,6 @@ Name | Type | Description | Notes **tier** | **String** | Tier | [optional] **discount** | **String** | Discount | [optional] **lowerLimit** | **String** | Lower limit | [optional] -**upperLimit** | **String** | Upper limit,＋ indicates positive infinity | [optional] +**upperLimit** | **String** | Upper limit, + indicates positive infinity | [optional] **leverage** | **String** | Position leverage | [optional] diff --git a/docs/UnifiedHistoryLoanRate.md b/docs/UnifiedHistoryLoanRate.md index 0042e17..4be5ce0 100644 --- a/docs/UnifiedHistoryLoanRate.md +++ b/docs/UnifiedHistoryLoanRate.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | Currency name | [optional] -**tier** | **String** | The VIP level of the floating rate required | [optional] -**tierUpRate** | **String** | VIP level corresponding floating rate | [optional] -**rates** | [**List<UnifiedHistoryLoanRateRates>**](UnifiedHistoryLoanRateRates.md) | Historical interest rate information, one data per hour, the array size is determined by the page and limit parameters provided by the interface request parameters, sorted from recent to far in time | [optional] +**tier** | **String** | VIP level for the floating rate to be retrieved | [optional] +**tierUpRate** | **String** | 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] diff --git a/docs/UnifiedHistoryLoanRateRates.md b/docs/UnifiedHistoryLoanRateRates.md index 78d076a..eeec610 100644 --- a/docs/UnifiedHistoryLoanRateRates.md +++ b/docs/UnifiedHistoryLoanRateRates.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**time** | **Long** | The hourly timestamp corresponding to the interest rate, in milliseconds | [optional] -**rate** | **String** | Historical interest rates for this hour | [optional] +**time** | **Long** | Hourly timestamp corresponding to this interest rate, in milliseconds | [optional] +**rate** | **String** | Historical interest rate for this hour | [optional] diff --git a/docs/UnifiedLeverageConfig.md b/docs/UnifiedLeverageConfig.md index f864f11..2bb44f2 100644 --- a/docs/UnifiedLeverageConfig.md +++ b/docs/UnifiedLeverageConfig.md @@ -10,6 +10,6 @@ Name | Type | Description | Notes **maxLeverage** | **String** | Maximum adjustable leverage ratio | [optional] **debit** | **String** | Current liabilities | [optional] **availableMargin** | **String** | Available Margin | [optional] -**borrowable** | **String** | The current leverage you can choose is | [optional] -**exceptLeverageBorrowable** | **String** | The maximum amount of margin that can be borrowed and the maximum amount of Uniloan that can be borrowed, whichever is smaller | [optional] +**borrowable** | **String** | Maximum borrowable amount at current leverage | [optional] +**exceptLeverageBorrowable** | **String** | Maximum borrowable from margin and maximum borrowable from Earn, whichever is smaller | [optional] diff --git a/docs/UnifiedLeverageSetting.md b/docs/UnifiedLeverageSetting.md index 1e45ee2..1f2e200 100644 --- a/docs/UnifiedLeverageSetting.md +++ b/docs/UnifiedLeverageSetting.md @@ -1,12 +1,12 @@ # UnifiedLeverageSetting -Loan currency leverage +Leverage multiplier for borrowing currency ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | Currency name | -**leverage** | **String** | multiple | +**leverage** | **String** | Multiplier | diff --git a/docs/UnifiedLoan.md b/docs/UnifiedLoan.md index 0a76782..58564c0 100644 --- a/docs/UnifiedLoan.md +++ b/docs/UnifiedLoan.md @@ -8,9 +8,9 @@ Borrow or repay Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | Currency | -**type** | [**TypeEnum**](#TypeEnum) | type: borrow - borrow, repay - repay | -**amount** | **String** | The amount of lending or repaying | -**repaidAll** | **Boolean** | Full repayment is solely for repayment operations. When set to 'true,' it overrides the 'amount,' allowing for direct full repayment. | [optional] +**type** | [**TypeEnum**](#TypeEnum) | Type: `borrow` - borrow, `repay` - repay | +**amount** | **String** | Borrow or repayment amount | +**repaidAll** | **Boolean** | Full repayment, only used for repayment operations. When set to `true`, overrides `amount` and directly repays the full amount | [optional] **text** | **String** | User defined custom ID | [optional] ## Enum: TypeEnum diff --git a/docs/UnifiedLoanRecord.md b/docs/UnifiedLoanRecord.md index 712c062..2b88b30 100644 --- a/docs/UnifiedLoanRecord.md +++ b/docs/UnifiedLoanRecord.md @@ -1,18 +1,18 @@ # UnifiedLoanRecord -Loan records +Borrowing Records ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Long** | id | [optional] [readonly] -**type** | **String** | type: borrow - borrow, repay - repay | [optional] [readonly] -**repaymentType** | **String** | Repayment type, none - No repayment type, manual_repay - Manual repayment, auto_repay - Automatic repayment, cancel_auto_repay - Automatic repayment after withdrawal, different_currencies_repayment - Different currency repayment | [optional] [readonly] -**borrowType** | **String** | Loan type, returned when querying loan records. manual_borrow - Manual repayment , auto_borrow - Automatic repayment | [optional] +**id** | **Long** | ID | [optional] [readonly] +**type** | **String** | Type: `borrow` - borrow, `repay` - repay | [optional] [readonly] +**repaymentType** | **String** | 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] +**borrowType** | **String** | Borrowing type, returned when querying loan records: manual_borrow - Manual borrowing, auto_borrow - Automatic borrowing | [optional] **currencyPair** | **String** | Currency pair | [optional] [readonly] **currency** | **String** | Currency | [optional] [readonly] -**amount** | **String** | The amount of lending or repaying | [optional] [readonly] +**amount** | **String** | Borrow or repayment amount | [optional] [readonly] **createTime** | **Long** | Created time | [optional] [readonly] diff --git a/docs/UnifiedLoanResult.md b/docs/UnifiedLoanResult.md index 86cc27d..938be13 100644 --- a/docs/UnifiedLoanResult.md +++ b/docs/UnifiedLoanResult.md @@ -1,11 +1,11 @@ # UnifiedLoanResult -Unified account loan and repayment response results +Unified account borrowing and repayment response result ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**tranId** | **Long** | Transaction id | [optional] +**tranId** | **Long** | Transaction ID | [optional] diff --git a/docs/UnifiedMarginTiers.md b/docs/UnifiedMarginTiers.md index 9066d98..2c4ab10 100644 --- a/docs/UnifiedMarginTiers.md +++ b/docs/UnifiedMarginTiers.md @@ -1,12 +1,12 @@ # UnifiedMarginTiers -Unified margin tiers +Unified account borrowing margin tiers ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | Currency name | [optional] -**marginTiers** | [**List<MarginTiers>**](MarginTiers.md) | Margin tiers | [optional] +**marginTiers** | [**List<MarginTiers>**](MarginTiers.md) | Tiered margin | [optional] diff --git a/docs/UnifiedModeSet.md b/docs/UnifiedModeSet.md index e9ad0a2..13ba0fa 100644 --- a/docs/UnifiedModeSet.md +++ b/docs/UnifiedModeSet.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**mode** | **String** | Unified account mode: - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single Currency Margin Model | +**mode** | **String** | 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] diff --git a/docs/UnifiedPortfolioInput.md b/docs/UnifiedPortfolioInput.md index 72ebefb..78bb520 100644 --- a/docs/UnifiedPortfolioInput.md +++ b/docs/UnifiedPortfolioInput.md @@ -1,7 +1,7 @@ # UnifiedPortfolioInput -Input for the portfolio margin calculator. +Portfolio margin calculator input ## Properties @@ -13,5 +13,5 @@ Name | Type | Description | Notes **futuresOrders** | [**List<MockFuturesOrder>**](MockFuturesOrder.md) | Futures order | [optional] **optionsPositions** | [**List<MockOptionsPosition>**](MockOptionsPosition.md) | Options positions | [optional] **optionsOrders** | [**List<MockOptionsOrder>**](MockOptionsOrder.md) | Option orders | [optional] -**spotHedge** | **Boolean** | Whether to enable spot hedging. | [optional] +**spotHedge** | **Boolean** | Whether to enable spot hedging | [optional] diff --git a/docs/UnifiedPortfolioOutput.md b/docs/UnifiedPortfolioOutput.md index 7847d96..d6fc162 100644 --- a/docs/UnifiedPortfolioOutput.md +++ b/docs/UnifiedPortfolioOutput.md @@ -1,14 +1,14 @@ # UnifiedPortfolioOutput -The output of the portfolio margin calculator. +Portfolio margin calculator output ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**maintainMarginTotal** | **String** | 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] -**initialMarginTotal** | **String** | Total initial margin, calculated as the maximum of the following three combinations: position, position + positive delta orders, position + negative delta orders. | [optional] -**calculateTime** | **Long** | Calculate time | [optional] +**maintainMarginTotal** | **String** | 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] +**initialMarginTotal** | **String** | Total initial margin, calculated as the maximum of the following three combinations: position, position + positive delta orders, position + negative delta orders | [optional] +**calculateTime** | **Long** | Calculation time | [optional] **riskUnit** | [**List<MockRiskUnit>**](MockRiskUnit.md) | Risk unit | [optional] diff --git a/docs/UnifiedRiskUnits.md b/docs/UnifiedRiskUnits.md index 688f93f..f64d09e 100644 --- a/docs/UnifiedRiskUnits.md +++ b/docs/UnifiedRiskUnits.md @@ -6,6 +6,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **userId** | **Long** | User ID | [optional] -**spotHedge** | **Boolean** | Spot hedging status, true - enabled, false - not enabled. | [optional] +**spotHedge** | **Boolean** | Spot hedging status: true - enabled, false - disabled | [optional] **riskUnits** | [**List<RiskUnits>**](RiskUnits.md) | Risk unit | [optional] diff --git a/docs/UnifiedSettings.md b/docs/UnifiedSettings.md index 56e6dca..8c56c9a 100644 --- a/docs/UnifiedSettings.md +++ b/docs/UnifiedSettings.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**usdtFutures** | **Boolean** | USDT contract switch. In cross-currency margin mode, it can only be turned on and not off | [optional] -**spotHedge** | **Boolean** | Spot hedging switch. | [optional] -**useFunding** | **Boolean** | switch, when the mode is cross-currency margin mode, whether to use Uniloan financial funds as margin | [optional] -**options** | **Boolean** | Option switch. In cross-currency margin mode, it can only be turned on and not off | [optional] +**usdtFutures** | **Boolean** | USDT futures switch. In cross-currency margin mode, can only be enabled and cannot be disabled | [optional] +**spotHedge** | **Boolean** | Spot hedging switch | [optional] +**useFunding** | **Boolean** | Earn switch, when mode is cross-currency margin mode, whether to use Earn funds as margin | [optional] +**options** | **Boolean** | Options switch. In cross-currency margin mode, can only be enabled and cannot be disabled | [optional] diff --git a/docs/UnifiedTransferable.md b/docs/UnifiedTransferable.md index cdeced4..23e6b01 100644 --- a/docs/UnifiedTransferable.md +++ b/docs/UnifiedTransferable.md @@ -6,5 +6,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | Currency detail | [optional] -**amount** | **String** | The maximum amount that can be transferred out | [optional] +**amount** | **String** | Maximum transferable amount | [optional] diff --git a/docs/UserLtvInfo.md b/docs/UserLtvInfo.md index 9577c0c..0298471 100644 --- a/docs/UserLtvInfo.md +++ b/docs/UserLtvInfo.md @@ -7,11 +7,11 @@ User's currency statistics data Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**collateralCurrency** | **String** | Collateral | [optional] +**collateralCurrency** | **String** | Collateral currency | [optional] **borrowCurrency** | **String** | Borrowed currency | [optional] -**initLtv** | **String** | The initial collateralization rate | [optional] -**alertLtv** | **String** | Warning collateralization ratio | [optional] -**liquidateLtv** | **String** | The liquidation collateralization rate | [optional] +**initLtv** | **String** | Initial collateralization rate | [optional] +**alertLtv** | **String** | Warning collateralization rate | [optional] +**liquidateLtv** | **String** | Liquidation collateralization rate | [optional] **minBorrowAmount** | **String** | Minimum borrowable amount for the loan currency | [optional] **leftBorrowableAmount** | **String** | Remaining borrowable amount for the loan currency | [optional] diff --git a/docs/UserSub.md b/docs/UserSub.md index 17c602f..4ebec41 100644 --- a/docs/UserSub.md +++ b/docs/UserSub.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uid** | **Long** | User ID | [optional] -**belong** | **String** | The system to which the user belongs (partner referral). If empty, it means not belonging to any system. | [optional] -**type** | **Long** | Type (0-not in the system 1-direct subordinate agent 2-indirect subordinate agent 3-direct direct customer 4-indirect direct customer 5-ordinary user) | [optional] +**belong** | **String** | User's system affiliation (partner/referral). Empty means not belonging to any system | [optional] +**type** | **Long** | 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] **refUid** | **Long** | Inviter user ID | [optional] diff --git a/docs/UserTotalAmount.md b/docs/UserTotalAmount.md index e95cc61..0dfe968 100644 --- a/docs/UserTotalAmount.md +++ b/docs/UserTotalAmount.md @@ -1,12 +1,12 @@ # UserTotalAmount -Total borrowed amount and pledged collateral amount by the user +User's total borrowing and collateral amount ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**borrowAmount** | **String** | Total borrowing amount, calculated in USDT | [optional] -**collateralAmount** | **String** | Total collateral amount, calculated in USDT | [optional] +**borrowAmount** | **String** | Total borrowing amount in USDT | [optional] +**collateralAmount** | **String** | Total collateral amount in USDT | [optional] diff --git a/docs/WalletApi.md b/docs/WalletApi.md index bc8ac1c..1fedfb4 100644 --- a/docs/WalletApi.md +++ b/docs/WalletApi.md @@ -4,34 +4,34 @@ All URIs are relative to *https://api.gateio.ws/api/v4* Method | HTTP request | Description ------------- | ------------- | ------------- -[**listCurrencyChains**](WalletApi.md#listCurrencyChains) | **GET** /wallet/currency_chains | List chains supported for specified currency +[**listCurrencyChains**](WalletApi.md#listCurrencyChains) | **GET** /wallet/currency_chains | Query chains supported for specified currency [**getDepositAddress**](WalletApi.md#getDepositAddress) | **GET** /wallet/deposit_address | Generate currency deposit address -[**listWithdrawals**](WalletApi.md#listWithdrawals) | **GET** /wallet/withdrawals | Retrieve withdrawal records -[**listDeposits**](WalletApi.md#listDeposits) | **GET** /wallet/deposits | Retrieve deposit records +[**listWithdrawals**](WalletApi.md#listWithdrawals) | **GET** /wallet/withdrawals | Get withdrawal records +[**listDeposits**](WalletApi.md#listDeposits) | **GET** /wallet/deposits | Get deposit records [**transfer**](WalletApi.md#transfer) | **POST** /wallet/transfers | Transfer between trading accounts -[**listSubAccountTransfers**](WalletApi.md#listSubAccountTransfers) | **GET** /wallet/sub_account_transfers | Retrieve transfer records between main and sub accounts +[**listSubAccountTransfers**](WalletApi.md#listSubAccountTransfers) | **GET** /wallet/sub_account_transfers | Get transfer records between main and sub accounts [**transferWithSubAccount**](WalletApi.md#transferWithSubAccount) | **POST** /wallet/sub_account_transfers | Transfer between main and sub accounts -[**subAccountToSubAccount**](WalletApi.md#subAccountToSubAccount) | **POST** /wallet/sub_account_to_sub_account | Sub-account transfers to sub-account +[**subAccountToSubAccount**](WalletApi.md#subAccountToSubAccount) | **POST** /wallet/sub_account_to_sub_account | Transfer between sub-accounts [**getTransferOrderStatus**](WalletApi.md#getTransferOrderStatus) | **GET** /wallet/order_status | Transfer status query -[**listWithdrawStatus**](WalletApi.md#listWithdrawStatus) | **GET** /wallet/withdraw_status | Retrieve withdrawal status -[**listSubAccountBalances**](WalletApi.md#listSubAccountBalances) | **GET** /wallet/sub_account_balances | Retrieve sub account balances -[**listSubAccountMarginBalances**](WalletApi.md#listSubAccountMarginBalances) | **GET** /wallet/sub_account_margin_balances | Query sub accounts' margin balances -[**listSubAccountFuturesBalances**](WalletApi.md#listSubAccountFuturesBalances) | **GET** /wallet/sub_account_futures_balances | Query sub accounts' futures account balances -[**listSubAccountCrossMarginBalances**](WalletApi.md#listSubAccountCrossMarginBalances) | **GET** /wallet/sub_account_cross_margin_balances | Query subaccount's cross_margin account info -[**listSavedAddress**](WalletApi.md#listSavedAddress) | **GET** /wallet/saved_address | Query saved address -[**getTradeFee**](WalletApi.md#getTradeFee) | **GET** /wallet/fee | Retrieve personal trading fee -[**getTotalBalance**](WalletApi.md#getTotalBalance) | **GET** /wallet/total_balance | Retrieve user's total balances -[**listSmallBalance**](WalletApi.md#listSmallBalance) | **GET** /wallet/small_balance | List small balance -[**convertSmallBalance**](WalletApi.md#convertSmallBalance) | **POST** /wallet/small_balance | Convert small balance -[**listSmallBalanceHistory**](WalletApi.md#listSmallBalanceHistory) | **GET** /wallet/small_balance_history | List small balance history -[**listPushOrders**](WalletApi.md#listPushOrders) | **GET** /wallet/push | Retrieve the UID transfer history +[**listWithdrawStatus**](WalletApi.md#listWithdrawStatus) | **GET** /wallet/withdraw_status | Query withdrawal status +[**listSubAccountBalances**](WalletApi.md#listSubAccountBalances) | **GET** /wallet/sub_account_balances | Query sub-account balance information +[**listSubAccountMarginBalances**](WalletApi.md#listSubAccountMarginBalances) | **GET** /wallet/sub_account_margin_balances | Query sub-account isolated margin account balance information +[**listSubAccountFuturesBalances**](WalletApi.md#listSubAccountFuturesBalances) | **GET** /wallet/sub_account_futures_balances | Query sub-account perpetual futures account balance information +[**listSubAccountCrossMarginBalances**](WalletApi.md#listSubAccountCrossMarginBalances) | **GET** /wallet/sub_account_cross_margin_balances | Query sub-account cross margin account balance information +[**listSavedAddress**](WalletApi.md#listSavedAddress) | **GET** /wallet/saved_address | Query withdrawal address whitelist +[**getTradeFee**](WalletApi.md#getTradeFee) | **GET** /wallet/fee | Query personal trading fees +[**getTotalBalance**](WalletApi.md#getTotalBalance) | **GET** /wallet/total_balance | Query personal account totals +[**listSmallBalance**](WalletApi.md#listSmallBalance) | **GET** /wallet/small_balance | Get list of convertible small balance currencies +[**convertSmallBalance**](WalletApi.md#convertSmallBalance) | **POST** /wallet/small_balance | Convert small balance currency +[**listSmallBalanceHistory**](WalletApi.md#listSmallBalanceHistory) | **GET** /wallet/small_balance_history | Get convertible small balance currency history +[**listPushOrders**](WalletApi.md#listPushOrders) | **GET** /wallet/push | Get UID transfer history # **listCurrencyChains** > List<CurrencyChain> listCurrencyChains(currency) -List chains supported for specified currency +Query chains supported for specified currency ### Example @@ -89,7 +89,7 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **getDepositAddress** @@ -163,9 +163,9 @@ Name | Type | Description | Notes # **listWithdrawals** > List<WithdrawalRecord> listWithdrawals().currency(currency).withdrawId(withdrawId).assetClass(assetClass).withdrawOrderId(withdrawOrderId).from(from).to(to).limit(limit).offset(offset).execute(); -Retrieve withdrawal records +Get withdrawal records -Record time range cannot exceed 30 days +Record query time range cannot exceed 30 days ### Example @@ -188,13 +188,13 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); WalletApi apiInstance = new WalletApi(defaultClient); - String currency = "BTC"; // String | Filter by currency. Return all currency records if not specified - String withdrawId = "withdrawId_example"; // String | 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 - String assetClass = "assetClass_example"; // String | 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 - String withdrawOrderId = "withdrawOrderId_example"; // String | User-defined order number when withdrawing. Default is empty. When not empty, the specified user-defined order number record will be queried - Long from = 1602120000L; // Long | Time range beginning, default to 7 days before current time - Long to = 1602123600L; // Long | Time range ending, default to current time - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + String currency = "BTC"; // String | Specify the currency. If not specified, returns all currencies + String withdrawId = "withdrawId_example"; // String | 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 + String assetClass = "assetClass_example"; // String | 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 + String withdrawOrderId = "withdrawOrderId_example"; // String | User-defined order number for withdrawal. Default is empty. When not empty, the specified user-defined order number record will be queried + Long from = 1602120000L; // Long | Start time for querying records, defaults to 7 days before current time if not specified + Long to = 1602123600L; // Long | End timestamp for the query, defaults to current time if not specified + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 try { List result = apiInstance.listWithdrawals() @@ -225,13 +225,13 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Filter by currency. Return all currency records if not specified | [optional] - **withdrawId** | **String**| 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] - **assetClass** | **String**| 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] - **withdrawOrderId** | **String**| User-defined order number when withdrawing. Default is empty. When not empty, the specified user-defined order number record will be queried | [optional] - **from** | **Long**| Time range beginning, default to 7 days before current time | [optional] - **to** | **Long**| Time range ending, default to current time | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **currency** | **String**| Specify the currency. If not specified, returns all currencies | [optional] + **withdrawId** | **String**| 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] + **assetClass** | **String**| 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] + **withdrawOrderId** | **String**| User-defined order number for withdrawal. Default is empty. When not empty, the specified user-defined order number record will be queried | [optional] + **from** | **Long**| Start time for querying records, defaults to 7 days before current time if not specified | [optional] + **to** | **Long**| End timestamp for the query, defaults to current time if not specified | [optional] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] ### Return type @@ -250,15 +250,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listDeposits** > List<DepositRecord> listDeposits().currency(currency).from(from).to(to).limit(limit).offset(offset).execute(); -Retrieve deposit records +Get deposit records -Record time range cannot exceed 30 days +Record query time range cannot exceed 30 days ### Example @@ -281,10 +281,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); WalletApi apiInstance = new WalletApi(defaultClient); - String currency = "BTC"; // String | Filter by currency. Return all currency records if not specified - Long from = 1602120000L; // Long | Time range beginning, default to 7 days before current time - Long to = 1602123600L; // Long | Time range ending, default to current time - Integer limit = 100; // Integer | The maximum number of entries returned in the list is limited to 500 transactions. + String currency = "BTC"; // String | Specify the currency. If not specified, returns all currencies + Long from = 1602120000L; // Long | Start time for querying records, defaults to 7 days before current time if not specified + Long to = 1602123600L; // Long | End timestamp for the query, defaults to current time if not specified + Integer limit = 100; // Integer | Maximum number of entries returned in the list, limited to 500 transactions Integer offset = 0; // Integer | List offset, starting from 0 try { List result = apiInstance.listDeposits() @@ -312,10 +312,10 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Filter by currency. Return all currency records if not specified | [optional] - **from** | **Long**| Time range beginning, default to 7 days before current time | [optional] - **to** | **Long**| Time range ending, default to current time | [optional] - **limit** | **Integer**| The maximum number of entries returned in the list is limited to 500 transactions. | [optional] [default to 100] + **currency** | **String**| Specify the currency. If not specified, returns all currencies | [optional] + **from** | **Long**| Start time for querying records, defaults to 7 days before current time if not specified | [optional] + **to** | **Long**| End timestamp for the query, defaults to current time if not specified | [optional] + **limit** | **Integer**| Maximum number of entries returned in the list, limited to 500 transactions | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] ### Return type @@ -334,7 +334,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **transfer** @@ -342,7 +342,7 @@ Name | Type | Description | Notes Transfer between trading accounts -Transfer between different accounts. Currently support transfers between the following: 1. spot - margin 2. spot - futures(perpetual) 3. spot - delivery 4. spot - options +Balance transfers between personal trading accounts. Currently supports the following transfer operations: 1. Spot account - Margin account 2. Spot account - Perpetual futures account 3. Spot account - Delivery futures account 4. Spot account - Options account ### Example @@ -404,15 +404,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Balance transferred | - | +**200** | Transfer operation successful | - | # **listSubAccountTransfers** -> List<SubAccountTransfer> listSubAccountTransfers().subUid(subUid).from(from).to(to).limit(limit).offset(offset).execute(); +> List<SubAccountTransferRecordItem> listSubAccountTransfers().subUid(subUid).from(from).to(to).limit(limit).offset(offset).execute(); -Retrieve transfer records between main and sub accounts +Get transfer records between main and sub accounts -Record time range cannot exceed 30 days > Note: only records after 2020-04-10 can be retrieved +Record query time range cannot exceed 30 days > Note: Only records after 2020-04-10 can be retrieved ### Example @@ -435,13 +435,13 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); WalletApi apiInstance = new WalletApi(defaultClient); - String subUid = "10003"; // String | User ID of sub-account, you can query multiple records separated by `,`. If not specified, it will return the records of all sub accounts - Long from = 1602120000L; // Long | Time range beginning, default to 7 days before current time - Long to = 1602123600L; // Long | Time range ending, default to current time - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + String subUid = "10003"; // String | Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts + Long from = 1602120000L; // Long | Start time for querying records, defaults to 7 days before current time if not specified + Long to = 1602123600L; // Long | End timestamp for the query, defaults to current time if not specified + Integer limit = 100; // Integer | Maximum number of records returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 try { - List result = apiInstance.listSubAccountTransfers() + List result = apiInstance.listSubAccountTransfers() .subUid(subUid) .from(from) .to(to) @@ -466,15 +466,15 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subUid** | **String**| 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** | **Long**| Time range beginning, default to 7 days before current time | [optional] - **to** | **Long**| Time range ending, default to current time | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **subUid** | **String**| Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts | [optional] + **from** | **Long**| Start time for querying records, defaults to 7 days before current time if not specified | [optional] + **to** | **Long**| End timestamp for the query, defaults to current time if not specified | [optional] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] ### Return type -[**List<SubAccountTransfer>**](SubAccountTransfer.md) +[**List<SubAccountTransferRecordItem>**](SubAccountTransferRecordItem.md) ### Authorization @@ -488,7 +488,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **transferWithSubAccount** @@ -496,7 +496,7 @@ Name | Type | Description | Notes Transfer between main and sub accounts -Support transferring with sub user's spot or futures account. Note that only main user's spot account is used no matter which sub user's account is operated. +Supports transfers to/from sub-account's spot or futures accounts. Note that regardless of which sub-account is operated, only the main account's spot account is used ### Example @@ -558,15 +558,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Balance transferred | - | +**200** | Transfer operation successful | - | # **subAccountToSubAccount** > TransactionID subAccountToSubAccount(subAccountToSubAccount) -Sub-account transfers to sub-account +Transfer between sub-accounts -It is possible to perform balance transfers between two sub-accounts under the same main account. You can use either the API Key of the main account or the API Key of the sub-account to initiate the transfer. +Supports balance transfers between two sub-accounts under the same main account. You can use either the main account's API Key or the source sub-account's API Key to perform the operation ### Example @@ -628,7 +628,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Balance transferred | - | +**200** | Transfer operation successful | - | # **getTransferOrderStatus** @@ -636,7 +636,7 @@ Name | Type | Description | Notes 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 @@ -659,8 +659,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); WalletApi apiInstance = new WalletApi(defaultClient); - String clientOrderId = "da3ce7a088c8b0372b741419c7829033"; // String | 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. - String txId = "59636381286"; // String | The transfer operation number and client_order_id cannot be empty at the same time + String clientOrderId = "da3ce7a088c8b0372b741419c7829033"; // String | 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 + String txId = "59636381286"; // String | Transfer operation number, cannot be empty at the same time as client_order_id try { TransferOrderStatus result = apiInstance.getTransferOrderStatus() .clientOrderId(clientOrderId) @@ -684,8 +684,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **clientOrderId** | **String**| 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] - **txId** | **String**| The transfer operation number and client_order_id cannot be empty at the same time | [optional] + **clientOrderId** | **String**| 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] + **txId** | **String**| Transfer operation number, cannot be empty at the same time as client_order_id | [optional] ### Return type @@ -703,13 +703,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Transfer status obtained successfully | - | +**200** | Transfer status retrieved successfully | - | # **listWithdrawStatus** > List<WithdrawStatus> listWithdrawStatus().currency(currency).execute(); -Retrieve withdrawal status +Query withdrawal status ### Example @@ -732,7 +732,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); WalletApi apiInstance = new WalletApi(defaultClient); - String currency = "BTC"; // String | Retrieve data of the specified currency + String currency = "BTC"; // String | Query by specified currency name try { List result = apiInstance.listWithdrawStatus() .currency(currency) @@ -755,7 +755,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | [optional] + **currency** | **String**| Query by specified currency name | [optional] ### Return type @@ -773,13 +773,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listSubAccountBalances** > List<SubAccountBalance> listSubAccountBalances().subUid(subUid).execute(); -Retrieve sub account balances +Query sub-account balance information ### Example @@ -802,7 +802,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); WalletApi apiInstance = new WalletApi(defaultClient); - String subUid = "10003"; // String | User ID of sub-account, you can query multiple records separated by `,`. If not specified, it will return the records of all sub accounts + String subUid = "10003"; // String | Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts try { List result = apiInstance.listSubAccountBalances() .subUid(subUid) @@ -825,7 +825,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subUid** | **String**| 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] + **subUid** | **String**| 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 @@ -843,13 +843,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listSubAccountMarginBalances** > List<SubAccountMarginBalance> listSubAccountMarginBalances().subUid(subUid).execute(); -Query sub accounts' margin balances +Query sub-account isolated margin account balance information ### Example @@ -872,7 +872,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); WalletApi apiInstance = new WalletApi(defaultClient); - String subUid = "10003"; // String | User ID of sub-account, you can query multiple records separated by `,`. If not specified, it will return the records of all sub accounts + String subUid = "10003"; // String | Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts try { List result = apiInstance.listSubAccountMarginBalances() .subUid(subUid) @@ -895,7 +895,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subUid** | **String**| 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] + **subUid** | **String**| 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 @@ -913,13 +913,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listSubAccountFuturesBalances** > List<SubAccountFuturesBalance> listSubAccountFuturesBalances().subUid(subUid).settle(settle).execute(); -Query sub accounts' futures account balances +Query sub-account perpetual futures account balance information ### Example @@ -942,8 +942,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); WalletApi apiInstance = new WalletApi(defaultClient); - String subUid = "10003"; // String | User ID of sub-account, you can query multiple records separated by `,`. If not specified, it will return the records of all sub accounts - String settle = "usdt"; // String | Query only balances of specified settle currency + String subUid = "10003"; // String | Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts + String settle = "usdt"; // String | Query balance of specified settlement currency try { List result = apiInstance.listSubAccountFuturesBalances() .subUid(subUid) @@ -967,8 +967,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subUid** | **String**| 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** | **String**| Query only balances of specified settle currency | [optional] + **subUid** | **String**| Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts | [optional] + **settle** | **String**| Query balance of specified settlement currency | [optional] ### Return type @@ -986,13 +986,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listSubAccountCrossMarginBalances** > List<SubAccountCrossMarginBalance> listSubAccountCrossMarginBalances().subUid(subUid).execute(); -Query subaccount's cross_margin account info +Query sub-account cross margin account balance information ### Example @@ -1015,7 +1015,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); WalletApi apiInstance = new WalletApi(defaultClient); - String subUid = "10003"; // String | User ID of sub-account, you can query multiple records separated by `,`. If not specified, it will return the records of all sub accounts + String subUid = "10003"; // String | Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts try { List result = apiInstance.listSubAccountCrossMarginBalances() .subUid(subUid) @@ -1038,7 +1038,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subUid** | **String**| 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] + **subUid** | **String**| 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 @@ -1056,13 +1056,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **listSavedAddress** > List<SavedAddress> listSavedAddress(currency).chain(chain).limit(limit).page(page).execute(); -Query saved address +Query withdrawal address whitelist ### Example @@ -1087,7 +1087,7 @@ public class Example { WalletApi apiInstance = new WalletApi(defaultClient); String currency = "USDT"; // String | Currency String chain = "\"\""; // String | Chain name - String limit = "\"50\""; // String | Maximum number returned, 100 at most + String limit = "\"50\""; // String | Maximum number returned, up to 100 Integer page = 1; // Integer | Page number try { List result = apiInstance.listSavedAddress(currency) @@ -1115,7 +1115,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **currency** | **String**| Currency | **chain** | **String**| Chain name | [optional] [default to ""] - **limit** | **String**| Maximum number returned, 100 at most | [optional] [default to "50"] + **limit** | **String**| Maximum number returned, up to 100 | [optional] [default to "50"] **page** | **Integer**| Page number | [optional] [default to 1] ### Return type @@ -1134,13 +1134,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved successfully | - | # **getTradeFee** > TradeFee getTradeFee().currencyPair(currencyPair).settle(settle).execute(); -Retrieve personal trading fee +Query personal trading fees ### Example @@ -1163,8 +1163,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); WalletApi apiInstance = new WalletApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | 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 - String settle = "BTC"; // String | 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. + String currencyPair = "BTC_USDT"; // String | Specify currency pair to get more accurate fee settings. This field is optional. Usually fee settings are the same for all currency pairs. + String settle = "BTC"; // String | 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. try { TradeFee result = apiInstance.getTradeFee() .currencyPair(currencyPair) @@ -1188,8 +1188,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| 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** | **String**| 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] [enum: BTC, USDT, USD] + **currencyPair** | **String**| 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** | **String**| 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] [enum: BTC, USDT, USD] ### Return type @@ -1207,15 +1207,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Query successful | - | # **getTotalBalance** > TotalBalance getTotalBalance().currency(currency).execute(); -Retrieve user's total balances +Query personal account totals -This endpoint returns an approximate sum of exchanged amount from all currencies to input currency for each account.The exchange rate and account balance could have been cached for at most 1 minute. It is not recommended to use its result for any trading calculation. For trading calculation, use the corresponding account query endpoint for each account type. For example: - `GET /spot/accounts` to query spot account balance - `GET /margin/accounts` to query margin account balance - `GET /futures/{settle}/accounts` to query futures account balance +This query endpoint returns the total *estimated value* of all currencies in each account converted to the input currency. Exchange rates and related account balance information may be cached for up to 1 minute. It is not recommended to use this interface data for real-time calculations. For real-time calculations, query the corresponding balance interface based on account type, such as: - `GET /spot/accounts` to query spot account - `GET /margin/accounts` to query margin account - `GET /futures/{settle}/accounts` to query futures account ### Example @@ -1238,7 +1238,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); WalletApi apiInstance = new WalletApi(defaultClient); - String currency = "\"USDT\""; // String | Currency unit used to calculate the balance amount. BTC, CNY, USD and USDT are allowed. USDT is the default. + String currency = "\"USDT\""; // String | Target currency type for statistical conversion. Accepts BTC, CNY, USD, and USDT. USDT is the default value try { TotalBalance result = apiInstance.getTotalBalance() .currency(currency) @@ -1261,7 +1261,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Currency unit used to calculate the balance amount. BTC, CNY, USD and USDT are allowed. USDT is the default. | [optional] [default to "USDT"] + **currency** | **String**| Target currency type for statistical conversion. Accepts BTC, CNY, USD, and USDT. USDT is the default value | [optional] [default to "USDT"] ### Return type @@ -1279,13 +1279,13 @@ 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 | - | # **listSmallBalance** > List<SmallBalance> listSmallBalance() -List small balance +Get list of convertible small balance currencies ### Example @@ -1349,7 +1349,7 @@ This endpoint does not need any parameter. # **convertSmallBalance** > convertSmallBalance(convertSmallBalance) -Convert small balance +Convert small balance currency ### Example @@ -1416,7 +1416,7 @@ null (empty response body) # **listSmallBalanceHistory** > List<SmallBalanceHistory> listSmallBalanceHistory().currency(currency).page(page).limit(limit).execute(); -List small balance history +Get convertible small balance currency history ### Example @@ -1439,9 +1439,9 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); WalletApi apiInstance = new WalletApi(defaultClient); - String currency = "currency_example"; // String | Currency + String currency = "currency_example"; // String | Currency to convert Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 100 + Integer limit = 100; // Integer | Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 try { List result = apiInstance.listSmallBalanceHistory() .currency(currency) @@ -1466,9 +1466,9 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Currency | [optional] + **currency** | **String**| Currency to convert | [optional] **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100] + **limit** | **Integer**| Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100] ### Return type @@ -1492,7 +1492,7 @@ Name | Type | Description | Notes # **listPushOrders** > List<UidPushOrder> listPushOrders().id(id).from(from).to(to).limit(limit).offset(offset).transactionType(transactionType).execute(); -Retrieve the UID transfer history +Get UID transfer history ### Example @@ -1516,11 +1516,11 @@ public class Example { WalletApi apiInstance = new WalletApi(defaultClient); Integer id = 56; // Integer | Order ID - Integer from = 56; // Integer | The start time of the query record. If not specified, it defaults to 7 days forward from the current time, in seconds Unix timestamp - Integer to = 56; // Integer | The end time of the query record. If not specified, the default is the current time, which is a Unix timestamp in seconds. - Integer limit = 100; // Integer | The maximum number of items returned in the list, the default value is 100 + Integer from = 56; // Integer | Start time for querying records. If not specified, defaults to 7 days before the current time. Unix timestamp in seconds + Integer to = 56; // Integer | End time for querying records. If not specified, defaults to the current time. Unix timestamp in seconds + Integer limit = 100; // Integer | Maximum number of items returned in the list, default value is 100 Integer offset = 0; // Integer | List offset, starting from 0 - String transactionType = "\"withdraw\""; // String | The list returns the order type `withdraw`, `deposit`, the default is `withdraw`. + String transactionType = "\"withdraw\""; // String | Order type returned in the list: `withdraw`, `deposit`. Default is `withdraw`. try { List result = apiInstance.listPushOrders() .id(id) @@ -1549,11 +1549,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **Integer**| Order ID | [optional] - **from** | **Integer**| 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** | **Integer**| 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** | **Integer**| The maximum number of items returned in the list, the default value is 100 | [optional] [default to 100] + **from** | **Integer**| Start time for querying records. If not specified, defaults to 7 days before the current time. Unix timestamp in seconds | [optional] + **to** | **Integer**| End time for querying records. If not specified, defaults to the current time. Unix timestamp in seconds | [optional] + **limit** | **Integer**| Maximum number of items returned in the list, default value is 100 | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] - **transactionType** | **String**| The list returns the order type `withdraw`, `deposit`, the default is `withdraw`. | [optional] [default to "withdraw"] + **transactionType** | **String**| Order type returned in the list: `withdraw`, `deposit`. Default is `withdraw`. | [optional] [default to "withdraw"] ### Return type diff --git a/docs/WithdrawStatus.md b/docs/WithdrawStatus.md index 953e781..8ae61da 100644 --- a/docs/WithdrawStatus.md +++ b/docs/WithdrawStatus.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **currency** | **String** | Currency | [optional] **name** | **String** | Currency name | [optional] **nameCn** | **String** | Currency Chinese name | [optional] -**deposit** | **String** | Deposits fee | [optional] +**deposit** | **String** | Deposit fee | [optional] **withdrawPercent** | **String** | Withdrawal fee rate percentage | [optional] **withdrawFix** | **String** | Fixed withdrawal fee | [optional] **withdrawDayLimit** | **String** | Daily allowed withdrawal amount | [optional] diff --git a/docs/WithdrawalApi.md b/docs/WithdrawalApi.md index c1d76ab..167f992 100644 --- a/docs/WithdrawalApi.md +++ b/docs/WithdrawalApi.md @@ -15,7 +15,7 @@ Method | HTTP request | Description Withdraw -Withdrawals to Gate addresses do not incur transaction fees. +If the recipient's on-chain address is also Gate, no transaction fee will be charged ### Example @@ -77,7 +77,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Withdraw request is accepted. Refer to withdrawal records for status | - | +**200** | Withdrawal request accepted. Check withdrawal record status for processing result | - | # **withdrawPushOrder** @@ -85,7 +85,7 @@ Name | Type | Description | Notes UID transfer -Transfers between main spot accounts are allowed; however, both parties cannot be sub-accounts +Transfers between main spot accounts. Both parties cannot be sub-accounts ### Example @@ -147,7 +147,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | The request has been accepted. Check the withdrawal record status for the processing result. | - | +**200** | Request accepted. Check withdrawal record status for processing result | - | # **cancelWithdrawal** @@ -215,5 +215,5 @@ 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 | - | diff --git a/docs/WithdrawalRecord.md b/docs/WithdrawalRecord.md index 54c9f53..58247a8 100644 --- a/docs/WithdrawalRecord.md +++ b/docs/WithdrawalRecord.md @@ -7,15 +7,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | Record ID | [optional] [readonly] **txid** | **String** | Hash record of the withdrawal | [optional] [readonly] -**blockNumber** | **String** | 区块编号 | [optional] [readonly] +**blockNumber** | **String** | Block Number | [optional] [readonly] **withdrawOrderId** | **String** | Client order id, up to 32 length and can only include 0-9, A-Z, a-z, underscore(_), hyphen(-) or dot(.) | [optional] **timestamp** | **String** | Operation time | [optional] [readonly] -**amount** | **String** | Currency amount | +**amount** | **String** | Token amount | **fee** | **String** | fee | [optional] [readonly] **currency** | **String** | Currency name | **address** | **String** | Withdrawal address | [optional] -**failReason** | **String** | The reason for withdrawal failure is that there is a value when status = CANCEL, and the rest of the state is empty | [optional] -**timestamp2** | **String** | 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 time to withdrawal success | [optional] +**failReason** | **String** | Reason for withdrawal failure. Has a value when status = CANCEL, empty for all other statuses | [optional] +**timestamp2** | **String** | 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** | **String** | Additional remarks with regards to the withdrawal | [optional] **status** | **String** | 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** | **String** | Name of the chain used in withdrawals | diff --git a/pom.xml b/pom.xml index 4f310b5..66fdb7c 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ gate-api jar gate-api - 6.98.0 + 7.1.8 https://github.com/gateio/gateapi-java.git Java client for gateapi @@ -25,9 +25,9 @@ Gate - support@mail.gate.io + support@mail.gate.com Gate - https://www.gate.io + https://www.gate.com @@ -185,12 +185,16 @@ org.sonatype.plugins nexus-staging-maven-plugin - 1.6.7 + 1.6.13 true ossrh - https://s01.oss.sonatype.org/ + https://ossrh-staging-api.central.sonatype.com true + 20 + 10 + true + true @@ -230,11 +234,11 @@ ossrh - https://s01.oss.sonatype.org/content/repositories/snapshots + https://ossrh-staging-api.central.sonatype.com/content/repositories/snapshots ossrh - https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/ + https://ossrh-staging-api.central.sonatype.com/service/local/staging/deploy/maven2/ diff --git a/settings.xml b/settings.xml index d1d41b5..68ff477 100644 --- a/settings.xml +++ b/settings.xml @@ -4,8 +4,8 @@ ossrh - ${env.MAVEN_USERNAME} - ${env.MAVEN_CENTRAL_TOKEN} + ${env.MAVEN_CENTRAL_USERNAME} + ${env.MAVEN_CENTRAL_PASSWORD} gpg.passphrase diff --git a/src/main/java/io/gate/gateapi/ApiCallback.java b/src/main/java/io/gate/gateapi/ApiCallback.java index 7a57edd..8b0ed68 100644 --- a/src/main/java/io/gate/gateapi/ApiCallback.java +++ b/src/main/java/io/gate/gateapi/ApiCallback.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/ApiClient.java b/src/main/java/io/gate/gateapi/ApiClient.java index 297aa6f..177103f 100644 --- a/src/main/java/io/gate/gateapi/ApiClient.java +++ b/src/main/java/io/gate/gateapi/ApiClient.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -113,7 +113,7 @@ private void init() { json = new JSON(); // Set default User-Agent. - setUserAgent("OpenAPI-Generator/6.98.0/java"); + setUserAgent("OpenAPI-Generator/7.1.8/java"); authentications = new HashMap(); } diff --git a/src/main/java/io/gate/gateapi/ApiException.java b/src/main/java/io/gate/gateapi/ApiException.java index 1427799..435362e 100644 --- a/src/main/java/io/gate/gateapi/ApiException.java +++ b/src/main/java/io/gate/gateapi/ApiException.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/ApiResponse.java b/src/main/java/io/gate/gateapi/ApiResponse.java index d24de01..d019d81 100644 --- a/src/main/java/io/gate/gateapi/ApiResponse.java +++ b/src/main/java/io/gate/gateapi/ApiResponse.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/Configuration.java b/src/main/java/io/gate/gateapi/Configuration.java index e51b74d..50578fc 100644 --- a/src/main/java/io/gate/gateapi/Configuration.java +++ b/src/main/java/io/gate/gateapi/Configuration.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/GzipRequestInterceptor.java b/src/main/java/io/gate/gateapi/GzipRequestInterceptor.java index aa2a2b2..363f118 100644 --- a/src/main/java/io/gate/gateapi/GzipRequestInterceptor.java +++ b/src/main/java/io/gate/gateapi/GzipRequestInterceptor.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/JSON.java b/src/main/java/io/gate/gateapi/JSON.java index 4fd2743..2d66d18 100644 --- a/src/main/java/io/gate/gateapi/JSON.java +++ b/src/main/java/io/gate/gateapi/JSON.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/Pair.java b/src/main/java/io/gate/gateapi/Pair.java index 4d937f7..95acb44 100644 --- a/src/main/java/io/gate/gateapi/Pair.java +++ b/src/main/java/io/gate/gateapi/Pair.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/ProgressRequestBody.java b/src/main/java/io/gate/gateapi/ProgressRequestBody.java index a9ba389..c36f23e 100644 --- a/src/main/java/io/gate/gateapi/ProgressRequestBody.java +++ b/src/main/java/io/gate/gateapi/ProgressRequestBody.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/ProgressResponseBody.java b/src/main/java/io/gate/gateapi/ProgressResponseBody.java index 1e2c15a..ce6f7c0 100644 --- a/src/main/java/io/gate/gateapi/ProgressResponseBody.java +++ b/src/main/java/io/gate/gateapi/ProgressResponseBody.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/StringUtil.java b/src/main/java/io/gate/gateapi/StringUtil.java index 860b4bf..38ce9f0 100644 --- a/src/main/java/io/gate/gateapi/StringUtil.java +++ b/src/main/java/io/gate/gateapi/StringUtil.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/api/AccountApi.java b/src/main/java/io/gate/gateapi/api/AccountApi.java index a6fbab3..3e3d775 100644 --- a/src/main/java/io/gate/gateapi/api/AccountApi.java +++ b/src/main/java/io/gate/gateapi/api/AccountApi.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -59,7 +59,7 @@ public void setApiClient(ApiClient apiClient) { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public okhttp3.Call getAccountDetailCall(final ApiCallback _callback) throws ApiException { @@ -98,14 +98,14 @@ private okhttp3.Call getAccountDetailValidateBeforeCall(final ApiCallback _callb } /** - * Get account detail + * Retrieve user account information * * @return AccountDetail * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public AccountDetail getAccountDetail() throws ApiException { @@ -114,14 +114,14 @@ public AccountDetail getAccountDetail() throws ApiException { } /** - * Get account detail + * Retrieve user account information * * @return ApiResponse<AccountDetail> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public ApiResponse getAccountDetailWithHttpInfo() throws ApiException { @@ -131,7 +131,7 @@ public ApiResponse getAccountDetailWithHttpInfo() throws ApiExcep } /** - * Get account detail (asynchronously) + * Retrieve user account information (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -139,7 +139,7 @@ public ApiResponse getAccountDetailWithHttpInfo() throws ApiExcep * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public okhttp3.Call getAccountDetailAsync(final ApiCallback _callback) throws ApiException { @@ -157,7 +157,7 @@ public okhttp3.Call getAccountDetailAsync(final ApiCallback _call * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public okhttp3.Call getAccountRateLimitCall(final ApiCallback _callback) throws ApiException { @@ -203,7 +203,7 @@ private okhttp3.Call getAccountRateLimitValidateBeforeCall(final ApiCallback _ca * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public List getAccountRateLimit() throws ApiException { @@ -219,7 +219,7 @@ public List getAccountRateLimit() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public ApiResponse> getAccountRateLimitWithHttpInfo() throws ApiException { @@ -237,7 +237,7 @@ public ApiResponse> getAccountRateLimitWithHttpInfo() thr * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public okhttp3.Call getAccountRateLimitAsync(final ApiCallback> _callback) throws ApiException { @@ -308,7 +308,7 @@ private APIlistSTPGroupsRequest() { /** * Set name - * @param name Perform a fuzzy search based on the name (optional) + * @param name Fuzzy search by name (optional) * @return APIlistSTPGroupsRequest */ public APIlistSTPGroupsRequest name(String name) { @@ -324,7 +324,7 @@ public APIlistSTPGroupsRequest name(String name) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -338,7 +338,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -353,7 +353,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -368,7 +368,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -377,13 +377,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) th } /** - * List STP Groups - * Retrieve the list of STP groups created by the main account user only + * Query STP user groups created by the user + * Only query STP user groups created by the current main account * @return APIlistSTPGroupsRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistSTPGroupsRequest listSTPGroups() { @@ -399,7 +399,7 @@ public APIlistSTPGroupsRequest listSTPGroups() { * @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 -
*/ public okhttp3.Call createSTPGroupCall(StpGroup stpGroup, final ApiCallback _callback) throws ApiException { @@ -443,7 +443,7 @@ private okhttp3.Call createSTPGroupValidateBeforeCall(StpGroup stpGroup, final A } /** - * Create STP Group + * Create STP user group * Only the main account is allowed to create a new STP user group * @param stpGroup (required) * @return StpGroup @@ -451,7 +451,7 @@ private okhttp3.Call createSTPGroupValidateBeforeCall(StpGroup stpGroup, final A * @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 -
*/ public StpGroup createSTPGroup(StpGroup stpGroup) throws ApiException { @@ -460,7 +460,7 @@ public StpGroup createSTPGroup(StpGroup stpGroup) throws ApiException { } /** - * Create STP Group + * Create STP user group * Only the main account is allowed to create a new STP user group * @param stpGroup (required) * @return ApiResponse<StpGroup> @@ -468,7 +468,7 @@ public StpGroup createSTPGroup(StpGroup stpGroup) throws ApiException { * @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 -
*/ public ApiResponse createSTPGroupWithHttpInfo(StpGroup stpGroup) throws ApiException { @@ -478,7 +478,7 @@ public ApiResponse createSTPGroupWithHttpInfo(StpGroup stpGroup) throw } /** - * Create STP Group (asynchronously) + * Create STP user group (asynchronously) * Only the main account is allowed to create a new STP user group * @param stpGroup (required) * @param _callback The callback to be executed when the API call finishes @@ -487,7 +487,7 @@ public ApiResponse createSTPGroupWithHttpInfo(StpGroup stpGroup) throw * @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 -
*/ public okhttp3.Call createSTPGroupAsync(StpGroup stpGroup, final ApiCallback _callback) throws ApiException { @@ -506,7 +506,7 @@ public okhttp3.Call createSTPGroupAsync(StpGroup stpGroup, final ApiCallback Status Code Description Response Headers - 200 List retrieved - + 200 List retrieved successfully - */ public okhttp3.Call listSTPGroupsUsersCall(Long stpId, final ApiCallback _callback) throws ApiException { @@ -551,15 +551,15 @@ private okhttp3.Call listSTPGroupsUsersValidateBeforeCall(Long stpId, final ApiC } /** - * List users of the STP group - * Only the main account that created this STP group is allowed to list the user ID of the STP group + * Query users in the STP user group + * Only the main account that created this STP group can query the account ID list in the current STP group * @param stpId STP Group ID (required) * @return List<StpGroupUser> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List listSTPGroupsUsers(Long stpId) throws ApiException { @@ -568,15 +568,15 @@ public List listSTPGroupsUsers(Long stpId) throws ApiException { } /** - * List users of the STP group - * Only the main account that created this STP group is allowed to list the user ID of the STP group + * Query users in the STP user group + * Only the main account that created this STP group can query the account ID list in the current STP group * @param stpId STP Group ID (required) * @return ApiResponse<List<StpGroupUser>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> listSTPGroupsUsersWithHttpInfo(Long stpId) throws ApiException { @@ -586,8 +586,8 @@ public ApiResponse> listSTPGroupsUsersWithHttpInfo(Long stpId } /** - * List users of the STP group (asynchronously) - * Only the main account that created this STP group is allowed to list the user ID of the STP group + * Query users in the STP user group (asynchronously) + * Only the main account that created this STP group can query the account ID list in the current STP group * @param stpId STP Group ID (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -595,7 +595,7 @@ public ApiResponse> listSTPGroupsUsersWithHttpInfo(Long stpId * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call listSTPGroupsUsersAsync(Long stpId, final ApiCallback> _callback) throws ApiException { @@ -615,7 +615,7 @@ public okhttp3.Call listSTPGroupsUsersAsync(Long stpId, final ApiCallback 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 - */ public okhttp3.Call addSTPGroupUsersCall(Long stpId, List requestBody, final ApiCallback _callback) throws ApiException { @@ -665,8 +665,8 @@ private okhttp3.Call addSTPGroupUsersValidateBeforeCall(Long stpId, List r } /** - * Add users to the STP group - * - Only the master account that created the STP user group is allowed to add users to the STP user group.- Only accounts under the main account are allowed to be added. Cross-account is not permitted + * Add users to the STP user group + * - 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 * @param stpId STP Group ID (required) * @param requestBody User ID (required) * @return List<StpGroupUser> @@ -674,7 +674,7 @@ private okhttp3.Call addSTPGroupUsersValidateBeforeCall(Long stpId, List r * @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 -
*/ public List addSTPGroupUsers(Long stpId, List requestBody) throws ApiException { @@ -683,8 +683,8 @@ public List addSTPGroupUsers(Long stpId, List requestBody) t } /** - * Add users to the STP group - * - Only the master account that created the STP user group is allowed to add users to the STP user group.- Only accounts under the main account are allowed to be added. Cross-account is not permitted + * Add users to the STP user group + * - 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 * @param stpId STP Group ID (required) * @param requestBody User ID (required) * @return ApiResponse<List<StpGroupUser>> @@ -692,7 +692,7 @@ public List addSTPGroupUsers(Long stpId, List requestBody) t * @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 -
*/ public ApiResponse> addSTPGroupUsersWithHttpInfo(Long stpId, List requestBody) throws ApiException { @@ -702,8 +702,8 @@ public ApiResponse> addSTPGroupUsersWithHttpInfo(Long stpId, } /** - * Add users to the STP group (asynchronously) - * - Only the master account that created the STP user group is allowed to add users to the STP user group.- Only accounts under the main account are allowed to be added. Cross-account is not permitted + * Add users to the STP user group (asynchronously) + * - 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 * @param stpId STP Group ID (required) * @param requestBody User ID (required) * @param _callback The callback to be executed when the API call finishes @@ -712,7 +712,7 @@ public ApiResponse> addSTPGroupUsersWithHttpInfo(Long stpId, * @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 -
*/ public okhttp3.Call addSTPGroupUsersAsync(Long stpId, List requestBody, final ApiCallback> _callback) throws ApiException { @@ -725,14 +725,14 @@ public okhttp3.Call addSTPGroupUsersAsync(Long stpId, List requestBody, fi /** * Build call for deleteSTPGroupUsers * @param stpId STP Group ID (required) - * @param userId STP user ID, multiple can be separated by commas (required) + * @param userId STP user IDs, multiple IDs can be separated by commas (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Users deleted successfully, returns current users in the STP group -
*/ public okhttp3.Call deleteSTPGroupUsersCall(Long stpId, Long userId, final ApiCallback _callback) throws ApiException { @@ -786,16 +786,16 @@ private okhttp3.Call deleteSTPGroupUsersValidateBeforeCall(Long stpId, Long user } /** - * 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 * @param stpId STP Group ID (required) - * @param userId STP user ID, multiple can be separated by commas (required) + * @param userId STP user IDs, multiple IDs can be separated by commas (required) * @return List<StpGroupUser> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Users deleted successfully, returns current users in the STP group -
*/ public List deleteSTPGroupUsers(Long stpId, Long userId) throws ApiException { @@ -804,16 +804,16 @@ public List deleteSTPGroupUsers(Long stpId, Long userId) throws Ap } /** - * 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 * @param stpId STP Group ID (required) - * @param userId STP user ID, multiple can be separated by commas (required) + * @param userId STP user IDs, multiple IDs can be separated by commas (required) * @return ApiResponse<List<StpGroupUser>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Users deleted successfully, returns current users in the STP group -
*/ public ApiResponse> deleteSTPGroupUsersWithHttpInfo(Long stpId, Long userId) throws ApiException { @@ -823,17 +823,17 @@ public ApiResponse> deleteSTPGroupUsersWithHttpInfo(Long stpI } /** - * Delete the user in the STP group (asynchronously) + * Delete users from the STP user group (asynchronously) * - 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 * @param stpId STP Group ID (required) - * @param userId STP user ID, multiple can be separated by commas (required) + * @param userId STP user IDs, multiple IDs can be separated by commas (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Users deleted successfully, returns current users in the STP group -
*/ public okhttp3.Call deleteSTPGroupUsersAsync(Long stpId, Long userId, final ApiCallback> _callback) throws ApiException { @@ -890,8 +890,8 @@ private okhttp3.Call getDebitFeeValidateBeforeCall(final ApiCallback _callback) } /** - * Query GT deduction configuration. - * Query the current GT deduction configuration for the account. + * Query GT fee deduction configuration + * Query the GT fee deduction configuration for the current account * @return DebitFee * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -906,8 +906,8 @@ public DebitFee getDebitFee() throws ApiException { } /** - * Query GT deduction configuration. - * Query the current GT deduction configuration for the account. + * Query GT fee deduction configuration + * Query the GT fee deduction configuration for the current account * @return ApiResponse<DebitFee> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -923,8 +923,8 @@ public ApiResponse getDebitFeeWithHttpInfo() throws ApiException { } /** - * Query GT deduction configuration. (asynchronously) - * Query the current GT deduction configuration for the account. + * Query GT fee deduction configuration (asynchronously) + * Query the GT fee deduction configuration for the current account * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -994,8 +994,8 @@ private okhttp3.Call setDebitFeeValidateBeforeCall(DebitFee debitFee, final ApiC } /** - * Set GT deduction. - * Enable or disable GT deduction for the current account. + * Configure GT fee deduction + * Enable or disable GT fee deduction for the current account * @param debitFee (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1009,8 +1009,8 @@ public void setDebitFee(DebitFee debitFee) throws ApiException { } /** - * Set GT deduction. - * Enable or disable GT deduction for the current account. + * Configure GT fee deduction + * Enable or disable GT fee deduction for the current account * @param debitFee (required) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -1026,8 +1026,8 @@ public ApiResponse setDebitFeeWithHttpInfo(DebitFee debitFee) throws ApiEx } /** - * Set GT deduction. (asynchronously) - * Enable or disable GT deduction for the current account. + * Configure GT fee deduction (asynchronously) + * Enable or disable GT fee deduction for the current account * @param debitFee (required) * @param _callback The callback to be executed when the API call finishes * @return The request call diff --git a/src/main/java/io/gate/gateapi/api/CollateralLoanApi.java b/src/main/java/io/gate/gateapi/api/CollateralLoanApi.java index 7bad281..135456c 100644 --- a/src/main/java/io/gate/gateapi/api/CollateralLoanApi.java +++ b/src/main/java/io/gate/gateapi/api/CollateralLoanApi.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -143,7 +143,7 @@ public APIlistCollateralLoanOrdersRequest page(Integer page) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistCollateralLoanOrdersRequest */ public APIlistCollateralLoanOrdersRequest limit(Integer limit) { @@ -153,7 +153,7 @@ public APIlistCollateralLoanOrdersRequest limit(Integer limit) { /** * Set collateralCurrency - * @param collateralCurrency Collateral (optional) + * @param collateralCurrency Collateral currency (optional) * @return APIlistCollateralLoanOrdersRequest */ public APIlistCollateralLoanOrdersRequest collateralCurrency(String collateralCurrency) { @@ -179,7 +179,7 @@ public APIlistCollateralLoanOrdersRequest borrowCurrency(String borrowCurrency) * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -193,7 +193,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -208,7 +208,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -223,7 +223,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcept * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -232,13 +232,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callb } /** - * List Orders + * Query collateral loan order list * * @return APIlistCollateralLoanOrdersRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistCollateralLoanOrdersRequest listCollateralLoanOrders() { @@ -254,7 +254,7 @@ public APIlistCollateralLoanOrdersRequest listCollateralLoanOrders() { * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Order placed successfully -
*/ public okhttp3.Call createCollateralLoanCall(CreateCollateralOrder createCollateralOrder, final ApiCallback _callback) throws ApiException { @@ -298,7 +298,7 @@ private okhttp3.Call createCollateralLoanValidateBeforeCall(CreateCollateralOrde } /** - * Place order + * Place collateral loan order * * @param createCollateralOrder (required) * @return OrderResp @@ -306,7 +306,7 @@ private okhttp3.Call createCollateralLoanValidateBeforeCall(CreateCollateralOrde * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Order placed successfully -
*/ public OrderResp createCollateralLoan(CreateCollateralOrder createCollateralOrder) throws ApiException { @@ -315,7 +315,7 @@ public OrderResp createCollateralLoan(CreateCollateralOrder createCollateralOrde } /** - * Place order + * Place collateral loan order * * @param createCollateralOrder (required) * @return ApiResponse<OrderResp> @@ -323,7 +323,7 @@ public OrderResp createCollateralLoan(CreateCollateralOrder createCollateralOrde * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Order placed successfully -
*/ public ApiResponse createCollateralLoanWithHttpInfo(CreateCollateralOrder createCollateralOrder) throws ApiException { @@ -333,7 +333,7 @@ public ApiResponse createCollateralLoanWithHttpInfo(CreateCollateralO } /** - * Place order (asynchronously) + * Place collateral loan order (asynchronously) * * @param createCollateralOrder (required) * @param _callback The callback to be executed when the API call finishes @@ -342,7 +342,7 @@ public ApiResponse createCollateralLoanWithHttpInfo(CreateCollateralO * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Order placed successfully -
*/ public okhttp3.Call createCollateralLoanAsync(CreateCollateralOrder createCollateralOrder, final ApiCallback _callback) throws ApiException { @@ -354,14 +354,14 @@ public okhttp3.Call createCollateralLoanAsync(CreateCollateralOrder createCollat /** * Build call for getCollateralLoanOrderDetail - * @param orderId Order ID returned on successful order creation (required) + * @param orderId Order ID returned when order is successfully created (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Order details queried successfully -
*/ public okhttp3.Call getCollateralLoanOrderDetailCall(Long orderId, final ApiCallback _callback) throws ApiException { @@ -406,15 +406,15 @@ private okhttp3.Call getCollateralLoanOrderDetailValidateBeforeCall(Long orderId } /** - * Get a single order + * Query single order details * - * @param orderId Order ID returned on successful order creation (required) + * @param orderId Order ID returned when order is successfully created (required) * @return CollateralOrder * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Order details queried successfully -
*/ public CollateralOrder getCollateralLoanOrderDetail(Long orderId) throws ApiException { @@ -423,15 +423,15 @@ public CollateralOrder getCollateralLoanOrderDetail(Long orderId) throws ApiExce } /** - * Get a single order + * Query single order details * - * @param orderId Order ID returned on successful order creation (required) + * @param orderId Order ID returned when order is successfully created (required) * @return ApiResponse<CollateralOrder> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Order details queried successfully -
*/ public ApiResponse getCollateralLoanOrderDetailWithHttpInfo(Long orderId) throws ApiException { @@ -441,16 +441,16 @@ public ApiResponse getCollateralLoanOrderDetailWithHttpInfo(Lon } /** - * Get a single order (asynchronously) + * Query single order details (asynchronously) * - * @param orderId Order ID returned on successful order creation (required) + * @param orderId Order ID returned when order is successfully created (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Order details queried successfully -
*/ public okhttp3.Call getCollateralLoanOrderDetailAsync(Long orderId, final ApiCallback _callback) throws ApiException { @@ -469,7 +469,7 @@ public okhttp3.Call getCollateralLoanOrderDetailAsync(Long orderId, final ApiCal * @http.response.details - +
Status Code Description Response Headers
200 Operated successfully -
200 Operation successful -
*/ public okhttp3.Call repayCollateralLoanCall(RepayLoan repayLoan, final ApiCallback _callback) throws ApiException { @@ -513,7 +513,7 @@ private okhttp3.Call repayCollateralLoanValidateBeforeCall(RepayLoan repayLoan, } /** - * Repayment + * Collateral loan repayment * * @param repayLoan (required) * @return RepayResp @@ -521,7 +521,7 @@ private okhttp3.Call repayCollateralLoanValidateBeforeCall(RepayLoan repayLoan, * @http.response.details - +
Status Code Description Response Headers
200 Operated successfully -
200 Operation successful -
*/ public RepayResp repayCollateralLoan(RepayLoan repayLoan) throws ApiException { @@ -530,7 +530,7 @@ public RepayResp repayCollateralLoan(RepayLoan repayLoan) throws ApiException { } /** - * Repayment + * Collateral loan repayment * * @param repayLoan (required) * @return ApiResponse<RepayResp> @@ -538,7 +538,7 @@ public RepayResp repayCollateralLoan(RepayLoan repayLoan) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Operated successfully -
200 Operation successful -
*/ public ApiResponse repayCollateralLoanWithHttpInfo(RepayLoan repayLoan) throws ApiException { @@ -548,7 +548,7 @@ public ApiResponse repayCollateralLoanWithHttpInfo(RepayLoan repayLoa } /** - * Repayment (asynchronously) + * Collateral loan repayment (asynchronously) * * @param repayLoan (required) * @param _callback The callback to be executed when the API call finishes @@ -557,7 +557,7 @@ public ApiResponse repayCollateralLoanWithHttpInfo(RepayLoan repayLoa * @http.response.details - +
Status Code Description Response Headers
200 Operated successfully -
200 Operation successful -
*/ public okhttp3.Call repayCollateralLoanAsync(RepayLoan repayLoan, final ApiCallback _callback) throws ApiException { @@ -674,7 +674,7 @@ public APIlistRepayRecordsRequest borrowCurrency(String borrowCurrency) { /** * Set collateralCurrency - * @param collateralCurrency Collateral (optional) + * @param collateralCurrency Collateral currency (optional) * @return APIlistRepayRecordsRequest */ public APIlistRepayRecordsRequest collateralCurrency(String collateralCurrency) { @@ -694,7 +694,7 @@ public APIlistRepayRecordsRequest page(Integer page) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistRepayRecordsRequest */ public APIlistRepayRecordsRequest limit(Integer limit) { @@ -704,7 +704,7 @@ public APIlistRepayRecordsRequest limit(Integer limit) { /** * Set from - * @param from Start timestamp of the query (optional) + * @param from Start timestamp for the query (optional) * @return APIlistRepayRecordsRequest */ public APIlistRepayRecordsRequest from(Long from) { @@ -714,7 +714,7 @@ public APIlistRepayRecordsRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to End timestamp for the query, defaults to current time if not specified (optional) * @return APIlistRepayRecordsRequest */ public APIlistRepayRecordsRequest to(Long to) { @@ -730,7 +730,7 @@ public APIlistRepayRecordsRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -744,7 +744,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -759,7 +759,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -774,7 +774,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -783,14 +783,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) } /** - * Repayment history + * Query collateral loan repayment records * * @param source Operation type: repay - Regular repayment, liquidate - Liquidation (required) * @return APIlistRepayRecordsRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIlistRepayRecordsRequest listRepayRecords(String source) { @@ -893,7 +893,7 @@ public APIlistCollateralRecordsRequest page(Integer page) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistCollateralRecordsRequest */ public APIlistCollateralRecordsRequest limit(Integer limit) { @@ -903,7 +903,7 @@ public APIlistCollateralRecordsRequest limit(Integer limit) { /** * Set from - * @param from Start timestamp of the query (optional) + * @param from Start timestamp for the query (optional) * @return APIlistCollateralRecordsRequest */ public APIlistCollateralRecordsRequest from(Long from) { @@ -913,7 +913,7 @@ public APIlistCollateralRecordsRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to End timestamp for the query, defaults to current time if not specified (optional) * @return APIlistCollateralRecordsRequest */ public APIlistCollateralRecordsRequest to(Long to) { @@ -933,7 +933,7 @@ public APIlistCollateralRecordsRequest borrowCurrency(String borrowCurrency) { /** * Set collateralCurrency - * @param collateralCurrency Collateral (optional) + * @param collateralCurrency Collateral currency (optional) * @return APIlistCollateralRecordsRequest */ public APIlistCollateralRecordsRequest collateralCurrency(String collateralCurrency) { @@ -949,7 +949,7 @@ public APIlistCollateralRecordsRequest collateralCurrency(String collateralCurre * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -963,7 +963,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -978,7 +978,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -993,7 +993,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcep * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1008,7 +1008,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _call * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIlistCollateralRecordsRequest listCollateralRecords() { @@ -1024,7 +1024,7 @@ public APIlistCollateralRecordsRequest listCollateralRecords() { * @http.response.details - +
Status Code Description Response Headers
204 Operated successfully -
204 Operation successful -
*/ public okhttp3.Call operateCollateralCall(CollateralAlign collateralAlign, final ApiCallback _callback) throws ApiException { @@ -1075,7 +1075,7 @@ private okhttp3.Call operateCollateralValidateBeforeCall(CollateralAlign collate * @http.response.details - +
Status Code Description Response Headers
204 Operated successfully -
204 Operation successful -
*/ public void operateCollateral(CollateralAlign collateralAlign) throws ApiException { @@ -1091,7 +1091,7 @@ public void operateCollateral(CollateralAlign collateralAlign) throws ApiExcepti * @http.response.details - +
Status Code Description Response Headers
204 Operated successfully -
204 Operation successful -
*/ public ApiResponse operateCollateralWithHttpInfo(CollateralAlign collateralAlign) throws ApiException { @@ -1109,7 +1109,7 @@ public ApiResponse operateCollateralWithHttpInfo(CollateralAlign collatera * @http.response.details - +
Status Code Description Response Headers
204 Operated successfully -
204 Operation successful -
*/ public okhttp3.Call operateCollateralAsync(CollateralAlign collateralAlign, final ApiCallback _callback) throws ApiException { @@ -1126,7 +1126,7 @@ public okhttp3.Call operateCollateralAsync(CollateralAlign collateralAlign, fina * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getUserTotalAmountCall(final ApiCallback _callback) throws ApiException { @@ -1165,14 +1165,14 @@ private okhttp3.Call getUserTotalAmountValidateBeforeCall(final ApiCallback _cal } /** - * Query the total borrowing and collateral amount for the user + * Query user's total borrowing and collateral amount * * @return UserTotalAmount * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public UserTotalAmount getUserTotalAmount() throws ApiException { @@ -1181,14 +1181,14 @@ public UserTotalAmount getUserTotalAmount() throws ApiException { } /** - * Query the total borrowing and collateral amount for the user + * Query user's total borrowing and collateral amount * * @return ApiResponse<UserTotalAmount> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse getUserTotalAmountWithHttpInfo() throws ApiException { @@ -1198,7 +1198,7 @@ public ApiResponse getUserTotalAmountWithHttpInfo() throws ApiE } /** - * Query the total borrowing and collateral amount for the user (asynchronously) + * Query user's total borrowing and collateral amount (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1206,7 +1206,7 @@ public ApiResponse getUserTotalAmountWithHttpInfo() throws ApiE * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getUserTotalAmountAsync(final ApiCallback _callback) throws ApiException { @@ -1218,7 +1218,7 @@ public okhttp3.Call getUserTotalAmountAsync(final ApiCallback _ /** * Build call for getUserLtvInfo - * @param collateralCurrency Collateral (required) + * @param collateralCurrency Collateral currency (required) * @param borrowCurrency Borrowed currency (required) * @param _callback Callback for upload/download progress * @return Call to execute @@ -1226,7 +1226,7 @@ public okhttp3.Call getUserTotalAmountAsync(final ApiCallback _ * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getUserLtvInfoCall(String collateralCurrency, String borrowCurrency, final ApiCallback _callback) throws ApiException { @@ -1283,16 +1283,16 @@ private okhttp3.Call getUserLtvInfoValidateBeforeCall(String collateralCurrency, } /** - * Query user's collateralization ratio + * Query user's collateralization ratio and remaining borrowable currencies * - * @param collateralCurrency Collateral (required) + * @param collateralCurrency Collateral currency (required) * @param borrowCurrency Borrowed currency (required) * @return UserLtvInfo * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public UserLtvInfo getUserLtvInfo(String collateralCurrency, String borrowCurrency) throws ApiException { @@ -1301,16 +1301,16 @@ public UserLtvInfo getUserLtvInfo(String collateralCurrency, String borrowCurren } /** - * Query user's collateralization ratio + * Query user's collateralization ratio and remaining borrowable currencies * - * @param collateralCurrency Collateral (required) + * @param collateralCurrency Collateral currency (required) * @param borrowCurrency Borrowed currency (required) * @return ApiResponse<UserLtvInfo> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse getUserLtvInfoWithHttpInfo(String collateralCurrency, String borrowCurrency) throws ApiException { @@ -1320,9 +1320,9 @@ public ApiResponse getUserLtvInfoWithHttpInfo(String collateralCurr } /** - * Query user's collateralization ratio (asynchronously) + * Query user's collateralization ratio and remaining borrowable currencies (asynchronously) * - * @param collateralCurrency Collateral (required) + * @param collateralCurrency Collateral currency (required) * @param borrowCurrency Borrowed currency (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1330,7 +1330,7 @@ public ApiResponse getUserLtvInfoWithHttpInfo(String collateralCurr * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getUserLtvInfoAsync(String collateralCurrency, String borrowCurrency, final ApiCallback _callback) throws ApiException { @@ -1401,7 +1401,7 @@ private APIlistCollateralCurrenciesRequest() { /** * Set loanCurrency - * @param loanCurrency The parameter loan_currency is used to specify the borrowing currency. If loan_currency is not provided, the API will return all supported borrowing currencies. If loan_currency is provided, the API will return an array of collateral currencies supported for the specified borrowing currency. (optional) + * @param loanCurrency 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 APIlistCollateralCurrenciesRequest */ public APIlistCollateralCurrenciesRequest loanCurrency(String loanCurrency) { @@ -1417,7 +1417,7 @@ public APIlistCollateralCurrenciesRequest loanCurrency(String loanCurrency) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1431,7 +1431,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -1446,7 +1446,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1461,7 +1461,7 @@ public ApiResponse> executeWithHttpInfo() throws Ap * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1476,7 +1476,7 @@ public okhttp3.Call executeAsync(final ApiCallback> * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIlistCollateralCurrenciesRequest listCollateralCurrencies() { diff --git a/src/main/java/io/gate/gateapi/api/DeliveryApi.java b/src/main/java/io/gate/gateapi/api/DeliveryApi.java index 388a8bb..81d8fee 100644 --- a/src/main/java/io/gate/gateapi/api/DeliveryApi.java +++ b/src/main/java/io/gate/gateapi/api/DeliveryApi.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -72,7 +72,7 @@ public void setApiClient(ApiClient apiClient) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call listDeliveryContractsCall(String settle, final ApiCallback _callback) throws ApiException { @@ -117,7 +117,7 @@ private okhttp3.Call listDeliveryContractsValidateBeforeCall(String settle, fina } /** - * List all futures contracts + * Query all futures contracts * * @param settle Settle currency (required) * @return List<DeliveryContract> @@ -125,7 +125,7 @@ private okhttp3.Call listDeliveryContractsValidateBeforeCall(String settle, fina * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List listDeliveryContracts(String settle) throws ApiException { @@ -134,7 +134,7 @@ public List listDeliveryContracts(String settle) throws ApiExc } /** - * List all futures contracts + * Query all futures contracts * * @param settle Settle currency (required) * @return ApiResponse<List<DeliveryContract>> @@ -142,7 +142,7 @@ public List listDeliveryContracts(String settle) throws ApiExc * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> listDeliveryContractsWithHttpInfo(String settle) throws ApiException { @@ -152,7 +152,7 @@ public ApiResponse> listDeliveryContractsWithHttpInfo(Str } /** - * List all futures contracts (asynchronously) + * Query all futures contracts (asynchronously) * * @param settle Settle currency (required) * @param _callback The callback to be executed when the API call finishes @@ -161,7 +161,7 @@ public ApiResponse> listDeliveryContractsWithHttpInfo(Str * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call listDeliveryContractsAsync(String settle, final ApiCallback> _callback) throws ApiException { @@ -232,7 +232,7 @@ private okhttp3.Call getDeliveryContractValidateBeforeCall(String settle, String } /** - * Get a single contract + * Query single contract information * * @param settle Settle currency (required) * @param contract Futures contract (required) @@ -250,7 +250,7 @@ public DeliveryContract getDeliveryContract(String settle, String contract) thro } /** - * Get a single contract + * Query single contract information * * @param settle Settle currency (required) * @param contract Futures contract (required) @@ -269,7 +269,7 @@ public ApiResponse getDeliveryContractWithHttpInfo(String sett } /** - * Get a single contract (asynchronously) + * Query single contract information (asynchronously) * * @param settle Settle currency (required) * @param contract Futures contract (required) @@ -379,7 +379,7 @@ private APIlistDeliveryOrderBookRequest(String settle, String contract) { /** * Set interval - * @param interval Order depth. 0 means no aggregation is applied. default to 0 (optional, default to 0) + * @param interval Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified (optional, default to 0) * @return APIlistDeliveryOrderBookRequest */ public APIlistDeliveryOrderBookRequest interval(String interval) { @@ -389,7 +389,7 @@ public APIlistDeliveryOrderBookRequest interval(String interval) { /** * Set limit - * @param limit Maximum number of order depth data in asks or bids (optional, default to 10) + * @param limit Number of depth levels (optional, default to 10) * @return APIlistDeliveryOrderBookRequest */ public APIlistDeliveryOrderBookRequest limit(Integer limit) { @@ -399,7 +399,7 @@ public APIlistDeliveryOrderBookRequest limit(Integer limit) { /** * Set withId - * @param withId Whether the order book update ID will be returned. This ID increases by 1 on every order book update (optional, default to false) + * @param withId Whether to return depth update ID. This ID increments by 1 each time depth changes (optional, default to false) * @return APIlistDeliveryOrderBookRequest */ public APIlistDeliveryOrderBookRequest withId(Boolean withId) { @@ -415,7 +415,7 @@ public APIlistDeliveryOrderBookRequest withId(Boolean withId) { * @http.response.details - +
Status Code Description Response Headers
200 Order book retrieved -
200 Depth query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -429,7 +429,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Order book retrieved -
200 Depth query successful -
*/ public FuturesOrderBook execute() throws ApiException { @@ -444,7 +444,7 @@ public FuturesOrderBook execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Order book retrieved -
200 Depth query successful -
*/ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -459,7 +459,7 @@ public ApiResponse executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Order book retrieved -
200 Depth query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -468,7 +468,7 @@ public okhttp3.Call executeAsync(final ApiCallback _callback) } /** - * Futures order book + * Query futures market depth information * Bids will be sorted by price from high to low, while asks sorted reversely * @param settle Settle currency (required) * @param contract Futures contract (required) @@ -476,7 +476,7 @@ public okhttp3.Call executeAsync(final ApiCallback _callback) * @http.response.details - +
Status Code Description Response Headers
200 Order book retrieved -
200 Depth query successful -
*/ public APIlistDeliveryOrderBookRequest listDeliveryOrderBook(String settle, String contract) { @@ -578,7 +578,7 @@ private APIlistDeliveryTradesRequest(String settle, String contract) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistDeliveryTradesRequest */ public APIlistDeliveryTradesRequest limit(Integer limit) { @@ -588,7 +588,7 @@ public APIlistDeliveryTradesRequest limit(Integer limit) { /** * Set lastId - * @param lastId 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) + * @param lastId 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) * @return APIlistDeliveryTradesRequest */ public APIlistDeliveryTradesRequest lastId(String lastId) { @@ -608,7 +608,7 @@ public APIlistDeliveryTradesRequest from(Long from) { /** * Set to - * @param to Specify end time in Unix seconds, default to current time (optional) + * @param to Specify end time in Unix seconds, default to current time. (optional) * @return APIlistDeliveryTradesRequest */ public APIlistDeliveryTradesRequest to(Long to) { @@ -624,7 +624,7 @@ public APIlistDeliveryTradesRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -638,7 +638,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -653,7 +653,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -668,7 +668,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -677,7 +677,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * Futures trading history + * Futures market transaction records * * @param settle Settle currency (required) * @param contract Futures contract (required) @@ -685,7 +685,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistDeliveryTradesRequest listDeliveryTrades(String settle, String contract) { @@ -797,7 +797,7 @@ public APIlistDeliveryCandlesticksRequest from(Long from) { /** * Set to - * @param to End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time (optional) + * @param 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 (optional) * @return APIlistDeliveryCandlesticksRequest */ public APIlistDeliveryCandlesticksRequest to(Long to) { @@ -807,7 +807,7 @@ public APIlistDeliveryCandlesticksRequest to(Long to) { /** * Set limit - * @param 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. (optional, default to 100) + * @param 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. (optional, default to 100) * @return APIlistDeliveryCandlesticksRequest */ public APIlistDeliveryCandlesticksRequest limit(Integer limit) { @@ -817,7 +817,7 @@ public APIlistDeliveryCandlesticksRequest limit(Integer limit) { /** * Set interval - * @param interval Interval time between data points. Note that `1w` means natual week(Mon-Sun), while `7d` means every 7d since unix 0 (optional, default to 5m) + * @param interval 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 APIlistDeliveryCandlesticksRequest */ public APIlistDeliveryCandlesticksRequest interval(String interval) { @@ -833,7 +833,7 @@ public APIlistDeliveryCandlesticksRequest interval(String interval) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -847,7 +847,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -862,7 +862,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -877,7 +877,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiEx * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -886,7 +886,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _c } /** - * 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` * @param settle Settle currency (required) * @param contract Futures contract (required) @@ -894,7 +894,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _c * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIlistDeliveryCandlesticksRequest listDeliveryCandlesticks(String settle, String contract) { @@ -986,7 +986,7 @@ public APIlistDeliveryTickersRequest contract(String contract) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1000,7 +1000,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -1015,7 +1015,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1030,7 +1030,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcepti * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1039,14 +1039,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callba } /** - * List futures tickers + * Get all futures trading statistics * * @param settle Settle currency (required) * @return APIlistDeliveryTickersRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIlistDeliveryTickersRequest listDeliveryTickers(String settle) { @@ -1122,7 +1122,7 @@ private APIlistDeliveryInsuranceLedgerRequest(String settle) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistDeliveryInsuranceLedgerRequest */ public APIlistDeliveryInsuranceLedgerRequest limit(Integer limit) { @@ -1138,7 +1138,7 @@ public APIlistDeliveryInsuranceLedgerRequest limit(Integer limit) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1152,7 +1152,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -1167,7 +1167,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1182,7 +1182,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcept * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1191,14 +1191,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callb } /** - * Futures insurance balance history + * Futures market insurance fund history * * @param settle Settle currency (required) * @return APIlistDeliveryInsuranceLedgerRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIlistDeliveryInsuranceLedgerRequest listDeliveryInsuranceLedger(String settle) { @@ -1214,7 +1214,7 @@ public APIlistDeliveryInsuranceLedgerRequest listDeliveryInsuranceLedger(String * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call listDeliveryAccountsCall(String settle, final ApiCallback _callback) throws ApiException { @@ -1259,7 +1259,7 @@ private okhttp3.Call listDeliveryAccountsValidateBeforeCall(String settle, final } /** - * Query futures account + * Get futures account * * @param settle Settle currency (required) * @return FuturesAccount @@ -1267,7 +1267,7 @@ private okhttp3.Call listDeliveryAccountsValidateBeforeCall(String settle, final * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public FuturesAccount listDeliveryAccounts(String settle) throws ApiException { @@ -1276,7 +1276,7 @@ public FuturesAccount listDeliveryAccounts(String settle) throws ApiException { } /** - * Query futures account + * Get futures account * * @param settle Settle currency (required) * @return ApiResponse<FuturesAccount> @@ -1284,7 +1284,7 @@ public FuturesAccount listDeliveryAccounts(String settle) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse listDeliveryAccountsWithHttpInfo(String settle) throws ApiException { @@ -1294,7 +1294,7 @@ public ApiResponse listDeliveryAccountsWithHttpInfo(String settl } /** - * Query futures account (asynchronously) + * Get futures account (asynchronously) * * @param settle Settle currency (required) * @param _callback The callback to be executed when the API call finishes @@ -1303,7 +1303,7 @@ public ApiResponse listDeliveryAccountsWithHttpInfo(String settl * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call listDeliveryAccountsAsync(String settle, final ApiCallback _callback) throws ApiException { @@ -1397,7 +1397,7 @@ private APIlistDeliveryAccountBookRequest(String settle) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistDeliveryAccountBookRequest */ public APIlistDeliveryAccountBookRequest limit(Integer limit) { @@ -1407,7 +1407,7 @@ public APIlistDeliveryAccountBookRequest limit(Integer limit) { /** * Set from - * @param from Start timestamp (optional) + * @param 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) (optional) * @return APIlistDeliveryAccountBookRequest */ public APIlistDeliveryAccountBookRequest from(Long from) { @@ -1417,7 +1417,7 @@ public APIlistDeliveryAccountBookRequest from(Long from) { /** * Set to - * @param to End timestamp (optional) + * @param to Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional) * @return APIlistDeliveryAccountBookRequest */ public APIlistDeliveryAccountBookRequest to(Long to) { @@ -1427,7 +1427,7 @@ public APIlistDeliveryAccountBookRequest to(Long to) { /** * Set type - * @param type Changing Type: - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate (optional) + * @param 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 (optional) * @return APIlistDeliveryAccountBookRequest */ public APIlistDeliveryAccountBookRequest type(String type) { @@ -1443,7 +1443,7 @@ public APIlistDeliveryAccountBookRequest type(String type) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1457,7 +1457,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -1472,7 +1472,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1487,7 +1487,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExc * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1496,14 +1496,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _ca } /** - * Query account book + * Query futures account change history * * @param settle Settle currency (required) * @return APIlistDeliveryAccountBookRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistDeliveryAccountBookRequest listDeliveryAccountBook(String settle) { @@ -1519,7 +1519,7 @@ public APIlistDeliveryAccountBookRequest listDeliveryAccountBook(String settle) * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call listDeliveryPositionsCall(String settle, final ApiCallback _callback) throws ApiException { @@ -1564,7 +1564,7 @@ private okhttp3.Call listDeliveryPositionsValidateBeforeCall(String settle, fina } /** - * List all positions of a user + * Get user position list * * @param settle Settle currency (required) * @return List<Position> @@ -1572,7 +1572,7 @@ private okhttp3.Call listDeliveryPositionsValidateBeforeCall(String settle, fina * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List listDeliveryPositions(String settle) throws ApiException { @@ -1581,7 +1581,7 @@ public List listDeliveryPositions(String settle) throws ApiException { } /** - * List all positions of a user + * Get user position list * * @param settle Settle currency (required) * @return ApiResponse<List<Position>> @@ -1589,7 +1589,7 @@ public List listDeliveryPositions(String settle) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> listDeliveryPositionsWithHttpInfo(String settle) throws ApiException { @@ -1599,7 +1599,7 @@ public ApiResponse> listDeliveryPositionsWithHttpInfo(String sett } /** - * List all positions of a user (asynchronously) + * Get user position list (asynchronously) * * @param settle Settle currency (required) * @param _callback The callback to be executed when the API call finishes @@ -1608,7 +1608,7 @@ public ApiResponse> listDeliveryPositionsWithHttpInfo(String sett * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call listDeliveryPositionsAsync(String settle, final ApiCallback> _callback) throws ApiException { @@ -1679,7 +1679,7 @@ private okhttp3.Call getDeliveryPositionValidateBeforeCall(String settle, String } /** - * Get single position + * Get single position information * * @param settle Settle currency (required) * @param contract Futures contract (required) @@ -1697,7 +1697,7 @@ public Position getDeliveryPosition(String settle, String contract) throws ApiEx } /** - * Get single position + * Get single position information * * @param settle Settle currency (required) * @param contract Futures contract (required) @@ -1716,7 +1716,7 @@ public ApiResponse getDeliveryPositionWithHttpInfo(String settle, Stri } /** - * Get single position (asynchronously) + * Get single position information (asynchronously) * * @param settle Settle currency (required) * @param contract Futures contract (required) @@ -1740,7 +1740,7 @@ public okhttp3.Call getDeliveryPositionAsync(String settle, String contract, fin * Build call for updateDeliveryPositionMargin * @param settle Settle currency (required) * @param contract Futures contract (required) - * @param change Margin change. Use positive number to increase margin, negative number otherwise. (required) + * @param change Margin change amount, positive number increases, negative number decreases (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -1811,7 +1811,7 @@ private okhttp3.Call updateDeliveryPositionMarginValidateBeforeCall(String settl * * @param settle Settle currency (required) * @param contract Futures contract (required) - * @param change Margin change. Use positive number to increase margin, negative number otherwise. (required) + * @param change Margin change amount, positive number increases, negative number decreases (required) * @return Position * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1830,7 +1830,7 @@ public Position updateDeliveryPositionMargin(String settle, String contract, Str * * @param settle Settle currency (required) * @param contract Futures contract (required) - * @param change Margin change. Use positive number to increase margin, negative number otherwise. (required) + * @param change Margin change amount, positive number increases, negative number decreases (required) * @return ApiResponse<Position> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1850,7 +1850,7 @@ public ApiResponse updateDeliveryPositionMarginWithHttpInfo(String set * * @param settle Settle currency (required) * @param contract Futures contract (required) - * @param change Margin change. Use positive number to increase margin, negative number otherwise. (required) + * @param change Margin change amount, positive number increases, negative number decreases (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -2239,7 +2239,7 @@ public APIlistDeliveryOrdersRequest contract(String contract) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistDeliveryOrdersRequest */ public APIlistDeliveryOrdersRequest limit(Integer limit) { @@ -2259,7 +2259,7 @@ public APIlistDeliveryOrdersRequest offset(Integer offset) { /** * Set lastId - * @param lastId Specify list staring point using the `id` of last record in previous list-query results (optional) + * @param lastId 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 APIlistDeliveryOrdersRequest */ public APIlistDeliveryOrdersRequest lastId(String lastId) { @@ -2269,7 +2269,7 @@ public APIlistDeliveryOrdersRequest lastId(String lastId) { /** * Set countTotal - * @param countTotal Whether to return total number matched. Default to 0(no return) (optional, default to 0) + * @param countTotal Whether to return total number matched, defaults to 0 (no return) (optional, default to 0) * @return APIlistDeliveryOrdersRequest */ public APIlistDeliveryOrdersRequest countTotal(Integer countTotal) { @@ -2285,7 +2285,7 @@ public APIlistDeliveryOrdersRequest countTotal(Integer countTotal) { * @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
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2299,7 +2299,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @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
*/ public List execute() throws ApiException { @@ -2314,7 +2314,7 @@ public List execute() throws ApiException { * @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
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -2329,7 +2329,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException * @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
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2338,15 +2338,15 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * List futures orders - * Zero-filled order cannot be retrieved 10 minutes after order cancellation + * Query futures order list + * Zero-fill orders cannot be retrieved 10 minutes after order cancellation * @param settle Settle currency (required) - * @param status Only list the orders with this status (required) + * @param status Query order list based on status (required) * @return APIlistDeliveryOrdersRequest * @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
*/ public APIlistDeliveryOrdersRequest listDeliveryOrders(String settle, String status) { @@ -2413,8 +2413,8 @@ private okhttp3.Call createDeliveryOrderValidateBeforeCall(String settle, Future } /** - * Create a futures order - * Zero-filled order cannot be retrieved 10 minutes after order cancellation + * Place futures order + * Zero-fill orders cannot be retrieved 10 minutes after order cancellation * @param settle Settle currency (required) * @param futuresOrder (required) * @return FuturesOrder @@ -2431,8 +2431,8 @@ public FuturesOrder createDeliveryOrder(String settle, FuturesOrder futuresOrder } /** - * Create a futures order - * Zero-filled order cannot be retrieved 10 minutes after order cancellation + * Place futures order + * Zero-fill orders cannot be retrieved 10 minutes after order cancellation * @param settle Settle currency (required) * @param futuresOrder (required) * @return ApiResponse<FuturesOrder> @@ -2450,8 +2450,8 @@ public ApiResponse createDeliveryOrderWithHttpInfo(String settle, } /** - * Create a futures order (asynchronously) - * Zero-filled order cannot be retrieved 10 minutes after order cancellation + * Place futures order (asynchronously) + * Zero-fill orders cannot be retrieved 10 minutes after order cancellation * @param settle Settle currency (required) * @param futuresOrder (required) * @param _callback The callback to be executed when the API call finishes @@ -2474,14 +2474,14 @@ public okhttp3.Call createDeliveryOrderAsync(String settle, FuturesOrder futures * Build call for cancelDeliveryOrders * @param settle Settle currency (required) * @param contract Futures contract (required) - * @param side All bids or asks. Both included if not specified (optional) + * @param side Specify all bids or all asks, both included if not specified (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
Status Code Description Response Headers
200 All orders matched cancelled -
200 Batch cancellation successful -
*/ public okhttp3.Call cancelDeliveryOrdersCall(String settle, String contract, String side, final ApiCallback _callback) throws ApiException { @@ -2539,17 +2539,17 @@ private okhttp3.Call cancelDeliveryOrdersValidateBeforeCall(String settle, Strin } /** - * Cancel all `open` orders matched - * Zero-filled order cannot be retrieved 10 minutes after order cancellation + * Cancel all orders with 'open' status + * Zero-fill orders cannot be retrieved 10 minutes after order cancellation * @param settle Settle currency (required) * @param contract Futures contract (required) - * @param side All bids or asks. Both included if not specified (optional) + * @param side Specify all bids or all asks, both included if not specified (optional) * @return List<FuturesOrder> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 All orders matched cancelled -
200 Batch cancellation successful -
*/ public List cancelDeliveryOrders(String settle, String contract, String side) throws ApiException { @@ -2558,17 +2558,17 @@ public List cancelDeliveryOrders(String settle, String contract, S } /** - * Cancel all `open` orders matched - * Zero-filled order cannot be retrieved 10 minutes after order cancellation + * Cancel all orders with 'open' status + * Zero-fill orders cannot be retrieved 10 minutes after order cancellation * @param settle Settle currency (required) * @param contract Futures contract (required) - * @param side All bids or asks. Both included if not specified (optional) + * @param side Specify all bids or all asks, both included if not specified (optional) * @return ApiResponse<List<FuturesOrder>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 All orders matched cancelled -
200 Batch cancellation successful -
*/ public ApiResponse> cancelDeliveryOrdersWithHttpInfo(String settle, String contract, String side) throws ApiException { @@ -2578,18 +2578,18 @@ public ApiResponse> cancelDeliveryOrdersWithHttpInfo(String s } /** - * Cancel all `open` orders matched (asynchronously) - * Zero-filled order cannot be retrieved 10 minutes after order cancellation + * Cancel all orders with 'open' status (asynchronously) + * Zero-fill orders cannot be retrieved 10 minutes after order cancellation * @param settle Settle currency (required) * @param contract Futures contract (required) - * @param side All bids or asks. Both included if not specified (optional) + * @param side Specify all bids or all asks, both included if not specified (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 All orders matched cancelled -
200 Batch cancellation successful -
*/ public okhttp3.Call cancelDeliveryOrdersAsync(String settle, String contract, String side, final ApiCallback> _callback) throws ApiException { @@ -2602,7 +2602,7 @@ public okhttp3.Call cancelDeliveryOrdersAsync(String settle, String contract, St /** * Build call for getDeliveryOrder * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -2660,10 +2660,10 @@ private okhttp3.Call getDeliveryOrderValidateBeforeCall(String settle, String or } /** - * Get a single order - * Zero-filled order cannot be retrieved 10 minutes after order cancellation + * Query single order details + * Zero-fill orders cannot be retrieved 10 minutes after order cancellation * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @return FuturesOrder * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -2678,10 +2678,10 @@ public FuturesOrder getDeliveryOrder(String settle, String orderId) throws ApiEx } /** - * Get a single order - * Zero-filled order cannot be retrieved 10 minutes after order cancellation + * Query single order details + * Zero-fill orders cannot be retrieved 10 minutes after order cancellation * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @return ApiResponse<FuturesOrder> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -2697,10 +2697,10 @@ public ApiResponse getDeliveryOrderWithHttpInfo(String settle, Str } /** - * Get a single order (asynchronously) - * Zero-filled order cannot be retrieved 10 minutes after order cancellation + * Query single order details (asynchronously) + * Zero-fill orders cannot be retrieved 10 minutes after order cancellation * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -2720,7 +2720,7 @@ public okhttp3.Call getDeliveryOrderAsync(String settle, String orderId, final A /** * Build call for cancelDeliveryOrder * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -2778,10 +2778,10 @@ private okhttp3.Call cancelDeliveryOrderValidateBeforeCall(String settle, String } /** - * Cancel a single order + * Cancel single order * * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @return FuturesOrder * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -2796,10 +2796,10 @@ public FuturesOrder cancelDeliveryOrder(String settle, String orderId) throws Ap } /** - * Cancel a single order + * Cancel single order * * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @return ApiResponse<FuturesOrder> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -2815,10 +2815,10 @@ public ApiResponse cancelDeliveryOrderWithHttpInfo(String settle, } /** - * Cancel a single order (asynchronously) + * Cancel single order (asynchronously) * * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -2949,7 +2949,7 @@ public APIgetMyDeliveryTradesRequest order(Long order) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIgetMyDeliveryTradesRequest */ public APIgetMyDeliveryTradesRequest limit(Integer limit) { @@ -2969,7 +2969,7 @@ public APIgetMyDeliveryTradesRequest offset(Integer offset) { /** * Set lastId - * @param lastId Specify list staring point using the `id` of last record in previous list-query results (optional) + * @param lastId 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 APIgetMyDeliveryTradesRequest */ public APIgetMyDeliveryTradesRequest lastId(String lastId) { @@ -2979,7 +2979,7 @@ public APIgetMyDeliveryTradesRequest lastId(String lastId) { /** * Set countTotal - * @param countTotal Whether to return total number matched. Default to 0(no return) (optional, default to 0) + * @param countTotal Whether to return total number matched, defaults to 0 (no return) (optional, default to 0) * @return APIgetMyDeliveryTradesRequest */ public APIgetMyDeliveryTradesRequest countTotal(Integer countTotal) { @@ -2995,7 +2995,7 @@ public APIgetMyDeliveryTradesRequest countTotal(Integer countTotal) { * @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
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -3009,7 +3009,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @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
*/ public List execute() throws ApiException { @@ -3024,7 +3024,7 @@ public List execute() throws ApiException { * @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
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -3039,7 +3039,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcepti * @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
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -3048,14 +3048,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callba } /** - * List personal trading history + * Query personal trading records * * @param settle Settle currency (required) * @return APIgetMyDeliveryTradesRequest * @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
*/ public APIgetMyDeliveryTradesRequest getMyDeliveryTrades(String settle) { @@ -3146,7 +3146,7 @@ public APIlistDeliveryPositionCloseRequest contract(String contract) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistDeliveryPositionCloseRequest */ public APIlistDeliveryPositionCloseRequest limit(Integer limit) { @@ -3162,7 +3162,7 @@ public APIlistDeliveryPositionCloseRequest limit(Integer limit) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -3176,7 +3176,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -3191,7 +3191,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -3206,7 +3206,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExceptio * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -3215,14 +3215,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callbac } /** - * List position close history + * Query position close history * * @param settle Settle currency (required) * @return APIlistDeliveryPositionCloseRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistDeliveryPositionCloseRequest listDeliveryPositionClose(String settle) { @@ -3318,7 +3318,7 @@ public APIlistDeliveryLiquidatesRequest contract(String contract) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistDeliveryLiquidatesRequest */ public APIlistDeliveryLiquidatesRequest limit(Integer limit) { @@ -3328,7 +3328,7 @@ public APIlistDeliveryLiquidatesRequest limit(Integer limit) { /** * Set at - * @param at Specify a liquidation timestamp (optional, default to 0) + * @param at Specify liquidation timestamp (optional, default to 0) * @return APIlistDeliveryLiquidatesRequest */ public APIlistDeliveryLiquidatesRequest at(Integer at) { @@ -3344,7 +3344,7 @@ public APIlistDeliveryLiquidatesRequest at(Integer at) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -3358,7 +3358,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -3373,7 +3373,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -3388,7 +3388,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcep * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -3397,14 +3397,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _call } /** - * List liquidation history + * Query liquidation history * * @param settle Settle currency (required) * @return APIlistDeliveryLiquidatesRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistDeliveryLiquidatesRequest listDeliveryLiquidates(String settle) { @@ -3500,7 +3500,7 @@ public APIlistDeliverySettlementsRequest contract(String contract) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistDeliverySettlementsRequest */ public APIlistDeliverySettlementsRequest limit(Integer limit) { @@ -3510,7 +3510,7 @@ public APIlistDeliverySettlementsRequest limit(Integer limit) { /** * Set at - * @param at Specify a settlement timestamp (optional, default to 0) + * @param at Specify settlement timestamp (optional, default to 0) * @return APIlistDeliverySettlementsRequest */ public APIlistDeliverySettlementsRequest at(Integer at) { @@ -3526,7 +3526,7 @@ public APIlistDeliverySettlementsRequest at(Integer at) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -3540,7 +3540,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -3555,7 +3555,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -3570,7 +3570,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExc * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -3579,14 +3579,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _ca } /** - * List settlement history + * Query settlement records * * @param settle Settle currency (required) * @return APIlistDeliverySettlementsRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistDeliverySettlementsRequest listDeliverySettlements(String settle) { @@ -3682,7 +3682,7 @@ public APIlistDeliveryRiskLimitTiersRequest contract(String contract) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistDeliveryRiskLimitTiersRequest */ public APIlistDeliveryRiskLimitTiersRequest limit(Integer limit) { @@ -3708,7 +3708,7 @@ public APIlistDeliveryRiskLimitTiersRequest offset(Integer offset) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -3722,7 +3722,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -3737,7 +3737,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -3752,7 +3752,7 @@ public ApiResponse> executeWithHttpInfo() throws Api * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -3761,14 +3761,14 @@ public okhttp3.Call executeAsync(final ApiCallback> } /** - * List risk limit tiers - * When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets.'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the 'contract' parameter is empty. + * Query risk limit tiers + * When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets. 'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the contract parameter is empty. * @param settle Settle currency (required) * @return APIlistDeliveryRiskLimitTiersRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIlistDeliveryRiskLimitTiersRequest listDeliveryRiskLimitTiers(String settle) { @@ -3875,7 +3875,7 @@ public APIlistPriceTriggeredDeliveryOrdersRequest contract(String contract) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistPriceTriggeredDeliveryOrdersRequest */ public APIlistPriceTriggeredDeliveryOrdersRequest limit(Integer limit) { @@ -3901,7 +3901,7 @@ public APIlistPriceTriggeredDeliveryOrdersRequest offset(Integer offset) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -3915,7 +3915,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -3930,7 +3930,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -3945,7 +3945,7 @@ public ApiResponse> executeWithHttpInfo() throw * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -3954,15 +3954,15 @@ public okhttp3.Call executeAsync(final ApiCallback Status Code Description Response Headers - 200 List retrieved - + 200 List retrieved successfully - */ public APIlistPriceTriggeredDeliveryOrdersRequest listPriceTriggeredDeliveryOrders(String settle, String status) { @@ -3979,7 +3979,7 @@ public APIlistPriceTriggeredDeliveryOrdersRequest listPriceTriggeredDeliveryOrde * @http.response.details - +
Status Code Description Response Headers
201 Order created -
201 Order created successfully -
*/ public okhttp3.Call createPriceTriggeredDeliveryOrderCall(String settle, FuturesPriceTriggeredOrder futuresPriceTriggeredOrder, final ApiCallback _callback) throws ApiException { @@ -4029,7 +4029,7 @@ private okhttp3.Call createPriceTriggeredDeliveryOrderValidateBeforeCall(String } /** - * Create a price-triggered order + * Create price-triggered order * * @param settle Settle currency (required) * @param futuresPriceTriggeredOrder (required) @@ -4038,7 +4038,7 @@ private okhttp3.Call createPriceTriggeredDeliveryOrderValidateBeforeCall(String * @http.response.details - +
Status Code Description Response Headers
201 Order created -
201 Order created successfully -
*/ public TriggerOrderResponse createPriceTriggeredDeliveryOrder(String settle, FuturesPriceTriggeredOrder futuresPriceTriggeredOrder) throws ApiException { @@ -4047,7 +4047,7 @@ public TriggerOrderResponse createPriceTriggeredDeliveryOrder(String settle, Fut } /** - * Create a price-triggered order + * Create price-triggered order * * @param settle Settle currency (required) * @param futuresPriceTriggeredOrder (required) @@ -4056,7 +4056,7 @@ public TriggerOrderResponse createPriceTriggeredDeliveryOrder(String settle, Fut * @http.response.details - +
Status Code Description Response Headers
201 Order created -
201 Order created successfully -
*/ public ApiResponse createPriceTriggeredDeliveryOrderWithHttpInfo(String settle, FuturesPriceTriggeredOrder futuresPriceTriggeredOrder) throws ApiException { @@ -4066,7 +4066,7 @@ public ApiResponse createPriceTriggeredDeliveryOrderWithHt } /** - * Create a price-triggered order (asynchronously) + * Create price-triggered order (asynchronously) * * @param settle Settle currency (required) * @param futuresPriceTriggeredOrder (required) @@ -4076,7 +4076,7 @@ public ApiResponse createPriceTriggeredDeliveryOrderWithHt * @http.response.details - +
Status Code Description Response Headers
201 Order created -
201 Order created successfully -
*/ public okhttp3.Call createPriceTriggeredDeliveryOrderAsync(String settle, FuturesPriceTriggeredOrder futuresPriceTriggeredOrder, final ApiCallback _callback) throws ApiException { @@ -4096,7 +4096,7 @@ public okhttp3.Call createPriceTriggeredDeliveryOrderAsync(String settle, Future * @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 -
*/ public okhttp3.Call cancelPriceTriggeredDeliveryOrderListCall(String settle, String contract, final ApiCallback _callback) throws ApiException { @@ -4150,7 +4150,7 @@ private okhttp3.Call cancelPriceTriggeredDeliveryOrderListValidateBeforeCall(Str } /** - * Cancel All Price-triggered Orders + * Cancel all auto orders * * @param settle Settle currency (required) * @param contract Futures contract (required) @@ -4159,7 +4159,7 @@ private okhttp3.Call cancelPriceTriggeredDeliveryOrderListValidateBeforeCall(Str * @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 -
*/ public List cancelPriceTriggeredDeliveryOrderList(String settle, String contract) throws ApiException { @@ -4168,7 +4168,7 @@ public List cancelPriceTriggeredDeliveryOrderList(St } /** - * Cancel All Price-triggered Orders + * Cancel all auto orders * * @param settle Settle currency (required) * @param contract Futures contract (required) @@ -4177,7 +4177,7 @@ public List cancelPriceTriggeredDeliveryOrderList(St * @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 -
*/ public ApiResponse> cancelPriceTriggeredDeliveryOrderListWithHttpInfo(String settle, String contract) throws ApiException { @@ -4187,7 +4187,7 @@ public ApiResponse> cancelPriceTriggeredDeliver } /** - * Cancel All Price-triggered Orders (asynchronously) + * Cancel all auto orders (asynchronously) * * @param settle Settle currency (required) * @param contract Futures contract (required) @@ -4197,7 +4197,7 @@ public ApiResponse> cancelPriceTriggeredDeliver * @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 -
*/ public okhttp3.Call cancelPriceTriggeredDeliveryOrderListAsync(String settle, String contract, final ApiCallback> _callback) throws ApiException { @@ -4210,14 +4210,14 @@ public okhttp3.Call cancelPriceTriggeredDeliveryOrderListAsync(String settle, St /** * Build call for getPriceTriggeredDeliveryOrder * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
Status Code Description Response Headers
200 Auto order detail -
200 Auto order details -
*/ public okhttp3.Call getPriceTriggeredDeliveryOrderCall(String settle, String orderId, final ApiCallback _callback) throws ApiException { @@ -4268,16 +4268,16 @@ private okhttp3.Call getPriceTriggeredDeliveryOrderValidateBeforeCall(String set } /** - * Get a price-triggered order + * Query single auto order details * * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @return FuturesPriceTriggeredOrder * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Auto order detail -
200 Auto order details -
*/ public FuturesPriceTriggeredOrder getPriceTriggeredDeliveryOrder(String settle, String orderId) throws ApiException { @@ -4286,16 +4286,16 @@ public FuturesPriceTriggeredOrder getPriceTriggeredDeliveryOrder(String settle, } /** - * Get a price-triggered order + * Query single auto order details * * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @return ApiResponse<FuturesPriceTriggeredOrder> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Auto order detail -
200 Auto order details -
*/ public ApiResponse getPriceTriggeredDeliveryOrderWithHttpInfo(String settle, String orderId) throws ApiException { @@ -4305,17 +4305,17 @@ public ApiResponse getPriceTriggeredDeliveryOrderWit } /** - * Get a price-triggered order (asynchronously) + * Query single auto order details (asynchronously) * * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 Auto order detail -
200 Auto order details -
*/ public okhttp3.Call getPriceTriggeredDeliveryOrderAsync(String settle, String orderId, final ApiCallback _callback) throws ApiException { @@ -4328,14 +4328,14 @@ public okhttp3.Call getPriceTriggeredDeliveryOrderAsync(String settle, String or /** * Build call for cancelPriceTriggeredDeliveryOrder * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
Status Code Description Response Headers
200 Auto order detail -
200 Auto order details -
*/ public okhttp3.Call cancelPriceTriggeredDeliveryOrderCall(String settle, String orderId, final ApiCallback _callback) throws ApiException { @@ -4386,16 +4386,16 @@ private okhttp3.Call cancelPriceTriggeredDeliveryOrderValidateBeforeCall(String } /** - * cancel a price-triggered order + * Cancel single auto order * * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @return FuturesPriceTriggeredOrder * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Auto order detail -
200 Auto order details -
*/ public FuturesPriceTriggeredOrder cancelPriceTriggeredDeliveryOrder(String settle, String orderId) throws ApiException { @@ -4404,16 +4404,16 @@ public FuturesPriceTriggeredOrder cancelPriceTriggeredDeliveryOrder(String settl } /** - * cancel a price-triggered order + * Cancel single auto order * * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @return ApiResponse<FuturesPriceTriggeredOrder> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Auto order detail -
200 Auto order details -
*/ public ApiResponse cancelPriceTriggeredDeliveryOrderWithHttpInfo(String settle, String orderId) throws ApiException { @@ -4423,17 +4423,17 @@ public ApiResponse cancelPriceTriggeredDeliveryOrder } /** - * cancel a price-triggered order (asynchronously) + * Cancel single auto order (asynchronously) * * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 Auto order detail -
200 Auto order details -
*/ public okhttp3.Call cancelPriceTriggeredDeliveryOrderAsync(String settle, String orderId, final ApiCallback _callback) throws ApiException { diff --git a/src/main/java/io/gate/gateapi/api/EarnApi.java b/src/main/java/io/gate/gateapi/api/EarnApi.java index 4aa1b54..78ffd05 100644 --- a/src/main/java/io/gate/gateapi/api/EarnApi.java +++ b/src/main/java/io/gate/gateapi/api/EarnApi.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -24,10 +24,13 @@ import io.gate.gateapi.models.DualGetPlans; import io.gate.gateapi.models.Eth2RateList; import io.gate.gateapi.models.Eth2Swap; +import io.gate.gateapi.models.FindCoin; import io.gate.gateapi.models.PlaceDualInvestmentOrder; import io.gate.gateapi.models.StructuredBuy; import io.gate.gateapi.models.StructuredGetProjectList; import io.gate.gateapi.models.StructuredOrderList; +import io.gate.gateapi.models.SwapCoin; +import io.gate.gateapi.models.SwapCoinStruct; import java.lang.reflect.Type; import java.util.ArrayList; @@ -63,7 +66,7 @@ public void setApiClient(ApiClient apiClient) { * @http.response.details - +
Status Code Description Response Headers
200 swap success -
200 Swap successful -
*/ public okhttp3.Call swapETH2Call(Eth2Swap eth2Swap, final ApiCallback _callback) throws ApiException { @@ -114,7 +117,7 @@ private okhttp3.Call swapETH2ValidateBeforeCall(Eth2Swap eth2Swap, final ApiCall * @http.response.details - +
Status Code Description Response Headers
200 swap success -
200 Swap successful -
*/ public void swapETH2(Eth2Swap eth2Swap) throws ApiException { @@ -130,7 +133,7 @@ public void swapETH2(Eth2Swap eth2Swap) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 swap success -
200 Swap successful -
*/ public ApiResponse swapETH2WithHttpInfo(Eth2Swap eth2Swap) throws ApiException { @@ -148,7 +151,7 @@ public ApiResponse swapETH2WithHttpInfo(Eth2Swap eth2Swap) throws ApiExcep * @http.response.details - +
Status Code Description Response Headers
200 swap success -
200 Swap successful -
*/ public okhttp3.Call swapETH2Async(Eth2Swap eth2Swap, final ApiCallback _callback) throws ApiException { @@ -165,7 +168,7 @@ public okhttp3.Call swapETH2Async(Eth2Swap eth2Swap, final ApiCallback _ca * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public okhttp3.Call rateListETH2Call(final ApiCallback _callback) throws ApiException { @@ -204,14 +207,14 @@ private okhttp3.Call rateListETH2ValidateBeforeCall(final ApiCallback _callback) } /** - * ETH2 historical rate of return query - * Check the ETH earnings rate record for the last 31 days + * ETH2 historical return rate query + * Query ETH earnings rate records for the last 31 days * @return List<Eth2RateList> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public List rateListETH2() throws ApiException { @@ -220,14 +223,14 @@ public List rateListETH2() throws ApiException { } /** - * ETH2 historical rate of return query - * Check the ETH earnings rate record for the last 31 days + * ETH2 historical return rate query + * Query ETH earnings rate records for the last 31 days * @return ApiResponse<List<Eth2RateList>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public ApiResponse> rateListETH2WithHttpInfo() throws ApiException { @@ -237,15 +240,15 @@ public ApiResponse> rateListETH2WithHttpInfo() throws ApiExce } /** - * ETH2 historical rate of return query (asynchronously) - * Check the ETH earnings rate record for the last 31 days + * ETH2 historical return rate query (asynchronously) + * Query ETH earnings rate records for the last 31 days * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public okhttp3.Call rateListETH2Async(final ApiCallback> _callback) throws ApiException { @@ -316,7 +319,7 @@ private APIlistDualInvestmentPlansRequest() { /** * Set planId - * @param planId Financial project id (optional) + * @param planId Financial project ID (optional) * @return APIlistDualInvestmentPlansRequest */ public APIlistDualInvestmentPlansRequest planId(Long planId) { @@ -332,7 +335,7 @@ public APIlistDualInvestmentPlansRequest planId(Long planId) { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -346,7 +349,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public List execute() throws ApiException { @@ -361,7 +364,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -376,7 +379,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -391,7 +394,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public APIlistDualInvestmentPlansRequest listDualInvestmentPlans() { @@ -474,7 +477,7 @@ private APIlistDualOrdersRequest() { /** * Set from - * @param from Start checkout time (optional) + * @param from Start settlement time (optional) * @return APIlistDualOrdersRequest */ public APIlistDualOrdersRequest from(Long from) { @@ -504,7 +507,7 @@ public APIlistDualOrdersRequest page(Integer page) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistDualOrdersRequest */ public APIlistDualOrdersRequest limit(Integer limit) { @@ -520,7 +523,7 @@ public APIlistDualOrdersRequest limit(Integer limit) { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -534,7 +537,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public List execute() throws ApiException { @@ -549,7 +552,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -564,7 +567,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExceptio * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -579,7 +582,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _callbac * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public APIlistDualOrdersRequest listDualOrders() { @@ -595,7 +598,7 @@ public APIlistDualOrdersRequest listDualOrders() { * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Order placed successfully -
*/ public okhttp3.Call placeDualOrderCall(PlaceDualInvestmentOrder placeDualInvestmentOrder, final ApiCallback _callback) throws ApiException { @@ -646,7 +649,7 @@ private okhttp3.Call placeDualOrderValidateBeforeCall(PlaceDualInvestmentOrder p * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Order placed successfully -
*/ public void placeDualOrder(PlaceDualInvestmentOrder placeDualInvestmentOrder) throws ApiException { @@ -662,7 +665,7 @@ public void placeDualOrder(PlaceDualInvestmentOrder placeDualInvestmentOrder) th * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Order placed successfully -
*/ public ApiResponse placeDualOrderWithHttpInfo(PlaceDualInvestmentOrder placeDualInvestmentOrder) throws ApiException { @@ -680,7 +683,7 @@ public ApiResponse placeDualOrderWithHttpInfo(PlaceDualInvestmentOrder pla * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Order placed successfully -
*/ public okhttp3.Call placeDualOrderAsync(PlaceDualInvestmentOrder placeDualInvestmentOrder, final ApiCallback _callback) throws ApiException { @@ -771,7 +774,7 @@ private APIlistStructuredProductsRequest(String status) { /** * Set type - * @param type Product Type (default all) `SharkFin2.0`-SharkFin `BullishSharkFin`-BullishSharkFin `BearishSharkFin`-BearishSharkFin `DoubleNoTouch`-DoubleNoTouch `RangeAccrual`-RangeAccrual `SnowBall`-SnowBall (optional) + * @param 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 (optional) * @return APIlistStructuredProductsRequest */ public APIlistStructuredProductsRequest type(String type) { @@ -791,7 +794,7 @@ public APIlistStructuredProductsRequest page(Integer page) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistStructuredProductsRequest */ public APIlistStructuredProductsRequest limit(Integer limit) { @@ -807,7 +810,7 @@ public APIlistStructuredProductsRequest limit(Integer limit) { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -821,7 +824,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public List execute() throws ApiException { @@ -836,7 +839,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -851,7 +854,7 @@ public ApiResponse> executeWithHttpInfo() throws * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -862,12 +865,12 @@ public okhttp3.Call executeAsync(final ApiCallback Status Code Description Response Headers - 200 Successful - + 200 Successfully retrieved - */ public APIlistStructuredProductsRequest listStructuredProducts(String status) { @@ -950,7 +953,7 @@ private APIlistStructuredOrdersRequest() { /** * Set from - * @param from Start timestamp (optional) + * @param 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) (optional) * @return APIlistStructuredOrdersRequest */ public APIlistStructuredOrdersRequest from(Long from) { @@ -960,7 +963,7 @@ public APIlistStructuredOrdersRequest from(Long from) { /** * Set to - * @param to End timestamp (optional) + * @param to Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional) * @return APIlistStructuredOrdersRequest */ public APIlistStructuredOrdersRequest to(Long to) { @@ -980,7 +983,7 @@ public APIlistStructuredOrdersRequest page(Integer page) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistStructuredOrdersRequest */ public APIlistStructuredOrdersRequest limit(Integer limit) { @@ -996,7 +999,7 @@ public APIlistStructuredOrdersRequest limit(Integer limit) { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1010,7 +1013,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public List execute() throws ApiException { @@ -1025,7 +1028,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1040,7 +1043,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiEx * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1055,7 +1058,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _c * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public APIlistStructuredOrdersRequest listStructuredOrders() { @@ -1071,7 +1074,7 @@ public APIlistStructuredOrdersRequest listStructuredOrders() { * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Order placed successfully -
*/ public okhttp3.Call placeStructuredOrderCall(StructuredBuy structuredBuy, final ApiCallback _callback) throws ApiException { @@ -1122,7 +1125,7 @@ private okhttp3.Call placeStructuredOrderValidateBeforeCall(StructuredBuy struct * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Order placed successfully -
*/ public void placeStructuredOrder(StructuredBuy structuredBuy) throws ApiException { @@ -1138,7 +1141,7 @@ public void placeStructuredOrder(StructuredBuy structuredBuy) throws ApiExceptio * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Order placed successfully -
*/ public ApiResponse placeStructuredOrderWithHttpInfo(StructuredBuy structuredBuy) throws ApiException { @@ -1156,7 +1159,7 @@ public ApiResponse placeStructuredOrderWithHttpInfo(StructuredBuy structur * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Order placed successfully -
*/ public okhttp3.Call placeStructuredOrderAsync(StructuredBuy structuredBuy, final ApiCallback _callback) throws ApiException { @@ -1165,4 +1168,218 @@ public okhttp3.Call placeStructuredOrderAsync(StructuredBuy structuredBuy, final return localVarCall; } + /** + * Build call for findCoin + * @param findCoin (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + +
Status Code Description Response Headers
200 Successfully retrieved -
+ */ + public okhttp3.Call findCoinCall(FindCoin findCoin, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = findCoin; + + // create path and map variables + String localVarPath = "/earn/staking/coins"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + String[] localVarAuthNames = new String[] { "apiv4" }; + return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call findCoinValidateBeforeCall(FindCoin findCoin, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'findCoin' is set + if (findCoin == null) { + throw new ApiException("Missing the required parameter 'findCoin' when calling findCoin(Async)"); + } + + okhttp3.Call localVarCall = findCoinCall(findCoin, _callback); + return localVarCall; + } + + /** + * Staking coins + * + * @param findCoin (required) + * @return Object + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + +
Status Code Description Response Headers
200 Successfully retrieved -
+ */ + public Object findCoin(FindCoin findCoin) throws ApiException { + ApiResponse localVarResp = findCoinWithHttpInfo(findCoin); + return localVarResp.getData(); + } + + /** + * Staking coins + * + * @param findCoin (required) + * @return ApiResponse<Object> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + +
Status Code Description Response Headers
200 Successfully retrieved -
+ */ + public ApiResponse findCoinWithHttpInfo(FindCoin findCoin) throws ApiException { + okhttp3.Call localVarCall = findCoinValidateBeforeCall(findCoin, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Staking coins (asynchronously) + * + * @param findCoin (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + +
Status Code Description Response Headers
200 Successfully retrieved -
+ */ + public okhttp3.Call findCoinAsync(FindCoin findCoin, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = findCoinValidateBeforeCall(findCoin, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + + /** + * Build call for swapStakingCoin + * @param swapCoin (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + +
Status Code Description Response Headers
200 Swap successful -
+ */ + public okhttp3.Call swapStakingCoinCall(SwapCoin swapCoin, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = swapCoin; + + // create path and map variables + String localVarPath = "/earn/staking/swap"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + String[] localVarAuthNames = new String[] { "apiv4" }; + return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call swapStakingCoinValidateBeforeCall(SwapCoin swapCoin, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'swapCoin' is set + if (swapCoin == null) { + throw new ApiException("Missing the required parameter 'swapCoin' when calling swapStakingCoin(Async)"); + } + + okhttp3.Call localVarCall = swapStakingCoinCall(swapCoin, _callback); + return localVarCall; + } + + /** + * On-chain token swap for earned coins + * + * @param swapCoin (required) + * @return SwapCoinStruct + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + +
Status Code Description Response Headers
200 Swap successful -
+ */ + public SwapCoinStruct swapStakingCoin(SwapCoin swapCoin) throws ApiException { + ApiResponse localVarResp = swapStakingCoinWithHttpInfo(swapCoin); + return localVarResp.getData(); + } + + /** + * On-chain token swap for earned coins + * + * @param swapCoin (required) + * @return ApiResponse<SwapCoinStruct> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + +
Status Code Description Response Headers
200 Swap successful -
+ */ + public ApiResponse swapStakingCoinWithHttpInfo(SwapCoin swapCoin) throws ApiException { + okhttp3.Call localVarCall = swapStakingCoinValidateBeforeCall(swapCoin, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * On-chain token swap for earned coins (asynchronously) + * + * @param swapCoin (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + +
Status Code Description Response Headers
200 Swap successful -
+ */ + public okhttp3.Call swapStakingCoinAsync(SwapCoin swapCoin, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = swapStakingCoinValidateBeforeCall(swapCoin, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + } diff --git a/src/main/java/io/gate/gateapi/api/EarnUniApi.java b/src/main/java/io/gate/gateapi/api/EarnUniApi.java index 555dbe2..c6a53ed 100644 --- a/src/main/java/io/gate/gateapi/api/EarnUniApi.java +++ b/src/main/java/io/gate/gateapi/api/EarnUniApi.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -26,7 +26,6 @@ import io.gate.gateapi.models.PatchUniLend; import io.gate.gateapi.models.UniCurrency; import io.gate.gateapi.models.UniCurrencyInterest; -import io.gate.gateapi.models.UniInterestMode; import io.gate.gateapi.models.UniInterestRecord; import io.gate.gateapi.models.UniLend; import io.gate.gateapi.models.UniLendInterest; @@ -65,7 +64,7 @@ public void setApiClient(ApiClient apiClient) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call listUniCurrenciesCall(final ApiCallback _callback) throws ApiException { @@ -104,14 +103,14 @@ private okhttp3.Call listUniCurrenciesValidateBeforeCall(final ApiCallback _call } /** - * List currencies for lending + * Query lending currency list * * @return List<UniCurrency> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List listUniCurrencies() throws ApiException { @@ -120,14 +119,14 @@ public List listUniCurrencies() throws ApiException { } /** - * List currencies for lending + * Query lending currency list * * @return ApiResponse<List<UniCurrency>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> listUniCurrenciesWithHttpInfo() throws ApiException { @@ -137,7 +136,7 @@ public ApiResponse> listUniCurrenciesWithHttpInfo() throws Api } /** - * List currencies for lending (asynchronously) + * Query lending currency list (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -145,7 +144,7 @@ public ApiResponse> listUniCurrenciesWithHttpInfo() throws Api * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call listUniCurrenciesAsync(final ApiCallback> _callback) throws ApiException { @@ -164,7 +163,7 @@ public okhttp3.Call listUniCurrenciesAsync(final ApiCallback> * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getUniCurrencyCall(String currency, final ApiCallback _callback) throws ApiException { @@ -209,7 +208,7 @@ private okhttp3.Call getUniCurrencyValidateBeforeCall(String currency, final Api } /** - * Get currency detail for lending + * Query single lending currency details * * @param currency Currency (required) * @return UniCurrency @@ -217,7 +216,7 @@ private okhttp3.Call getUniCurrencyValidateBeforeCall(String currency, final Api * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public UniCurrency getUniCurrency(String currency) throws ApiException { @@ -226,7 +225,7 @@ public UniCurrency getUniCurrency(String currency) throws ApiException { } /** - * Get currency detail for lending + * Query single lending currency details * * @param currency Currency (required) * @return ApiResponse<UniCurrency> @@ -234,7 +233,7 @@ public UniCurrency getUniCurrency(String currency) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse getUniCurrencyWithHttpInfo(String currency) throws ApiException { @@ -244,7 +243,7 @@ public ApiResponse getUniCurrencyWithHttpInfo(String currency) thro } /** - * Get currency detail for lending (asynchronously) + * Query single lending currency details (asynchronously) * * @param currency Currency (required) * @param _callback The callback to be executed when the API call finishes @@ -253,7 +252,7 @@ public ApiResponse getUniCurrencyWithHttpInfo(String currency) thro * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getUniCurrencyAsync(String currency, final ApiCallback _callback) throws ApiException { @@ -334,7 +333,7 @@ private APIlistUserUniLendsRequest() { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Query by specified currency name (optional) * @return APIlistUserUniLendsRequest */ public APIlistUserUniLendsRequest currency(String currency) { @@ -354,7 +353,7 @@ public APIlistUserUniLendsRequest page(Integer page) { /** * Set limit - * @param limit Maximum response items. Default: 100, minimum: 1, Maximum: 100 (optional, default to 100) + * @param limit Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 (optional, default to 100) * @return APIlistUserUniLendsRequest */ public APIlistUserUniLendsRequest limit(Integer limit) { @@ -370,7 +369,7 @@ public APIlistUserUniLendsRequest limit(Integer limit) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -384,7 +383,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -399,7 +398,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -414,7 +413,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -423,13 +422,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) thr } /** - * List user's lending orders + * Query user's lending order list * * @return APIlistUserUniLendsRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIlistUserUniLendsRequest listUserUniLends() { @@ -445,7 +444,7 @@ public APIlistUserUniLendsRequest listUserUniLends() { * @http.response.details - +
Status Code Description Response Headers
204 Operated successfully -
204 Operation successful -
*/ public okhttp3.Call createUniLendCall(CreateUniLend createUniLend, final ApiCallback _callback) throws ApiException { @@ -489,14 +488,14 @@ private okhttp3.Call createUniLendValidateBeforeCall(CreateUniLend createUniLend } /** - * Lend or redeem - * `Lending`: The minimum interest rate is required in lending. The lending result is updated hourly and the interest profit is paid on the next hour. A high interest rate might lead to unsuccessful lending and no profit will be gained for that hour. If the funds are redeemed before the hourly settlement, no interest can be obtained for that hour. About priority: the orders created or amended first under the same interest rate will be lent out first `Redemption`: Funds that failed to be lent can be redeemed immediately. For the successfully lent funds, enjoy the hourly income, and the redemption will arrive at the next hour `Note`: Two minutes before and after the hour is the settlement time, lending and redemption are prohibited. + * 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. * @param createUniLend (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
204 Operated successfully -
204 Operation successful -
*/ public void createUniLend(CreateUniLend createUniLend) throws ApiException { @@ -504,15 +503,15 @@ public void createUniLend(CreateUniLend createUniLend) throws ApiException { } /** - * Lend or redeem - * `Lending`: The minimum interest rate is required in lending. The lending result is updated hourly and the interest profit is paid on the next hour. A high interest rate might lead to unsuccessful lending and no profit will be gained for that hour. If the funds are redeemed before the hourly settlement, no interest can be obtained for that hour. About priority: the orders created or amended first under the same interest rate will be lent out first `Redemption`: Funds that failed to be lent can be redeemed immediately. For the successfully lent funds, enjoy the hourly income, and the redemption will arrive at the next hour `Note`: Two minutes before and after the hour is the settlement time, lending and redemption are prohibited. + * 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. * @param createUniLend (required) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
204 Operated successfully -
204 Operation successful -
*/ public ApiResponse createUniLendWithHttpInfo(CreateUniLend createUniLend) throws ApiException { @@ -521,8 +520,8 @@ public ApiResponse createUniLendWithHttpInfo(CreateUniLend createUniLend) } /** - * Lend or redeem (asynchronously) - * `Lending`: The minimum interest rate is required in lending. The lending result is updated hourly and the interest profit is paid on the next hour. A high interest rate might lead to unsuccessful lending and no profit will be gained for that hour. If the funds are redeemed before the hourly settlement, no interest can be obtained for that hour. About priority: the orders created or amended first under the same interest rate will be lent out first `Redemption`: Funds that failed to be lent can be redeemed immediately. For the successfully lent funds, enjoy the hourly income, and the redemption will arrive at the next hour `Note`: Two minutes before and after the hour is the settlement time, lending and redemption are prohibited. + * Create lending or redemption (asynchronously) + * 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. * @param createUniLend (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -530,7 +529,7 @@ public ApiResponse createUniLendWithHttpInfo(CreateUniLend createUniLend) * @http.response.details - +
Status Code Description Response Headers
204 Operated successfully -
204 Operation successful -
*/ public okhttp3.Call createUniLendAsync(CreateUniLend createUniLend, final ApiCallback _callback) throws ApiException { @@ -548,7 +547,7 @@ public okhttp3.Call createUniLendAsync(CreateUniLend createUniLend, final ApiCal * @http.response.details - +
Status Code Description Response Headers
204 Updated -
204 Updated successfully -
*/ public okhttp3.Call changeUniLendCall(PatchUniLend patchUniLend, final ApiCallback _callback) throws ApiException { @@ -592,14 +591,14 @@ private okhttp3.Call changeUniLendValidateBeforeCall(PatchUniLend patchUniLend, } /** - * Amend lending order - * Currently only supports amending the minimum interest rate (hour) + * Amend user lending information + * Currently only supports amending minimum interest rate (hourly) * @param patchUniLend (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
204 Updated -
204 Updated successfully -
*/ public void changeUniLend(PatchUniLend patchUniLend) throws ApiException { @@ -607,15 +606,15 @@ public void changeUniLend(PatchUniLend patchUniLend) throws ApiException { } /** - * Amend lending order - * Currently only supports amending the minimum interest rate (hour) + * Amend user lending information + * Currently only supports amending minimum interest rate (hourly) * @param patchUniLend (required) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
204 Updated -
204 Updated successfully -
*/ public ApiResponse changeUniLendWithHttpInfo(PatchUniLend patchUniLend) throws ApiException { @@ -624,8 +623,8 @@ public ApiResponse changeUniLendWithHttpInfo(PatchUniLend patchUniLend) th } /** - * Amend lending order (asynchronously) - * Currently only supports amending the minimum interest rate (hour) + * Amend user lending information (asynchronously) + * Currently only supports amending minimum interest rate (hourly) * @param patchUniLend (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -633,7 +632,7 @@ public ApiResponse changeUniLendWithHttpInfo(PatchUniLend patchUniLend) th * @http.response.details - +
Status Code Description Response Headers
204 Updated -
204 Updated successfully -
*/ public okhttp3.Call changeUniLendAsync(PatchUniLend patchUniLend, final ApiCallback _callback) throws ApiException { @@ -728,7 +727,7 @@ private APIlistUniLendRecordsRequest() { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Query by specified currency name (optional) * @return APIlistUniLendRecordsRequest */ public APIlistUniLendRecordsRequest currency(String currency) { @@ -748,7 +747,7 @@ public APIlistUniLendRecordsRequest page(Integer page) { /** * Set limit - * @param limit Maximum response items. Default: 100, minimum: 1, Maximum: 100 (optional, default to 100) + * @param limit Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 (optional, default to 100) * @return APIlistUniLendRecordsRequest */ public APIlistUniLendRecordsRequest limit(Integer limit) { @@ -758,7 +757,7 @@ public APIlistUniLendRecordsRequest limit(Integer limit) { /** * Set from - * @param from Start timestamp (optional) + * @param 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) (optional) * @return APIlistUniLendRecordsRequest */ public APIlistUniLendRecordsRequest from(Long from) { @@ -768,7 +767,7 @@ public APIlistUniLendRecordsRequest from(Long from) { /** * Set to - * @param to End timestamp (optional) + * @param to Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional) * @return APIlistUniLendRecordsRequest */ public APIlistUniLendRecordsRequest to(Long to) { @@ -778,7 +777,7 @@ public APIlistUniLendRecordsRequest to(Long to) { /** * Set type - * @param type type: lend - lend, redeem - redeem (optional) + * @param type Operation type: lend - Lend, redeem - Redeem (optional) * @return APIlistUniLendRecordsRequest */ public APIlistUniLendRecordsRequest type(String type) { @@ -794,7 +793,7 @@ public APIlistUniLendRecordsRequest type(String type) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -808,7 +807,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -823,7 +822,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -838,7 +837,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExceptio * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -847,13 +846,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callbac } /** - * List records of lending + * Query lending transaction records * * @return APIlistUniLendRecordsRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIlistUniLendRecordsRequest listUniLendRecords() { @@ -869,7 +868,7 @@ public APIlistUniLendRecordsRequest listUniLendRecords() { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getUniInterestCall(String currency, final ApiCallback _callback) throws ApiException { @@ -914,7 +913,7 @@ private okhttp3.Call getUniInterestValidateBeforeCall(String currency, final Api } /** - * Get the user's total interest income of specified currency + * Query user's total interest income for specified currency * * @param currency Currency (required) * @return UniLendInterest @@ -922,7 +921,7 @@ private okhttp3.Call getUniInterestValidateBeforeCall(String currency, final Api * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public UniLendInterest getUniInterest(String currency) throws ApiException { @@ -931,7 +930,7 @@ public UniLendInterest getUniInterest(String currency) throws ApiException { } /** - * Get the user's total interest income of specified currency + * Query user's total interest income for specified currency * * @param currency Currency (required) * @return ApiResponse<UniLendInterest> @@ -939,7 +938,7 @@ public UniLendInterest getUniInterest(String currency) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse getUniInterestWithHttpInfo(String currency) throws ApiException { @@ -949,7 +948,7 @@ public ApiResponse getUniInterestWithHttpInfo(String currency) } /** - * Get the user's total interest income of specified currency (asynchronously) + * Query user's total interest income for specified currency (asynchronously) * * @param currency Currency (required) * @param _callback The callback to be executed when the API call finishes @@ -958,7 +957,7 @@ public ApiResponse getUniInterestWithHttpInfo(String currency) * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getUniInterestAsync(String currency, final ApiCallback _callback) throws ApiException { @@ -1049,7 +1048,7 @@ private APIlistUniInterestRecordsRequest() { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Query by specified currency name (optional) * @return APIlistUniInterestRecordsRequest */ public APIlistUniInterestRecordsRequest currency(String currency) { @@ -1069,7 +1068,7 @@ public APIlistUniInterestRecordsRequest page(Integer page) { /** * Set limit - * @param limit Maximum response items. Default: 100, minimum: 1, Maximum: 100 (optional, default to 100) + * @param limit Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 (optional, default to 100) * @return APIlistUniInterestRecordsRequest */ public APIlistUniInterestRecordsRequest limit(Integer limit) { @@ -1079,7 +1078,7 @@ public APIlistUniInterestRecordsRequest limit(Integer limit) { /** * Set from - * @param from Start timestamp (optional) + * @param 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) (optional) * @return APIlistUniInterestRecordsRequest */ public APIlistUniInterestRecordsRequest from(Long from) { @@ -1089,7 +1088,7 @@ public APIlistUniInterestRecordsRequest from(Long from) { /** * Set to - * @param to End timestamp (optional) + * @param to Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional) * @return APIlistUniInterestRecordsRequest */ public APIlistUniInterestRecordsRequest to(Long to) { @@ -1105,7 +1104,7 @@ public APIlistUniInterestRecordsRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1119,7 +1118,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -1134,7 +1133,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1149,7 +1148,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExce * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1158,122 +1157,19 @@ public okhttp3.Call executeAsync(final ApiCallback> _cal } /** - * List interest records + * Query user dividend records * * @return APIlistUniInterestRecordsRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIlistUniInterestRecordsRequest listUniInterestRecords() { return new APIlistUniInterestRecordsRequest(); } - /** - * Build call for switchInterestReinvest - * @param uniInterestMode (required) - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - -
Status Code Description Response Headers
204 Success -
- */ - public okhttp3.Call switchInterestReinvestCall(UniInterestMode uniInterestMode, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = uniInterestMode; - - // create path and map variables - String localVarPath = "/earn/uni/interest_reinvest"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - final String[] localVarAccepts = { - - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - "application/json" - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - localVarHeaderParams.put("Content-Type", localVarContentType); - - String[] localVarAuthNames = new String[] { "apiv4" }; - return localVarApiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @SuppressWarnings("rawtypes") - private okhttp3.Call switchInterestReinvestValidateBeforeCall(UniInterestMode uniInterestMode, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'uniInterestMode' is set - if (uniInterestMode == null) { - throw new ApiException("Missing the required parameter 'uniInterestMode' when calling switchInterestReinvest(Async)"); - } - - okhttp3.Call localVarCall = switchInterestReinvestCall(uniInterestMode, _callback); - return localVarCall; - } - - /** - * Set interest reinvestment toggle - * - * @param uniInterestMode (required) - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - -
Status Code Description Response Headers
204 Success -
- */ - public void switchInterestReinvest(UniInterestMode uniInterestMode) throws ApiException { - switchInterestReinvestWithHttpInfo(uniInterestMode); - } - - /** - * Set interest reinvestment toggle - * - * @param uniInterestMode (required) - * @return ApiResponse<Void> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - -
Status Code Description Response Headers
204 Success -
- */ - public ApiResponse switchInterestReinvestWithHttpInfo(UniInterestMode uniInterestMode) throws ApiException { - okhttp3.Call localVarCall = switchInterestReinvestValidateBeforeCall(uniInterestMode, null); - return localVarApiClient.execute(localVarCall); - } - - /** - * Set interest reinvestment toggle (asynchronously) - * - * @param uniInterestMode (required) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - -
Status Code Description Response Headers
204 Success -
- */ - public okhttp3.Call switchInterestReinvestAsync(UniInterestMode uniInterestMode, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = switchInterestReinvestValidateBeforeCall(uniInterestMode, _callback); - localVarApiClient.executeAsync(localVarCall, _callback); - return localVarCall; - } - /** * Build call for getUniInterestStatus * @param currency Currency (required) @@ -1283,7 +1179,7 @@ public okhttp3.Call switchInterestReinvestAsync(UniInterestMode uniInterestMode, * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getUniInterestStatusCall(String currency, final ApiCallback _callback) throws ApiException { @@ -1328,7 +1224,7 @@ private okhttp3.Call getUniInterestStatusValidateBeforeCall(String currency, fin } /** - * query currency interest compounding status + * Query currency interest compounding status * * @param currency Currency (required) * @return UniCurrencyInterest @@ -1336,7 +1232,7 @@ private okhttp3.Call getUniInterestStatusValidateBeforeCall(String currency, fin * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public UniCurrencyInterest getUniInterestStatus(String currency) throws ApiException { @@ -1345,7 +1241,7 @@ public UniCurrencyInterest getUniInterestStatus(String currency) throws ApiExcep } /** - * query currency interest compounding status + * Query currency interest compounding status * * @param currency Currency (required) * @return ApiResponse<UniCurrencyInterest> @@ -1353,7 +1249,7 @@ public UniCurrencyInterest getUniInterestStatus(String currency) throws ApiExcep * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse getUniInterestStatusWithHttpInfo(String currency) throws ApiException { @@ -1363,7 +1259,7 @@ public ApiResponse getUniInterestStatusWithHttpInfo(String } /** - * query currency interest compounding status (asynchronously) + * Query currency interest compounding status (asynchronously) * * @param currency Currency (required) * @param _callback The callback to be executed when the API call finishes @@ -1372,7 +1268,7 @@ public ApiResponse getUniInterestStatusWithHttpInfo(String * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getUniInterestStatusAsync(String currency, final ApiCallback _callback) throws ApiException { @@ -1384,8 +1280,8 @@ public okhttp3.Call getUniInterestStatusAsync(String currency, final ApiCallback /** * Build call for listUniChart - * @param from Start timestamp, unit s, maximum span of 30 days (required) - * @param to End timestamp, unit s, maximum span of 30 days (required) + * @param from Start timestamp in seconds, maximum span 30 days (required) + * @param to End timestamp in seconds, maximum span 30 days (required) * @param asset Currency name (required) * @param _callback Callback for upload/download progress * @return Call to execute @@ -1393,7 +1289,7 @@ public okhttp3.Call getUniInterestStatusAsync(String currency, final ApiCallback * @http.response.details - +
Status Code Description Response Headers
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-06-04 01:35+0000 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <LL@li.org> Plural-Forms: nplurals=2; plural=(n != 1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <L@li.org> Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 -
*/ public okhttp3.Call listUniChartCall(Long from, Long to, String asset, final ApiCallback _callback) throws ApiException { @@ -1460,16 +1356,16 @@ private okhttp3.Call listUniChartValidateBeforeCall(Long from, Long to, String a /** * UniLoan currency annualized trend chart - * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-06-04 01:35+0000 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <LL@li.org> Plural-Forms: nplurals=2; plural=(n != 1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 - * @param from Start timestamp, unit s, maximum span of 30 days (required) - * @param to End timestamp, unit s, maximum span of 30 days (required) + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <L@li.org> Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 + * @param from Start timestamp in seconds, maximum span 30 days (required) + * @param to End timestamp in seconds, maximum span 30 days (required) * @param asset Currency name (required) * @return List<InlineResponse200> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-06-04 01:35+0000 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <LL@li.org> Plural-Forms: nplurals=2; plural=(n != 1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <L@li.org> Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 -
*/ public List listUniChart(Long from, Long to, String asset) throws ApiException { @@ -1479,16 +1375,16 @@ public List listUniChart(Long from, Long to, String asset) th /** * UniLoan currency annualized trend chart - * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-06-04 01:35+0000 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <LL@li.org> Plural-Forms: nplurals=2; plural=(n != 1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 - * @param from Start timestamp, unit s, maximum span of 30 days (required) - * @param to End timestamp, unit s, maximum span of 30 days (required) + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <L@li.org> Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 + * @param from Start timestamp in seconds, maximum span 30 days (required) + * @param to End timestamp in seconds, maximum span 30 days (required) * @param asset Currency name (required) * @return ApiResponse<List<InlineResponse200>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-06-04 01:35+0000 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <LL@li.org> Plural-Forms: nplurals=2; plural=(n != 1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <L@li.org> Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 -
*/ public ApiResponse> listUniChartWithHttpInfo(Long from, Long to, String asset) throws ApiException { @@ -1499,9 +1395,9 @@ public ApiResponse> listUniChartWithHttpInfo(Long from, /** * UniLoan currency annualized trend chart (asynchronously) - * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-06-04 01:35+0000 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <LL@li.org> Plural-Forms: nplurals=2; plural=(n != 1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 - * @param from Start timestamp, unit s, maximum span of 30 days (required) - * @param to End timestamp, unit s, maximum span of 30 days (required) + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <L@li.org> Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 + * @param from Start timestamp in seconds, maximum span 30 days (required) + * @param to End timestamp in seconds, maximum span 30 days (required) * @param asset Currency name (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1509,7 +1405,7 @@ public ApiResponse> listUniChartWithHttpInfo(Long from, * @http.response.details - +
Status Code Description Response Headers
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-06-04 01:35+0000 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <LL@li.org> Plural-Forms: nplurals=2; plural=(n != 1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <L@li.org> Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 -
*/ public okhttp3.Call listUniChartAsync(Long from, Long to, String asset, final ApiCallback> _callback) throws ApiException { @@ -1527,7 +1423,7 @@ public okhttp3.Call listUniChartAsync(Long from, Long to, String asset, final Ap * @http.response.details - +
Status Code Description Response Headers
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-06-04 01:35+0000 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <LL@li.org> Plural-Forms: nplurals=2; plural=(n != 1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <L@li.org> Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 -
*/ public okhttp3.Call listUniRateCall(final ApiCallback _callback) throws ApiException { @@ -1566,14 +1462,14 @@ private okhttp3.Call listUniRateValidateBeforeCall(final ApiCallback _callback) } /** - * Currency estimate annualized interest rate - * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-06-04 01:35+0000 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <LL@li.org> Plural-Forms: nplurals=2; plural=(n != 1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 + * 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 <EMAIL@ADDRESS> Language: en Language-Team: en <L@li.org> Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 * @return List<InlineResponse2001> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-06-04 01:35+0000 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <LL@li.org> Plural-Forms: nplurals=2; plural=(n != 1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <L@li.org> Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 -
*/ public List listUniRate() throws ApiException { @@ -1582,14 +1478,14 @@ public List listUniRate() throws ApiException { } /** - * Currency estimate annualized interest rate - * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-06-04 01:35+0000 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <LL@li.org> Plural-Forms: nplurals=2; plural=(n != 1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 + * 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 <EMAIL@ADDRESS> Language: en Language-Team: en <L@li.org> Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 * @return ApiResponse<List<InlineResponse2001>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-06-04 01:35+0000 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <LL@li.org> Plural-Forms: nplurals=2; plural=(n != 1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <L@li.org> Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 -
*/ public ApiResponse> listUniRateWithHttpInfo() throws ApiException { @@ -1599,15 +1495,15 @@ public ApiResponse> listUniRateWithHttpInfo() throws Ap } /** - * Currency estimate annualized interest rate (asynchronously) - * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-06-04 01:35+0000 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <LL@li.org> Plural-Forms: nplurals=2; plural=(n != 1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 + * Currency estimated annualized interest rate (asynchronously) + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <L@li.org> Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-06-04 01:35+0000 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <LL@li.org> Plural-Forms: nplurals=2; plural=(n != 1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <EMAIL@ADDRESS> Language: en Language-Team: en <L@li.org> Plural-Forms: nplurals=2; plural=(n !=1) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Generated-By: Babel 2.8.0 -
*/ public okhttp3.Call listUniRateAsync(final ApiCallback> _callback) throws ApiException { diff --git a/src/main/java/io/gate/gateapi/api/FlashSwapApi.java b/src/main/java/io/gate/gateapi/api/FlashSwapApi.java index 67cfb0f..b168961 100644 --- a/src/main/java/io/gate/gateapi/api/FlashSwapApi.java +++ b/src/main/java/io/gate/gateapi/api/FlashSwapApi.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -122,7 +122,7 @@ private APIlistFlashSwapCurrencyPairRequest() { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Query by specified currency name (optional) * @return APIlistFlashSwapCurrencyPairRequest */ public APIlistFlashSwapCurrencyPairRequest currency(String currency) { @@ -142,7 +142,7 @@ public APIlistFlashSwapCurrencyPairRequest page(Integer page) { /** * Set limit - * @param limit Maximum response items. Default: 100, minimum: 1, Maximum: 1000 (optional, default to 1000) + * @param limit Maximum number of items returned. Default: 1000, minimum: 1, maximum: 1000 (optional, default to 1000) * @return APIlistFlashSwapCurrencyPairRequest */ public APIlistFlashSwapCurrencyPairRequest limit(Integer limit) { @@ -158,7 +158,7 @@ public APIlistFlashSwapCurrencyPairRequest limit(Integer limit) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -172,7 +172,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -187,7 +187,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -202,7 +202,7 @@ public ApiResponse> executeWithHttpInfo() throws Api * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -217,7 +217,7 @@ public okhttp3.Call executeAsync(final ApiCallback> * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIlistFlashSwapCurrencyPairRequest listFlashSwapCurrencyPair() { @@ -310,7 +310,7 @@ private APIlistFlashSwapOrdersRequest() { /** * Set status - * @param status Flash swap order status `1` - success `2` - failure (optional) + * @param status Flash swap order status `1` - success `2` - failed (optional) * @return APIlistFlashSwapOrdersRequest */ public APIlistFlashSwapOrdersRequest status(Integer status) { @@ -320,7 +320,7 @@ public APIlistFlashSwapOrdersRequest status(Integer status) { /** * Set sellCurrency - * @param sellCurrency Currency to sell which can be retrieved from supported currency list API `GET /flash_swap/currencies` (optional) + * @param sellCurrency Asset name to sell - Retrieved from API `GET /flash_swap/currencies` for supported flash swap currencies (optional) * @return APIlistFlashSwapOrdersRequest */ public APIlistFlashSwapOrdersRequest sellCurrency(String sellCurrency) { @@ -330,7 +330,7 @@ public APIlistFlashSwapOrdersRequest sellCurrency(String sellCurrency) { /** * Set buyCurrency - * @param buyCurrency Currency to buy which can be retrieved from supported currency list API `GET /flash_swap/currencies` (optional) + * @param buyCurrency Asset name to buy - Retrieved from API `GET /flash_swap/currencies` for supported flash swap currencies (optional) * @return APIlistFlashSwapOrdersRequest */ public APIlistFlashSwapOrdersRequest buyCurrency(String buyCurrency) { @@ -340,7 +340,7 @@ public APIlistFlashSwapOrdersRequest buyCurrency(String buyCurrency) { /** * Set reverse - * @param reverse If results are sorted by id in reverse order. Default to `true` - `true`: sort by id in descending order(recent first) - `false`: sort by id in ascending order(oldest first) (optional) + * @param 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) (optional) * @return APIlistFlashSwapOrdersRequest */ public APIlistFlashSwapOrdersRequest reverse(Boolean reverse) { @@ -350,7 +350,7 @@ public APIlistFlashSwapOrdersRequest reverse(Boolean reverse) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistFlashSwapOrdersRequest */ public APIlistFlashSwapOrdersRequest limit(Integer limit) { @@ -376,7 +376,7 @@ public APIlistFlashSwapOrdersRequest page(Integer page) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -390,7 +390,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -405,7 +405,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -420,7 +420,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcepti * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -429,13 +429,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callba } /** - * List all flash swap orders + * Query flash swap order list * * @return APIlistFlashSwapOrdersRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistFlashSwapOrdersRequest listFlashSwapOrders() { @@ -451,7 +451,7 @@ public APIlistFlashSwapOrdersRequest listFlashSwapOrders() { * @http.response.details - +
Status Code Description Response Headers
201 The flash swap order is created successfully -
201 Flash swap order created successfully -
*/ public okhttp3.Call createFlashSwapOrderCall(FlashSwapOrderRequest flashSwapOrderRequest, final ApiCallback _callback) throws ApiException { @@ -503,7 +503,7 @@ private okhttp3.Call createFlashSwapOrderValidateBeforeCall(FlashSwapOrderReques * @http.response.details - +
Status Code Description Response Headers
201 The flash swap order is created successfully -
201 Flash swap order created successfully -
*/ public FlashSwapOrder createFlashSwapOrder(FlashSwapOrderRequest flashSwapOrderRequest) throws ApiException { @@ -520,7 +520,7 @@ public FlashSwapOrder createFlashSwapOrder(FlashSwapOrderRequest flashSwapOrderR * @http.response.details - +
Status Code Description Response Headers
201 The flash swap order is created successfully -
201 Flash swap order created successfully -
*/ public ApiResponse createFlashSwapOrderWithHttpInfo(FlashSwapOrderRequest flashSwapOrderRequest) throws ApiException { @@ -539,7 +539,7 @@ public ApiResponse createFlashSwapOrderWithHttpInfo(FlashSwapOrd * @http.response.details - +
Status Code Description Response Headers
201 The flash swap order is created successfully -
201 Flash swap order created successfully -
*/ public okhttp3.Call createFlashSwapOrderAsync(FlashSwapOrderRequest flashSwapOrderRequest, final ApiCallback _callback) throws ApiException { @@ -558,7 +558,7 @@ public okhttp3.Call createFlashSwapOrderAsync(FlashSwapOrderRequest flashSwapOrd * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getFlashSwapOrderCall(Integer orderId, final ApiCallback _callback) throws ApiException { @@ -603,7 +603,7 @@ private okhttp3.Call getFlashSwapOrderValidateBeforeCall(Integer orderId, final } /** - * Get a single flash swap order's detail + * Query single flash swap order * * @param orderId Flash swap order ID (required) * @return FlashSwapOrder @@ -611,7 +611,7 @@ private okhttp3.Call getFlashSwapOrderValidateBeforeCall(Integer orderId, final * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public FlashSwapOrder getFlashSwapOrder(Integer orderId) throws ApiException { @@ -620,7 +620,7 @@ public FlashSwapOrder getFlashSwapOrder(Integer orderId) throws ApiException { } /** - * Get a single flash swap order's detail + * Query single flash swap order * * @param orderId Flash swap order ID (required) * @return ApiResponse<FlashSwapOrder> @@ -628,7 +628,7 @@ public FlashSwapOrder getFlashSwapOrder(Integer orderId) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse getFlashSwapOrderWithHttpInfo(Integer orderId) throws ApiException { @@ -638,7 +638,7 @@ public ApiResponse getFlashSwapOrderWithHttpInfo(Integer orderId } /** - * Get a single flash swap order's detail (asynchronously) + * Query single flash swap order (asynchronously) * * @param orderId Flash swap order ID (required) * @param _callback The callback to be executed when the API call finishes @@ -647,7 +647,7 @@ public ApiResponse getFlashSwapOrderWithHttpInfo(Integer orderId * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getFlashSwapOrderAsync(Integer orderId, final ApiCallback _callback) throws ApiException { @@ -666,7 +666,7 @@ public okhttp3.Call getFlashSwapOrderAsync(Integer orderId, final ApiCallback Status Code Description Response Headers - 200 The flash swap order successfully previewed - + 200 Flash swap order preview successful - */ public okhttp3.Call previewFlashSwapOrderCall(FlashSwapPreviewRequest flashSwapPreviewRequest, final ApiCallback _callback) throws ApiException { @@ -710,7 +710,7 @@ private okhttp3.Call previewFlashSwapOrderValidateBeforeCall(FlashSwapPreviewReq } /** - * Initiate a flash swap order preview + * Flash swap order preview * * @param flashSwapPreviewRequest (required) * @return FlashSwapOrderPreview @@ -718,7 +718,7 @@ private okhttp3.Call previewFlashSwapOrderValidateBeforeCall(FlashSwapPreviewReq * @http.response.details - +
Status Code Description Response Headers
200 The flash swap order successfully previewed -
200 Flash swap order preview successful -
*/ public FlashSwapOrderPreview previewFlashSwapOrder(FlashSwapPreviewRequest flashSwapPreviewRequest) throws ApiException { @@ -727,7 +727,7 @@ public FlashSwapOrderPreview previewFlashSwapOrder(FlashSwapPreviewRequest flash } /** - * Initiate a flash swap order preview + * Flash swap order preview * * @param flashSwapPreviewRequest (required) * @return ApiResponse<FlashSwapOrderPreview> @@ -735,7 +735,7 @@ public FlashSwapOrderPreview previewFlashSwapOrder(FlashSwapPreviewRequest flash * @http.response.details - +
Status Code Description Response Headers
200 The flash swap order successfully previewed -
200 Flash swap order preview successful -
*/ public ApiResponse previewFlashSwapOrderWithHttpInfo(FlashSwapPreviewRequest flashSwapPreviewRequest) throws ApiException { @@ -745,7 +745,7 @@ public ApiResponse previewFlashSwapOrderWithHttpInfo(Flas } /** - * Initiate a flash swap order preview (asynchronously) + * Flash swap order preview (asynchronously) * * @param flashSwapPreviewRequest (required) * @param _callback The callback to be executed when the API call finishes @@ -754,7 +754,7 @@ public ApiResponse previewFlashSwapOrderWithHttpInfo(Flas * @http.response.details - +
Status Code Description Response Headers
200 The flash swap order successfully previewed -
200 Flash swap order preview successful -
*/ public okhttp3.Call previewFlashSwapOrderAsync(FlashSwapPreviewRequest flashSwapPreviewRequest, final ApiCallback _callback) throws ApiException { diff --git a/src/main/java/io/gate/gateapi/api/FuturesApi.java b/src/main/java/io/gate/gateapi/api/FuturesApi.java index ece4533..b2d70e3 100644 --- a/src/main/java/io/gate/gateapi/api/FuturesApi.java +++ b/src/main/java/io/gate/gateapi/api/FuturesApi.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -39,8 +39,10 @@ import io.gate.gateapi.models.FuturesOrder; import io.gate.gateapi.models.FuturesOrderAmendment; import io.gate.gateapi.models.FuturesOrderBook; +import io.gate.gateapi.models.FuturesPositionCrossMode; import io.gate.gateapi.models.FuturesPremiumIndex; import io.gate.gateapi.models.FuturesPriceTriggeredOrder; +import io.gate.gateapi.models.FuturesRiskLimitTier; import io.gate.gateapi.models.FuturesTicker; import io.gate.gateapi.models.FuturesTrade; import io.gate.gateapi.models.InlineObject; @@ -151,7 +153,7 @@ private APIlistFuturesContractsRequest(String settle) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistFuturesContractsRequest */ public APIlistFuturesContractsRequest limit(Integer limit) { @@ -177,7 +179,7 @@ public APIlistFuturesContractsRequest offset(Integer offset) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -191,7 +193,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -206,7 +208,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -221,7 +223,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -230,14 +232,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) th } /** - * List all futures contracts + * Query all futures contracts * * @param settle Settle currency (required) * @return APIlistFuturesContractsRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistFuturesContractsRequest listFuturesContracts(String settle) { @@ -305,7 +307,7 @@ private okhttp3.Call getFuturesContractValidateBeforeCall(String settle, String } /** - * Get a single contract + * Query single contract information * * @param settle Settle currency (required) * @param contract Futures contract (required) @@ -323,7 +325,7 @@ public Contract getFuturesContract(String settle, String contract) throws ApiExc } /** - * Get a single contract + * Query single contract information * * @param settle Settle currency (required) * @param contract Futures contract (required) @@ -342,7 +344,7 @@ public ApiResponse getFuturesContractWithHttpInfo(String settle, Strin } /** - * Get a single contract (asynchronously) + * Query single contract information (asynchronously) * * @param settle Settle currency (required) * @param contract Futures contract (required) @@ -452,7 +454,7 @@ private APIlistFuturesOrderBookRequest(String settle, String contract) { /** * Set interval - * @param interval Order depth. 0 means no aggregation is applied. default to 0 (optional, default to "0") + * @param interval Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified (optional, default to "0") * @return APIlistFuturesOrderBookRequest */ public APIlistFuturesOrderBookRequest interval(String interval) { @@ -462,7 +464,7 @@ public APIlistFuturesOrderBookRequest interval(String interval) { /** * Set limit - * @param limit Maximum number of order depth data in asks or bids (optional, default to 10) + * @param limit Number of depth levels (optional, default to 10) * @return APIlistFuturesOrderBookRequest */ public APIlistFuturesOrderBookRequest limit(Integer limit) { @@ -472,7 +474,7 @@ public APIlistFuturesOrderBookRequest limit(Integer limit) { /** * Set withId - * @param withId Whether the order book update ID will be returned. This ID increases by 1 on every order book update (optional, default to false) + * @param withId Whether to return depth update ID. This ID increments by 1 each time depth changes (optional, default to false) * @return APIlistFuturesOrderBookRequest */ public APIlistFuturesOrderBookRequest withId(Boolean withId) { @@ -488,7 +490,7 @@ public APIlistFuturesOrderBookRequest withId(Boolean withId) { * @http.response.details - +
Status Code Description Response Headers
200 Order book retrieved -
200 Depth query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -502,7 +504,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Order book retrieved -
200 Depth query successful -
*/ public FuturesOrderBook execute() throws ApiException { @@ -517,7 +519,7 @@ public FuturesOrderBook execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Order book retrieved -
200 Depth query successful -
*/ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -532,7 +534,7 @@ public ApiResponse executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Order book retrieved -
200 Depth query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -541,7 +543,7 @@ public okhttp3.Call executeAsync(final ApiCallback _callback) } /** - * Futures order book + * Query futures market depth information * Bids will be sorted by price from high to low, while asks sorted reversely * @param settle Settle currency (required) * @param contract Futures contract (required) @@ -549,7 +551,7 @@ public okhttp3.Call executeAsync(final ApiCallback _callback) * @http.response.details - +
Status Code Description Response Headers
200 Order book retrieved -
200 Depth query successful -
*/ public APIlistFuturesOrderBookRequest listFuturesOrderBook(String settle, String contract) { @@ -656,7 +658,7 @@ private APIlistFuturesTradesRequest(String settle, String contract) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistFuturesTradesRequest */ public APIlistFuturesTradesRequest limit(Integer limit) { @@ -696,7 +698,7 @@ public APIlistFuturesTradesRequest from(Long from) { /** * Set to - * @param to Specify end time in Unix seconds, default to current time (optional) + * @param to Specify end time in Unix seconds, default to current time. (optional) * @return APIlistFuturesTradesRequest */ public APIlistFuturesTradesRequest to(Long to) { @@ -712,7 +714,7 @@ public APIlistFuturesTradesRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -726,7 +728,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -741,7 +743,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -756,7 +758,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -765,7 +767,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * Futures trading history + * Futures market transaction records * * @param settle Settle currency (required) * @param contract Futures contract (required) @@ -773,14 +775,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistFuturesTradesRequest listFuturesTrades(String settle, String contract) { return new APIlistFuturesTradesRequest(settle, contract); } - private okhttp3.Call listFuturesCandlesticksCall(String settle, String contract, Long from, Long to, Integer limit, String interval, final ApiCallback _callback) throws ApiException { + private okhttp3.Call listFuturesCandlesticksCall(String settle, String contract, Long from, Long to, Integer limit, String interval, String timezone, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables @@ -809,6 +811,10 @@ private okhttp3.Call listFuturesCandlesticksCall(String settle, String contract, localVarQueryParams.addAll(localVarApiClient.parameterToPair("interval", interval)); } + if (timezone != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("timezone", timezone)); + } + Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); @@ -831,7 +837,7 @@ private okhttp3.Call listFuturesCandlesticksCall(String settle, String contract, } @SuppressWarnings("rawtypes") - private okhttp3.Call listFuturesCandlesticksValidateBeforeCall(String settle, String contract, Long from, Long to, Integer limit, String interval, final ApiCallback _callback) throws ApiException { + private okhttp3.Call listFuturesCandlesticksValidateBeforeCall(String settle, String contract, Long from, Long to, Integer limit, String interval, String timezone, final ApiCallback _callback) throws ApiException { // verify the required parameter 'settle' is set if (settle == null) { throw new ApiException("Missing the required parameter 'settle' when calling listFuturesCandlesticks(Async)"); @@ -842,19 +848,19 @@ private okhttp3.Call listFuturesCandlesticksValidateBeforeCall(String settle, St throw new ApiException("Missing the required parameter 'contract' when calling listFuturesCandlesticks(Async)"); } - okhttp3.Call localVarCall = listFuturesCandlesticksCall(settle, contract, from, to, limit, interval, _callback); + okhttp3.Call localVarCall = listFuturesCandlesticksCall(settle, contract, from, to, limit, interval, timezone, _callback); return localVarCall; } - private ApiResponse> listFuturesCandlesticksWithHttpInfo(String settle, String contract, Long from, Long to, Integer limit, String interval) throws ApiException { - okhttp3.Call localVarCall = listFuturesCandlesticksValidateBeforeCall(settle, contract, from, to, limit, interval, null); + private ApiResponse> listFuturesCandlesticksWithHttpInfo(String settle, String contract, Long from, Long to, Integer limit, String interval, String timezone) throws ApiException { + okhttp3.Call localVarCall = listFuturesCandlesticksValidateBeforeCall(settle, contract, from, to, limit, interval, timezone, null); Type localVarReturnType = new TypeToken>(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } - private okhttp3.Call listFuturesCandlesticksAsync(String settle, String contract, Long from, Long to, Integer limit, String interval, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = listFuturesCandlesticksValidateBeforeCall(settle, contract, from, to, limit, interval, _callback); + private okhttp3.Call listFuturesCandlesticksAsync(String settle, String contract, Long from, Long to, Integer limit, String interval, String timezone, final ApiCallback> _callback) throws ApiException { + okhttp3.Call localVarCall = listFuturesCandlesticksValidateBeforeCall(settle, contract, from, to, limit, interval, timezone, _callback); Type localVarReturnType = new TypeToken>(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -867,6 +873,7 @@ public class APIlistFuturesCandlesticksRequest { private Long to; private Integer limit; private String interval; + private String timezone; private APIlistFuturesCandlesticksRequest(String settle, String contract) { this.settle = settle; @@ -885,7 +892,7 @@ public APIlistFuturesCandlesticksRequest from(Long from) { /** * Set to - * @param to End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time (optional) + * @param 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 (optional) * @return APIlistFuturesCandlesticksRequest */ public APIlistFuturesCandlesticksRequest to(Long to) { @@ -895,7 +902,7 @@ public APIlistFuturesCandlesticksRequest to(Long to) { /** * Set limit - * @param 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. (optional, default to 100) + * @param 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. (optional, default to 100) * @return APIlistFuturesCandlesticksRequest */ public APIlistFuturesCandlesticksRequest limit(Integer limit) { @@ -905,7 +912,7 @@ public APIlistFuturesCandlesticksRequest limit(Integer limit) { /** * Set interval - * @param interval Interval time between data points. Note that `1w` means natual week(Mon-Sun), while `7d` means every 7d since unix 0. Note that 30d means 1 natual month, not 30 days (optional, default to "5m") + * @param 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 (optional, default to 5m) * @return APIlistFuturesCandlesticksRequest */ public APIlistFuturesCandlesticksRequest interval(String interval) { @@ -913,6 +920,16 @@ public APIlistFuturesCandlesticksRequest interval(String interval) { return this; } + /** + * Set timezone + * @param timezone Time zone: all/utc0/utc8, default utc0 (optional, default to "utc0") + * @return APIlistFuturesCandlesticksRequest + */ + public APIlistFuturesCandlesticksRequest timezone(String timezone) { + this.timezone = timezone; + return this; + } + /** * Build call for listFuturesCandlesticks * @param _callback ApiCallback API callback @@ -921,11 +938,11 @@ public APIlistFuturesCandlesticksRequest interval(String interval) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { - return listFuturesCandlesticksCall(settle, contract, from, to, limit, interval, _callback); + return listFuturesCandlesticksCall(settle, contract, from, to, limit, interval, timezone, _callback); } /** @@ -935,11 +952,11 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { - ApiResponse> localVarResp = listFuturesCandlesticksWithHttpInfo(settle, contract, from, to, limit, interval); + ApiResponse> localVarResp = listFuturesCandlesticksWithHttpInfo(settle, contract, from, to, limit, interval, timezone); return localVarResp.getData(); } @@ -950,11 +967,11 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { - return listFuturesCandlesticksWithHttpInfo(settle, contract, from, to, limit, interval); + return listFuturesCandlesticksWithHttpInfo(settle, contract, from, to, limit, interval, timezone); } /** @@ -965,16 +982,16 @@ public ApiResponse> executeWithHttpInfo() throws ApiExc * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { - return listFuturesCandlesticksAsync(settle, contract, from, to, limit, interval, _callback); + return listFuturesCandlesticksAsync(settle, contract, from, to, limit, interval, timezone, _callback); } } /** - * 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` * @param settle Settle currency (required) * @param contract Futures contract (required) @@ -982,7 +999,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _ca * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIlistFuturesCandlesticksRequest listFuturesCandlesticks(String settle, String contract) { @@ -1094,7 +1111,7 @@ public APIlistFuturesPremiumIndexRequest from(Long from) { /** * Set to - * @param to End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time (optional) + * @param 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 (optional) * @return APIlistFuturesPremiumIndexRequest */ public APIlistFuturesPremiumIndexRequest to(Long to) { @@ -1104,7 +1121,7 @@ public APIlistFuturesPremiumIndexRequest to(Long to) { /** * Set limit - * @param 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. (optional, default to 100) + * @param 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. (optional, default to 100) * @return APIlistFuturesPremiumIndexRequest */ public APIlistFuturesPremiumIndexRequest limit(Integer limit) { @@ -1114,7 +1131,7 @@ public APIlistFuturesPremiumIndexRequest limit(Integer limit) { /** * Set interval - * @param interval Interval time between data points (optional, default to "5m") + * @param interval Time interval between data points (optional, default to 5m) * @return APIlistFuturesPremiumIndexRequest */ public APIlistFuturesPremiumIndexRequest interval(String interval) { @@ -1130,7 +1147,7 @@ public APIlistFuturesPremiumIndexRequest interval(String interval) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1144,7 +1161,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -1159,7 +1176,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1174,7 +1191,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiEx * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1183,7 +1200,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _c } /** - * 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 * @param settle Settle currency (required) * @param contract Futures contract (required) @@ -1191,7 +1208,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _c * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIlistFuturesPremiumIndexRequest listFuturesPremiumIndex(String settle, String contract) { @@ -1283,7 +1300,7 @@ public APIlistFuturesTickersRequest contract(String contract) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1297,7 +1314,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -1312,7 +1329,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1327,7 +1344,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExceptio * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1336,14 +1353,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callbac } /** - * List futures tickers + * Get all futures trading statistics * * @param settle Settle currency (required) * @return APIlistFuturesTickersRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIlistFuturesTickersRequest listFuturesTickers(String settle) { @@ -1440,7 +1457,7 @@ private APIlistFuturesFundingRateHistoryRequest(String settle, String contract) /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistFuturesFundingRateHistoryRequest */ public APIlistFuturesFundingRateHistoryRequest limit(Integer limit) { @@ -1450,7 +1467,7 @@ public APIlistFuturesFundingRateHistoryRequest limit(Integer limit) { /** * Set from - * @param from Start timestamp (optional) + * @param 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) (optional) * @return APIlistFuturesFundingRateHistoryRequest */ public APIlistFuturesFundingRateHistoryRequest from(Long from) { @@ -1460,7 +1477,7 @@ public APIlistFuturesFundingRateHistoryRequest from(Long from) { /** * Set to - * @param to End timestamp (optional) + * @param to Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional) * @return APIlistFuturesFundingRateHistoryRequest */ public APIlistFuturesFundingRateHistoryRequest to(Long to) { @@ -1476,7 +1493,7 @@ public APIlistFuturesFundingRateHistoryRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 History retrieved -
200 History query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1490,7 +1507,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 History retrieved -
200 History query successful -
*/ public List execute() throws ApiException { @@ -1505,7 +1522,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 History retrieved -
200 History query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1520,7 +1537,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExce * @http.response.details - +
Status Code Description Response Headers
200 History retrieved -
200 History query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1529,7 +1546,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _cal } /** - * Funding rate history + * Futures market historical funding rate * * @param settle Settle currency (required) * @param contract Futures contract (required) @@ -1537,7 +1554,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _cal * @http.response.details - +
Status Code Description Response Headers
200 History retrieved -
200 History query successful -
*/ public APIlistFuturesFundingRateHistoryRequest listFuturesFundingRateHistory(String settle, String contract) { @@ -1613,7 +1630,7 @@ private APIlistFuturesInsuranceLedgerRequest(String settle) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistFuturesInsuranceLedgerRequest */ public APIlistFuturesInsuranceLedgerRequest limit(Integer limit) { @@ -1629,7 +1646,7 @@ public APIlistFuturesInsuranceLedgerRequest limit(Integer limit) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1643,7 +1660,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -1658,7 +1675,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1673,7 +1690,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcept * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1682,14 +1699,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callb } /** - * Futures insurance balance history + * Futures market insurance fund history * * @param settle Settle currency (required) * @return APIlistFuturesInsuranceLedgerRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIlistFuturesInsuranceLedgerRequest listFuturesInsuranceLedger(String settle) { @@ -1822,7 +1839,7 @@ public APIlistContractStatsRequest limit(Integer limit) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1836,7 +1853,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -1851,7 +1868,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1866,7 +1883,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1875,7 +1892,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * Futures stats + * Futures statistics * * @param settle Settle currency (required) * @param contract Futures contract (required) @@ -1883,7 +1900,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistContractStatsRequest listContractStats(String settle, String contract) { @@ -1900,7 +1917,7 @@ public APIlistContractStatsRequest listContractStats(String settle, String contr * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getIndexConstituentsCall(String settle, String index, final ApiCallback _callback) throws ApiException { @@ -1951,7 +1968,7 @@ private okhttp3.Call getIndexConstituentsValidateBeforeCall(String settle, Strin } /** - * Get index constituents + * Query index constituents * * @param settle Settle currency (required) * @param index Index name (required) @@ -1960,7 +1977,7 @@ private okhttp3.Call getIndexConstituentsValidateBeforeCall(String settle, Strin * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public FuturesIndexConstituents getIndexConstituents(String settle, String index) throws ApiException { @@ -1969,7 +1986,7 @@ public FuturesIndexConstituents getIndexConstituents(String settle, String index } /** - * Get index constituents + * Query index constituents * * @param settle Settle currency (required) * @param index Index name (required) @@ -1978,7 +1995,7 @@ public FuturesIndexConstituents getIndexConstituents(String settle, String index * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse getIndexConstituentsWithHttpInfo(String settle, String index) throws ApiException { @@ -1988,7 +2005,7 @@ public ApiResponse getIndexConstituentsWithHttpInfo(St } /** - * Get index constituents (asynchronously) + * Query index constituents (asynchronously) * * @param settle Settle currency (required) * @param index Index name (required) @@ -1998,7 +2015,7 @@ public ApiResponse getIndexConstituentsWithHttpInfo(St * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getIndexConstituentsAsync(String settle, String index, final ApiCallback _callback) throws ApiException { @@ -2102,7 +2119,7 @@ public APIlistLiquidatedOrdersRequest contract(String contract) { /** * Set from - * @param from Start timestamp (optional) + * @param 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) (optional) * @return APIlistLiquidatedOrdersRequest */ public APIlistLiquidatedOrdersRequest from(Long from) { @@ -2112,7 +2129,7 @@ public APIlistLiquidatedOrdersRequest from(Long from) { /** * Set to - * @param to End timestamp (optional) + * @param to Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional) * @return APIlistLiquidatedOrdersRequest */ public APIlistLiquidatedOrdersRequest to(Long to) { @@ -2122,7 +2139,7 @@ public APIlistLiquidatedOrdersRequest to(Long to) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistLiquidatedOrdersRequest */ public APIlistLiquidatedOrdersRequest limit(Integer limit) { @@ -2138,7 +2155,7 @@ public APIlistLiquidatedOrdersRequest limit(Integer limit) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2152,7 +2169,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -2167,7 +2184,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -2182,7 +2199,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcept * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2191,14 +2208,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callb } /** - * Retrieve liquidation history - * Interval between `from` and `to` cannot exceeds 3600. Some private fields will not be returned in public endpoints. Refer to field description for detail. + * 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 details * @param settle Settle currency (required) * @return APIlistLiquidatedOrdersRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistLiquidatedOrdersRequest listLiquidatedOrders(String settle) { @@ -2294,7 +2311,7 @@ public APIlistFuturesRiskLimitTiersRequest contract(String contract) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistFuturesRiskLimitTiersRequest */ public APIlistFuturesRiskLimitTiersRequest limit(Integer limit) { @@ -2320,7 +2337,7 @@ public APIlistFuturesRiskLimitTiersRequest offset(Integer offset) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2334,7 +2351,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -2349,7 +2366,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -2364,7 +2381,7 @@ public ApiResponse> executeWithHttpInfo() throws Api * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2373,14 +2390,14 @@ public okhttp3.Call executeAsync(final ApiCallback> } /** - * List risk limit tiers - * When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets.'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the 'contract' parameter is empty. + * Query risk limit tiers + * When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets. 'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the contract parameter is empty. * @param settle Settle currency (required) * @return APIlistFuturesRiskLimitTiersRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIlistFuturesRiskLimitTiersRequest listFuturesRiskLimitTiers(String settle) { @@ -2396,7 +2413,7 @@ public APIlistFuturesRiskLimitTiersRequest listFuturesRiskLimitTiers(String sett * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call listFuturesAccountsCall(String settle, final ApiCallback _callback) throws ApiException { @@ -2441,7 +2458,7 @@ private okhttp3.Call listFuturesAccountsValidateBeforeCall(String settle, final } /** - * Query futures account + * Get futures account * * @param settle Settle currency (required) * @return FuturesAccount @@ -2449,7 +2466,7 @@ private okhttp3.Call listFuturesAccountsValidateBeforeCall(String settle, final * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public FuturesAccount listFuturesAccounts(String settle) throws ApiException { @@ -2458,7 +2475,7 @@ public FuturesAccount listFuturesAccounts(String settle) throws ApiException { } /** - * Query futures account + * Get futures account * * @param settle Settle currency (required) * @return ApiResponse<FuturesAccount> @@ -2466,7 +2483,7 @@ public FuturesAccount listFuturesAccounts(String settle) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse listFuturesAccountsWithHttpInfo(String settle) throws ApiException { @@ -2476,7 +2493,7 @@ public ApiResponse listFuturesAccountsWithHttpInfo(String settle } /** - * Query futures account (asynchronously) + * Get futures account (asynchronously) * * @param settle Settle currency (required) * @param _callback The callback to be executed when the API call finishes @@ -2485,7 +2502,7 @@ public ApiResponse listFuturesAccountsWithHttpInfo(String settle * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call listFuturesAccountsAsync(String settle, final ApiCallback _callback) throws ApiException { @@ -2599,7 +2616,7 @@ public APIlistFuturesAccountBookRequest contract(String contract) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistFuturesAccountBookRequest */ public APIlistFuturesAccountBookRequest limit(Integer limit) { @@ -2619,7 +2636,7 @@ public APIlistFuturesAccountBookRequest offset(Integer offset) { /** * Set from - * @param from Start timestamp (optional) + * @param 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) (optional) * @return APIlistFuturesAccountBookRequest */ public APIlistFuturesAccountBookRequest from(Long from) { @@ -2629,7 +2646,7 @@ public APIlistFuturesAccountBookRequest from(Long from) { /** * Set to - * @param to End timestamp (optional) + * @param to Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional) * @return APIlistFuturesAccountBookRequest */ public APIlistFuturesAccountBookRequest to(Long to) { @@ -2639,7 +2656,7 @@ public APIlistFuturesAccountBookRequest to(Long to) { /** * Set type - * @param type Changing Type： - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction (optional) + * @param 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 (optional) * @return APIlistFuturesAccountBookRequest */ public APIlistFuturesAccountBookRequest type(String type) { @@ -2655,7 +2672,7 @@ public APIlistFuturesAccountBookRequest type(String type) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2669,7 +2686,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -2684,7 +2701,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -2699,7 +2716,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExc * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2708,14 +2725,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _ca } /** - * Query account book - * If the `contract` field is provided, it can only filter records that include this field after 2023-10-30. + * Query futures account change history + * If the contract field is passed, only records containing this field after 2023-10-30 can be filtered. * @param settle Settle currency (required) * @return APIlistFuturesAccountBookRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistFuturesAccountBookRequest listFuturesAccountBook(String settle) { @@ -2801,7 +2818,7 @@ private APIlistPositionsRequest(String settle) { /** * Set holding - * @param holding Return only real positions - true, return all - false. (optional) + * @param holding Return only real positions - true, return all - false (optional) * @return APIlistPositionsRequest */ public APIlistPositionsRequest holding(Boolean holding) { @@ -2811,7 +2828,7 @@ public APIlistPositionsRequest holding(Boolean holding) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistPositionsRequest */ public APIlistPositionsRequest limit(Integer limit) { @@ -2837,7 +2854,7 @@ public APIlistPositionsRequest offset(Integer offset) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2851,7 +2868,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -2866,7 +2883,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -2881,7 +2898,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2890,14 +2907,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) th } /** - * List all positions of a user + * Get user position list * * @param settle Settle currency (required) * @return APIlistPositionsRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistPositionsRequest listPositions(String settle) { @@ -3035,7 +3052,7 @@ public okhttp3.Call executeAsync(final ApiCallback _callback) throws A } /** - * Get single position + * Get single position information * * @param settle Settle currency (required) * @param contract Futures contract (required) @@ -3054,7 +3071,7 @@ public APIgetPositionRequest getPosition(String settle, String contract) { * Build call for updatePositionMargin * @param settle Settle currency (required) * @param contract Futures contract (required) - * @param change Margin change. Use positive number to increase margin, negative number otherwise. (required) + * @param change Margin change amount, positive number increases, negative number decreases (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -3125,7 +3142,7 @@ private okhttp3.Call updatePositionMarginValidateBeforeCall(String settle, Strin * * @param settle Settle currency (required) * @param contract Futures contract (required) - * @param change Margin change. Use positive number to increase margin, negative number otherwise. (required) + * @param change Margin change amount, positive number increases, negative number decreases (required) * @return Position * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -3144,7 +3161,7 @@ public Position updatePositionMargin(String settle, String contract, String chan * * @param settle Settle currency (required) * @param contract Futures contract (required) - * @param change Margin change. Use positive number to increase margin, negative number otherwise. (required) + * @param change Margin change amount, positive number increases, negative number decreases (required) * @return ApiResponse<Position> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -3164,7 +3181,7 @@ public ApiResponse updatePositionMarginWithHttpInfo(String settle, Str * * @param settle Settle currency (required) * @param contract Futures contract (required) - * @param change Margin change. Use positive number to increase margin, negative number otherwise. (required) + * @param change Margin change amount, positive number increases, negative number decreases (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -3186,7 +3203,8 @@ public okhttp3.Call updatePositionMarginAsync(String settle, String contract, St * @param settle Settle currency (required) * @param contract Futures contract (required) * @param leverage New position leverage (required) - * @param crossLeverageLimit Cross margin leverage(valid only when `leverage` is 0) (optional) + * @param crossLeverageLimit Cross margin leverage (valid only when `leverage` is 0) (optional) + * @param pid Product ID (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -3196,7 +3214,7 @@ public okhttp3.Call updatePositionMarginAsync(String settle, String contract, St 200 Position information - */ - public okhttp3.Call updatePositionLeverageCall(String settle, String contract, String leverage, String crossLeverageLimit, final ApiCallback _callback) throws ApiException { + public okhttp3.Call updatePositionLeverageCall(String settle, String contract, String leverage, String crossLeverageLimit, Integer pid, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables @@ -3214,6 +3232,10 @@ public okhttp3.Call updatePositionLeverageCall(String settle, String contract, S localVarQueryParams.addAll(localVarApiClient.parameterToPair("cross_leverage_limit", crossLeverageLimit)); } + if (pid != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("pid", pid)); + } + Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); @@ -3236,7 +3258,7 @@ public okhttp3.Call updatePositionLeverageCall(String settle, String contract, S } @SuppressWarnings("rawtypes") - private okhttp3.Call updatePositionLeverageValidateBeforeCall(String settle, String contract, String leverage, String crossLeverageLimit, final ApiCallback _callback) throws ApiException { + private okhttp3.Call updatePositionLeverageValidateBeforeCall(String settle, String contract, String leverage, String crossLeverageLimit, Integer pid, final ApiCallback _callback) throws ApiException { // verify the required parameter 'settle' is set if (settle == null) { throw new ApiException("Missing the required parameter 'settle' when calling updatePositionLeverage(Async)"); @@ -3252,7 +3274,7 @@ private okhttp3.Call updatePositionLeverageValidateBeforeCall(String settle, Str throw new ApiException("Missing the required parameter 'leverage' when calling updatePositionLeverage(Async)"); } - okhttp3.Call localVarCall = updatePositionLeverageCall(settle, contract, leverage, crossLeverageLimit, _callback); + okhttp3.Call localVarCall = updatePositionLeverageCall(settle, contract, leverage, crossLeverageLimit, pid, _callback); return localVarCall; } @@ -3262,7 +3284,8 @@ private okhttp3.Call updatePositionLeverageValidateBeforeCall(String settle, Str * @param settle Settle currency (required) * @param contract Futures contract (required) * @param leverage New position leverage (required) - * @param crossLeverageLimit Cross margin leverage(valid only when `leverage` is 0) (optional) + * @param crossLeverageLimit Cross margin leverage (valid only when `leverage` is 0) (optional) + * @param pid Product ID (optional) * @return Position * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -3271,8 +3294,8 @@ private okhttp3.Call updatePositionLeverageValidateBeforeCall(String settle, Str 200 Position information - */ - public Position updatePositionLeverage(String settle, String contract, String leverage, String crossLeverageLimit) throws ApiException { - ApiResponse localVarResp = updatePositionLeverageWithHttpInfo(settle, contract, leverage, crossLeverageLimit); + public Position updatePositionLeverage(String settle, String contract, String leverage, String crossLeverageLimit, Integer pid) throws ApiException { + ApiResponse localVarResp = updatePositionLeverageWithHttpInfo(settle, contract, leverage, crossLeverageLimit, pid); return localVarResp.getData(); } @@ -3282,7 +3305,8 @@ public Position updatePositionLeverage(String settle, String contract, String le * @param settle Settle currency (required) * @param contract Futures contract (required) * @param leverage New position leverage (required) - * @param crossLeverageLimit Cross margin leverage(valid only when `leverage` is 0) (optional) + * @param crossLeverageLimit Cross margin leverage (valid only when `leverage` is 0) (optional) + * @param pid Product ID (optional) * @return ApiResponse<Position> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -3291,8 +3315,8 @@ public Position updatePositionLeverage(String settle, String contract, String le 200 Position information - */ - public ApiResponse updatePositionLeverageWithHttpInfo(String settle, String contract, String leverage, String crossLeverageLimit) throws ApiException { - okhttp3.Call localVarCall = updatePositionLeverageValidateBeforeCall(settle, contract, leverage, crossLeverageLimit, null); + public ApiResponse updatePositionLeverageWithHttpInfo(String settle, String contract, String leverage, String crossLeverageLimit, Integer pid) throws ApiException { + okhttp3.Call localVarCall = updatePositionLeverageValidateBeforeCall(settle, contract, leverage, crossLeverageLimit, pid, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -3303,7 +3327,8 @@ public ApiResponse updatePositionLeverageWithHttpInfo(String settle, S * @param settle Settle currency (required) * @param contract Futures contract (required) * @param leverage New position leverage (required) - * @param crossLeverageLimit Cross margin leverage(valid only when `leverage` is 0) (optional) + * @param crossLeverageLimit Cross margin leverage (valid only when `leverage` is 0) (optional) + * @param pid Product ID (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -3313,8 +3338,8 @@ public ApiResponse updatePositionLeverageWithHttpInfo(String settle, S 200 Position information - */ - public okhttp3.Call updatePositionLeverageAsync(String settle, String contract, String leverage, String crossLeverageLimit, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = updatePositionLeverageValidateBeforeCall(settle, contract, leverage, crossLeverageLimit, _callback); + public okhttp3.Call updatePositionLeverageAsync(String settle, String contract, String leverage, String crossLeverageLimit, Integer pid, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = updatePositionLeverageValidateBeforeCall(settle, contract, leverage, crossLeverageLimit, pid, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -3323,7 +3348,7 @@ public okhttp3.Call updatePositionLeverageAsync(String settle, String contract, /** * Build call for updatePositionCrossMode * @param settle Settle currency (required) - * @param inlineObject (required) + * @param futuresPositionCrossMode (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -3333,8 +3358,8 @@ public okhttp3.Call updatePositionLeverageAsync(String settle, String contract, 200 Position information - */ - public okhttp3.Call updatePositionCrossModeCall(String settle, InlineObject inlineObject, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = inlineObject; + public okhttp3.Call updatePositionCrossModeCall(String settle, FuturesPositionCrossMode futuresPositionCrossMode, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = futuresPositionCrossMode; // create path and map variables String localVarPath = "/futures/{settle}/positions/cross_mode" @@ -3364,26 +3389,26 @@ public okhttp3.Call updatePositionCrossModeCall(String settle, InlineObject inli } @SuppressWarnings("rawtypes") - private okhttp3.Call updatePositionCrossModeValidateBeforeCall(String settle, InlineObject inlineObject, final ApiCallback _callback) throws ApiException { + private okhttp3.Call updatePositionCrossModeValidateBeforeCall(String settle, FuturesPositionCrossMode futuresPositionCrossMode, final ApiCallback _callback) throws ApiException { // verify the required parameter 'settle' is set if (settle == null) { throw new ApiException("Missing the required parameter 'settle' when calling updatePositionCrossMode(Async)"); } - // verify the required parameter 'inlineObject' is set - if (inlineObject == null) { - throw new ApiException("Missing the required parameter 'inlineObject' when calling updatePositionCrossMode(Async)"); + // verify the required parameter 'futuresPositionCrossMode' is set + if (futuresPositionCrossMode == null) { + throw new ApiException("Missing the required parameter 'futuresPositionCrossMode' when calling updatePositionCrossMode(Async)"); } - okhttp3.Call localVarCall = updatePositionCrossModeCall(settle, inlineObject, _callback); + okhttp3.Call localVarCall = updatePositionCrossModeCall(settle, futuresPositionCrossMode, _callback); return localVarCall; } /** - * Switch to the full position-by-store mode + * Switch Position Margin Mode * * @param settle Settle currency (required) - * @param inlineObject (required) + * @param futuresPositionCrossMode (required) * @return Position * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -3392,16 +3417,16 @@ private okhttp3.Call updatePositionCrossModeValidateBeforeCall(String settle, In 200 Position information - */ - public Position updatePositionCrossMode(String settle, InlineObject inlineObject) throws ApiException { - ApiResponse localVarResp = updatePositionCrossModeWithHttpInfo(settle, inlineObject); + public Position updatePositionCrossMode(String settle, FuturesPositionCrossMode futuresPositionCrossMode) throws ApiException { + ApiResponse localVarResp = updatePositionCrossModeWithHttpInfo(settle, futuresPositionCrossMode); return localVarResp.getData(); } /** - * Switch to the full position-by-store mode + * Switch Position Margin Mode * * @param settle Settle currency (required) - * @param inlineObject (required) + * @param futuresPositionCrossMode (required) * @return ApiResponse<Position> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -3410,17 +3435,17 @@ public Position updatePositionCrossMode(String settle, InlineObject inlineObject 200 Position information - */ - public ApiResponse updatePositionCrossModeWithHttpInfo(String settle, InlineObject inlineObject) throws ApiException { - okhttp3.Call localVarCall = updatePositionCrossModeValidateBeforeCall(settle, inlineObject, null); + public ApiResponse updatePositionCrossModeWithHttpInfo(String settle, FuturesPositionCrossMode futuresPositionCrossMode) throws ApiException { + okhttp3.Call localVarCall = updatePositionCrossModeValidateBeforeCall(settle, futuresPositionCrossMode, null); Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * Switch to the full position-by-store mode (asynchronously) + * Switch Position Margin Mode (asynchronously) * * @param settle Settle currency (required) - * @param inlineObject (required) + * @param futuresPositionCrossMode (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -3430,18 +3455,135 @@ public ApiResponse updatePositionCrossModeWithHttpInfo(String settle, 200 Position information - */ - public okhttp3.Call updatePositionCrossModeAsync(String settle, InlineObject inlineObject, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = updatePositionCrossModeValidateBeforeCall(settle, inlineObject, _callback); + public okhttp3.Call updatePositionCrossModeAsync(String settle, FuturesPositionCrossMode futuresPositionCrossMode, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = updatePositionCrossModeValidateBeforeCall(settle, futuresPositionCrossMode, _callback); Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } + /** + * Build call for updateDualCompPositionCrossMode + * @param settle Settle currency (required) + * @param inlineObject (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + +
Status Code Description Response Headers
200 Query successful -
+ */ + public okhttp3.Call updateDualCompPositionCrossModeCall(String settle, InlineObject inlineObject, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = inlineObject; + + // create path and map variables + String localVarPath = "/futures/{settle}/dual_comp/positions/cross_mode" + .replaceAll("\\{" + "settle" + "\\}", localVarApiClient.escapeString(settle)); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + String[] localVarAuthNames = new String[] { "apiv4" }; + return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call updateDualCompPositionCrossModeValidateBeforeCall(String settle, InlineObject inlineObject, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'settle' is set + if (settle == null) { + throw new ApiException("Missing the required parameter 'settle' when calling updateDualCompPositionCrossMode(Async)"); + } + + // verify the required parameter 'inlineObject' is set + if (inlineObject == null) { + throw new ApiException("Missing the required parameter 'inlineObject' when calling updateDualCompPositionCrossMode(Async)"); + } + + okhttp3.Call localVarCall = updateDualCompPositionCrossModeCall(settle, inlineObject, _callback); + return localVarCall; + } + + /** + * Switch Between Cross and Isolated Margin Modes Under Hedge Mode + * + * @param settle Settle currency (required) + * @param inlineObject (required) + * @return List<Position> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + +
Status Code Description Response Headers
200 Query successful -
+ */ + public List updateDualCompPositionCrossMode(String settle, InlineObject inlineObject) throws ApiException { + ApiResponse> localVarResp = updateDualCompPositionCrossModeWithHttpInfo(settle, inlineObject); + return localVarResp.getData(); + } + + /** + * Switch Between Cross and Isolated Margin Modes Under Hedge Mode + * + * @param settle Settle currency (required) + * @param inlineObject (required) + * @return ApiResponse<List<Position>> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + +
Status Code Description Response Headers
200 Query successful -
+ */ + public ApiResponse> updateDualCompPositionCrossModeWithHttpInfo(String settle, InlineObject inlineObject) throws ApiException { + okhttp3.Call localVarCall = updateDualCompPositionCrossModeValidateBeforeCall(settle, inlineObject, null); + Type localVarReturnType = new TypeToken>(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Switch Between Cross and Isolated Margin Modes Under Hedge Mode (asynchronously) + * + * @param settle Settle currency (required) + * @param inlineObject (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + +
Status Code Description Response Headers
200 Query successful -
+ */ + public okhttp3.Call updateDualCompPositionCrossModeAsync(String settle, InlineObject inlineObject, final ApiCallback> _callback) throws ApiException { + okhttp3.Call localVarCall = updateDualCompPositionCrossModeValidateBeforeCall(settle, inlineObject, _callback); + Type localVarReturnType = new TypeToken>(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** * Build call for updatePositionRiskLimit * @param settle Settle currency (required) * @param contract Futures contract (required) - * @param riskLimit New Risk Limit Value (required) + * @param riskLimit New risk limit value (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -3512,7 +3654,7 @@ private okhttp3.Call updatePositionRiskLimitValidateBeforeCall(String settle, St * * @param settle Settle currency (required) * @param contract Futures contract (required) - * @param riskLimit New Risk Limit Value (required) + * @param riskLimit New risk limit value (required) * @return Position * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -3531,7 +3673,7 @@ public Position updatePositionRiskLimit(String settle, String contract, String r * * @param settle Settle currency (required) * @param contract Futures contract (required) - * @param riskLimit New Risk Limit Value (required) + * @param riskLimit New risk limit value (required) * @return ApiResponse<Position> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -3551,7 +3693,7 @@ public ApiResponse updatePositionRiskLimitWithHttpInfo(String settle, * * @param settle Settle currency (required) * @param contract Futures contract (required) - * @param riskLimit New Risk Limit Value (required) + * @param riskLimit New risk limit value (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -3578,7 +3720,7 @@ public okhttp3.Call updatePositionRiskLimitAsync(String settle, String contract, * @http.response.details - +
Status Code Description Response Headers
200 Updated -
200 Updated successfully -
*/ public okhttp3.Call setDualModeCall(String settle, Boolean dualMode, final ApiCallback _callback) throws ApiException { @@ -3632,8 +3774,8 @@ private okhttp3.Call setDualModeValidateBeforeCall(String settle, Boolean dualMo } /** - * Enable or disable dual mode - * Before setting dual mode, make sure all positions are closed and no orders are open + * Set position mode + * The prerequisite for changing mode is that all positions have no holdings and no pending orders * @param settle Settle currency (required) * @param dualMode Whether to enable dual mode (required) * @return FuturesAccount @@ -3641,7 +3783,7 @@ private okhttp3.Call setDualModeValidateBeforeCall(String settle, Boolean dualMo * @http.response.details - +
Status Code Description Response Headers
200 Updated -
200 Updated successfully -
*/ public FuturesAccount setDualMode(String settle, Boolean dualMode) throws ApiException { @@ -3650,8 +3792,8 @@ public FuturesAccount setDualMode(String settle, Boolean dualMode) throws ApiExc } /** - * Enable or disable dual mode - * Before setting dual mode, make sure all positions are closed and no orders are open + * Set position mode + * The prerequisite for changing mode is that all positions have no holdings and no pending orders * @param settle Settle currency (required) * @param dualMode Whether to enable dual mode (required) * @return ApiResponse<FuturesAccount> @@ -3659,7 +3801,7 @@ public FuturesAccount setDualMode(String settle, Boolean dualMode) throws ApiExc * @http.response.details - +
Status Code Description Response Headers
200 Updated -
200 Updated successfully -
*/ public ApiResponse setDualModeWithHttpInfo(String settle, Boolean dualMode) throws ApiException { @@ -3669,8 +3811,8 @@ public ApiResponse setDualModeWithHttpInfo(String settle, Boolea } /** - * Enable or disable dual mode (asynchronously) - * Before setting dual mode, make sure all positions are closed and no orders are open + * Set position mode (asynchronously) + * The prerequisite for changing mode is that all positions have no holdings and no pending orders * @param settle Settle currency (required) * @param dualMode Whether to enable dual mode (required) * @param _callback The callback to be executed when the API call finishes @@ -3679,7 +3821,7 @@ public ApiResponse setDualModeWithHttpInfo(String settle, Boolea * @http.response.details - +
Status Code Description Response Headers
200 Updated -
200 Updated successfully -
*/ public okhttp3.Call setDualModeAsync(String settle, Boolean dualMode, final ApiCallback _callback) throws ApiException { @@ -3767,7 +3909,7 @@ private APIgetDualModePositionRequest(String settle, String contract) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -3781,7 +3923,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -3796,7 +3938,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -3811,7 +3953,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -3820,7 +3962,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) th } /** - * Retrieve position detail in dual mode + * Get position information in dual mode * * @param settle Settle currency (required) * @param contract Futures contract (required) @@ -3828,7 +3970,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) th * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIgetDualModePositionRequest getDualModePosition(String settle, String contract) { @@ -3839,7 +3981,7 @@ public APIgetDualModePositionRequest getDualModePosition(String settle, String c * Build call for updateDualModePositionMargin * @param settle Settle currency (required) * @param contract Futures contract (required) - * @param change Margin change. Use positive number to increase margin, negative number otherwise. (required) + * @param change Margin change amount, positive number increases, negative number decreases (required) * @param dualSide Long or short position (required) * @param _callback Callback for upload/download progress * @return Call to execute @@ -3847,7 +3989,7 @@ public APIgetDualModePositionRequest getDualModePosition(String settle, String c * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call updateDualModePositionMarginCall(String settle, String contract, String change, String dualSide, final ApiCallback _callback) throws ApiException { @@ -3920,14 +4062,14 @@ private okhttp3.Call updateDualModePositionMarginValidateBeforeCall(String settl * * @param settle Settle currency (required) * @param contract Futures contract (required) - * @param change Margin change. Use positive number to increase margin, negative number otherwise. (required) + * @param change Margin change amount, positive number increases, negative number decreases (required) * @param dualSide Long or short position (required) * @return List<Position> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List updateDualModePositionMargin(String settle, String contract, String change, String dualSide) throws ApiException { @@ -3940,14 +4082,14 @@ public List updateDualModePositionMargin(String settle, String contrac * * @param settle Settle currency (required) * @param contract Futures contract (required) - * @param change Margin change. Use positive number to increase margin, negative number otherwise. (required) + * @param change Margin change amount, positive number increases, negative number decreases (required) * @param dualSide Long or short position (required) * @return ApiResponse<List<Position>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> updateDualModePositionMarginWithHttpInfo(String settle, String contract, String change, String dualSide) throws ApiException { @@ -3961,7 +4103,7 @@ public ApiResponse> updateDualModePositionMarginWithHttpInfo(Stri * * @param settle Settle currency (required) * @param contract Futures contract (required) - * @param change Margin change. Use positive number to increase margin, negative number otherwise. (required) + * @param change Margin change amount, positive number increases, negative number decreases (required) * @param dualSide Long or short position (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -3969,7 +4111,7 @@ public ApiResponse> updateDualModePositionMarginWithHttpInfo(Stri * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call updateDualModePositionMarginAsync(String settle, String contract, String change, String dualSide, final ApiCallback> _callback) throws ApiException { @@ -3984,14 +4126,14 @@ public okhttp3.Call updateDualModePositionMarginAsync(String settle, String cont * @param settle Settle currency (required) * @param contract Futures contract (required) * @param leverage New position leverage (required) - * @param crossLeverageLimit Cross margin leverage(valid only when `leverage` is 0) (optional) + * @param crossLeverageLimit Cross margin leverage (valid only when `leverage` is 0) (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call updateDualModePositionLeverageCall(String settle, String contract, String leverage, String crossLeverageLimit, final ApiCallback _callback) throws ApiException { @@ -4060,13 +4202,13 @@ private okhttp3.Call updateDualModePositionLeverageValidateBeforeCall(String set * @param settle Settle currency (required) * @param contract Futures contract (required) * @param leverage New position leverage (required) - * @param crossLeverageLimit Cross margin leverage(valid only when `leverage` is 0) (optional) + * @param crossLeverageLimit Cross margin leverage (valid only when `leverage` is 0) (optional) * @return List<Position> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List updateDualModePositionLeverage(String settle, String contract, String leverage, String crossLeverageLimit) throws ApiException { @@ -4080,13 +4222,13 @@ public List updateDualModePositionLeverage(String settle, String contr * @param settle Settle currency (required) * @param contract Futures contract (required) * @param leverage New position leverage (required) - * @param crossLeverageLimit Cross margin leverage(valid only when `leverage` is 0) (optional) + * @param crossLeverageLimit Cross margin leverage (valid only when `leverage` is 0) (optional) * @return ApiResponse<List<Position>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> updateDualModePositionLeverageWithHttpInfo(String settle, String contract, String leverage, String crossLeverageLimit) throws ApiException { @@ -4101,14 +4243,14 @@ public ApiResponse> updateDualModePositionLeverageWithHttpInfo(St * @param settle Settle currency (required) * @param contract Futures contract (required) * @param leverage New position leverage (required) - * @param crossLeverageLimit Cross margin leverage(valid only when `leverage` is 0) (optional) + * @param crossLeverageLimit Cross margin leverage (valid only when `leverage` is 0) (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call updateDualModePositionLeverageAsync(String settle, String contract, String leverage, String crossLeverageLimit, final ApiCallback> _callback) throws ApiException { @@ -4122,14 +4264,14 @@ public okhttp3.Call updateDualModePositionLeverageAsync(String settle, String co * Build call for updateDualModePositionRiskLimit * @param settle Settle currency (required) * @param contract Futures contract (required) - * @param riskLimit New Risk Limit Value (required) + * @param riskLimit New risk limit value (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call updateDualModePositionRiskLimitCall(String settle, String contract, String riskLimit, final ApiCallback _callback) throws ApiException { @@ -4193,13 +4335,13 @@ private okhttp3.Call updateDualModePositionRiskLimitValidateBeforeCall(String se * * @param settle Settle currency (required) * @param contract Futures contract (required) - * @param riskLimit New Risk Limit Value (required) + * @param riskLimit New risk limit value (required) * @return List<Position> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List updateDualModePositionRiskLimit(String settle, String contract, String riskLimit) throws ApiException { @@ -4212,13 +4354,13 @@ public List updateDualModePositionRiskLimit(String settle, String cont * * @param settle Settle currency (required) * @param contract Futures contract (required) - * @param riskLimit New Risk Limit Value (required) + * @param riskLimit New risk limit value (required) * @return ApiResponse<List<Position>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> updateDualModePositionRiskLimitWithHttpInfo(String settle, String contract, String riskLimit) throws ApiException { @@ -4232,14 +4374,14 @@ public ApiResponse> updateDualModePositionRiskLimitWithHttpInfo(S * * @param settle Settle currency (required) * @param contract Futures contract (required) - * @param riskLimit New Risk Limit Value (required) + * @param riskLimit New risk limit value (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call updateDualModePositionRiskLimitAsync(String settle, String contract, String riskLimit, final ApiCallback> _callback) throws ApiException { @@ -4354,7 +4496,7 @@ public APIlistFuturesOrdersRequest contract(String contract) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistFuturesOrdersRequest */ public APIlistFuturesOrdersRequest limit(Integer limit) { @@ -4374,7 +4516,7 @@ public APIlistFuturesOrdersRequest offset(Integer offset) { /** * Set lastId - * @param lastId Specify list staring point using the `id` of last record in previous list-query results (optional) + * @param lastId 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 APIlistFuturesOrdersRequest */ public APIlistFuturesOrdersRequest lastId(String lastId) { @@ -4390,7 +4532,7 @@ public APIlistFuturesOrdersRequest lastId(String lastId) { * @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
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -4404,7 +4546,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @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
*/ public List execute() throws ApiException { @@ -4419,7 +4561,7 @@ public List execute() throws ApiException { * @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
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -4434,7 +4576,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException * @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
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -4443,15 +4585,15 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * 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`. * @param settle Settle currency (required) - * @param status Only list the orders with this status (required) + * @param status Query order list based on status (required) * @return APIlistFuturesOrdersRequest * @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
*/ public APIlistFuturesOrdersRequest listFuturesOrders(String settle, String status) { @@ -4523,8 +4665,8 @@ private okhttp3.Call createFuturesOrderValidateBeforeCall(String settle, Futures } /** - * Create a 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 position: reduce_only=false, size is a positive 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` + * 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` * @param settle Settle currency (required) * @param futuresOrder (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) @@ -4542,8 +4684,8 @@ public FuturesOrder createFuturesOrder(String settle, FuturesOrder futuresOrder, } /** - * Create a 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 position: reduce_only=false, size is a positive 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` + * 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` * @param settle Settle currency (required) * @param futuresOrder (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) @@ -4562,8 +4704,8 @@ public ApiResponse createFuturesOrderWithHttpInfo(String settle, F } /** - * Create a futures order (asynchronously) - * - 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 position: reduce_only=false, size is a positive 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` + * Place futures order (asynchronously) + * - 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` * @param settle Settle currency (required) * @param futuresOrder (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) @@ -4588,17 +4730,19 @@ public okhttp3.Call createFuturesOrderAsync(String settle, FuturesOrder futuresO * @param settle Settle currency (required) * @param contract Futures contract (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) - * @param side Specify all buy orders or all sell orders, if not specify them, both are included. Revoke all buy orders and revoke all sell orders and make ask (optional) + * @param 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 (optional) + * @param excludeReduceOnly Whether to exclude reduce-only orders (optional, default to false) + * @param text Remark for order cancellation (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
Status Code Description Response Headers
200 All orders matched cancelled -
200 Batch cancellation successful -
*/ - public okhttp3.Call cancelFuturesOrdersCall(String settle, String contract, String xGateExptime, String side, final ApiCallback _callback) throws ApiException { + public okhttp3.Call cancelFuturesOrdersCall(String settle, String contract, String xGateExptime, String side, Boolean excludeReduceOnly, String text, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables @@ -4615,6 +4759,14 @@ public okhttp3.Call cancelFuturesOrdersCall(String settle, String contract, Stri localVarQueryParams.addAll(localVarApiClient.parameterToPair("side", side)); } + if (excludeReduceOnly != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("exclude_reduce_only", excludeReduceOnly)); + } + + if (text != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("text", text)); + } + Map localVarHeaderParams = new HashMap(); if (xGateExptime != null) { localVarHeaderParams.put("x-gate-exptime", localVarApiClient.parameterToString(xGateExptime)); @@ -4641,7 +4793,7 @@ public okhttp3.Call cancelFuturesOrdersCall(String settle, String contract, Stri } @SuppressWarnings("rawtypes") - private okhttp3.Call cancelFuturesOrdersValidateBeforeCall(String settle, String contract, String xGateExptime, String side, final ApiCallback _callback) throws ApiException { + private okhttp3.Call cancelFuturesOrdersValidateBeforeCall(String settle, String contract, String xGateExptime, String side, Boolean excludeReduceOnly, String text, final ApiCallback _callback) throws ApiException { // verify the required parameter 'settle' is set if (settle == null) { throw new ApiException("Missing the required parameter 'settle' when calling cancelFuturesOrders(Async)"); @@ -4652,69 +4804,75 @@ private okhttp3.Call cancelFuturesOrdersValidateBeforeCall(String settle, String throw new ApiException("Missing the required parameter 'contract' when calling cancelFuturesOrders(Async)"); } - okhttp3.Call localVarCall = cancelFuturesOrdersCall(settle, contract, xGateExptime, side, _callback); + okhttp3.Call localVarCall = cancelFuturesOrdersCall(settle, contract, xGateExptime, side, excludeReduceOnly, text, _callback); return localVarCall; } /** - * Cancel all `open` orders matched - * Zero-filled order cannot be retrieved 10 minutes after order cancellation + * Cancel all orders with 'open' status + * Zero-fill orders cannot be retrieved 10 minutes after order cancellation * @param settle Settle currency (required) * @param contract Futures contract (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) - * @param side Specify all buy orders or all sell orders, if not specify them, both are included. Revoke all buy orders and revoke all sell orders and make ask (optional) + * @param 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 (optional) + * @param excludeReduceOnly Whether to exclude reduce-only orders (optional, default to false) + * @param text Remark for order cancellation (optional) * @return List<FuturesOrder> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 All orders matched cancelled -
200 Batch cancellation successful -
*/ - public List cancelFuturesOrders(String settle, String contract, String xGateExptime, String side) throws ApiException { - ApiResponse> localVarResp = cancelFuturesOrdersWithHttpInfo(settle, contract, xGateExptime, side); + public List cancelFuturesOrders(String settle, String contract, String xGateExptime, String side, Boolean excludeReduceOnly, String text) throws ApiException { + ApiResponse> localVarResp = cancelFuturesOrdersWithHttpInfo(settle, contract, xGateExptime, side, excludeReduceOnly, text); return localVarResp.getData(); } /** - * Cancel all `open` orders matched - * Zero-filled order cannot be retrieved 10 minutes after order cancellation + * Cancel all orders with 'open' status + * Zero-fill orders cannot be retrieved 10 minutes after order cancellation * @param settle Settle currency (required) * @param contract Futures contract (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) - * @param side Specify all buy orders or all sell orders, if not specify them, both are included. Revoke all buy orders and revoke all sell orders and make ask (optional) + * @param 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 (optional) + * @param excludeReduceOnly Whether to exclude reduce-only orders (optional, default to false) + * @param text Remark for order cancellation (optional) * @return ApiResponse<List<FuturesOrder>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 All orders matched cancelled -
200 Batch cancellation successful -
*/ - public ApiResponse> cancelFuturesOrdersWithHttpInfo(String settle, String contract, String xGateExptime, String side) throws ApiException { - okhttp3.Call localVarCall = cancelFuturesOrdersValidateBeforeCall(settle, contract, xGateExptime, side, null); + public ApiResponse> cancelFuturesOrdersWithHttpInfo(String settle, String contract, String xGateExptime, String side, Boolean excludeReduceOnly, String text) throws ApiException { + okhttp3.Call localVarCall = cancelFuturesOrdersValidateBeforeCall(settle, contract, xGateExptime, side, excludeReduceOnly, text, null); Type localVarReturnType = new TypeToken>(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * Cancel all `open` orders matched (asynchronously) - * Zero-filled order cannot be retrieved 10 minutes after order cancellation + * Cancel all orders with 'open' status (asynchronously) + * Zero-fill orders cannot be retrieved 10 minutes after order cancellation * @param settle Settle currency (required) * @param contract Futures contract (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) - * @param side Specify all buy orders or all sell orders, if not specify them, both are included. Revoke all buy orders and revoke all sell orders and make ask (optional) + * @param 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 (optional) + * @param excludeReduceOnly Whether to exclude reduce-only orders (optional, default to false) + * @param text Remark for order cancellation (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 All orders matched cancelled -
200 Batch cancellation successful -
*/ - public okhttp3.Call cancelFuturesOrdersAsync(String settle, String contract, String xGateExptime, String side, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = cancelFuturesOrdersValidateBeforeCall(settle, contract, xGateExptime, side, _callback); + public okhttp3.Call cancelFuturesOrdersAsync(String settle, String contract, String xGateExptime, String side, Boolean excludeReduceOnly, String text, final ApiCallback> _callback) throws ApiException { + okhttp3.Call localVarCall = cancelFuturesOrdersValidateBeforeCall(settle, contract, xGateExptime, side, excludeReduceOnly, text, _callback); Type localVarReturnType = new TypeToken>(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -4819,7 +4977,7 @@ public APIgetOrdersWithTimeRangeRequest contract(String contract) { /** * Set from - * @param from Start timestamp (optional) + * @param 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) (optional) * @return APIgetOrdersWithTimeRangeRequest */ public APIgetOrdersWithTimeRangeRequest from(Long from) { @@ -4829,7 +4987,7 @@ public APIgetOrdersWithTimeRangeRequest from(Long from) { /** * Set to - * @param to End timestamp (optional) + * @param to Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional) * @return APIgetOrdersWithTimeRangeRequest */ public APIgetOrdersWithTimeRangeRequest to(Long to) { @@ -4839,7 +4997,7 @@ public APIgetOrdersWithTimeRangeRequest to(Long to) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIgetOrdersWithTimeRangeRequest */ public APIgetOrdersWithTimeRangeRequest limit(Integer limit) { @@ -4865,7 +5023,7 @@ public APIgetOrdersWithTimeRangeRequest offset(Integer offset) { * @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
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -4879,7 +5037,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @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
*/ public List execute() throws ApiException { @@ -4894,7 +5052,7 @@ public List execute() throws ApiException { * @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
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -4909,7 +5067,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException * @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
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -4918,14 +5076,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * List Futures Orders By Time Range + * Query futures order list by time range * * @param settle Settle currency (required) * @return APIgetOrdersWithTimeRangeRequest * @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
*/ public APIgetOrdersWithTimeRangeRequest getOrdersWithTimeRange(String settle) { @@ -4943,7 +5101,7 @@ public APIgetOrdersWithTimeRangeRequest getOrdersWithTimeRange(String settle) { * @http.response.details - +
Status Code Description Response Headers
200 Request is completed -
200 Request execution completed -
*/ public okhttp3.Call createBatchFuturesOrderCall(String settle, List futuresOrder, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -4997,7 +5155,7 @@ private okhttp3.Call createBatchFuturesOrderValidateBeforeCall(String settle, Li } /** - * 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 * @param settle Settle currency (required) * @param futuresOrder (required) @@ -5007,7 +5165,7 @@ private okhttp3.Call createBatchFuturesOrderValidateBeforeCall(String settle, Li * @http.response.details - +
Status Code Description Response Headers
200 Request is completed -
200 Request execution completed -
*/ public List createBatchFuturesOrder(String settle, List futuresOrder, String xGateExptime) throws ApiException { @@ -5016,7 +5174,7 @@ public List createBatchFuturesOrder(String settle, List createBatchFuturesOrder(String settle, List Status Code Description Response Headers - 200 Request is completed - + 200 Request execution completed - */ public ApiResponse> createBatchFuturesOrderWithHttpInfo(String settle, List futuresOrder, String xGateExptime) throws ApiException { @@ -5036,7 +5194,7 @@ public ApiResponse> createBatchFuturesOrderWithHttpInfo( } /** - * Create a batch of futures orders (asynchronously) + * Place batch futures orders (asynchronously) * - 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 * @param settle Settle currency (required) * @param futuresOrder (required) @@ -5047,7 +5205,7 @@ public ApiResponse> createBatchFuturesOrderWithHttpInfo( * @http.response.details - +
Status Code Description Response Headers
200 Request is completed -
200 Request execution completed -
*/ public okhttp3.Call createBatchFuturesOrderAsync(String settle, List futuresOrder, String xGateExptime, final ApiCallback> _callback) throws ApiException { @@ -5060,7 +5218,7 @@ public okhttp3.Call createBatchFuturesOrderAsync(String settle, List getFuturesOrderWithHttpInfo(String settle, Stri } /** - * Get a single order (asynchronously) + * Query single order details (asynchronously) * - Zero-fill order cannot be retrieved for 10 minutes after cancellation - Historical orders, by default, only data within the past 6 months is supported. * @param settle Settle currency (required) - * @param orderId Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. (required) + * @param orderId 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 _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -5178,7 +5336,7 @@ public okhttp3.Call getFuturesOrderAsync(String settle, String orderId, final Ap /** * Build call for amendFuturesOrder * @param settle Settle currency (required) - * @param orderId Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. (required) + * @param orderId 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 (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @param _callback Callback for upload/download progress @@ -5247,10 +5405,10 @@ private okhttp3.Call amendFuturesOrderValidateBeforeCall(String settle, String o } /** - * Amend an order + * Amend single order * * @param settle Settle currency (required) - * @param orderId Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. (required) + * @param orderId 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 (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @return FuturesOrder @@ -5267,10 +5425,10 @@ public FuturesOrder amendFuturesOrder(String settle, String orderId, FuturesOrde } /** - * Amend an order + * Amend single order * * @param settle Settle currency (required) - * @param orderId Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. (required) + * @param orderId 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 (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @return ApiResponse<FuturesOrder> @@ -5288,10 +5446,10 @@ public ApiResponse amendFuturesOrderWithHttpInfo(String settle, St } /** - * Amend an order (asynchronously) + * Amend single order (asynchronously) * * @param settle Settle currency (required) - * @param orderId Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. (required) + * @param orderId 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 (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @param _callback The callback to be executed when the API call finishes @@ -5313,7 +5471,7 @@ public okhttp3.Call amendFuturesOrderAsync(String settle, String orderId, Future /** * Build call for cancelFuturesOrder * @param settle Settle currency (required) - * @param orderId Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. (required) + * @param orderId 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 xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @param _callback Callback for upload/download progress * @return Call to execute @@ -5376,10 +5534,10 @@ private okhttp3.Call cancelFuturesOrderValidateBeforeCall(String settle, String } /** - * Cancel a single order + * Cancel single order * * @param settle Settle currency (required) - * @param orderId Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. (required) + * @param orderId 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 xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @return FuturesOrder * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -5395,10 +5553,10 @@ public FuturesOrder cancelFuturesOrder(String settle, String orderId, String xGa } /** - * Cancel a single order + * Cancel single order * * @param settle Settle currency (required) - * @param orderId Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. (required) + * @param orderId 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 xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @return ApiResponse<FuturesOrder> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -5415,10 +5573,10 @@ public ApiResponse cancelFuturesOrderWithHttpInfo(String settle, S } /** - * Cancel a single order (asynchronously) + * Cancel single order (asynchronously) * * @param settle Settle currency (required) - * @param orderId Order ID returned, or user custom ID(i.e., `text` field). Operations based on custom ID can only be checked when the order is in orderbook. When the order is finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. (required) + * @param orderId 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 xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -5545,7 +5703,7 @@ public APIgetMyTradesRequest order(Long order) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIgetMyTradesRequest */ public APIgetMyTradesRequest limit(Integer limit) { @@ -5581,7 +5739,7 @@ public APIgetMyTradesRequest lastId(String lastId) { * @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
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -5595,7 +5753,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @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
*/ public List execute() throws ApiException { @@ -5610,7 +5768,7 @@ public List execute() throws ApiException { * @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
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -5625,7 +5783,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcepti * @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
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -5634,14 +5792,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callba } /** - * 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`. * @param settle Settle currency (required) * @return APIgetMyTradesRequest * @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
*/ public APIgetMyTradesRequest getMyTrades(String settle) { @@ -5752,7 +5910,7 @@ public APIgetMyTradesWithTimeRangeRequest contract(String contract) { /** * Set from - * @param from Start timestamp (optional) + * @param 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) (optional) * @return APIgetMyTradesWithTimeRangeRequest */ public APIgetMyTradesWithTimeRangeRequest from(Long from) { @@ -5762,7 +5920,7 @@ public APIgetMyTradesWithTimeRangeRequest from(Long from) { /** * Set to - * @param to End timestamp (optional) + * @param to Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional) * @return APIgetMyTradesWithTimeRangeRequest */ public APIgetMyTradesWithTimeRangeRequest to(Long to) { @@ -5772,7 +5930,7 @@ public APIgetMyTradesWithTimeRangeRequest to(Long to) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIgetMyTradesWithTimeRangeRequest */ public APIgetMyTradesWithTimeRangeRequest limit(Integer limit) { @@ -5792,7 +5950,7 @@ public APIgetMyTradesWithTimeRangeRequest offset(Integer offset) { /** * Set role - * @param role Query role, maker or taker. (optional) + * @param role Query role, maker or taker (optional) * @return APIgetMyTradesWithTimeRangeRequest */ public APIgetMyTradesWithTimeRangeRequest role(String role) { @@ -5808,7 +5966,7 @@ public APIgetMyTradesWithTimeRangeRequest role(String role) { * @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
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -5822,7 +5980,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @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
*/ public List execute() throws ApiException { @@ -5837,7 +5995,7 @@ public List execute() throws ApiException { * @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
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -5852,7 +6010,7 @@ public ApiResponse> executeWithHttpInfo() throws A * @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
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -5861,14 +6019,14 @@ public okhttp3.Call executeAsync(final ApiCallback } /** - * List personal trading history by time range + * Query personal trading records by time range * * @param settle Settle currency (required) * @return APIgetMyTradesWithTimeRangeRequest * @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
*/ public APIgetMyTradesWithTimeRangeRequest getMyTradesWithTimeRange(String settle) { @@ -5984,7 +6142,7 @@ public APIlistPositionCloseRequest contract(String contract) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistPositionCloseRequest */ public APIlistPositionCloseRequest limit(Integer limit) { @@ -6004,7 +6162,7 @@ public APIlistPositionCloseRequest offset(Integer offset) { /** * Set from - * @param from Start timestamp (optional) + * @param 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) (optional) * @return APIlistPositionCloseRequest */ public APIlistPositionCloseRequest from(Long from) { @@ -6014,7 +6172,7 @@ public APIlistPositionCloseRequest from(Long from) { /** * Set to - * @param to End timestamp (optional) + * @param to Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional) * @return APIlistPositionCloseRequest */ public APIlistPositionCloseRequest to(Long to) { @@ -6024,7 +6182,7 @@ public APIlistPositionCloseRequest to(Long to) { /** * Set side - * @param side Query side. long or shot (optional) + * @param side Query side. long or shot (optional) * @return APIlistPositionCloseRequest */ public APIlistPositionCloseRequest side(String side) { @@ -6050,7 +6208,7 @@ public APIlistPositionCloseRequest pnl(String pnl) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -6064,7 +6222,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -6079,7 +6237,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -6094,7 +6252,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExceptio * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -6103,21 +6261,21 @@ public okhttp3.Call executeAsync(final ApiCallback> _callbac } /** - * List position close history + * Query position close history * * @param settle Settle currency (required) * @return APIlistPositionCloseRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistPositionCloseRequest listPositionClose(String settle) { return new APIlistPositionCloseRequest(settle); } - private okhttp3.Call listLiquidatesCall(String settle, String contract, Integer limit, Integer at, final ApiCallback _callback) throws ApiException { + private okhttp3.Call listLiquidatesCall(String settle, String contract, Integer limit, Integer offset, Long from, Long to, Integer at, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables @@ -6134,6 +6292,18 @@ private okhttp3.Call listLiquidatesCall(String settle, String contract, Integer localVarQueryParams.addAll(localVarApiClient.parameterToPair("limit", limit)); } + if (offset != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("offset", offset)); + } + + if (from != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("from", from)); + } + + if (to != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("to", to)); + } + if (at != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("at", at)); } @@ -6160,25 +6330,25 @@ private okhttp3.Call listLiquidatesCall(String settle, String contract, Integer } @SuppressWarnings("rawtypes") - private okhttp3.Call listLiquidatesValidateBeforeCall(String settle, String contract, Integer limit, Integer at, final ApiCallback _callback) throws ApiException { + private okhttp3.Call listLiquidatesValidateBeforeCall(String settle, String contract, Integer limit, Integer offset, Long from, Long to, Integer at, final ApiCallback _callback) throws ApiException { // verify the required parameter 'settle' is set if (settle == null) { throw new ApiException("Missing the required parameter 'settle' when calling listLiquidates(Async)"); } - okhttp3.Call localVarCall = listLiquidatesCall(settle, contract, limit, at, _callback); + okhttp3.Call localVarCall = listLiquidatesCall(settle, contract, limit, offset, from, to, at, _callback); return localVarCall; } - private ApiResponse> listLiquidatesWithHttpInfo(String settle, String contract, Integer limit, Integer at) throws ApiException { - okhttp3.Call localVarCall = listLiquidatesValidateBeforeCall(settle, contract, limit, at, null); + private ApiResponse> listLiquidatesWithHttpInfo(String settle, String contract, Integer limit, Integer offset, Long from, Long to, Integer at) throws ApiException { + okhttp3.Call localVarCall = listLiquidatesValidateBeforeCall(settle, contract, limit, offset, from, to, at, null); Type localVarReturnType = new TypeToken>(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } - private okhttp3.Call listLiquidatesAsync(String settle, String contract, Integer limit, Integer at, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = listLiquidatesValidateBeforeCall(settle, contract, limit, at, _callback); + private okhttp3.Call listLiquidatesAsync(String settle, String contract, Integer limit, Integer offset, Long from, Long to, Integer at, final ApiCallback> _callback) throws ApiException { + okhttp3.Call localVarCall = listLiquidatesValidateBeforeCall(settle, contract, limit, offset, from, to, at, _callback); Type localVarReturnType = new TypeToken>(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -6188,6 +6358,9 @@ public class APIlistLiquidatesRequest { private final String settle; private String contract; private Integer limit; + private Integer offset; + private Long from; + private Long to; private Integer at; private APIlistLiquidatesRequest(String settle) { @@ -6206,7 +6379,7 @@ public APIlistLiquidatesRequest contract(String contract) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistLiquidatesRequest */ public APIlistLiquidatesRequest limit(Integer limit) { @@ -6214,9 +6387,39 @@ public APIlistLiquidatesRequest limit(Integer limit) { return this; } + /** + * Set offset + * @param offset List offset, starting from 0 (optional, default to 0) + * @return APIlistLiquidatesRequest + */ + public APIlistLiquidatesRequest offset(Integer offset) { + this.offset = offset; + return this; + } + + /** + * Set from + * @param 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) (optional) + * @return APIlistLiquidatesRequest + */ + public APIlistLiquidatesRequest from(Long from) { + this.from = from; + return this; + } + + /** + * Set to + * @param to Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional) + * @return APIlistLiquidatesRequest + */ + public APIlistLiquidatesRequest to(Long to) { + this.to = to; + return this; + } + /** * Set at - * @param at Specify a liquidation timestamp (optional, default to 0) + * @param at Specify liquidation timestamp (optional, default to 0) * @return APIlistLiquidatesRequest */ public APIlistLiquidatesRequest at(Integer at) { @@ -6232,11 +6435,11 @@ public APIlistLiquidatesRequest at(Integer at) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { - return listLiquidatesCall(settle, contract, limit, at, _callback); + return listLiquidatesCall(settle, contract, limit, offset, from, to, at, _callback); } /** @@ -6246,11 +6449,11 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { - ApiResponse> localVarResp = listLiquidatesWithHttpInfo(settle, contract, limit, at); + ApiResponse> localVarResp = listLiquidatesWithHttpInfo(settle, contract, limit, offset, from, to, at); return localVarResp.getData(); } @@ -6261,11 +6464,11 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { - return listLiquidatesWithHttpInfo(settle, contract, limit, at); + return listLiquidatesWithHttpInfo(settle, contract, limit, offset, from, to, at); } /** @@ -6276,30 +6479,30 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcep * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { - return listLiquidatesAsync(settle, contract, limit, at, _callback); + return listLiquidatesAsync(settle, contract, limit, offset, from, to, at, _callback); } } /** - * List liquidation history + * Query liquidation history * * @param settle Settle currency (required) * @return APIlistLiquidatesRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistLiquidatesRequest listLiquidates(String settle) { return new APIlistLiquidatesRequest(settle); } - private okhttp3.Call listAutoDeleveragesCall(String settle, String contract, Integer limit, Integer at, final ApiCallback _callback) throws ApiException { + private okhttp3.Call listAutoDeleveragesCall(String settle, String contract, Integer limit, Integer offset, Long from, Long to, Integer at, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables @@ -6316,6 +6519,18 @@ private okhttp3.Call listAutoDeleveragesCall(String settle, String contract, Int localVarQueryParams.addAll(localVarApiClient.parameterToPair("limit", limit)); } + if (offset != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("offset", offset)); + } + + if (from != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("from", from)); + } + + if (to != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("to", to)); + } + if (at != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("at", at)); } @@ -6342,25 +6557,25 @@ private okhttp3.Call listAutoDeleveragesCall(String settle, String contract, Int } @SuppressWarnings("rawtypes") - private okhttp3.Call listAutoDeleveragesValidateBeforeCall(String settle, String contract, Integer limit, Integer at, final ApiCallback _callback) throws ApiException { + private okhttp3.Call listAutoDeleveragesValidateBeforeCall(String settle, String contract, Integer limit, Integer offset, Long from, Long to, Integer at, final ApiCallback _callback) throws ApiException { // verify the required parameter 'settle' is set if (settle == null) { throw new ApiException("Missing the required parameter 'settle' when calling listAutoDeleverages(Async)"); } - okhttp3.Call localVarCall = listAutoDeleveragesCall(settle, contract, limit, at, _callback); + okhttp3.Call localVarCall = listAutoDeleveragesCall(settle, contract, limit, offset, from, to, at, _callback); return localVarCall; } - private ApiResponse> listAutoDeleveragesWithHttpInfo(String settle, String contract, Integer limit, Integer at) throws ApiException { - okhttp3.Call localVarCall = listAutoDeleveragesValidateBeforeCall(settle, contract, limit, at, null); + private ApiResponse> listAutoDeleveragesWithHttpInfo(String settle, String contract, Integer limit, Integer offset, Long from, Long to, Integer at) throws ApiException { + okhttp3.Call localVarCall = listAutoDeleveragesValidateBeforeCall(settle, contract, limit, offset, from, to, at, null); Type localVarReturnType = new TypeToken>(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } - private okhttp3.Call listAutoDeleveragesAsync(String settle, String contract, Integer limit, Integer at, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = listAutoDeleveragesValidateBeforeCall(settle, contract, limit, at, _callback); + private okhttp3.Call listAutoDeleveragesAsync(String settle, String contract, Integer limit, Integer offset, Long from, Long to, Integer at, final ApiCallback> _callback) throws ApiException { + okhttp3.Call localVarCall = listAutoDeleveragesValidateBeforeCall(settle, contract, limit, offset, from, to, at, _callback); Type localVarReturnType = new TypeToken>(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -6370,6 +6585,9 @@ public class APIlistAutoDeleveragesRequest { private final String settle; private String contract; private Integer limit; + private Integer offset; + private Long from; + private Long to; private Integer at; private APIlistAutoDeleveragesRequest(String settle) { @@ -6388,7 +6606,7 @@ public APIlistAutoDeleveragesRequest contract(String contract) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistAutoDeleveragesRequest */ public APIlistAutoDeleveragesRequest limit(Integer limit) { @@ -6396,9 +6614,39 @@ public APIlistAutoDeleveragesRequest limit(Integer limit) { return this; } + /** + * Set offset + * @param offset List offset, starting from 0 (optional, default to 0) + * @return APIlistAutoDeleveragesRequest + */ + public APIlistAutoDeleveragesRequest offset(Integer offset) { + this.offset = offset; + return this; + } + + /** + * Set from + * @param 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) (optional) + * @return APIlistAutoDeleveragesRequest + */ + public APIlistAutoDeleveragesRequest from(Long from) { + this.from = from; + return this; + } + + /** + * Set to + * @param to Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional) + * @return APIlistAutoDeleveragesRequest + */ + public APIlistAutoDeleveragesRequest to(Long to) { + this.to = to; + return this; + } + /** * Set at - * @param at Specify an auto-deleveraging timestamp (optional, default to 0) + * @param at Specify auto-deleveraging timestamp (optional, default to 0) * @return APIlistAutoDeleveragesRequest */ public APIlistAutoDeleveragesRequest at(Integer at) { @@ -6414,11 +6662,11 @@ public APIlistAutoDeleveragesRequest at(Integer at) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { - return listAutoDeleveragesCall(settle, contract, limit, at, _callback); + return listAutoDeleveragesCall(settle, contract, limit, offset, from, to, at, _callback); } /** @@ -6428,11 +6676,11 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { - ApiResponse> localVarResp = listAutoDeleveragesWithHttpInfo(settle, contract, limit, at); + ApiResponse> localVarResp = listAutoDeleveragesWithHttpInfo(settle, contract, limit, offset, from, to, at); return localVarResp.getData(); } @@ -6443,11 +6691,11 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { - return listAutoDeleveragesWithHttpInfo(settle, contract, limit, at); + return listAutoDeleveragesWithHttpInfo(settle, contract, limit, offset, from, to, at); } /** @@ -6458,23 +6706,23 @@ public ApiResponse> executeWithHttpInfo() throws Api * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { - return listAutoDeleveragesAsync(settle, contract, limit, at, _callback); + return listAutoDeleveragesAsync(settle, contract, limit, offset, from, to, at, _callback); } } /** - * List Auto-Deleveraging History + * Query ADL auto-deleveraging order information * * @param settle Settle currency (required) * @return APIlistAutoDeleveragesRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistAutoDeleveragesRequest listAutoDeleverages(String settle) { @@ -6491,7 +6739,7 @@ public APIlistAutoDeleveragesRequest listAutoDeleverages(String settle) { * @http.response.details - +
Status Code Description Response Headers
200 Set countdown successfully -
200 Countdown set successfully -
*/ public okhttp3.Call countdownCancelAllFuturesCall(String settle, CountdownCancelAllFuturesTask countdownCancelAllFuturesTask, final ApiCallback _callback) throws ApiException { @@ -6542,7 +6790,7 @@ private okhttp3.Call countdownCancelAllFuturesValidateBeforeCall(String settle, /** * Countdown cancel orders - * When the timeout set by the user is reached, if there is no cancel or set a new countdown, the related pending orders will be automatically cancelled. This endpoint can be called repeatedly to set a new countdown or cancel the countdown. For example, call this endpoint at 30s intervals, each countdown`timeout` is set to 30s. If this endpoint is not called again within 30 seconds, all pending orders on the specified `market` will be automatically cancelled, if no `market` is specified, all market pending orders will be cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the cacnel function will be cancelled. + * Heartbeat detection for contract orders: When the user-set `timeout` time is reached, if neither the existing countdown is canceled nor a new countdown is set, the relevant contract orders will be automatically canceled. This API can be called repeatedly to or cancel the countdown. Usage example: Repeatedly call this API at 30-second intervals, setting the `timeout` to 30 (seconds) each time. If this API is not called again within 30 seconds, all open orders on your specified `market` will be automatically canceled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will terminate, and the automatic order cancellation function will be disabled. * @param settle Settle currency (required) * @param countdownCancelAllFuturesTask (required) * @return TriggerTime @@ -6550,7 +6798,7 @@ private okhttp3.Call countdownCancelAllFuturesValidateBeforeCall(String settle, * @http.response.details - +
Status Code Description Response Headers
200 Set countdown successfully -
200 Countdown set successfully -
*/ public TriggerTime countdownCancelAllFutures(String settle, CountdownCancelAllFuturesTask countdownCancelAllFuturesTask) throws ApiException { @@ -6560,7 +6808,7 @@ public TriggerTime countdownCancelAllFutures(String settle, CountdownCancelAllFu /** * Countdown cancel orders - * When the timeout set by the user is reached, if there is no cancel or set a new countdown, the related pending orders will be automatically cancelled. This endpoint can be called repeatedly to set a new countdown or cancel the countdown. For example, call this endpoint at 30s intervals, each countdown`timeout` is set to 30s. If this endpoint is not called again within 30 seconds, all pending orders on the specified `market` will be automatically cancelled, if no `market` is specified, all market pending orders will be cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the cacnel function will be cancelled. + * Heartbeat detection for contract orders: When the user-set `timeout` time is reached, if neither the existing countdown is canceled nor a new countdown is set, the relevant contract orders will be automatically canceled. This API can be called repeatedly to or cancel the countdown. Usage example: Repeatedly call this API at 30-second intervals, setting the `timeout` to 30 (seconds) each time. If this API is not called again within 30 seconds, all open orders on your specified `market` will be automatically canceled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will terminate, and the automatic order cancellation function will be disabled. * @param settle Settle currency (required) * @param countdownCancelAllFuturesTask (required) * @return ApiResponse<TriggerTime> @@ -6568,7 +6816,7 @@ public TriggerTime countdownCancelAllFutures(String settle, CountdownCancelAllFu * @http.response.details - +
Status Code Description Response Headers
200 Set countdown successfully -
200 Countdown set successfully -
*/ public ApiResponse countdownCancelAllFuturesWithHttpInfo(String settle, CountdownCancelAllFuturesTask countdownCancelAllFuturesTask) throws ApiException { @@ -6579,7 +6827,7 @@ public ApiResponse countdownCancelAllFuturesWithHttpInfo(String set /** * Countdown cancel orders (asynchronously) - * When the timeout set by the user is reached, if there is no cancel or set a new countdown, the related pending orders will be automatically cancelled. This endpoint can be called repeatedly to set a new countdown or cancel the countdown. For example, call this endpoint at 30s intervals, each countdown`timeout` is set to 30s. If this endpoint is not called again within 30 seconds, all pending orders on the specified `market` will be automatically cancelled, if no `market` is specified, all market pending orders will be cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the cacnel function will be cancelled. + * Heartbeat detection for contract orders: When the user-set `timeout` time is reached, if neither the existing countdown is canceled nor a new countdown is set, the relevant contract orders will be automatically canceled. This API can be called repeatedly to or cancel the countdown. Usage example: Repeatedly call this API at 30-second intervals, setting the `timeout` to 30 (seconds) each time. If this API is not called again within 30 seconds, all open orders on your specified `market` will be automatically canceled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will terminate, and the automatic order cancellation function will be disabled. * @param settle Settle currency (required) * @param countdownCancelAllFuturesTask (required) * @param _callback The callback to be executed when the API call finishes @@ -6588,7 +6836,7 @@ public ApiResponse countdownCancelAllFuturesWithHttpInfo(String set * @http.response.details - +
Status Code Description Response Headers
200 Set countdown successfully -
200 Countdown set successfully -
*/ public okhttp3.Call countdownCancelAllFuturesAsync(String settle, CountdownCancelAllFuturesTask countdownCancelAllFuturesTask, final ApiCallback _callback) throws ApiException { @@ -6683,7 +6931,7 @@ public APIgetFuturesFeeRequest contract(String contract) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -6697,7 +6945,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public Map execute() throws ApiException { @@ -6712,7 +6960,7 @@ public Map execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -6727,7 +6975,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExce * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -6736,14 +6984,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _cal } /** - * Query user trading fee rates + * Query futures market trading fee rates * * @param settle Settle currency (required) * @return APIgetFuturesFeeRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIgetFuturesFeeRequest getFuturesFee(String settle) { @@ -6815,8 +7063,8 @@ private okhttp3.Call cancelBatchFutureOrdersValidateBeforeCall(String settle, Li } /** - * Cancel a batch of orders with an ID list - * Multiple distinct order ID list can be specified。Each request can cancel a maximum of 20 records. + * Cancel batch orders by specified ID list + * Multiple different order IDs can be specified, maximum 20 records per request * @param settle Settle currency (required) * @param requestBody (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) @@ -6834,8 +7082,8 @@ public List cancelBatchFutureOrders(String settle, List } /** - * Cancel a batch of orders with an ID list - * Multiple distinct order ID list can be specified。Each request can cancel a maximum of 20 records. + * Cancel batch orders by specified ID list + * Multiple different order IDs can be specified, maximum 20 records per request * @param settle Settle currency (required) * @param requestBody (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) @@ -6854,8 +7102,8 @@ public ApiResponse> cancelBatchFutureOrdersWithHtt } /** - * Cancel a batch of orders with an ID list (asynchronously) - * Multiple distinct order ID list can be specified。Each request can cancel a maximum of 20 records. + * Cancel batch orders by specified ID list (asynchronously) + * Multiple different order IDs can be specified, maximum 20 records per request * @param settle Settle currency (required) * @param requestBody (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) @@ -6886,7 +7134,7 @@ public okhttp3.Call cancelBatchFutureOrdersAsync(String settle, List req * @http.response.details - +
Status Code Description Response Headers
200 Request is completed -
200 Request execution completed -
*/ public okhttp3.Call amendBatchFutureOrdersCall(String settle, List batchAmendOrderReq, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -6940,8 +7188,8 @@ private okhttp3.Call amendBatchFutureOrdersValidateBeforeCall(String settle, Lis } /** - * Batch modify orders with specified IDs - * You can specify multiple different order IDs. You can only modify up to 10 orders in one request. + * Batch modify orders by specified IDs + * Multiple different order IDs can be specified, maximum 10 orders per request * @param settle Settle currency (required) * @param batchAmendOrderReq (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) @@ -6950,7 +7198,7 @@ private okhttp3.Call amendBatchFutureOrdersValidateBeforeCall(String settle, Lis * @http.response.details - +
Status Code Description Response Headers
200 Request is completed -
200 Request execution completed -
*/ public List amendBatchFutureOrders(String settle, List batchAmendOrderReq, String xGateExptime) throws ApiException { @@ -6959,8 +7207,8 @@ public List amendBatchFutureOrders(String settle, List amendBatchFutureOrders(String settle, List Status Code Description Response Headers - 200 Request is completed - + 200 Request execution completed - */ public ApiResponse> amendBatchFutureOrdersWithHttpInfo(String settle, List batchAmendOrderReq, String xGateExptime) throws ApiException { @@ -6979,8 +7227,8 @@ public ApiResponse> amendBatchFutureOrdersWithHttpInfo(S } /** - * Batch modify orders with specified IDs (asynchronously) - * You can specify multiple different order IDs. You can only modify up to 10 orders in one request. + * Batch modify orders by specified IDs (asynchronously) + * Multiple different order IDs can be specified, maximum 10 orders per request * @param settle Settle currency (required) * @param batchAmendOrderReq (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) @@ -6990,7 +7238,7 @@ public ApiResponse> amendBatchFutureOrdersWithHttpInfo(S * @http.response.details - +
Status Code Description Response Headers
200 Request is completed -
200 Request execution completed -
*/ public okhttp3.Call amendBatchFutureOrdersAsync(String settle, List batchAmendOrderReq, String xGateExptime, final ApiCallback> _callback) throws ApiException { @@ -7000,6 +7248,127 @@ public okhttp3.Call amendBatchFutureOrdersAsync(String settle, List + Status Code Description Response Headers + 200 Query successful - + + */ + public okhttp3.Call getFuturesRiskLimitTableCall(String settle, String tableId, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/futures/{settle}/risk_limit_table" + .replaceAll("\\{" + "settle" + "\\}", localVarApiClient.escapeString(settle)); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + if (tableId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("table_id", tableId)); + } + + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + String[] localVarAuthNames = new String[] { }; + return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call getFuturesRiskLimitTableValidateBeforeCall(String settle, String tableId, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'settle' is set + if (settle == null) { + throw new ApiException("Missing the required parameter 'settle' when calling getFuturesRiskLimitTable(Async)"); + } + + // verify the required parameter 'tableId' is set + if (tableId == null) { + throw new ApiException("Missing the required parameter 'tableId' when calling getFuturesRiskLimitTable(Async)"); + } + + okhttp3.Call localVarCall = getFuturesRiskLimitTableCall(settle, tableId, _callback); + return localVarCall; + } + + /** + * Query risk limit table by table_id + * Just pass table_id + * @param settle Settle currency (required) + * @param tableId Risk limit table ID (required) + * @return List<FuturesRiskLimitTier> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + +
Status Code Description Response Headers
200 Query successful -
+ */ + public List getFuturesRiskLimitTable(String settle, String tableId) throws ApiException { + ApiResponse> localVarResp = getFuturesRiskLimitTableWithHttpInfo(settle, tableId); + return localVarResp.getData(); + } + + /** + * Query risk limit table by table_id + * Just pass table_id + * @param settle Settle currency (required) + * @param tableId Risk limit table ID (required) + * @return ApiResponse<List<FuturesRiskLimitTier>> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + +
Status Code Description Response Headers
200 Query successful -
+ */ + public ApiResponse> getFuturesRiskLimitTableWithHttpInfo(String settle, String tableId) throws ApiException { + okhttp3.Call localVarCall = getFuturesRiskLimitTableValidateBeforeCall(settle, tableId, null); + Type localVarReturnType = new TypeToken>(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Query risk limit table by table_id (asynchronously) + * Just pass table_id + * @param settle Settle currency (required) + * @param tableId Risk limit table ID (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + +
Status Code Description Response Headers
200 Query successful -
+ */ + public okhttp3.Call getFuturesRiskLimitTableAsync(String settle, String tableId, final ApiCallback> _callback) throws ApiException { + okhttp3.Call localVarCall = getFuturesRiskLimitTableValidateBeforeCall(settle, tableId, _callback); + Type localVarReturnType = new TypeToken>(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + private okhttp3.Call listPriceTriggeredOrdersCall(String settle, String status, String contract, Integer limit, Integer offset, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; @@ -7100,7 +7469,7 @@ public APIlistPriceTriggeredOrdersRequest contract(String contract) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistPriceTriggeredOrdersRequest */ public APIlistPriceTriggeredOrdersRequest limit(Integer limit) { @@ -7126,7 +7495,7 @@ public APIlistPriceTriggeredOrdersRequest offset(Integer offset) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -7140,7 +7509,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -7155,7 +7524,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -7170,7 +7539,7 @@ public ApiResponse> executeWithHttpInfo() throw * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -7179,15 +7548,15 @@ public okhttp3.Call executeAsync(final ApiCallback Status Code Description Response Headers - 200 List retrieved - + 200 List retrieved successfully - */ public APIlistPriceTriggeredOrdersRequest listPriceTriggeredOrders(String settle, String status) { @@ -7204,7 +7573,7 @@ public APIlistPriceTriggeredOrdersRequest listPriceTriggeredOrders(String settle * @http.response.details - +
Status Code Description Response Headers
201 Order created -
201 Order created successfully -
*/ public okhttp3.Call createPriceTriggeredOrderCall(String settle, FuturesPriceTriggeredOrder futuresPriceTriggeredOrder, final ApiCallback _callback) throws ApiException { @@ -7254,7 +7623,7 @@ private okhttp3.Call createPriceTriggeredOrderValidateBeforeCall(String settle, } /** - * Create a price-triggered order + * Create price-triggered order * * @param settle Settle currency (required) * @param futuresPriceTriggeredOrder (required) @@ -7263,7 +7632,7 @@ private okhttp3.Call createPriceTriggeredOrderValidateBeforeCall(String settle, * @http.response.details - +
Status Code Description Response Headers
201 Order created -
201 Order created successfully -
*/ public TriggerOrderResponse createPriceTriggeredOrder(String settle, FuturesPriceTriggeredOrder futuresPriceTriggeredOrder) throws ApiException { @@ -7272,7 +7641,7 @@ public TriggerOrderResponse createPriceTriggeredOrder(String settle, FuturesPric } /** - * Create a price-triggered order + * Create price-triggered order * * @param settle Settle currency (required) * @param futuresPriceTriggeredOrder (required) @@ -7281,7 +7650,7 @@ public TriggerOrderResponse createPriceTriggeredOrder(String settle, FuturesPric * @http.response.details - +
Status Code Description Response Headers
201 Order created -
201 Order created successfully -
*/ public ApiResponse createPriceTriggeredOrderWithHttpInfo(String settle, FuturesPriceTriggeredOrder futuresPriceTriggeredOrder) throws ApiException { @@ -7291,7 +7660,7 @@ public ApiResponse createPriceTriggeredOrderWithHttpInfo(S } /** - * Create a price-triggered order (asynchronously) + * Create price-triggered order (asynchronously) * * @param settle Settle currency (required) * @param futuresPriceTriggeredOrder (required) @@ -7301,7 +7670,7 @@ public ApiResponse createPriceTriggeredOrderWithHttpInfo(S * @http.response.details - +
Status Code Description Response Headers
201 Order created -
201 Order created successfully -
*/ public okhttp3.Call createPriceTriggeredOrderAsync(String settle, FuturesPriceTriggeredOrder futuresPriceTriggeredOrder, final ApiCallback _callback) throws ApiException { @@ -7321,7 +7690,7 @@ public okhttp3.Call createPriceTriggeredOrderAsync(String settle, FuturesPriceTr * @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 -
*/ public okhttp3.Call cancelPriceTriggeredOrderListCall(String settle, String contract, final ApiCallback _callback) throws ApiException { @@ -7370,7 +7739,7 @@ private okhttp3.Call cancelPriceTriggeredOrderListValidateBeforeCall(String sett } /** - * Cancel All Price-triggered Orders + * Cancel all auto orders * * @param settle Settle currency (required) * @param contract Futures contract, return related data only if specified (optional) @@ -7379,7 +7748,7 @@ private okhttp3.Call cancelPriceTriggeredOrderListValidateBeforeCall(String sett * @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 -
*/ public List cancelPriceTriggeredOrderList(String settle, String contract) throws ApiException { @@ -7388,7 +7757,7 @@ public List cancelPriceTriggeredOrderList(String set } /** - * Cancel All Price-triggered Orders + * Cancel all auto orders * * @param settle Settle currency (required) * @param contract Futures contract, return related data only if specified (optional) @@ -7397,7 +7766,7 @@ public List cancelPriceTriggeredOrderList(String set * @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 -
*/ public ApiResponse> cancelPriceTriggeredOrderListWithHttpInfo(String settle, String contract) throws ApiException { @@ -7407,7 +7776,7 @@ public ApiResponse> cancelPriceTriggeredOrderLi } /** - * Cancel All Price-triggered Orders (asynchronously) + * Cancel all auto orders (asynchronously) * * @param settle Settle currency (required) * @param contract Futures contract, return related data only if specified (optional) @@ -7417,7 +7786,7 @@ public ApiResponse> cancelPriceTriggeredOrderLi * @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 -
*/ public okhttp3.Call cancelPriceTriggeredOrderListAsync(String settle, String contract, final ApiCallback> _callback) throws ApiException { @@ -7430,14 +7799,14 @@ public okhttp3.Call cancelPriceTriggeredOrderListAsync(String settle, String con /** * Build call for getPriceTriggeredOrder * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
Status Code Description Response Headers
200 Auto order detail -
200 Auto order details -
*/ public okhttp3.Call getPriceTriggeredOrderCall(String settle, String orderId, final ApiCallback _callback) throws ApiException { @@ -7488,16 +7857,16 @@ private okhttp3.Call getPriceTriggeredOrderValidateBeforeCall(String settle, Str } /** - * Get a price-triggered order + * Query single auto order details * * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @return FuturesPriceTriggeredOrder * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Auto order detail -
200 Auto order details -
*/ public FuturesPriceTriggeredOrder getPriceTriggeredOrder(String settle, String orderId) throws ApiException { @@ -7506,16 +7875,16 @@ public FuturesPriceTriggeredOrder getPriceTriggeredOrder(String settle, String o } /** - * Get a price-triggered order + * Query single auto order details * * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @return ApiResponse<FuturesPriceTriggeredOrder> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Auto order detail -
200 Auto order details -
*/ public ApiResponse getPriceTriggeredOrderWithHttpInfo(String settle, String orderId) throws ApiException { @@ -7525,17 +7894,17 @@ public ApiResponse getPriceTriggeredOrderWithHttpInf } /** - * Get a price-triggered order (asynchronously) + * Query single auto order details (asynchronously) * * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 Auto order detail -
200 Auto order details -
*/ public okhttp3.Call getPriceTriggeredOrderAsync(String settle, String orderId, final ApiCallback _callback) throws ApiException { @@ -7548,14 +7917,14 @@ public okhttp3.Call getPriceTriggeredOrderAsync(String settle, String orderId, f /** * Build call for cancelPriceTriggeredOrder * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
Status Code Description Response Headers
200 Auto order detail -
200 Auto order details -
*/ public okhttp3.Call cancelPriceTriggeredOrderCall(String settle, String orderId, final ApiCallback _callback) throws ApiException { @@ -7606,16 +7975,16 @@ private okhttp3.Call cancelPriceTriggeredOrderValidateBeforeCall(String settle, } /** - * cancel a price-triggered order + * Cancel single auto order * * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @return FuturesPriceTriggeredOrder * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Auto order detail -
200 Auto order details -
*/ public FuturesPriceTriggeredOrder cancelPriceTriggeredOrder(String settle, String orderId) throws ApiException { @@ -7624,16 +7993,16 @@ public FuturesPriceTriggeredOrder cancelPriceTriggeredOrder(String settle, Strin } /** - * cancel a price-triggered order + * Cancel single auto order * * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @return ApiResponse<FuturesPriceTriggeredOrder> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Auto order detail -
200 Auto order details -
*/ public ApiResponse cancelPriceTriggeredOrderWithHttpInfo(String settle, String orderId) throws ApiException { @@ -7643,17 +8012,17 @@ public ApiResponse cancelPriceTriggeredOrderWithHttp } /** - * cancel a price-triggered order (asynchronously) + * Cancel single auto order (asynchronously) * * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 Auto order detail -
200 Auto order details -
*/ public okhttp3.Call cancelPriceTriggeredOrderAsync(String settle, String orderId, final ApiCallback _callback) throws ApiException { diff --git a/src/main/java/io/gate/gateapi/api/MarginApi.java b/src/main/java/io/gate/gateapi/api/MarginApi.java index 0f8e029..f9834ba 100644 --- a/src/main/java/io/gate/gateapi/api/MarginApi.java +++ b/src/main/java/io/gate/gateapi/api/MarginApi.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -21,21 +21,14 @@ import io.gate.gateapi.models.AutoRepaySetting; -import io.gate.gateapi.models.CrossMarginAccount; -import io.gate.gateapi.models.CrossMarginAccountBook; -import io.gate.gateapi.models.CrossMarginCurrency; import io.gate.gateapi.models.CrossMarginLoan; -import io.gate.gateapi.models.CrossMarginRepayRequest; import io.gate.gateapi.models.CrossMarginRepayment; -import io.gate.gateapi.models.CrossMarginTransferable; import io.gate.gateapi.models.FundingAccount; import io.gate.gateapi.models.MarginAccount; import io.gate.gateapi.models.MarginAccountBook; import io.gate.gateapi.models.MarginLeverageTier; import io.gate.gateapi.models.MarginMarketLeverage; import io.gate.gateapi.models.MarginTransferable; -import io.gate.gateapi.models.UniLoanInterestRecord; -import io.gate.gateapi.models.UnifiedBorrowable; import java.lang.reflect.Type; import java.util.ArrayList; @@ -139,7 +132,7 @@ public APIlistMarginAccountsRequest currencyPair(String currencyPair) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -153,7 +146,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -168,7 +161,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -183,7 +176,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExceptio * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -198,7 +191,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _callbac * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistMarginAccountsRequest listMarginAccounts() { @@ -296,7 +289,7 @@ private APIlistMarginAccountBookRequest() { /** * Set currency - * @param currency List records related to specified currency only. If specified, `currency_pair` is also required. (optional) + * @param currency Query history for specified currency. If `currency` is specified, `currency_pair` must also be specified. (optional) * @return APIlistMarginAccountBookRequest */ public APIlistMarginAccountBookRequest currency(String currency) { @@ -306,7 +299,7 @@ public APIlistMarginAccountBookRequest currency(String currency) { /** * Set currencyPair - * @param currencyPair List records related to specified currency pair. Used in combination with `currency`. Ignored if `currency` is not provided (optional) + * @param currencyPair Specify margin account currency pair. Used in combination with `currency`. Ignored if `currency` is not specified (optional) * @return APIlistMarginAccountBookRequest */ public APIlistMarginAccountBookRequest currencyPair(String currencyPair) { @@ -316,7 +309,7 @@ public APIlistMarginAccountBookRequest currencyPair(String currencyPair) { /** * Set type - * @param type Only retrieve changes of the specified type. All types will be returned if not specified. (optional) + * @param type Query by specified account change type. If not specified, all change types will be included. (optional) * @return APIlistMarginAccountBookRequest */ public APIlistMarginAccountBookRequest type(String type) { @@ -326,7 +319,7 @@ public APIlistMarginAccountBookRequest type(String type) { /** * Set from - * @param from Start timestamp of the query (optional) + * @param from Start timestamp for the query (optional) * @return APIlistMarginAccountBookRequest */ public APIlistMarginAccountBookRequest from(Long from) { @@ -336,7 +329,7 @@ public APIlistMarginAccountBookRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to End timestamp for the query, defaults to current time if not specified (optional) * @return APIlistMarginAccountBookRequest */ public APIlistMarginAccountBookRequest to(Long to) { @@ -356,7 +349,7 @@ public APIlistMarginAccountBookRequest page(Integer page) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistMarginAccountBookRequest */ public APIlistMarginAccountBookRequest limit(Integer limit) { @@ -372,7 +365,7 @@ public APIlistMarginAccountBookRequest limit(Integer limit) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -386,7 +379,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -401,7 +394,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -416,7 +409,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExce * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -425,13 +418,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _cal } /** - * List margin account balance change history - * Only transferals from and to margin account are provided for now. Time range allows 30 days at most + * Query margin account balance change history + * Currently only provides transfer history to and from margin accounts. Query time range cannot exceed 30 days * @return APIlistMarginAccountBookRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistMarginAccountBookRequest listMarginAccountBook() { @@ -499,7 +492,7 @@ private APIlistFundingAccountsRequest() { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Query by specified currency name (optional) * @return APIlistFundingAccountsRequest */ public APIlistFundingAccountsRequest currency(String currency) { @@ -515,7 +508,7 @@ public APIlistFundingAccountsRequest currency(String currency) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -529,7 +522,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -544,7 +537,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -559,7 +552,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcepti * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -574,7 +567,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _callba * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistFundingAccountsRequest listFundingAccounts() { @@ -589,7 +582,7 @@ public APIlistFundingAccountsRequest listFundingAccounts() { * @http.response.details - +
Status Code Description Response Headers
200 Current auto repayment setting -
200 User's current auto repayment settings -
*/ public okhttp3.Call getAutoRepayStatusCall(final ApiCallback _callback) throws ApiException { @@ -628,14 +621,14 @@ private okhttp3.Call getAutoRepayStatusValidateBeforeCall(final ApiCallback _cal } /** - * Retrieve user auto repayment setting + * Query user auto repayment settings * * @return AutoRepaySetting * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Current auto repayment setting -
200 User's current auto repayment settings -
*/ public AutoRepaySetting getAutoRepayStatus() throws ApiException { @@ -644,14 +637,14 @@ public AutoRepaySetting getAutoRepayStatus() throws ApiException { } /** - * Retrieve user auto repayment setting + * Query user auto repayment settings * * @return ApiResponse<AutoRepaySetting> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Current auto repayment setting -
200 User's current auto repayment settings -
*/ public ApiResponse getAutoRepayStatusWithHttpInfo() throws ApiException { @@ -661,7 +654,7 @@ public ApiResponse getAutoRepayStatusWithHttpInfo() throws Api } /** - * Retrieve user auto repayment setting (asynchronously) + * Query user auto repayment settings (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -669,7 +662,7 @@ public ApiResponse getAutoRepayStatusWithHttpInfo() throws Api * @http.response.details - +
Status Code Description Response Headers
200 Current auto repayment setting -
200 User's current auto repayment settings -
*/ public okhttp3.Call getAutoRepayStatusAsync(final ApiCallback _callback) throws ApiException { @@ -681,14 +674,14 @@ public okhttp3.Call getAutoRepayStatusAsync(final ApiCallback /** * Build call for setAutoRepay - * @param status New auto repayment status. `on` - enabled, `off` - disabled (required) + * @param status Whether to enable auto repayment: `on` - enabled, `off` - disabled (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
Status Code Description Response Headers
200 Current auto repayment setting -
200 User's current auto repayment settings -
*/ public okhttp3.Call setAutoRepayCall(String status, final ApiCallback _callback) throws ApiException { @@ -736,15 +729,15 @@ private okhttp3.Call setAutoRepayValidateBeforeCall(String status, final ApiCall } /** - * Update user's auto repayment setting + * Update user auto repayment settings * - * @param status New auto repayment status. `on` - enabled, `off` - disabled (required) + * @param status Whether to enable auto repayment: `on` - enabled, `off` - disabled (required) * @return AutoRepaySetting * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Current auto repayment setting -
200 User's current auto repayment settings -
*/ public AutoRepaySetting setAutoRepay(String status) throws ApiException { @@ -753,15 +746,15 @@ public AutoRepaySetting setAutoRepay(String status) throws ApiException { } /** - * Update user's auto repayment setting + * Update user auto repayment settings * - * @param status New auto repayment status. `on` - enabled, `off` - disabled (required) + * @param status Whether to enable auto repayment: `on` - enabled, `off` - disabled (required) * @return ApiResponse<AutoRepaySetting> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Current auto repayment setting -
200 User's current auto repayment settings -
*/ public ApiResponse setAutoRepayWithHttpInfo(String status) throws ApiException { @@ -771,16 +764,16 @@ public ApiResponse setAutoRepayWithHttpInfo(String status) thr } /** - * Update user's auto repayment setting (asynchronously) + * Update user auto repayment settings (asynchronously) * - * @param status New auto repayment status. `on` - enabled, `off` - disabled (required) + * @param status Whether to enable auto repayment: `on` - enabled, `off` - disabled (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 Current auto repayment setting -
200 User's current auto repayment settings -
*/ public okhttp3.Call setAutoRepayAsync(String status, final ApiCallback _callback) throws ApiException { @@ -878,7 +871,7 @@ public APIgetMarginTransferableRequest currencyPair(String currencyPair) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -892,7 +885,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public MarginTransferable execute() throws ApiException { @@ -907,7 +900,7 @@ public MarginTransferable execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -922,7 +915,7 @@ public ApiResponse executeWithHttpInfo() throws ApiException * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -931,14 +924,14 @@ public okhttp3.Call executeAsync(final ApiCallback _callback } /** - * Get the max transferable amount for a specific margin currency + * Get maximum transferable amount for isolated margin * - * @param currency Retrieve data of the specified currency (required) + * @param currency Query by specified currency name (required) * @return APIgetMarginTransferableRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIgetMarginTransferableRequest getMarginTransferable(String currency) { @@ -946,26 +939,29 @@ public APIgetMarginTransferableRequest getMarginTransferable(String currency) { } /** - * Build call for listCrossMarginCurrencies + * Build call for getUserMarginTier + * @param currencyPair Currency pair (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 Query successful -
- * @deprecated */ - @Deprecated - public okhttp3.Call listCrossMarginCurrenciesCall(final ApiCallback _callback) throws ApiException { + public okhttp3.Call getUserMarginTierCall(String currencyPair, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/margin/cross/currencies"; + String localVarPath = "/margin/user/loan_margin_tiers"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); + if (currencyPair != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency_pair", currencyPair)); + } + Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); @@ -983,98 +979,100 @@ public okhttp3.Call listCrossMarginCurrenciesCall(final ApiCallback _callback) t final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); - String[] localVarAuthNames = new String[] { }; + String[] localVarAuthNames = new String[] { "apiv4" }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } - @Deprecated @SuppressWarnings("rawtypes") - private okhttp3.Call listCrossMarginCurrenciesValidateBeforeCall(final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = listCrossMarginCurrenciesCall(_callback); + private okhttp3.Call getUserMarginTierValidateBeforeCall(String currencyPair, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'currencyPair' is set + if (currencyPair == null) { + throw new ApiException("Missing the required parameter 'currencyPair' when calling getUserMarginTier(Async)"); + } + + okhttp3.Call localVarCall = getUserMarginTierCall(currencyPair, _callback); return localVarCall; } /** - * Currencies supported by cross margin.(deprecated) + * Query user's own leverage lending tiers in current market * - * @return List<CrossMarginCurrency> + * @param currencyPair Currency pair (required) + * @return List<MarginLeverageTier> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 Query successful -
- * @deprecated */ - @Deprecated - public List listCrossMarginCurrencies() throws ApiException { - ApiResponse> localVarResp = listCrossMarginCurrenciesWithHttpInfo(); + public List getUserMarginTier(String currencyPair) throws ApiException { + ApiResponse> localVarResp = getUserMarginTierWithHttpInfo(currencyPair); return localVarResp.getData(); } /** - * Currencies supported by cross margin.(deprecated) + * Query user's own leverage lending tiers in current market * - * @return ApiResponse<List<CrossMarginCurrency>> + * @param currencyPair Currency pair (required) + * @return ApiResponse<List<MarginLeverageTier>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 Query successful -
- * @deprecated */ - @Deprecated - public ApiResponse> listCrossMarginCurrenciesWithHttpInfo() throws ApiException { - okhttp3.Call localVarCall = listCrossMarginCurrenciesValidateBeforeCall(null); - Type localVarReturnType = new TypeToken>(){}.getType(); + public ApiResponse> getUserMarginTierWithHttpInfo(String currencyPair) throws ApiException { + okhttp3.Call localVarCall = getUserMarginTierValidateBeforeCall(currencyPair, null); + Type localVarReturnType = new TypeToken>(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * Currencies supported by cross margin.(deprecated) (asynchronously) + * Query user's own leverage lending tiers in current market (asynchronously) * + * @param currencyPair Currency pair (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 Query successful -
- * @deprecated */ - @Deprecated - public okhttp3.Call listCrossMarginCurrenciesAsync(final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = listCrossMarginCurrenciesValidateBeforeCall(_callback); - Type localVarReturnType = new TypeToken>(){}.getType(); + public okhttp3.Call getUserMarginTierAsync(String currencyPair, final ApiCallback> _callback) throws ApiException { + okhttp3.Call localVarCall = getUserMarginTierValidateBeforeCall(currencyPair, _callback); + Type localVarReturnType = new TypeToken>(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** - * Build call for getCrossMarginCurrency - * @param currency Currency name (required) + * Build call for getMarketMarginTier + * @param currencyPair Currency pair (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
- * @deprecated */ - @Deprecated - public okhttp3.Call getCrossMarginCurrencyCall(String currency, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getMarketMarginTierCall(String currencyPair, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/margin/cross/currencies/{currency}" - .replaceAll("\\{" + "currency" + "\\}", localVarApiClient.escapeString(currency)); + String localVarPath = "/margin/loan_margin_tiers"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); + if (currencyPair != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency_pair", currencyPair)); + } + Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); @@ -1096,97 +1094,89 @@ public okhttp3.Call getCrossMarginCurrencyCall(String currency, final ApiCallbac return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } - @Deprecated @SuppressWarnings("rawtypes") - private okhttp3.Call getCrossMarginCurrencyValidateBeforeCall(String currency, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'currency' is set - if (currency == null) { - throw new ApiException("Missing the required parameter 'currency' when calling getCrossMarginCurrency(Async)"); + private okhttp3.Call getMarketMarginTierValidateBeforeCall(String currencyPair, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'currencyPair' is set + if (currencyPair == null) { + throw new ApiException("Missing the required parameter 'currencyPair' when calling getMarketMarginTier(Async)"); } - okhttp3.Call localVarCall = getCrossMarginCurrencyCall(currency, _callback); + okhttp3.Call localVarCall = getMarketMarginTierCall(currencyPair, _callback); return localVarCall; } /** - * Retrieve detail of one single currency supported by cross margin. (deprecated) + * Query current market leverage lending tiers * - * @param currency Currency name (required) - * @return CrossMarginCurrency + * @param currencyPair Currency pair (required) + * @return List<MarginLeverageTier> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
- * @deprecated */ - @Deprecated - public CrossMarginCurrency getCrossMarginCurrency(String currency) throws ApiException { - ApiResponse localVarResp = getCrossMarginCurrencyWithHttpInfo(currency); + public List getMarketMarginTier(String currencyPair) throws ApiException { + ApiResponse> localVarResp = getMarketMarginTierWithHttpInfo(currencyPair); return localVarResp.getData(); } /** - * Retrieve detail of one single currency supported by cross margin. (deprecated) + * Query current market leverage lending tiers * - * @param currency Currency name (required) - * @return ApiResponse<CrossMarginCurrency> + * @param currencyPair Currency pair (required) + * @return ApiResponse<List<MarginLeverageTier>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
- * @deprecated */ - @Deprecated - public ApiResponse getCrossMarginCurrencyWithHttpInfo(String currency) throws ApiException { - okhttp3.Call localVarCall = getCrossMarginCurrencyValidateBeforeCall(currency, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse> getMarketMarginTierWithHttpInfo(String currencyPair) throws ApiException { + okhttp3.Call localVarCall = getMarketMarginTierValidateBeforeCall(currencyPair, null); + Type localVarReturnType = new TypeToken>(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * Retrieve detail of one single currency supported by cross margin. (deprecated) (asynchronously) + * Query current market leverage lending tiers (asynchronously) * - * @param currency Currency name (required) + * @param currencyPair Currency pair (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
- * @deprecated */ - @Deprecated - public okhttp3.Call getCrossMarginCurrencyAsync(String currency, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getCrossMarginCurrencyValidateBeforeCall(currency, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); + public okhttp3.Call getMarketMarginTierAsync(String currencyPair, final ApiCallback> _callback) throws ApiException { + okhttp3.Call localVarCall = getMarketMarginTierValidateBeforeCall(currencyPair, _callback); + Type localVarReturnType = new TypeToken>(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** - * Build call for getCrossMarginAccount + * Build call for setUserMarketLeverage + * @param marginMarketLeverage (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
204 Set successfully -
- * @deprecated */ - @Deprecated - public okhttp3.Call getCrossMarginAccountCall(final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; + public okhttp3.Call setUserMarketLeverageCall(MarginMarketLeverage marginMarketLeverage, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = marginMarketLeverage; // create path and map variables - String localVarPath = "/margin/cross/accounts"; + String localVarPath = "/margin/leverage/user_market_setting"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -1194,7 +1184,7 @@ public okhttp3.Call getCrossMarginAccountCall(final ApiCallback _callback) throw Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "application/json" + }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -1202,110 +1192,87 @@ public okhttp3.Call getCrossMarginAccountCall(final ApiCallback _callback) throw } final String[] localVarContentTypes = { - + "application/json" }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); String[] localVarAuthNames = new String[] { "apiv4" }; - return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } - @Deprecated @SuppressWarnings("rawtypes") - private okhttp3.Call getCrossMarginAccountValidateBeforeCall(final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getCrossMarginAccountCall(_callback); + private okhttp3.Call setUserMarketLeverageValidateBeforeCall(MarginMarketLeverage marginMarketLeverage, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'marginMarketLeverage' is set + if (marginMarketLeverage == null) { + throw new ApiException("Missing the required parameter 'marginMarketLeverage' when calling setUserMarketLeverage(Async)"); + } + + okhttp3.Call localVarCall = setUserMarketLeverageCall(marginMarketLeverage, _callback); return localVarCall; } /** - * Retrieve cross margin account. (deprecated) + * Set user market leverage multiplier * - * @return CrossMarginAccount + * @param marginMarketLeverage (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
204 Set successfully -
- * @deprecated */ - @Deprecated - public CrossMarginAccount getCrossMarginAccount() throws ApiException { - ApiResponse localVarResp = getCrossMarginAccountWithHttpInfo(); - return localVarResp.getData(); + public void setUserMarketLeverage(MarginMarketLeverage marginMarketLeverage) throws ApiException { + setUserMarketLeverageWithHttpInfo(marginMarketLeverage); } /** - * Retrieve cross margin account. (deprecated) + * Set user market leverage multiplier * - * @return ApiResponse<CrossMarginAccount> + * @param marginMarketLeverage (required) + * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
204 Set successfully -
- * @deprecated */ - @Deprecated - public ApiResponse getCrossMarginAccountWithHttpInfo() throws ApiException { - okhttp3.Call localVarCall = getCrossMarginAccountValidateBeforeCall(null); - Type localVarReturnType = new TypeToken(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); + public ApiResponse setUserMarketLeverageWithHttpInfo(MarginMarketLeverage marginMarketLeverage) throws ApiException { + okhttp3.Call localVarCall = setUserMarketLeverageValidateBeforeCall(marginMarketLeverage, null); + return localVarApiClient.execute(localVarCall); } /** - * Retrieve cross margin account. (deprecated) (asynchronously) + * Set user market leverage multiplier (asynchronously) * + * @param marginMarketLeverage (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
204 Set successfully -
- * @deprecated */ - @Deprecated - public okhttp3.Call getCrossMarginAccountAsync(final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getCrossMarginAccountValidateBeforeCall(_callback); - Type localVarReturnType = new TypeToken(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + public okhttp3.Call setUserMarketLeverageAsync(MarginMarketLeverage marginMarketLeverage, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = setUserMarketLeverageValidateBeforeCall(marginMarketLeverage, _callback); + localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } - private okhttp3.Call listCrossMarginAccountBookCall(String currency, Long from, Long to, Integer page, Integer limit, String type, final ApiCallback _callback) throws ApiException { + private okhttp3.Call listMarginUserAccountCall(String currencyPair, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/margin/cross/account_book"; + String localVarPath = "/margin/user/account"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); - if (currency != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); - } - - if (from != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("from", from)); - } - - if (to != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("to", to)); - } - - if (page != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("page", page)); - } - - if (limit != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("limit", limit)); - } - - if (type != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("type", type)); + if (currencyPair != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency_pair", currencyPair)); } Map localVarHeaderParams = new HashMap(); @@ -1329,180 +1296,114 @@ private okhttp3.Call listCrossMarginAccountBookCall(String currency, Long from, return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } - @Deprecated @SuppressWarnings("rawtypes") - private okhttp3.Call listCrossMarginAccountBookValidateBeforeCall(String currency, Long from, Long to, Integer page, Integer limit, String type, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = listCrossMarginAccountBookCall(currency, from, to, page, limit, type, _callback); + private okhttp3.Call listMarginUserAccountValidateBeforeCall(String currencyPair, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = listMarginUserAccountCall(currencyPair, _callback); return localVarCall; } - private ApiResponse> listCrossMarginAccountBookWithHttpInfo(String currency, Long from, Long to, Integer page, Integer limit, String type) throws ApiException { - okhttp3.Call localVarCall = listCrossMarginAccountBookValidateBeforeCall(currency, from, to, page, limit, type, null); - Type localVarReturnType = new TypeToken>(){}.getType(); + private ApiResponse> listMarginUserAccountWithHttpInfo(String currencyPair) throws ApiException { + okhttp3.Call localVarCall = listMarginUserAccountValidateBeforeCall(currencyPair, null); + Type localVarReturnType = new TypeToken>(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } - private okhttp3.Call listCrossMarginAccountBookAsync(String currency, Long from, Long to, Integer page, Integer limit, String type, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = listCrossMarginAccountBookValidateBeforeCall(currency, from, to, page, limit, type, _callback); - Type localVarReturnType = new TypeToken>(){}.getType(); + private okhttp3.Call listMarginUserAccountAsync(String currencyPair, final ApiCallback> _callback) throws ApiException { + okhttp3.Call localVarCall = listMarginUserAccountValidateBeforeCall(currencyPair, _callback); + Type localVarReturnType = new TypeToken>(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } - public class APIlistCrossMarginAccountBookRequest { - private String currency; - private Long from; - private Long to; - private Integer page; - private Integer limit; - private String type; - - private APIlistCrossMarginAccountBookRequest() { - } - - /** - * Set currency - * @param currency Filter by currency (optional) - * @return APIlistCrossMarginAccountBookRequest - */ - public APIlistCrossMarginAccountBookRequest currency(String currency) { - this.currency = currency; - return this; - } - - /** - * Set from - * @param from Start timestamp of the query (optional) - * @return APIlistCrossMarginAccountBookRequest - */ - public APIlistCrossMarginAccountBookRequest from(Long from) { - this.from = from; - return this; - } - - /** - * Set to - * @param to Time range ending, default to current time (optional) - * @return APIlistCrossMarginAccountBookRequest - */ - public APIlistCrossMarginAccountBookRequest to(Long to) { - this.to = to; - return this; - } - - /** - * Set page - * @param page Page number (optional, default to 1) - * @return APIlistCrossMarginAccountBookRequest - */ - public APIlistCrossMarginAccountBookRequest page(Integer page) { - this.page = page; - return this; - } + public class APIlistMarginUserAccountRequest { + private String currencyPair; - /** - * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) - * @return APIlistCrossMarginAccountBookRequest - */ - public APIlistCrossMarginAccountBookRequest limit(Integer limit) { - this.limit = limit; - return this; + private APIlistMarginUserAccountRequest() { } /** - * Set type - * @param type Only retrieve changes of the specified type. All types will be returned if not specified. (optional) - * @return APIlistCrossMarginAccountBookRequest + * Set currencyPair + * @param currencyPair Currency pair (optional) + * @return APIlistMarginUserAccountRequest */ - public APIlistCrossMarginAccountBookRequest type(String type) { - this.type = type; + public APIlistMarginUserAccountRequest currencyPair(String currencyPair) { + this.currencyPair = currencyPair; return this; } /** - * Build call for listCrossMarginAccountBook + * Build call for listMarginUserAccount * @param _callback ApiCallback API callback * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
- * @deprecated */ - @Deprecated public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { - return listCrossMarginAccountBookCall(currency, from, to, page, limit, type, _callback); + return listMarginUserAccountCall(currencyPair, _callback); } /** - * Execute listCrossMarginAccountBook request - * @return List<CrossMarginAccountBook> + * Execute listMarginUserAccount request + * @return List<MarginAccount> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
- * @deprecated */ - @Deprecated - public List execute() throws ApiException { - ApiResponse> localVarResp = listCrossMarginAccountBookWithHttpInfo(currency, from, to, page, limit, type); + public List execute() throws ApiException { + ApiResponse> localVarResp = listMarginUserAccountWithHttpInfo(currencyPair); return localVarResp.getData(); } /** - * Execute listCrossMarginAccountBook request with HTTP info returned - * @return ApiResponse<List<CrossMarginAccountBook>> + * Execute listMarginUserAccount request with HTTP info returned + * @return ApiResponse<List<MarginAccount>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
- * @deprecated */ - @Deprecated - public ApiResponse> executeWithHttpInfo() throws ApiException { - return listCrossMarginAccountBookWithHttpInfo(currency, from, to, page, limit, type); + public ApiResponse> executeWithHttpInfo() throws ApiException { + return listMarginUserAccountWithHttpInfo(currencyPair); } /** - * Execute listCrossMarginAccountBook request (asynchronously) + * Execute listMarginUserAccount request (asynchronously) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
- * @deprecated */ - @Deprecated - public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { - return listCrossMarginAccountBookAsync(currency, from, to, page, limit, type, _callback); + public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { + return listMarginUserAccountAsync(currencyPair, _callback); } } /** - * Retrieve cross margin account change history. (deprecated) - * The record query time range is not allowed to exceed 30 days. When using the limit&page paging function to retrieve data, the maximum number of pages is 100,000, that is, (limit page - 1) <= 100000. - * @return APIlistCrossMarginAccountBookRequest + * Query user's isolated margin account list + * Supports querying risk ratio isolated accounts and margin ratio isolated accounts + * @return APIlistMarginUserAccountRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
- * @deprecated */ - @Deprecated - public APIlistCrossMarginAccountBookRequest listCrossMarginAccountBook() { - return new APIlistCrossMarginAccountBookRequest(); + public APIlistMarginUserAccountRequest listMarginUserAccount() { + return new APIlistMarginUserAccountRequest(); } private okhttp3.Call listCrossMarginLoansCall(Integer status, String currency, Integer limit, Integer offset, Boolean reverse, final ApiCallback _callback) throws ApiException { @@ -1593,7 +1494,7 @@ private APIlistCrossMarginLoansRequest(Integer status) { /** * Set currency - * @param currency Filter by currency (optional) + * @param currency Query by specified currency, includes all currencies if not specified (optional) * @return APIlistCrossMarginLoansRequest */ public APIlistCrossMarginLoansRequest currency(String currency) { @@ -1603,7 +1504,7 @@ public APIlistCrossMarginLoansRequest currency(String currency) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistCrossMarginLoansRequest */ public APIlistCrossMarginLoansRequest limit(Integer limit) { @@ -1639,7 +1540,7 @@ public APIlistCrossMarginLoansRequest reverse(Boolean reverse) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
* @deprecated */ @@ -1655,7 +1556,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
* @deprecated */ @@ -1672,7 +1573,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
* @deprecated */ @@ -1689,7 +1590,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcept * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
* @deprecated */ @@ -1700,14 +1601,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callb } /** - * List cross margin borrow history. (deprecated) - * Sort by creation time in descending order by default. Set `reverse=false` to return ascending results. + * Query cross margin borrow history (deprecated) + * Sorted by creation time in descending order by default. Set `reverse=false` for ascending order * @param status Filter by status. Supported values are 2 and 3. (deprecated.) (required) * @return APIlistCrossMarginLoansRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
* @deprecated */ @@ -1716,244 +1617,11 @@ public APIlistCrossMarginLoansRequest listCrossMarginLoans(Integer status) { return new APIlistCrossMarginLoansRequest(status); } - /** - * Build call for createCrossMarginLoan - * @param crossMarginLoan (required) - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully borrowed -
- * @deprecated - */ - @Deprecated - public okhttp3.Call createCrossMarginLoanCall(CrossMarginLoan crossMarginLoan, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = crossMarginLoan; + private okhttp3.Call listCrossMarginRepaymentsCall(String currency, String loanId, Integer limit, Integer offset, Boolean reverse, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = null; // create path and map variables - String localVarPath = "/margin/cross/loans"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - final String[] localVarAccepts = { - "application/json" - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - "application/json" - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - localVarHeaderParams.put("Content-Type", localVarContentType); - - String[] localVarAuthNames = new String[] { "apiv4" }; - return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @Deprecated - @SuppressWarnings("rawtypes") - private okhttp3.Call createCrossMarginLoanValidateBeforeCall(CrossMarginLoan crossMarginLoan, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'crossMarginLoan' is set - if (crossMarginLoan == null) { - throw new ApiException("Missing the required parameter 'crossMarginLoan' when calling createCrossMarginLoan(Async)"); - } - - okhttp3.Call localVarCall = createCrossMarginLoanCall(crossMarginLoan, _callback); - return localVarCall; - } - - /** - * Create a cross margin borrow loan. (deprecated) - * Borrow amount cannot be less than currency minimum borrow amount - * @param crossMarginLoan (required) - * @return CrossMarginLoan - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully borrowed -
- * @deprecated - */ - @Deprecated - public CrossMarginLoan createCrossMarginLoan(CrossMarginLoan crossMarginLoan) throws ApiException { - ApiResponse localVarResp = createCrossMarginLoanWithHttpInfo(crossMarginLoan); - return localVarResp.getData(); - } - - /** - * Create a cross margin borrow loan. (deprecated) - * Borrow amount cannot be less than currency minimum borrow amount - * @param crossMarginLoan (required) - * @return ApiResponse<CrossMarginLoan> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully borrowed -
- * @deprecated - */ - @Deprecated - public ApiResponse createCrossMarginLoanWithHttpInfo(CrossMarginLoan crossMarginLoan) throws ApiException { - okhttp3.Call localVarCall = createCrossMarginLoanValidateBeforeCall(crossMarginLoan, null); - Type localVarReturnType = new TypeToken(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - /** - * Create a cross margin borrow loan. (deprecated) (asynchronously) - * Borrow amount cannot be less than currency minimum borrow amount - * @param crossMarginLoan (required) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully borrowed -
- * @deprecated - */ - @Deprecated - public okhttp3.Call createCrossMarginLoanAsync(CrossMarginLoan crossMarginLoan, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = createCrossMarginLoanValidateBeforeCall(crossMarginLoan, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - /** - * Build call for getCrossMarginLoan - * @param loanId Borrow loan ID (required) - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- * @deprecated - */ - @Deprecated - public okhttp3.Call getCrossMarginLoanCall(String loanId, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/margin/cross/loans/{loan_id}" - .replaceAll("\\{" + "loan_id" + "\\}", localVarApiClient.escapeString(loanId)); - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - final String[] localVarAccepts = { - "application/json" - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - localVarHeaderParams.put("Content-Type", localVarContentType); - - String[] localVarAuthNames = new String[] { "apiv4" }; - return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @Deprecated - @SuppressWarnings("rawtypes") - private okhttp3.Call getCrossMarginLoanValidateBeforeCall(String loanId, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'loanId' is set - if (loanId == null) { - throw new ApiException("Missing the required parameter 'loanId' when calling getCrossMarginLoan(Async)"); - } - - okhttp3.Call localVarCall = getCrossMarginLoanCall(loanId, _callback); - return localVarCall; - } - - /** - * Retrieve single borrow loan detail. (deprecated) - * - * @param loanId Borrow loan ID (required) - * @return CrossMarginLoan - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- * @deprecated - */ - @Deprecated - public CrossMarginLoan getCrossMarginLoan(String loanId) throws ApiException { - ApiResponse localVarResp = getCrossMarginLoanWithHttpInfo(loanId); - return localVarResp.getData(); - } - - /** - * Retrieve single borrow loan detail. (deprecated) - * - * @param loanId Borrow loan ID (required) - * @return ApiResponse<CrossMarginLoan> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- * @deprecated - */ - @Deprecated - public ApiResponse getCrossMarginLoanWithHttpInfo(String loanId) throws ApiException { - okhttp3.Call localVarCall = getCrossMarginLoanValidateBeforeCall(loanId, null); - Type localVarReturnType = new TypeToken(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - /** - * Retrieve single borrow loan detail. (deprecated) (asynchronously) - * - * @param loanId Borrow loan ID (required) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- * @deprecated - */ - @Deprecated - public okhttp3.Call getCrossMarginLoanAsync(String loanId, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getCrossMarginLoanValidateBeforeCall(loanId, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - private okhttp3.Call listCrossMarginRepaymentsCall(String currency, String loanId, Integer limit, Integer offset, Boolean reverse, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/margin/cross/repayments"; + String localVarPath = "/margin/cross/repayments"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -2051,7 +1719,7 @@ public APIlistCrossMarginRepaymentsRequest loanId(String loanId) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistCrossMarginRepaymentsRequest */ public APIlistCrossMarginRepaymentsRequest limit(Integer limit) { @@ -2087,7 +1755,7 @@ public APIlistCrossMarginRepaymentsRequest reverse(Boolean reverse) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
* @deprecated */ @@ -2103,7 +1771,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
* @deprecated */ @@ -2120,7 +1788,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
* @deprecated */ @@ -2137,7 +1805,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiE * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
* @deprecated */ @@ -2149,12 +1817,12 @@ public okhttp3.Call executeAsync(final ApiCallback> _ /** * 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 * @return APIlistCrossMarginRepaymentsRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
* @deprecated */ @@ -2163,1162 +1831,4 @@ public APIlistCrossMarginRepaymentsRequest listCrossMarginRepayments() { return new APIlistCrossMarginRepaymentsRequest(); } - /** - * Build call for repayCrossMarginLoan - * @param crossMarginRepayRequest (required) - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - -
Status Code Description Response Headers
200 Loan repaid -
- * @deprecated - */ - @Deprecated - public okhttp3.Call repayCrossMarginLoanCall(CrossMarginRepayRequest crossMarginRepayRequest, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = crossMarginRepayRequest; - - // create path and map variables - String localVarPath = "/margin/cross/repayments"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - final String[] localVarAccepts = { - "application/json" - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - "application/json" - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - localVarHeaderParams.put("Content-Type", localVarContentType); - - String[] localVarAuthNames = new String[] { "apiv4" }; - return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @Deprecated - @SuppressWarnings("rawtypes") - private okhttp3.Call repayCrossMarginLoanValidateBeforeCall(CrossMarginRepayRequest crossMarginRepayRequest, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'crossMarginRepayRequest' is set - if (crossMarginRepayRequest == null) { - throw new ApiException("Missing the required parameter 'crossMarginRepayRequest' when calling repayCrossMarginLoan(Async)"); - } - - okhttp3.Call localVarCall = repayCrossMarginLoanCall(crossMarginRepayRequest, _callback); - return localVarCall; - } - - /** - * Cross margin repayments. (deprecated) - * When the liquidity of the currency is insufficient and the transaction risk is high, the currency will be disabled, and funds cannot be transferred.When the available balance of cross-margin is insufficient, the balance of the spot account can be used for repayment. Please ensure that the balance of the spot account is sufficient, and system uses cross-margin account for repayment first - * @param crossMarginRepayRequest (required) - * @return List<CrossMarginLoan> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - -
Status Code Description Response Headers
200 Loan repaid -
- * @deprecated - */ - @Deprecated - public List repayCrossMarginLoan(CrossMarginRepayRequest crossMarginRepayRequest) throws ApiException { - ApiResponse> localVarResp = repayCrossMarginLoanWithHttpInfo(crossMarginRepayRequest); - return localVarResp.getData(); - } - - /** - * Cross margin repayments. (deprecated) - * When the liquidity of the currency is insufficient and the transaction risk is high, the currency will be disabled, and funds cannot be transferred.When the available balance of cross-margin is insufficient, the balance of the spot account can be used for repayment. Please ensure that the balance of the spot account is sufficient, and system uses cross-margin account for repayment first - * @param crossMarginRepayRequest (required) - * @return ApiResponse<List<CrossMarginLoan>> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - -
Status Code Description Response Headers
200 Loan repaid -
- * @deprecated - */ - @Deprecated - public ApiResponse> repayCrossMarginLoanWithHttpInfo(CrossMarginRepayRequest crossMarginRepayRequest) throws ApiException { - okhttp3.Call localVarCall = repayCrossMarginLoanValidateBeforeCall(crossMarginRepayRequest, null); - Type localVarReturnType = new TypeToken>(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - /** - * Cross margin repayments. (deprecated) (asynchronously) - * When the liquidity of the currency is insufficient and the transaction risk is high, the currency will be disabled, and funds cannot be transferred.When the available balance of cross-margin is insufficient, the balance of the spot account can be used for repayment. Please ensure that the balance of the spot account is sufficient, and system uses cross-margin account for repayment first - * @param crossMarginRepayRequest (required) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - -
Status Code Description Response Headers
200 Loan repaid -
- * @deprecated - */ - @Deprecated - public okhttp3.Call repayCrossMarginLoanAsync(CrossMarginRepayRequest crossMarginRepayRequest, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = repayCrossMarginLoanValidateBeforeCall(crossMarginRepayRequest, _callback); - Type localVarReturnType = new TypeToken>(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - private okhttp3.Call getCrossMarginInterestRecordsCall(String currency, Integer page, Integer limit, Long from, Long to, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/margin/cross/interest_records"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - if (currency != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); - } - - if (page != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("page", page)); - } - - if (limit != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("limit", limit)); - } - - if (from != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("from", from)); - } - - if (to != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("to", to)); - } - - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - final String[] localVarAccepts = { - "application/json" - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - localVarHeaderParams.put("Content-Type", localVarContentType); - - String[] localVarAuthNames = new String[] { "apiv4" }; - return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @Deprecated - @SuppressWarnings("rawtypes") - private okhttp3.Call getCrossMarginInterestRecordsValidateBeforeCall(String currency, Integer page, Integer limit, Long from, Long to, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getCrossMarginInterestRecordsCall(currency, page, limit, from, to, _callback); - return localVarCall; - } - - - private ApiResponse> getCrossMarginInterestRecordsWithHttpInfo(String currency, Integer page, Integer limit, Long from, Long to) throws ApiException { - okhttp3.Call localVarCall = getCrossMarginInterestRecordsValidateBeforeCall(currency, page, limit, from, to, null); - Type localVarReturnType = new TypeToken>(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - private okhttp3.Call getCrossMarginInterestRecordsAsync(String currency, Integer page, Integer limit, Long from, Long to, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = getCrossMarginInterestRecordsValidateBeforeCall(currency, page, limit, from, to, _callback); - Type localVarReturnType = new TypeToken>(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - public class APIgetCrossMarginInterestRecordsRequest { - private String currency; - private Integer page; - private Integer limit; - private Long from; - private Long to; - - private APIgetCrossMarginInterestRecordsRequest() { - } - - /** - * Set currency - * @param currency Retrieve data of the specified currency (optional) - * @return APIgetCrossMarginInterestRecordsRequest - */ - public APIgetCrossMarginInterestRecordsRequest currency(String currency) { - this.currency = currency; - return this; - } - - /** - * Set page - * @param page Page number (optional, default to 1) - * @return APIgetCrossMarginInterestRecordsRequest - */ - public APIgetCrossMarginInterestRecordsRequest page(Integer page) { - this.page = page; - return this; - } - - /** - * Set limit - * @param limit Maximum response items. Default: 100, minimum: 1, Maximum: 100 (optional, default to 100) - * @return APIgetCrossMarginInterestRecordsRequest - */ - public APIgetCrossMarginInterestRecordsRequest limit(Integer limit) { - this.limit = limit; - return this; - } - - /** - * Set from - * @param from Start timestamp (optional) - * @return APIgetCrossMarginInterestRecordsRequest - */ - public APIgetCrossMarginInterestRecordsRequest from(Long from) { - this.from = from; - return this; - } - - /** - * Set to - * @param to End timestamp (optional) - * @return APIgetCrossMarginInterestRecordsRequest - */ - public APIgetCrossMarginInterestRecordsRequest to(Long to) { - this.to = to; - return this; - } - - /** - * Build call for getCrossMarginInterestRecords - * @param _callback ApiCallback API callback - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- * @deprecated - */ - @Deprecated - public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { - return getCrossMarginInterestRecordsCall(currency, page, limit, from, to, _callback); - } - - /** - * Execute getCrossMarginInterestRecords request - * @return List<UniLoanInterestRecord> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- * @deprecated - */ - @Deprecated - public List execute() throws ApiException { - ApiResponse> localVarResp = getCrossMarginInterestRecordsWithHttpInfo(currency, page, limit, from, to); - return localVarResp.getData(); - } - - /** - * Execute getCrossMarginInterestRecords request with HTTP info returned - * @return ApiResponse<List<UniLoanInterestRecord>> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- * @deprecated - */ - @Deprecated - public ApiResponse> executeWithHttpInfo() throws ApiException { - return getCrossMarginInterestRecordsWithHttpInfo(currency, page, limit, from, to); - } - - /** - * Execute getCrossMarginInterestRecords request (asynchronously) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- * @deprecated - */ - @Deprecated - public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { - return getCrossMarginInterestRecordsAsync(currency, page, limit, from, to, _callback); - } - } - - /** - * Interest records for the cross margin account. (deprecated) - * - * @return APIgetCrossMarginInterestRecordsRequest - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- * @deprecated - */ - @Deprecated - public APIgetCrossMarginInterestRecordsRequest getCrossMarginInterestRecords() { - return new APIgetCrossMarginInterestRecordsRequest(); - } - - /** - * Build call for getCrossMarginTransferable - * @param currency Retrieve data of the specified currency (required) - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- * @deprecated - */ - @Deprecated - public okhttp3.Call getCrossMarginTransferableCall(String currency, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/margin/cross/transferable"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - if (currency != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); - } - - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - final String[] localVarAccepts = { - "application/json" - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - localVarHeaderParams.put("Content-Type", localVarContentType); - - String[] localVarAuthNames = new String[] { "apiv4" }; - return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @Deprecated - @SuppressWarnings("rawtypes") - private okhttp3.Call getCrossMarginTransferableValidateBeforeCall(String currency, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'currency' is set - if (currency == null) { - throw new ApiException("Missing the required parameter 'currency' when calling getCrossMarginTransferable(Async)"); - } - - okhttp3.Call localVarCall = getCrossMarginTransferableCall(currency, _callback); - return localVarCall; - } - - /** - * Get the max transferable amount for a specific cross margin currency. (deprecated) - * - * @param currency Retrieve data of the specified currency (required) - * @return CrossMarginTransferable - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- * @deprecated - */ - @Deprecated - public CrossMarginTransferable getCrossMarginTransferable(String currency) throws ApiException { - ApiResponse localVarResp = getCrossMarginTransferableWithHttpInfo(currency); - return localVarResp.getData(); - } - - /** - * Get the max transferable amount for a specific cross margin currency. (deprecated) - * - * @param currency Retrieve data of the specified currency (required) - * @return ApiResponse<CrossMarginTransferable> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- * @deprecated - */ - @Deprecated - public ApiResponse getCrossMarginTransferableWithHttpInfo(String currency) throws ApiException { - okhttp3.Call localVarCall = getCrossMarginTransferableValidateBeforeCall(currency, null); - Type localVarReturnType = new TypeToken(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - /** - * Get the max transferable amount for a specific cross margin currency. (deprecated) (asynchronously) - * - * @param currency Retrieve data of the specified currency (required) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- * @deprecated - */ - @Deprecated - public okhttp3.Call getCrossMarginTransferableAsync(String currency, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getCrossMarginTransferableValidateBeforeCall(currency, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - /** - * Build call for getCrossMarginEstimateRate - * @param currencies An array of up to 10 specifying the currency name (required) - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- * @deprecated - */ - @Deprecated - public okhttp3.Call getCrossMarginEstimateRateCall(List currencies, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/margin/cross/estimate_rate"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - if (currencies != null) { - localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "currencies", currencies)); - } - - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - final String[] localVarAccepts = { - "application/json" - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - localVarHeaderParams.put("Content-Type", localVarContentType); - - String[] localVarAuthNames = new String[] { "apiv4" }; - return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @Deprecated - @SuppressWarnings("rawtypes") - private okhttp3.Call getCrossMarginEstimateRateValidateBeforeCall(List currencies, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'currencies' is set - if (currencies == null) { - throw new ApiException("Missing the required parameter 'currencies' when calling getCrossMarginEstimateRate(Async)"); - } - - okhttp3.Call localVarCall = getCrossMarginEstimateRateCall(currencies, _callback); - return localVarCall; - } - - /** - * Estimated interest rates. (deprecated) - * Please note that the interest rates are subject to change based on the borrowing and lending demand, and therefore, the provided rates may not be entirely accurate. - * @param currencies An array of up to 10 specifying the currency name (required) - * @return Map<String, String> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- * @deprecated - */ - @Deprecated - public Map getCrossMarginEstimateRate(List currencies) throws ApiException { - ApiResponse> localVarResp = getCrossMarginEstimateRateWithHttpInfo(currencies); - return localVarResp.getData(); - } - - /** - * Estimated interest rates. (deprecated) - * Please note that the interest rates are subject to change based on the borrowing and lending demand, and therefore, the provided rates may not be entirely accurate. - * @param currencies An array of up to 10 specifying the currency name (required) - * @return ApiResponse<Map<String, String>> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- * @deprecated - */ - @Deprecated - public ApiResponse> getCrossMarginEstimateRateWithHttpInfo(List currencies) throws ApiException { - okhttp3.Call localVarCall = getCrossMarginEstimateRateValidateBeforeCall(currencies, null); - Type localVarReturnType = new TypeToken>(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - /** - * Estimated interest rates. (deprecated) (asynchronously) - * 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. - * @param currencies An array of up to 10 specifying the currency name (required) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- * @deprecated - */ - @Deprecated - public okhttp3.Call getCrossMarginEstimateRateAsync(List currencies, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = getCrossMarginEstimateRateValidateBeforeCall(currencies, _callback); - Type localVarReturnType = new TypeToken>(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - /** - * Build call for getCrossMarginBorrowable - * @param currency Retrieve data of the specified currency (required) - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- * @deprecated - */ - @Deprecated - public okhttp3.Call getCrossMarginBorrowableCall(String currency, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/margin/cross/borrowable"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - if (currency != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); - } - - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - final String[] localVarAccepts = { - "application/json" - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - localVarHeaderParams.put("Content-Type", localVarContentType); - - String[] localVarAuthNames = new String[] { "apiv4" }; - return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @Deprecated - @SuppressWarnings("rawtypes") - private okhttp3.Call getCrossMarginBorrowableValidateBeforeCall(String currency, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'currency' is set - if (currency == null) { - throw new ApiException("Missing the required parameter 'currency' when calling getCrossMarginBorrowable(Async)"); - } - - okhttp3.Call localVarCall = getCrossMarginBorrowableCall(currency, _callback); - return localVarCall; - } - - /** - * Get the max borrowable amount for a specific cross margin currency. (deprecated) - * - * @param currency Retrieve data of the specified currency (required) - * @return UnifiedBorrowable - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- * @deprecated - */ - @Deprecated - public UnifiedBorrowable getCrossMarginBorrowable(String currency) throws ApiException { - ApiResponse localVarResp = getCrossMarginBorrowableWithHttpInfo(currency); - return localVarResp.getData(); - } - - /** - * Get the max borrowable amount for a specific cross margin currency. (deprecated) - * - * @param currency Retrieve data of the specified currency (required) - * @return ApiResponse<UnifiedBorrowable> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- * @deprecated - */ - @Deprecated - public ApiResponse getCrossMarginBorrowableWithHttpInfo(String currency) throws ApiException { - okhttp3.Call localVarCall = getCrossMarginBorrowableValidateBeforeCall(currency, null); - Type localVarReturnType = new TypeToken(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - /** - * Get the max borrowable amount for a specific cross margin currency. (deprecated) (asynchronously) - * - * @param currency Retrieve data of the specified currency (required) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- * @deprecated - */ - @Deprecated - public okhttp3.Call getCrossMarginBorrowableAsync(String currency, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getCrossMarginBorrowableValidateBeforeCall(currency, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - /** - * Build call for getUserMarginTier - * @param currencyPair Currency pair (required) - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- */ - public okhttp3.Call getUserMarginTierCall(String currencyPair, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/margin/user/loan_margin_tiers"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - if (currencyPair != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency_pair", currencyPair)); - } - - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - final String[] localVarAccepts = { - "application/json" - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - localVarHeaderParams.put("Content-Type", localVarContentType); - - String[] localVarAuthNames = new String[] { "apiv4" }; - return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @SuppressWarnings("rawtypes") - private okhttp3.Call getUserMarginTierValidateBeforeCall(String currencyPair, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'currencyPair' is set - if (currencyPair == null) { - throw new ApiException("Missing the required parameter 'currencyPair' when calling getUserMarginTier(Async)"); - } - - okhttp3.Call localVarCall = getUserMarginTierCall(currencyPair, _callback); - return localVarCall; - } - - /** - * Check the user's own leverage lending gradient in the current market - * - * @param currencyPair Currency pair (required) - * @return List<MarginLeverageTier> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- */ - public List getUserMarginTier(String currencyPair) throws ApiException { - ApiResponse> localVarResp = getUserMarginTierWithHttpInfo(currencyPair); - return localVarResp.getData(); - } - - /** - * Check the user's own leverage lending gradient in the current market - * - * @param currencyPair Currency pair (required) - * @return ApiResponse<List<MarginLeverageTier>> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- */ - public ApiResponse> getUserMarginTierWithHttpInfo(String currencyPair) throws ApiException { - okhttp3.Call localVarCall = getUserMarginTierValidateBeforeCall(currencyPair, null); - Type localVarReturnType = new TypeToken>(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - /** - * Check the user's own leverage lending gradient in the current market (asynchronously) - * - * @param currencyPair Currency pair (required) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- */ - public okhttp3.Call getUserMarginTierAsync(String currencyPair, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = getUserMarginTierValidateBeforeCall(currencyPair, _callback); - Type localVarReturnType = new TypeToken>(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - /** - * Build call for getMarketMarginTier - * @param currencyPair Currency pair (required) - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- */ - public okhttp3.Call getMarketMarginTierCall(String currencyPair, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/margin/loan_margin_tiers"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - if (currencyPair != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency_pair", currencyPair)); - } - - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - final String[] localVarAccepts = { - "application/json" - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - localVarHeaderParams.put("Content-Type", localVarContentType); - - String[] localVarAuthNames = new String[] { }; - return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @SuppressWarnings("rawtypes") - private okhttp3.Call getMarketMarginTierValidateBeforeCall(String currencyPair, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'currencyPair' is set - if (currencyPair == null) { - throw new ApiException("Missing the required parameter 'currencyPair' when calling getMarketMarginTier(Async)"); - } - - okhttp3.Call localVarCall = getMarketMarginTierCall(currencyPair, _callback); - return localVarCall; - } - - /** - * Query the current market leverage lending gradient - * - * @param currencyPair Currency pair (required) - * @return List<MarginLeverageTier> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- */ - public List getMarketMarginTier(String currencyPair) throws ApiException { - ApiResponse> localVarResp = getMarketMarginTierWithHttpInfo(currencyPair); - return localVarResp.getData(); - } - - /** - * Query the current market leverage lending gradient - * - * @param currencyPair Currency pair (required) - * @return ApiResponse<List<MarginLeverageTier>> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- */ - public ApiResponse> getMarketMarginTierWithHttpInfo(String currencyPair) throws ApiException { - okhttp3.Call localVarCall = getMarketMarginTierValidateBeforeCall(currencyPair, null); - Type localVarReturnType = new TypeToken>(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - /** - * Query the current market leverage lending gradient (asynchronously) - * - * @param currencyPair Currency pair (required) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- */ - public okhttp3.Call getMarketMarginTierAsync(String currencyPair, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = getMarketMarginTierValidateBeforeCall(currencyPair, _callback); - Type localVarReturnType = new TypeToken>(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - /** - * Build call for setUserMarketLeverage - * @param marginMarketLeverage (required) - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - -
Status Code Description Response Headers
204 Success -
- */ - public okhttp3.Call setUserMarketLeverageCall(MarginMarketLeverage marginMarketLeverage, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = marginMarketLeverage; - - // create path and map variables - String localVarPath = "/margin/leverage/user_market_setting"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - final String[] localVarAccepts = { - - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - "application/json" - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - localVarHeaderParams.put("Content-Type", localVarContentType); - - String[] localVarAuthNames = new String[] { "apiv4" }; - return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @SuppressWarnings("rawtypes") - private okhttp3.Call setUserMarketLeverageValidateBeforeCall(MarginMarketLeverage marginMarketLeverage, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'marginMarketLeverage' is set - if (marginMarketLeverage == null) { - throw new ApiException("Missing the required parameter 'marginMarketLeverage' when calling setUserMarketLeverage(Async)"); - } - - okhttp3.Call localVarCall = setUserMarketLeverageCall(marginMarketLeverage, _callback); - return localVarCall; - } - - /** - * Set the user market leverage multiple - * - * @param marginMarketLeverage (required) - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - -
Status Code Description Response Headers
204 Success -
- */ - public void setUserMarketLeverage(MarginMarketLeverage marginMarketLeverage) throws ApiException { - setUserMarketLeverageWithHttpInfo(marginMarketLeverage); - } - - /** - * Set the user market leverage multiple - * - * @param marginMarketLeverage (required) - * @return ApiResponse<Void> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - -
Status Code Description Response Headers
204 Success -
- */ - public ApiResponse setUserMarketLeverageWithHttpInfo(MarginMarketLeverage marginMarketLeverage) throws ApiException { - okhttp3.Call localVarCall = setUserMarketLeverageValidateBeforeCall(marginMarketLeverage, null); - return localVarApiClient.execute(localVarCall); - } - - /** - * Set the user market leverage multiple (asynchronously) - * - * @param marginMarketLeverage (required) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - -
Status Code Description Response Headers
204 Success -
- */ - public okhttp3.Call setUserMarketLeverageAsync(MarginMarketLeverage marginMarketLeverage, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = setUserMarketLeverageValidateBeforeCall(marginMarketLeverage, _callback); - localVarApiClient.executeAsync(localVarCall, _callback); - return localVarCall; - } - - private okhttp3.Call listMarginUserAccountCall(String currencyPair, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/margin/user/account"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - if (currencyPair != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency_pair", currencyPair)); - } - - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - final String[] localVarAccepts = { - "application/json" - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - localVarHeaderParams.put("Content-Type", localVarContentType); - - String[] localVarAuthNames = new String[] { "apiv4" }; - return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @SuppressWarnings("rawtypes") - private okhttp3.Call listMarginUserAccountValidateBeforeCall(String currencyPair, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = listMarginUserAccountCall(currencyPair, _callback); - return localVarCall; - } - - - private ApiResponse> listMarginUserAccountWithHttpInfo(String currencyPair) throws ApiException { - okhttp3.Call localVarCall = listMarginUserAccountValidateBeforeCall(currencyPair, null); - Type localVarReturnType = new TypeToken>(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - private okhttp3.Call listMarginUserAccountAsync(String currencyPair, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = listMarginUserAccountValidateBeforeCall(currencyPair, _callback); - Type localVarReturnType = new TypeToken>(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - public class APIlistMarginUserAccountRequest { - private String currencyPair; - - private APIlistMarginUserAccountRequest() { - } - - /** - * Set currencyPair - * @param currencyPair Currency pair (optional) - * @return APIlistMarginUserAccountRequest - */ - public APIlistMarginUserAccountRequest currencyPair(String currencyPair) { - this.currencyPair = currencyPair; - return this; - } - - /** - * Build call for listMarginUserAccount - * @param _callback ApiCallback API callback - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - -
Status Code Description Response Headers
200 List retrieved -
- */ - public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { - return listMarginUserAccountCall(currencyPair, _callback); - } - - /** - * Execute listMarginUserAccount request - * @return List<MarginAccount> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - -
Status Code Description Response Headers
200 List retrieved -
- */ - public List execute() throws ApiException { - ApiResponse> localVarResp = listMarginUserAccountWithHttpInfo(currencyPair); - return localVarResp.getData(); - } - - /** - * Execute listMarginUserAccount request with HTTP info returned - * @return ApiResponse<List<MarginAccount>> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - -
Status Code Description Response Headers
200 List retrieved -
- */ - public ApiResponse> executeWithHttpInfo() throws ApiException { - return listMarginUserAccountWithHttpInfo(currencyPair); - } - - /** - * Execute listMarginUserAccount request (asynchronously) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - -
Status Code Description Response Headers
200 List retrieved -
- */ - public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { - return listMarginUserAccountAsync(currencyPair, _callback); - } - } - - /** - * Query the user's leverage account list - * Support querying risk rate per position account and margin rate per position account - * @return APIlistMarginUserAccountRequest - * @http.response.details - - - -
Status Code Description Response Headers
200 List retrieved -
- */ - public APIlistMarginUserAccountRequest listMarginUserAccount() { - return new APIlistMarginUserAccountRequest(); - } - } diff --git a/src/main/java/io/gate/gateapi/api/MarginUniApi.java b/src/main/java/io/gate/gateapi/api/MarginUniApi.java index fe94879..67b72ae 100644 --- a/src/main/java/io/gate/gateapi/api/MarginUniApi.java +++ b/src/main/java/io/gate/gateapi/api/MarginUniApi.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -60,7 +60,7 @@ public void setApiClient(ApiClient apiClient) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call listUniCurrencyPairsCall(final ApiCallback _callback) throws ApiException { @@ -106,7 +106,7 @@ private okhttp3.Call listUniCurrencyPairsValidateBeforeCall(final ApiCallback _c * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List listUniCurrencyPairs() throws ApiException { @@ -122,7 +122,7 @@ public List listUniCurrencyPairs() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> listUniCurrencyPairsWithHttpInfo() throws ApiException { @@ -140,7 +140,7 @@ public ApiResponse> listUniCurrencyPairsWithHttpInfo() thr * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call listUniCurrencyPairsAsync(final ApiCallback> _callback) throws ApiException { @@ -159,7 +159,7 @@ public okhttp3.Call listUniCurrencyPairsAsync(final ApiCallback Status Code Description Response Headers - 200 Successfully retrieved - + 200 Query successful - */ public okhttp3.Call getUniCurrencyPairCall(String currencyPair, final ApiCallback _callback) throws ApiException { @@ -204,7 +204,7 @@ private okhttp3.Call getUniCurrencyPairValidateBeforeCall(String currencyPair, f } /** - * Get detail of lending market + * Get lending market details * * @param currencyPair Currency pair (required) * @return UniCurrencyPair @@ -212,7 +212,7 @@ private okhttp3.Call getUniCurrencyPairValidateBeforeCall(String currencyPair, f * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public UniCurrencyPair getUniCurrencyPair(String currencyPair) throws ApiException { @@ -221,7 +221,7 @@ public UniCurrencyPair getUniCurrencyPair(String currencyPair) throws ApiExcepti } /** - * Get detail of lending market + * Get lending market details * * @param currencyPair Currency pair (required) * @return ApiResponse<UniCurrencyPair> @@ -229,7 +229,7 @@ public UniCurrencyPair getUniCurrencyPair(String currencyPair) throws ApiExcepti * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse getUniCurrencyPairWithHttpInfo(String currencyPair) throws ApiException { @@ -239,7 +239,7 @@ public ApiResponse getUniCurrencyPairWithHttpInfo(String curren } /** - * Get detail of lending market (asynchronously) + * Get lending market details (asynchronously) * * @param currencyPair Currency pair (required) * @param _callback The callback to be executed when the API call finishes @@ -248,7 +248,7 @@ public ApiResponse getUniCurrencyPairWithHttpInfo(String curren * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getUniCurrencyPairAsync(String currencyPair, final ApiCallback _callback) throws ApiException { @@ -260,14 +260,14 @@ public okhttp3.Call getUniCurrencyPairAsync(String currencyPair, final ApiCallba /** * Build call for getMarginUniEstimateRate - * @param currencies An array of up to 10 specifying the currency name (required) + * @param currencies Array of currency names to query, maximum 10 (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getMarginUniEstimateRateCall(List currencies, final ApiCallback _callback) throws ApiException { @@ -315,15 +315,15 @@ private okhttp3.Call getMarginUniEstimateRateValidateBeforeCall(List cur } /** - * Estimate interest Rate - * 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. - * @param currencies An array of up to 10 specifying the currency name (required) + * Estimate interest rate for isolated margin currencies + * Interest rates change hourly based on lending depth, so completely accurate rates cannot be provided. + * @param currencies Array of currency names to query, maximum 10 (required) * @return Map<String, String> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public Map getMarginUniEstimateRate(List currencies) throws ApiException { @@ -332,15 +332,15 @@ public Map getMarginUniEstimateRate(List currencies) thr } /** - * Estimate interest Rate - * 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. - * @param currencies An array of up to 10 specifying the currency name (required) + * Estimate interest rate for isolated margin currencies + * Interest rates change hourly based on lending depth, so completely accurate rates cannot be provided. + * @param currencies Array of currency names to query, maximum 10 (required) * @return ApiResponse<Map<String, String>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> getMarginUniEstimateRateWithHttpInfo(List currencies) throws ApiException { @@ -350,16 +350,16 @@ public ApiResponse> getMarginUniEstimateRateWithHttpInfo(Lis } /** - * Estimate interest Rate (asynchronously) - * 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. - * @param currencies An array of up to 10 specifying the currency name (required) + * Estimate interest rate for isolated margin currencies (asynchronously) + * Interest rates change hourly based on lending depth, so completely accurate rates cannot be provided. + * @param currencies Array of currency names to query, maximum 10 (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getMarginUniEstimateRateAsync(List currencies, final ApiCallback> _callback) throws ApiException { @@ -455,7 +455,7 @@ public APIlistUniLoansRequest currencyPair(String currencyPair) { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Query by specified currency name (optional) * @return APIlistUniLoansRequest */ public APIlistUniLoansRequest currency(String currency) { @@ -475,7 +475,7 @@ public APIlistUniLoansRequest page(Integer page) { /** * Set limit - * @param limit Maximum response items. Default: 100, minimum: 1, Maximum: 100 (optional, default to 100) + * @param limit Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 (optional, default to 100) * @return APIlistUniLoansRequest */ public APIlistUniLoansRequest limit(Integer limit) { @@ -491,7 +491,7 @@ public APIlistUniLoansRequest limit(Integer limit) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -505,7 +505,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -520,7 +520,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -535,7 +535,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -544,13 +544,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) thr } /** - * List loans + * Query loans * * @return APIlistUniLoansRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIlistUniLoansRequest listUniLoans() { @@ -566,7 +566,7 @@ public APIlistUniLoansRequest listUniLoans() { * @http.response.details - +
Status Code Description Response Headers
204 Operated successfully -
204 Operation successful -
*/ public okhttp3.Call createUniLoanCall(CreateUniLoan createUniLoan, final ApiCallback _callback) throws ApiException { @@ -617,7 +617,7 @@ private okhttp3.Call createUniLoanValidateBeforeCall(CreateUniLoan createUniLoan * @http.response.details - +
Status Code Description Response Headers
204 Operated successfully -
204 Operation successful -
*/ public void createUniLoan(CreateUniLoan createUniLoan) throws ApiException { @@ -633,7 +633,7 @@ public void createUniLoan(CreateUniLoan createUniLoan) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
204 Operated successfully -
204 Operation successful -
*/ public ApiResponse createUniLoanWithHttpInfo(CreateUniLoan createUniLoan) throws ApiException { @@ -651,7 +651,7 @@ public ApiResponse createUniLoanWithHttpInfo(CreateUniLoan createUniLoan) * @http.response.details - +
Status Code Description Response Headers
204 Operated successfully -
204 Operation successful -
*/ public okhttp3.Call createUniLoanAsync(CreateUniLoan createUniLoan, final ApiCallback _callback) throws ApiException { @@ -741,7 +741,7 @@ private APIlistUniLoanRecordsRequest() { /** * Set type - * @param type type: borrow - borrow, repay - repay (optional) + * @param type Type: `borrow` - borrow, `repay` - repay (optional) * @return APIlistUniLoanRecordsRequest */ public APIlistUniLoanRecordsRequest type(String type) { @@ -751,7 +751,7 @@ public APIlistUniLoanRecordsRequest type(String type) { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Query by specified currency name (optional) * @return APIlistUniLoanRecordsRequest */ public APIlistUniLoanRecordsRequest currency(String currency) { @@ -781,7 +781,7 @@ public APIlistUniLoanRecordsRequest page(Integer page) { /** * Set limit - * @param limit Maximum response items. Default: 100, minimum: 1, Maximum: 100 (optional, default to 100) + * @param limit Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 (optional, default to 100) * @return APIlistUniLoanRecordsRequest */ public APIlistUniLoanRecordsRequest limit(Integer limit) { @@ -797,7 +797,7 @@ public APIlistUniLoanRecordsRequest limit(Integer limit) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -811,7 +811,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -826,7 +826,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -841,7 +841,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExceptio * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -850,13 +850,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callbac } /** - * Get load records + * Query loan records * * @return APIlistUniLoanRecordsRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIlistUniLoanRecordsRequest listUniLoanRecords() { @@ -959,7 +959,7 @@ public APIlistUniLoanInterestRecordsRequest currencyPair(String currencyPair) { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Query by specified currency name (optional) * @return APIlistUniLoanInterestRecordsRequest */ public APIlistUniLoanInterestRecordsRequest currency(String currency) { @@ -979,7 +979,7 @@ public APIlistUniLoanInterestRecordsRequest page(Integer page) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistUniLoanInterestRecordsRequest */ public APIlistUniLoanInterestRecordsRequest limit(Integer limit) { @@ -989,7 +989,7 @@ public APIlistUniLoanInterestRecordsRequest limit(Integer limit) { /** * Set from - * @param from Start timestamp (optional) + * @param 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) (optional) * @return APIlistUniLoanInterestRecordsRequest */ public APIlistUniLoanInterestRecordsRequest from(Long from) { @@ -999,7 +999,7 @@ public APIlistUniLoanInterestRecordsRequest from(Long from) { /** * Set to - * @param to End timestamp (optional) + * @param to Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional) * @return APIlistUniLoanInterestRecordsRequest */ public APIlistUniLoanInterestRecordsRequest to(Long to) { @@ -1015,7 +1015,7 @@ public APIlistUniLoanInterestRecordsRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1029,7 +1029,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -1044,7 +1044,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1059,7 +1059,7 @@ public ApiResponse> executeWithHttpInfo() throws Api * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1068,13 +1068,13 @@ public okhttp3.Call executeAsync(final ApiCallback> } /** - * List interest records + * Query interest deduction records * * @return APIlistUniLoanInterestRecordsRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIlistUniLoanInterestRecordsRequest listUniLoanInterestRecords() { @@ -1083,7 +1083,7 @@ public APIlistUniLoanInterestRecordsRequest listUniLoanInterestRecords() { /** * Build call for getUniBorrowable - * @param currency Retrieve data of the specified currency (required) + * @param currency Query by specified currency name (required) * @param currencyPair Currency pair (required) * @param _callback Callback for upload/download progress * @return Call to execute @@ -1091,7 +1091,7 @@ public APIlistUniLoanInterestRecordsRequest listUniLoanInterestRecords() { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getUniBorrowableCall(String currency, String currencyPair, final ApiCallback _callback) throws ApiException { @@ -1148,16 +1148,16 @@ private okhttp3.Call getUniBorrowableValidateBeforeCall(String currency, String } /** - * Get maximum borrowable + * Query maximum borrowable amount by currency * - * @param currency Retrieve data of the specified currency (required) + * @param currency Query by specified currency name (required) * @param currencyPair Currency pair (required) * @return MaxUniBorrowable * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public MaxUniBorrowable getUniBorrowable(String currency, String currencyPair) throws ApiException { @@ -1166,16 +1166,16 @@ public MaxUniBorrowable getUniBorrowable(String currency, String currencyPair) t } /** - * Get maximum borrowable + * Query maximum borrowable amount by currency * - * @param currency Retrieve data of the specified currency (required) + * @param currency Query by specified currency name (required) * @param currencyPair Currency pair (required) * @return ApiResponse<MaxUniBorrowable> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse getUniBorrowableWithHttpInfo(String currency, String currencyPair) throws ApiException { @@ -1185,9 +1185,9 @@ public ApiResponse getUniBorrowableWithHttpInfo(String currenc } /** - * Get maximum borrowable (asynchronously) + * Query maximum borrowable amount by currency (asynchronously) * - * @param currency Retrieve data of the specified currency (required) + * @param currency Query by specified currency name (required) * @param currencyPair Currency pair (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1195,7 +1195,7 @@ public ApiResponse getUniBorrowableWithHttpInfo(String currenc * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getUniBorrowableAsync(String currency, String currencyPair, final ApiCallback _callback) throws ApiException { diff --git a/src/main/java/io/gate/gateapi/api/MultiCollateralLoanApi.java b/src/main/java/io/gate/gateapi/api/MultiCollateralLoanApi.java index 2498e2c..0dee912 100644 --- a/src/main/java/io/gate/gateapi/api/MultiCollateralLoanApi.java +++ b/src/main/java/io/gate/gateapi/api/MultiCollateralLoanApi.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -146,7 +146,7 @@ public APIlistMultiCollateralOrdersRequest page(Integer page) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 10) + * @param limit Maximum number of records returned in a single list (optional, default to 10) * @return APIlistMultiCollateralOrdersRequest */ public APIlistMultiCollateralOrdersRequest limit(Integer limit) { @@ -156,7 +156,7 @@ public APIlistMultiCollateralOrdersRequest limit(Integer limit) { /** * Set sort - * @param sort Sort types: time_desc - default sorting by creation time in descending order, ltv_asc - ascending order of ltv, ltv_desc - descending order of ltv. (optional) + * @param sort Sort type: `time_desc` - Created time descending (default), `ltv_asc` - Collateral ratio ascending, `ltv_desc` - Collateral ratio descending. (optional) * @return APIlistMultiCollateralOrdersRequest */ public APIlistMultiCollateralOrdersRequest sort(String sort) { @@ -166,7 +166,7 @@ public APIlistMultiCollateralOrdersRequest sort(String sort) { /** * Set orderType - * @param orderType Order type, current - query current orders, fixed - query fixed orders. If not specified, default to querying current orders (optional) + * @param orderType Order type: current - Query current orders, fixed - Query fixed orders, defaults to current orders if not specified (optional) * @return APIlistMultiCollateralOrdersRequest */ public APIlistMultiCollateralOrdersRequest orderType(String orderType) { @@ -182,7 +182,7 @@ public APIlistMultiCollateralOrdersRequest orderType(String orderType) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -196,7 +196,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -211,7 +211,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -226,7 +226,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiE * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -235,13 +235,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _ } /** - * List Multi-Collateral Orders + * Query multi-currency collateral order list * * @return APIlistMultiCollateralOrdersRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistMultiCollateralOrdersRequest listMultiCollateralOrders() { @@ -257,7 +257,7 @@ public APIlistMultiCollateralOrdersRequest listMultiCollateralOrders() { * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Order placed successfully -
*/ public okhttp3.Call createMultiCollateralCall(CreateMultiCollateralOrder createMultiCollateralOrder, final ApiCallback _callback) throws ApiException { @@ -301,7 +301,7 @@ private okhttp3.Call createMultiCollateralValidateBeforeCall(CreateMultiCollater } /** - * Create Multi-Collateral Order + * Place multi-currency collateral order * * @param createMultiCollateralOrder (required) * @return OrderResp @@ -309,7 +309,7 @@ private okhttp3.Call createMultiCollateralValidateBeforeCall(CreateMultiCollater * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Order placed successfully -
*/ public OrderResp createMultiCollateral(CreateMultiCollateralOrder createMultiCollateralOrder) throws ApiException { @@ -318,7 +318,7 @@ public OrderResp createMultiCollateral(CreateMultiCollateralOrder createMultiCol } /** - * Create Multi-Collateral Order + * Place multi-currency collateral order * * @param createMultiCollateralOrder (required) * @return ApiResponse<OrderResp> @@ -326,7 +326,7 @@ public OrderResp createMultiCollateral(CreateMultiCollateralOrder createMultiCol * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Order placed successfully -
*/ public ApiResponse createMultiCollateralWithHttpInfo(CreateMultiCollateralOrder createMultiCollateralOrder) throws ApiException { @@ -336,7 +336,7 @@ public ApiResponse createMultiCollateralWithHttpInfo(CreateMultiColla } /** - * Create Multi-Collateral Order (asynchronously) + * Place multi-currency collateral order (asynchronously) * * @param createMultiCollateralOrder (required) * @param _callback The callback to be executed when the API call finishes @@ -345,7 +345,7 @@ public ApiResponse createMultiCollateralWithHttpInfo(CreateMultiColla * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Order placed successfully -
*/ public okhttp3.Call createMultiCollateralAsync(CreateMultiCollateralOrder createMultiCollateralOrder, final ApiCallback _callback) throws ApiException { @@ -357,14 +357,14 @@ public okhttp3.Call createMultiCollateralAsync(CreateMultiCollateralOrder create /** * Build call for getMultiCollateralOrderDetail - * @param orderId Order ID returned on successful order creation (required) + * @param orderId Order ID returned when order is successfully created (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Order details queried successfully -
*/ public okhttp3.Call getMultiCollateralOrderDetailCall(String orderId, final ApiCallback _callback) throws ApiException { @@ -409,15 +409,15 @@ private okhttp3.Call getMultiCollateralOrderDetailValidateBeforeCall(String orde } /** - * Get Multi-Collateral Order Detail + * Query order details * - * @param orderId Order ID returned on successful order creation (required) + * @param orderId Order ID returned when order is successfully created (required) * @return MultiCollateralOrder * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Order details queried successfully -
*/ public MultiCollateralOrder getMultiCollateralOrderDetail(String orderId) throws ApiException { @@ -426,15 +426,15 @@ public MultiCollateralOrder getMultiCollateralOrderDetail(String orderId) throws } /** - * Get Multi-Collateral Order Detail + * Query order details * - * @param orderId Order ID returned on successful order creation (required) + * @param orderId Order ID returned when order is successfully created (required) * @return ApiResponse<MultiCollateralOrder> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Order details queried successfully -
*/ public ApiResponse getMultiCollateralOrderDetailWithHttpInfo(String orderId) throws ApiException { @@ -444,16 +444,16 @@ public ApiResponse getMultiCollateralOrderDetailWithHttpIn } /** - * Get Multi-Collateral Order Detail (asynchronously) + * Query order details (asynchronously) * - * @param orderId Order ID returned on successful order creation (required) + * @param orderId Order ID returned when order is successfully created (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Order details queried successfully -
*/ public okhttp3.Call getMultiCollateralOrderDetailAsync(String orderId, final ApiCallback _callback) throws ApiException { @@ -575,7 +575,7 @@ public APIlistMultiRepayRecordsRequest page(Integer page) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 10) + * @param limit Maximum number of records returned in a single list (optional, default to 10) * @return APIlistMultiRepayRecordsRequest */ public APIlistMultiRepayRecordsRequest limit(Integer limit) { @@ -585,7 +585,7 @@ public APIlistMultiRepayRecordsRequest limit(Integer limit) { /** * Set from - * @param from Start timestamp of the query (optional) + * @param from Start timestamp for the query (optional) * @return APIlistMultiRepayRecordsRequest */ public APIlistMultiRepayRecordsRequest from(Long from) { @@ -595,7 +595,7 @@ public APIlistMultiRepayRecordsRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to End timestamp for the query, defaults to current time if not specified (optional) * @return APIlistMultiRepayRecordsRequest */ public APIlistMultiRepayRecordsRequest to(Long to) { @@ -611,7 +611,7 @@ public APIlistMultiRepayRecordsRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -625,7 +625,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -640,7 +640,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -655,7 +655,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcep * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -664,14 +664,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _call } /** - * List Multi-Collateral Repay Records + * Query multi-currency collateral repayment records * * @param type Operation type: repay - Regular repayment, liquidate - Liquidation (required) * @return APIlistMultiRepayRecordsRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIlistMultiRepayRecordsRequest listMultiRepayRecords(String type) { @@ -687,7 +687,7 @@ public APIlistMultiRepayRecordsRequest listMultiRepayRecords(String type) { * @http.response.details - +
Status Code Description Response Headers
200 Operated successfully -
200 Operation successful -
*/ public okhttp3.Call repayMultiCollateralLoanCall(RepayMultiLoan repayMultiLoan, final ApiCallback _callback) throws ApiException { @@ -731,7 +731,7 @@ private okhttp3.Call repayMultiCollateralLoanValidateBeforeCall(RepayMultiLoan r } /** - * Repay Multi-Collateral Loan + * Multi-currency collateral repayment * * @param repayMultiLoan (required) * @return MultiRepayResp @@ -739,7 +739,7 @@ private okhttp3.Call repayMultiCollateralLoanValidateBeforeCall(RepayMultiLoan r * @http.response.details - +
Status Code Description Response Headers
200 Operated successfully -
200 Operation successful -
*/ public MultiRepayResp repayMultiCollateralLoan(RepayMultiLoan repayMultiLoan) throws ApiException { @@ -748,7 +748,7 @@ public MultiRepayResp repayMultiCollateralLoan(RepayMultiLoan repayMultiLoan) th } /** - * Repay Multi-Collateral Loan + * Multi-currency collateral repayment * * @param repayMultiLoan (required) * @return ApiResponse<MultiRepayResp> @@ -756,7 +756,7 @@ public MultiRepayResp repayMultiCollateralLoan(RepayMultiLoan repayMultiLoan) th * @http.response.details - +
Status Code Description Response Headers
200 Operated successfully -
200 Operation successful -
*/ public ApiResponse repayMultiCollateralLoanWithHttpInfo(RepayMultiLoan repayMultiLoan) throws ApiException { @@ -766,7 +766,7 @@ public ApiResponse repayMultiCollateralLoanWithHttpInfo(RepayMul } /** - * Repay Multi-Collateral Loan (asynchronously) + * Multi-currency collateral repayment (asynchronously) * * @param repayMultiLoan (required) * @param _callback The callback to be executed when the API call finishes @@ -775,7 +775,7 @@ public ApiResponse repayMultiCollateralLoanWithHttpInfo(RepayMul * @http.response.details - +
Status Code Description Response Headers
200 Operated successfully -
200 Operation successful -
*/ public okhttp3.Call repayMultiCollateralLoanAsync(RepayMultiLoan repayMultiLoan, final ApiCallback _callback) throws ApiException { @@ -876,7 +876,7 @@ public APIlistMultiCollateralRecordsRequest page(Integer page) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 10) + * @param limit Maximum number of records returned in a single list (optional, default to 10) * @return APIlistMultiCollateralRecordsRequest */ public APIlistMultiCollateralRecordsRequest limit(Integer limit) { @@ -886,7 +886,7 @@ public APIlistMultiCollateralRecordsRequest limit(Integer limit) { /** * Set from - * @param from Start timestamp of the query (optional) + * @param from Start timestamp for the query (optional) * @return APIlistMultiCollateralRecordsRequest */ public APIlistMultiCollateralRecordsRequest from(Long from) { @@ -896,7 +896,7 @@ public APIlistMultiCollateralRecordsRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to End timestamp for the query, defaults to current time if not specified (optional) * @return APIlistMultiCollateralRecordsRequest */ public APIlistMultiCollateralRecordsRequest to(Long to) { @@ -906,7 +906,7 @@ public APIlistMultiCollateralRecordsRequest to(Long to) { /** * Set collateralCurrency - * @param collateralCurrency Collateral (optional) + * @param collateralCurrency Collateral currency (optional) * @return APIlistMultiCollateralRecordsRequest */ public APIlistMultiCollateralRecordsRequest collateralCurrency(String collateralCurrency) { @@ -922,7 +922,7 @@ public APIlistMultiCollateralRecordsRequest collateralCurrency(String collateral * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -936,7 +936,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -951,7 +951,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -966,7 +966,7 @@ public ApiResponse> executeWithHttpInfo() throws Api * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -981,7 +981,7 @@ public okhttp3.Call executeAsync(final ApiCallback> * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistMultiCollateralRecordsRequest listMultiCollateralRecords() { @@ -997,7 +997,7 @@ public APIlistMultiCollateralRecordsRequest listMultiCollateralRecords() { * @http.response.details - +
Status Code Description Response Headers
200 Operated successfully -
200 Operation successful -
*/ public okhttp3.Call operateMultiCollateralCall(CollateralAdjust collateralAdjust, final ApiCallback _callback) throws ApiException { @@ -1041,7 +1041,7 @@ private okhttp3.Call operateMultiCollateralValidateBeforeCall(CollateralAdjust c } /** - * Operate Multi-Collateral + * Add or withdraw collateral * * @param collateralAdjust (required) * @return CollateralAdjustRes @@ -1049,7 +1049,7 @@ private okhttp3.Call operateMultiCollateralValidateBeforeCall(CollateralAdjust c * @http.response.details - +
Status Code Description Response Headers
200 Operated successfully -
200 Operation successful -
*/ public CollateralAdjustRes operateMultiCollateral(CollateralAdjust collateralAdjust) throws ApiException { @@ -1058,7 +1058,7 @@ public CollateralAdjustRes operateMultiCollateral(CollateralAdjust collateralAdj } /** - * Operate Multi-Collateral + * Add or withdraw collateral * * @param collateralAdjust (required) * @return ApiResponse<CollateralAdjustRes> @@ -1066,7 +1066,7 @@ public CollateralAdjustRes operateMultiCollateral(CollateralAdjust collateralAdj * @http.response.details - +
Status Code Description Response Headers
200 Operated successfully -
200 Operation successful -
*/ public ApiResponse operateMultiCollateralWithHttpInfo(CollateralAdjust collateralAdjust) throws ApiException { @@ -1076,7 +1076,7 @@ public ApiResponse operateMultiCollateralWithHttpInfo(Colla } /** - * Operate Multi-Collateral (asynchronously) + * Add or withdraw collateral (asynchronously) * * @param collateralAdjust (required) * @param _callback The callback to be executed when the API call finishes @@ -1085,7 +1085,7 @@ public ApiResponse operateMultiCollateralWithHttpInfo(Colla * @http.response.details - +
Status Code Description Response Headers
200 Operated successfully -
200 Operation successful -
*/ public okhttp3.Call operateMultiCollateralAsync(CollateralAdjust collateralAdjust, final ApiCallback _callback) throws ApiException { @@ -1097,15 +1097,15 @@ public okhttp3.Call operateMultiCollateralAsync(CollateralAdjust collateralAdjus /** * Build call for listUserCurrencyQuota - * @param type Currency types: collateral - collateral currency, borrow - borrowing currency. (required) - * @param currency When specifying collateral currencies, you can use commas to separate multiple currencies; for borrowing currencies, only one currency can be provided. (required) + * @param type Currency type: collateral - Collateral currency, borrow - Borrowing currency (required) + * @param 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 _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call listUserCurrencyQuotaCall(String type, String currency, final ApiCallback _callback) throws ApiException { @@ -1162,16 +1162,16 @@ private okhttp3.Call listUserCurrencyQuotaValidateBeforeCall(String type, String } /** - * List User Currency Quota + * Query user's collateral and borrowing currency quota information * - * @param type Currency types: collateral - collateral currency, borrow - borrowing currency. (required) - * @param currency When specifying collateral currencies, you can use commas to separate multiple currencies; for borrowing currencies, only one currency can be provided. (required) + * @param type Currency type: collateral - Collateral currency, borrow - Borrowing currency (required) + * @param 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) * @return List<CurrencyQuota> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List listUserCurrencyQuota(String type, String currency) throws ApiException { @@ -1180,16 +1180,16 @@ public List listUserCurrencyQuota(String type, String currency) t } /** - * List User Currency Quota + * Query user's collateral and borrowing currency quota information * - * @param type Currency types: collateral - collateral currency, borrow - borrowing currency. (required) - * @param currency When specifying collateral currencies, you can use commas to separate multiple currencies; for borrowing currencies, only one currency can be provided. (required) + * @param type Currency type: collateral - Collateral currency, borrow - Borrowing currency (required) + * @param 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) * @return ApiResponse<List<CurrencyQuota>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> listUserCurrencyQuotaWithHttpInfo(String type, String currency) throws ApiException { @@ -1199,17 +1199,17 @@ public ApiResponse> listUserCurrencyQuotaWithHttpInfo(String } /** - * List User Currency Quota (asynchronously) + * Query user's collateral and borrowing currency quota information (asynchronously) * - * @param type Currency types: collateral - collateral currency, borrow - borrowing currency. (required) - * @param currency When specifying collateral currencies, you can use commas to separate multiple currencies; for borrowing currencies, only one currency can be provided. (required) + * @param type Currency type: collateral - Collateral currency, borrow - Borrowing currency (required) + * @param 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 _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call listUserCurrencyQuotaAsync(String type, String currency, final ApiCallback> _callback) throws ApiException { @@ -1227,7 +1227,7 @@ public okhttp3.Call listUserCurrencyQuotaAsync(String type, String currency, fin * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call listMultiCollateralCurrenciesCall(final ApiCallback _callback) throws ApiException { @@ -1266,14 +1266,14 @@ private okhttp3.Call listMultiCollateralCurrenciesValidateBeforeCall(final ApiCa } /** - * Query supported borrowing and collateral currencies in Multi-Collateral + * Query supported borrowing and collateral currencies for multi-currency collateral * * @return MultiCollateralCurrency * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public MultiCollateralCurrency listMultiCollateralCurrencies() throws ApiException { @@ -1282,14 +1282,14 @@ public MultiCollateralCurrency listMultiCollateralCurrencies() throws ApiExcepti } /** - * Query supported borrowing and collateral currencies in Multi-Collateral + * Query supported borrowing and collateral currencies for multi-currency collateral * * @return ApiResponse<MultiCollateralCurrency> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse listMultiCollateralCurrenciesWithHttpInfo() throws ApiException { @@ -1299,7 +1299,7 @@ public ApiResponse listMultiCollateralCurrenciesWithHtt } /** - * Query supported borrowing and collateral currencies in Multi-Collateral (asynchronously) + * Query supported borrowing and collateral currencies for multi-currency collateral (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1307,7 +1307,7 @@ public ApiResponse listMultiCollateralCurrenciesWithHtt * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call listMultiCollateralCurrenciesAsync(final ApiCallback _callback) throws ApiException { @@ -1325,7 +1325,7 @@ public okhttp3.Call listMultiCollateralCurrenciesAsync(final ApiCallback Status Code Description Response Headers - 200 Successfully retrieved - + 200 Query successful - */ public okhttp3.Call getMultiCollateralLtvCall(final ApiCallback _callback) throws ApiException { @@ -1364,14 +1364,14 @@ private okhttp3.Call getMultiCollateralLtvValidateBeforeCall(final ApiCallback _ } /** - * Get Multi-Collateral ratio - * The Multi-Collateral ratio is fixed, irrespective of the currency. + * Query collateralization ratio information + * Multi-currency collateral ratio is fixed, independent of currency * @return CollateralLtv * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public CollateralLtv getMultiCollateralLtv() throws ApiException { @@ -1380,14 +1380,14 @@ public CollateralLtv getMultiCollateralLtv() throws ApiException { } /** - * Get Multi-Collateral ratio - * The Multi-Collateral ratio is fixed, irrespective of the currency. + * Query collateralization ratio information + * Multi-currency collateral ratio is fixed, independent of currency * @return ApiResponse<CollateralLtv> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse getMultiCollateralLtvWithHttpInfo() throws ApiException { @@ -1397,15 +1397,15 @@ public ApiResponse getMultiCollateralLtvWithHttpInfo() throws Api } /** - * Get Multi-Collateral ratio (asynchronously) - * The Multi-Collateral ratio is fixed, irrespective of the currency. + * Query collateralization ratio information (asynchronously) + * Multi-currency collateral ratio is fixed, independent of currency * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getMultiCollateralLtvAsync(final ApiCallback _callback) throws ApiException { @@ -1423,7 +1423,7 @@ public okhttp3.Call getMultiCollateralLtvAsync(final ApiCallback * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getMultiCollateralFixRateCall(final ApiCallback _callback) throws ApiException { @@ -1462,14 +1462,14 @@ private okhttp3.Call getMultiCollateralFixRateValidateBeforeCall(final ApiCallba } /** - * Query fixed interest rates for the currency for 7 days and 30 days + * Query currency's 7-day and 30-day fixed interest rates * * @return List<CollateralFixRate> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List getMultiCollateralFixRate() throws ApiException { @@ -1478,14 +1478,14 @@ public List getMultiCollateralFixRate() throws ApiException { } /** - * Query fixed interest rates for the currency for 7 days and 30 days + * Query currency's 7-day and 30-day fixed interest rates * * @return ApiResponse<List<CollateralFixRate>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> getMultiCollateralFixRateWithHttpInfo() throws ApiException { @@ -1495,7 +1495,7 @@ public ApiResponse> getMultiCollateralFixRateWithHttpInf } /** - * Query fixed interest rates for the currency for 7 days and 30 days (asynchronously) + * Query currency's 7-day and 30-day fixed interest rates (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1503,7 +1503,7 @@ public ApiResponse> getMultiCollateralFixRateWithHttpInf * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getMultiCollateralFixRateAsync(final ApiCallback> _callback) throws ApiException { @@ -1585,7 +1585,7 @@ private APIgetMultiCollateralCurrentRateRequest(List currencies) { /** * Set vipLevel - * @param vipLevel VIP level, defaults to 0 if not transferred (optional, default to "0") + * @param vipLevel VIP level, defaults to 0 if not specified (optional, default to "0") * @return APIgetMultiCollateralCurrentRateRequest */ public APIgetMultiCollateralCurrentRateRequest vipLevel(String vipLevel) { @@ -1601,7 +1601,7 @@ public APIgetMultiCollateralCurrentRateRequest vipLevel(String vipLevel) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1615,7 +1615,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -1630,7 +1630,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1645,7 +1645,7 @@ public ApiResponse> executeWithHttpInfo() throws Api * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1654,14 +1654,14 @@ public okhttp3.Call executeAsync(final ApiCallback> } /** - * Query the current interest rate of the currency - * Query the current interest rate of the currency in the last hour. The current interest rate is updated every hour. - * @param currencies Specify the currency name to query the array. The array is separated by commas and has a maximum of 100 items. (required) + * Query currency's current interest rate + * Query currency's current interest rate for the previous hour, current interest rate updates hourly + * @param currencies Specify currency name query array, separated by commas, maximum 100 items (required) * @return APIgetMultiCollateralCurrentRateRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIgetMultiCollateralCurrentRateRequest getMultiCollateralCurrentRate(List currencies) { diff --git a/src/main/java/io/gate/gateapi/api/OptionsApi.java b/src/main/java/io/gate/gateapi/api/OptionsApi.java index bf72060..538f7f5 100644 --- a/src/main/java/io/gate/gateapi/api/OptionsApi.java +++ b/src/main/java/io/gate/gateapi/api/OptionsApi.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -74,7 +74,7 @@ public void setApiClient(ApiClient apiClient) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call listOptionsUnderlyingsCall(final ApiCallback _callback) throws ApiException { @@ -113,14 +113,14 @@ private okhttp3.Call listOptionsUnderlyingsValidateBeforeCall(final ApiCallback } /** - * List all underlyings + * List all underlying assets * * @return List<OptionsUnderlying> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List listOptionsUnderlyings() throws ApiException { @@ -129,14 +129,14 @@ public List listOptionsUnderlyings() throws ApiException { } /** - * List all underlyings + * List all underlying assets * * @return ApiResponse<List<OptionsUnderlying>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> listOptionsUnderlyingsWithHttpInfo() throws ApiException { @@ -146,7 +146,7 @@ public ApiResponse> listOptionsUnderlyingsWithHttpInfo() } /** - * List all underlyings (asynchronously) + * List all underlying assets (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -154,7 +154,7 @@ public ApiResponse> listOptionsUnderlyingsWithHttpInfo() * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call listOptionsUnderlyingsAsync(final ApiCallback> _callback) throws ApiException { @@ -173,7 +173,7 @@ public okhttp3.Call listOptionsUnderlyingsAsync(final ApiCallback Status Code Description Response Headers - 200 List expiration times of specified underlying - + 200 List expiration dates for specified underlying - */ public okhttp3.Call listOptionsExpirationsCall(String underlying, final ApiCallback _callback) throws ApiException { @@ -221,7 +221,7 @@ private okhttp3.Call listOptionsExpirationsValidateBeforeCall(String underlying, } /** - * List all expiration times + * List all expiration dates * * @param underlying Underlying (Obtained by listing underlying endpoint) (required) * @return List<Long> @@ -229,7 +229,7 @@ private okhttp3.Call listOptionsExpirationsValidateBeforeCall(String underlying, * @http.response.details - +
Status Code Description Response Headers
200 List expiration times of specified underlying -
200 List expiration dates for specified underlying -
*/ public List listOptionsExpirations(String underlying) throws ApiException { @@ -238,7 +238,7 @@ public List listOptionsExpirations(String underlying) throws ApiException } /** - * List all expiration times + * List all expiration dates * * @param underlying Underlying (Obtained by listing underlying endpoint) (required) * @return ApiResponse<List<Long>> @@ -246,7 +246,7 @@ public List listOptionsExpirations(String underlying) throws ApiException * @http.response.details - +
Status Code Description Response Headers
200 List expiration times of specified underlying -
200 List expiration dates for specified underlying -
*/ public ApiResponse> listOptionsExpirationsWithHttpInfo(String underlying) throws ApiException { @@ -256,7 +256,7 @@ public ApiResponse> listOptionsExpirationsWithHttpInfo(String underly } /** - * List all expiration times (asynchronously) + * List all expiration dates (asynchronously) * * @param underlying Underlying (Obtained by listing underlying endpoint) (required) * @param _callback The callback to be executed when the API call finishes @@ -265,7 +265,7 @@ public ApiResponse> listOptionsExpirationsWithHttpInfo(String underly * @http.response.details - +
Status Code Description Response Headers
200 List expiration times of specified underlying -
200 List expiration dates for specified underlying -
*/ public okhttp3.Call listOptionsExpirationsAsync(String underlying, final ApiCallback> _callback) throws ApiException { @@ -347,7 +347,7 @@ private APIlistOptionsContractsRequest(String underlying) { /** * Set expiration - * @param expiration Unix timestamp of the expiration time (optional) + * @param expiration Unix timestamp of expiration date (optional) * @return APIlistOptionsContractsRequest */ public APIlistOptionsContractsRequest expiration(Long expiration) { @@ -363,7 +363,7 @@ public APIlistOptionsContractsRequest expiration(Long expiration) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -377,7 +377,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -392,7 +392,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -407,7 +407,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcept * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -416,14 +416,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callb } /** - * List all the contracts with specified underlying and expiration time + * List all contracts for specified underlying and expiration date * * @param underlying Underlying (Obtained by listing underlying endpoint) (required) * @return APIlistOptionsContractsRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistOptionsContractsRequest listOptionsContracts(String underlying) { @@ -439,7 +439,7 @@ public APIlistOptionsContractsRequest listOptionsContracts(String underlying) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getOptionsContractCall(String contract, final ApiCallback _callback) throws ApiException { @@ -484,7 +484,7 @@ private okhttp3.Call getOptionsContractValidateBeforeCall(String contract, final } /** - * Query specified contract detail + * Query specified contract details * * @param contract (required) * @return OptionsContract @@ -492,7 +492,7 @@ private okhttp3.Call getOptionsContractValidateBeforeCall(String contract, final * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public OptionsContract getOptionsContract(String contract) throws ApiException { @@ -501,7 +501,7 @@ public OptionsContract getOptionsContract(String contract) throws ApiException { } /** - * Query specified contract detail + * Query specified contract details * * @param contract (required) * @return ApiResponse<OptionsContract> @@ -509,7 +509,7 @@ public OptionsContract getOptionsContract(String contract) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse getOptionsContractWithHttpInfo(String contract) throws ApiException { @@ -519,7 +519,7 @@ public ApiResponse getOptionsContractWithHttpInfo(String contra } /** - * Query specified contract detail (asynchronously) + * Query specified contract details (asynchronously) * * @param contract (required) * @param _callback The callback to be executed when the API call finishes @@ -528,7 +528,7 @@ public ApiResponse getOptionsContractWithHttpInfo(String contra * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getOptionsContractAsync(String contract, final ApiCallback _callback) throws ApiException { @@ -625,7 +625,7 @@ private APIlistOptionsSettlementsRequest(String underlying) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistOptionsSettlementsRequest */ public APIlistOptionsSettlementsRequest limit(Integer limit) { @@ -645,7 +645,7 @@ public APIlistOptionsSettlementsRequest offset(Integer offset) { /** * Set from - * @param from Start timestamp (optional) + * @param 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) (optional) * @return APIlistOptionsSettlementsRequest */ public APIlistOptionsSettlementsRequest from(Long from) { @@ -655,7 +655,7 @@ public APIlistOptionsSettlementsRequest from(Long from) { /** * Set to - * @param to End timestamp (optional) + * @param to Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional) * @return APIlistOptionsSettlementsRequest */ public APIlistOptionsSettlementsRequest to(Long to) { @@ -671,7 +671,7 @@ public APIlistOptionsSettlementsRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -685,7 +685,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -700,7 +700,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -715,7 +715,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExce * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -731,7 +731,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _cal * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistOptionsSettlementsRequest listOptionsSettlements(String underlying) { @@ -749,7 +749,7 @@ public APIlistOptionsSettlementsRequest listOptionsSettlements(String underlying * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getOptionsSettlementCall(String contract, String underlying, Long at, final ApiCallback _callback) throws ApiException { @@ -812,7 +812,7 @@ private okhttp3.Call getOptionsSettlementValidateBeforeCall(String contract, Str } /** - * Get specified contract's settlement + * Get specified contract settlement information * * @param contract (required) * @param underlying Underlying (Obtained by listing underlying endpoint) (required) @@ -822,7 +822,7 @@ private okhttp3.Call getOptionsSettlementValidateBeforeCall(String contract, Str * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public OptionsSettlement getOptionsSettlement(String contract, String underlying, Long at) throws ApiException { @@ -831,7 +831,7 @@ public OptionsSettlement getOptionsSettlement(String contract, String underlying } /** - * Get specified contract's settlement + * Get specified contract settlement information * * @param contract (required) * @param underlying Underlying (Obtained by listing underlying endpoint) (required) @@ -841,7 +841,7 @@ public OptionsSettlement getOptionsSettlement(String contract, String underlying * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse getOptionsSettlementWithHttpInfo(String contract, String underlying, Long at) throws ApiException { @@ -851,7 +851,7 @@ public ApiResponse getOptionsSettlementWithHttpInfo(String co } /** - * Get specified contract's settlement (asynchronously) + * Get specified contract settlement information (asynchronously) * * @param contract (required) * @param underlying Underlying (Obtained by listing underlying endpoint) (required) @@ -862,7 +862,7 @@ public ApiResponse getOptionsSettlementWithHttpInfo(String co * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getOptionsSettlementAsync(String contract, String underlying, Long at, final ApiCallback _callback) throws ApiException { @@ -974,7 +974,7 @@ public APIlistMyOptionsSettlementsRequest contract(String contract) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistMyOptionsSettlementsRequest */ public APIlistMyOptionsSettlementsRequest limit(Integer limit) { @@ -994,7 +994,7 @@ public APIlistMyOptionsSettlementsRequest offset(Integer offset) { /** * Set from - * @param from Start timestamp (optional) + * @param 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) (optional) * @return APIlistMyOptionsSettlementsRequest */ public APIlistMyOptionsSettlementsRequest from(Long from) { @@ -1004,7 +1004,7 @@ public APIlistMyOptionsSettlementsRequest from(Long from) { /** * Set to - * @param to End timestamp (optional) + * @param to Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional) * @return APIlistMyOptionsSettlementsRequest */ public APIlistMyOptionsSettlementsRequest to(Long to) { @@ -1020,7 +1020,7 @@ public APIlistMyOptionsSettlementsRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1034,7 +1034,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -1049,7 +1049,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1064,7 +1064,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiE * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1073,14 +1073,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _ } /** - * List my options settlements + * Query personal settlement records * * @param underlying Underlying (Obtained by listing underlying endpoint) (required) * @return APIlistMyOptionsSettlementsRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistMyOptionsSettlementsRequest listMyOptionsSettlements(String underlying) { @@ -1169,7 +1169,7 @@ private APIlistOptionsOrderBookRequest(String contract) { /** * Set interval - * @param interval Order depth. 0 means no aggregation is applied. default to 0 (optional, default to 0) + * @param interval Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified (optional, default to 0) * @return APIlistOptionsOrderBookRequest */ public APIlistOptionsOrderBookRequest interval(String interval) { @@ -1179,7 +1179,7 @@ public APIlistOptionsOrderBookRequest interval(String interval) { /** * Set limit - * @param limit Maximum number of order depth data in asks or bids (optional, default to 10) + * @param limit Number of depth levels (optional, default to 10) * @return APIlistOptionsOrderBookRequest */ public APIlistOptionsOrderBookRequest limit(Integer limit) { @@ -1189,7 +1189,7 @@ public APIlistOptionsOrderBookRequest limit(Integer limit) { /** * Set withId - * @param withId Whether the order book update ID will be returned. This ID increases by 1 on every order book update (optional, default to false) + * @param withId Whether to return depth update ID. This ID increments by 1 each time depth changes (optional, default to false) * @return APIlistOptionsOrderBookRequest */ public APIlistOptionsOrderBookRequest withId(Boolean withId) { @@ -1205,7 +1205,7 @@ public APIlistOptionsOrderBookRequest withId(Boolean withId) { * @http.response.details - +
Status Code Description Response Headers
200 Order book retrieved -
200 Depth query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1219,7 +1219,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Order book retrieved -
200 Depth query successful -
*/ public FuturesOrderBook execute() throws ApiException { @@ -1234,7 +1234,7 @@ public FuturesOrderBook execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Order book retrieved -
200 Depth query successful -
*/ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -1249,7 +1249,7 @@ public ApiResponse executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Order book retrieved -
200 Depth query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -1258,14 +1258,14 @@ public okhttp3.Call executeAsync(final ApiCallback _callback) } /** - * Options order book + * Query options contract order book * Bids will be sorted by price from high to low, while asks sorted reversely * @param contract Options contract name (required) * @return APIlistOptionsOrderBookRequest * @http.response.details - +
Status Code Description Response Headers
200 Order book retrieved -
200 Depth query successful -
*/ public APIlistOptionsOrderBookRequest listOptionsOrderBook(String contract) { @@ -1281,7 +1281,7 @@ public APIlistOptionsOrderBookRequest listOptionsOrderBook(String contract) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call listOptionsTickersCall(String underlying, final ApiCallback _callback) throws ApiException { @@ -1329,7 +1329,7 @@ private okhttp3.Call listOptionsTickersValidateBeforeCall(String underlying, fin } /** - * List tickers of options contracts + * Query options market ticker information * * @param underlying Underlying (Obtained by listing underlying endpoint) (required) * @return List<OptionsTicker> @@ -1337,7 +1337,7 @@ private okhttp3.Call listOptionsTickersValidateBeforeCall(String underlying, fin * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List listOptionsTickers(String underlying) throws ApiException { @@ -1346,7 +1346,7 @@ public List listOptionsTickers(String underlying) throws ApiExcep } /** - * List tickers of options contracts + * Query options market ticker information * * @param underlying Underlying (Obtained by listing underlying endpoint) (required) * @return ApiResponse<List<OptionsTicker>> @@ -1354,7 +1354,7 @@ public List listOptionsTickers(String underlying) throws ApiExcep * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> listOptionsTickersWithHttpInfo(String underlying) throws ApiException { @@ -1364,7 +1364,7 @@ public ApiResponse> listOptionsTickersWithHttpInfo(String un } /** - * List tickers of options contracts (asynchronously) + * Query options market ticker information (asynchronously) * * @param underlying Underlying (Obtained by listing underlying endpoint) (required) * @param _callback The callback to be executed when the API call finishes @@ -1373,7 +1373,7 @@ public ApiResponse> listOptionsTickersWithHttpInfo(String un * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call listOptionsTickersAsync(String underlying, final ApiCallback> _callback) throws ApiException { @@ -1392,7 +1392,7 @@ public okhttp3.Call listOptionsTickersAsync(String underlying, final ApiCallback * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call listOptionsUnderlyingTickersCall(String underlying, final ApiCallback _callback) throws ApiException { @@ -1437,7 +1437,7 @@ private okhttp3.Call listOptionsUnderlyingTickersValidateBeforeCall(String under } /** - * Get underlying ticker + * Query underlying ticker information * * @param underlying Underlying (required) * @return OptionsUnderlyingTicker @@ -1445,7 +1445,7 @@ private okhttp3.Call listOptionsUnderlyingTickersValidateBeforeCall(String under * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public OptionsUnderlyingTicker listOptionsUnderlyingTickers(String underlying) throws ApiException { @@ -1454,7 +1454,7 @@ public OptionsUnderlyingTicker listOptionsUnderlyingTickers(String underlying) t } /** - * Get underlying ticker + * Query underlying ticker information * * @param underlying Underlying (required) * @return ApiResponse<OptionsUnderlyingTicker> @@ -1462,7 +1462,7 @@ public OptionsUnderlyingTicker listOptionsUnderlyingTickers(String underlying) t * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse listOptionsUnderlyingTickersWithHttpInfo(String underlying) throws ApiException { @@ -1472,7 +1472,7 @@ public ApiResponse listOptionsUnderlyingTickersWithHttp } /** - * Get underlying ticker (asynchronously) + * Query underlying ticker information (asynchronously) * * @param underlying Underlying (required) * @param _callback The callback to be executed when the API call finishes @@ -1481,7 +1481,7 @@ public ApiResponse listOptionsUnderlyingTickersWithHttp * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call listOptionsUnderlyingTickersAsync(String underlying, final ApiCallback _callback) throws ApiException { @@ -1578,7 +1578,7 @@ private APIlistOptionsCandlesticksRequest(String contract) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistOptionsCandlesticksRequest */ public APIlistOptionsCandlesticksRequest limit(Integer limit) { @@ -1588,7 +1588,7 @@ public APIlistOptionsCandlesticksRequest limit(Integer limit) { /** * Set from - * @param from Start timestamp (optional) + * @param 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) (optional) * @return APIlistOptionsCandlesticksRequest */ public APIlistOptionsCandlesticksRequest from(Long from) { @@ -1598,7 +1598,7 @@ public APIlistOptionsCandlesticksRequest from(Long from) { /** * Set to - * @param to End timestamp (optional) + * @param to Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional) * @return APIlistOptionsCandlesticksRequest */ public APIlistOptionsCandlesticksRequest to(Long to) { @@ -1608,7 +1608,7 @@ public APIlistOptionsCandlesticksRequest to(Long to) { /** * Set interval - * @param interval Interval time between data points (optional, default to 5m) + * @param interval Time interval between data points (optional, default to 5m) * @return APIlistOptionsCandlesticksRequest */ public APIlistOptionsCandlesticksRequest interval(String interval) { @@ -1624,7 +1624,7 @@ public APIlistOptionsCandlesticksRequest interval(String interval) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1638,7 +1638,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -1653,7 +1653,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1668,7 +1668,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExc * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1677,14 +1677,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _ca } /** - * Get options candlesticks + * Options contract market candlestick chart * * @param contract Options contract name (required) * @return APIlistOptionsCandlesticksRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIlistOptionsCandlesticksRequest listOptionsCandlesticks(String contract) { @@ -1778,7 +1778,7 @@ private APIlistOptionsUnderlyingCandlesticksRequest(String underlying) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistOptionsUnderlyingCandlesticksRequest */ public APIlistOptionsUnderlyingCandlesticksRequest limit(Integer limit) { @@ -1788,7 +1788,7 @@ public APIlistOptionsUnderlyingCandlesticksRequest limit(Integer limit) { /** * Set from - * @param from Start timestamp (optional) + * @param 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) (optional) * @return APIlistOptionsUnderlyingCandlesticksRequest */ public APIlistOptionsUnderlyingCandlesticksRequest from(Long from) { @@ -1798,7 +1798,7 @@ public APIlistOptionsUnderlyingCandlesticksRequest from(Long from) { /** * Set to - * @param to End timestamp (optional) + * @param to Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional) * @return APIlistOptionsUnderlyingCandlesticksRequest */ public APIlistOptionsUnderlyingCandlesticksRequest to(Long to) { @@ -1808,7 +1808,7 @@ public APIlistOptionsUnderlyingCandlesticksRequest to(Long to) { /** * Set interval - * @param interval Interval time between data points (optional, default to 5m) + * @param interval Time interval between data points (optional, default to 5m) * @return APIlistOptionsUnderlyingCandlesticksRequest */ public APIlistOptionsUnderlyingCandlesticksRequest interval(String interval) { @@ -1824,7 +1824,7 @@ public APIlistOptionsUnderlyingCandlesticksRequest interval(String interval) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1838,7 +1838,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -1853,7 +1853,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1868,7 +1868,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExc * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1877,14 +1877,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _ca } /** - * Mark price candlesticks of an underlying + * Underlying index price candlestick chart * * @param underlying Underlying (Obtained by listing underlying endpoint) (required) * @return APIlistOptionsUnderlyingCandlesticksRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIlistOptionsUnderlyingCandlesticksRequest listOptionsUnderlyingCandlesticks(String underlying) { @@ -1987,7 +1987,7 @@ public APIlistOptionsTradesRequest contract(String contract) { /** * Set type - * @param type `C` is call, while `P` is put (optional) + * @param type `C` for call, `P` for put (optional) * @return APIlistOptionsTradesRequest */ public APIlistOptionsTradesRequest type(String type) { @@ -1997,7 +1997,7 @@ public APIlistOptionsTradesRequest type(String type) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistOptionsTradesRequest */ public APIlistOptionsTradesRequest limit(Integer limit) { @@ -2017,7 +2017,7 @@ public APIlistOptionsTradesRequest offset(Integer offset) { /** * Set from - * @param from Start timestamp (optional) + * @param 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) (optional) * @return APIlistOptionsTradesRequest */ public APIlistOptionsTradesRequest from(Long from) { @@ -2027,7 +2027,7 @@ public APIlistOptionsTradesRequest from(Long from) { /** * Set to - * @param to End timestamp (optional) + * @param to Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional) * @return APIlistOptionsTradesRequest */ public APIlistOptionsTradesRequest to(Long to) { @@ -2043,7 +2043,7 @@ public APIlistOptionsTradesRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2057,7 +2057,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -2072,7 +2072,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -2087,7 +2087,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2096,13 +2096,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * Options trade history + * Market trade records * * @return APIlistOptionsTradesRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistOptionsTradesRequest listOptionsTrades() { @@ -2117,7 +2117,7 @@ public APIlistOptionsTradesRequest listOptionsTrades() { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call listOptionsAccountCall(final ApiCallback _callback) throws ApiException { @@ -2156,14 +2156,14 @@ private okhttp3.Call listOptionsAccountValidateBeforeCall(final ApiCallback _cal } /** - * List options account + * Query account information * * @return OptionsAccount * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public OptionsAccount listOptionsAccount() throws ApiException { @@ -2172,14 +2172,14 @@ public OptionsAccount listOptionsAccount() throws ApiException { } /** - * List options account + * Query account information * * @return ApiResponse<OptionsAccount> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse listOptionsAccountWithHttpInfo() throws ApiException { @@ -2189,7 +2189,7 @@ public ApiResponse listOptionsAccountWithHttpInfo() throws ApiEx } /** - * List options account (asynchronously) + * Query account information (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -2197,7 +2197,7 @@ public ApiResponse listOptionsAccountWithHttpInfo() throws ApiEx * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call listOptionsAccountAsync(final ApiCallback _callback) throws ApiException { @@ -2288,7 +2288,7 @@ private APIlistOptionsAccountBookRequest() { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistOptionsAccountBookRequest */ public APIlistOptionsAccountBookRequest limit(Integer limit) { @@ -2308,7 +2308,7 @@ public APIlistOptionsAccountBookRequest offset(Integer offset) { /** * Set from - * @param from Start timestamp (optional) + * @param 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) (optional) * @return APIlistOptionsAccountBookRequest */ public APIlistOptionsAccountBookRequest from(Long from) { @@ -2318,7 +2318,7 @@ public APIlistOptionsAccountBookRequest from(Long from) { /** * Set to - * @param to End timestamp (optional) + * @param to Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional) * @return APIlistOptionsAccountBookRequest */ public APIlistOptionsAccountBookRequest to(Long to) { @@ -2328,7 +2328,7 @@ public APIlistOptionsAccountBookRequest to(Long to) { /** * Set type - * @param type Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - set: settlement PNL (optional) + * @param type Change types: - dnw: Deposit & Withdrawal - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - set: Settlement P&L (optional) * @return APIlistOptionsAccountBookRequest */ public APIlistOptionsAccountBookRequest type(String type) { @@ -2344,7 +2344,7 @@ public APIlistOptionsAccountBookRequest type(String type) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2358,7 +2358,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -2373,7 +2373,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -2388,7 +2388,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExc * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2397,13 +2397,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _ca } /** - * List account changing history + * Query account change history * * @return APIlistOptionsAccountBookRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistOptionsAccountBookRequest listOptionsAccountBook() { @@ -2487,7 +2487,7 @@ public APIlistOptionsPositionsRequest underlying(String underlying) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2501,7 +2501,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -2516,7 +2516,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -2531,7 +2531,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcept * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2546,7 +2546,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _callb * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistOptionsPositionsRequest listOptionsPositions() { @@ -2562,7 +2562,7 @@ public APIlistOptionsPositionsRequest listOptionsPositions() { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getOptionsPositionCall(String contract, final ApiCallback _callback) throws ApiException { @@ -2615,7 +2615,7 @@ private okhttp3.Call getOptionsPositionValidateBeforeCall(String contract, final * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public OptionsPosition getOptionsPosition(String contract) throws ApiException { @@ -2632,7 +2632,7 @@ public OptionsPosition getOptionsPosition(String contract) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse getOptionsPositionWithHttpInfo(String contract) throws ApiException { @@ -2651,7 +2651,7 @@ public ApiResponse getOptionsPositionWithHttpInfo(String contra * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getOptionsPositionAsync(String contract, final ApiCallback _callback) throws ApiException { @@ -2749,7 +2749,7 @@ public APIlistOptionsPositionCloseRequest contract(String contract) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2763,7 +2763,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -2778,7 +2778,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -2793,7 +2793,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiE * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2809,7 +2809,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _ * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistOptionsPositionCloseRequest listOptionsPositionClose(String underlying) { @@ -2933,7 +2933,7 @@ public APIlistOptionsOrdersRequest underlying(String underlying) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistOptionsOrdersRequest */ public APIlistOptionsOrdersRequest limit(Integer limit) { @@ -2953,7 +2953,7 @@ public APIlistOptionsOrdersRequest offset(Integer offset) { /** * Set from - * @param from Start timestamp (optional) + * @param 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) (optional) * @return APIlistOptionsOrdersRequest */ public APIlistOptionsOrdersRequest from(Long from) { @@ -2963,7 +2963,7 @@ public APIlistOptionsOrdersRequest from(Long from) { /** * Set to - * @param to End timestamp (optional) + * @param to Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional) * @return APIlistOptionsOrdersRequest */ public APIlistOptionsOrdersRequest to(Long to) { @@ -2979,7 +2979,7 @@ public APIlistOptionsOrdersRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2993,7 +2993,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -3008,7 +3008,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -3023,7 +3023,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -3034,12 +3034,12 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback /** * List options orders * - * @param status Only list the orders with this status (required) + * @param status Query order list based on status (required) * @return APIlistOptionsOrdersRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistOptionsOrdersRequest listOptionsOrders(String status) { @@ -3157,14 +3157,14 @@ public okhttp3.Call createOptionsOrderAsync(OptionsOrder optionsOrder, final Api * Build call for cancelOptionsOrders * @param contract Options contract name (optional) * @param underlying Underlying (optional) - * @param side All bids or asks. Both included if not specified (optional) + * @param side Specify all bids or all asks, both included if not specified (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
Status Code Description Response Headers
200 All orders matched cancelled -
200 Batch cancellation successful -
*/ public okhttp3.Call cancelOptionsOrdersCall(String contract, String underlying, String side, final ApiCallback _callback) throws ApiException { @@ -3215,17 +3215,17 @@ private okhttp3.Call cancelOptionsOrdersValidateBeforeCall(String contract, Stri } /** - * Cancel all `open` orders matched + * Cancel all orders with 'open' status * * @param contract Options contract name (optional) * @param underlying Underlying (optional) - * @param side All bids or asks. Both included if not specified (optional) + * @param side Specify all bids or all asks, both included if not specified (optional) * @return List<OptionsOrder> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 All orders matched cancelled -
200 Batch cancellation successful -
*/ public List cancelOptionsOrders(String contract, String underlying, String side) throws ApiException { @@ -3234,17 +3234,17 @@ public List cancelOptionsOrders(String contract, String underlying } /** - * Cancel all `open` orders matched + * Cancel all orders with 'open' status * * @param contract Options contract name (optional) * @param underlying Underlying (optional) - * @param side All bids or asks. Both included if not specified (optional) + * @param side Specify all bids or all asks, both included if not specified (optional) * @return ApiResponse<List<OptionsOrder>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 All orders matched cancelled -
200 Batch cancellation successful -
*/ public ApiResponse> cancelOptionsOrdersWithHttpInfo(String contract, String underlying, String side) throws ApiException { @@ -3254,18 +3254,18 @@ public ApiResponse> cancelOptionsOrdersWithHttpInfo(String co } /** - * Cancel all `open` orders matched (asynchronously) + * Cancel all orders with 'open' status (asynchronously) * * @param contract Options contract name (optional) * @param underlying Underlying (optional) - * @param side All bids or asks. Both included if not specified (optional) + * @param side Specify all bids or all asks, both included if not specified (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 All orders matched cancelled -
200 Batch cancellation successful -
*/ public okhttp3.Call cancelOptionsOrdersAsync(String contract, String underlying, String side, final ApiCallback> _callback) throws ApiException { @@ -3277,7 +3277,7 @@ public okhttp3.Call cancelOptionsOrdersAsync(String contract, String underlying, /** * Build call for getOptionsOrder - * @param orderId Order ID returned on successful order creation (required) + * @param orderId Order ID returned when order is successfully created (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -3329,9 +3329,9 @@ private okhttp3.Call getOptionsOrderValidateBeforeCall(Long orderId, final ApiCa } /** - * Get a single order + * Query single order details * - * @param orderId Order ID returned on successful order creation (required) + * @param orderId Order ID returned when order is successfully created (required) * @return OptionsOrder * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -3346,9 +3346,9 @@ public OptionsOrder getOptionsOrder(Long orderId) throws ApiException { } /** - * Get a single order + * Query single order details * - * @param orderId Order ID returned on successful order creation (required) + * @param orderId Order ID returned when order is successfully created (required) * @return ApiResponse<OptionsOrder> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -3364,9 +3364,9 @@ public ApiResponse getOptionsOrderWithHttpInfo(Long orderId) throw } /** - * Get a single order (asynchronously) + * Query single order details (asynchronously) * - * @param orderId Order ID returned on successful order creation (required) + * @param orderId Order ID returned when order is successfully created (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -3385,7 +3385,7 @@ public okhttp3.Call getOptionsOrderAsync(Long orderId, final ApiCallback cancelOptionsOrderWithHttpInfo(Long orderId) th } /** - * Cancel a single order (asynchronously) + * Cancel single order (asynchronously) * - * @param orderId Order ID returned on successful order creation (required) + * @param orderId Order ID returned when order is successfully created (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -3500,7 +3500,7 @@ public okhttp3.Call cancelOptionsOrderAsync(Long orderId, final ApiCallback Status Code Description Response Headers - 200 Set countdown successfully - + 200 Countdown set successfully - */ public okhttp3.Call countdownCancelAllOptionsCall(CountdownCancelAllOptionsTask countdownCancelAllOptionsTask, final ApiCallback _callback) throws ApiException { @@ -3545,14 +3545,14 @@ private okhttp3.Call countdownCancelAllOptionsValidateBeforeCall(CountdownCancel /** * Countdown cancel orders - * Option order heartbeat detection, when the `timeout` time set by the user is reached, if the existing countdown is not canceled or a new countdown is set, the related `option pending order` will be automatically canceled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at intervals of 30 seconds, with each countdown `timeout` set to 30 (seconds). If this interface is not called again within 30 seconds, all pending orders on the `underlying` `contract` you specified will be automatically cancelled. If `underlying` `contract` is not specified, all pending orders of the user will be automatically cancelled If `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the automatic order cancellation function will be cancelled. + * Option order heartbeat detection, when the `timeout` time set by the user is reached, if the existing countdown is not canceled or a new countdown is set, the related `option pending order` will be automatically canceled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at intervals of 30 seconds, with each countdown `timeout` set to 30 (seconds). If this interface is not called again within 30 seconds, all pending orders on the `underlying` `contract` you specified will be automatically cancelled. If `underlying` `contract` is not specified, user will be automatically cancelled If `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the automatic order cancellation function will be cancelled. * @param countdownCancelAllOptionsTask (required) * @return TriggerTime * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Set countdown successfully -
200 Countdown set successfully -
*/ public TriggerTime countdownCancelAllOptions(CountdownCancelAllOptionsTask countdownCancelAllOptionsTask) throws ApiException { @@ -3562,14 +3562,14 @@ public TriggerTime countdownCancelAllOptions(CountdownCancelAllOptionsTask count /** * Countdown cancel orders - * Option order heartbeat detection, when the `timeout` time set by the user is reached, if the existing countdown is not canceled or a new countdown is set, the related `option pending order` will be automatically canceled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at intervals of 30 seconds, with each countdown `timeout` set to 30 (seconds). If this interface is not called again within 30 seconds, all pending orders on the `underlying` `contract` you specified will be automatically cancelled. If `underlying` `contract` is not specified, all pending orders of the user will be automatically cancelled If `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the automatic order cancellation function will be cancelled. + * Option order heartbeat detection, when the `timeout` time set by the user is reached, if the existing countdown is not canceled or a new countdown is set, the related `option pending order` will be automatically canceled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at intervals of 30 seconds, with each countdown `timeout` set to 30 (seconds). If this interface is not called again within 30 seconds, all pending orders on the `underlying` `contract` you specified will be automatically cancelled. If `underlying` `contract` is not specified, user will be automatically cancelled If `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the automatic order cancellation function will be cancelled. * @param countdownCancelAllOptionsTask (required) * @return ApiResponse<TriggerTime> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Set countdown successfully -
200 Countdown set successfully -
*/ public ApiResponse countdownCancelAllOptionsWithHttpInfo(CountdownCancelAllOptionsTask countdownCancelAllOptionsTask) throws ApiException { @@ -3580,7 +3580,7 @@ public ApiResponse countdownCancelAllOptionsWithHttpInfo(CountdownC /** * Countdown cancel orders (asynchronously) - * Option order heartbeat detection, when the `timeout` time set by the user is reached, if the existing countdown is not canceled or a new countdown is set, the related `option pending order` will be automatically canceled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at intervals of 30 seconds, with each countdown `timeout` set to 30 (seconds). If this interface is not called again within 30 seconds, all pending orders on the `underlying` `contract` you specified will be automatically cancelled. If `underlying` `contract` is not specified, all pending orders of the user will be automatically cancelled If `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the automatic order cancellation function will be cancelled. + * Option order heartbeat detection, when the `timeout` time set by the user is reached, if the existing countdown is not canceled or a new countdown is set, the related `option pending order` will be automatically canceled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at intervals of 30 seconds, with each countdown `timeout` set to 30 (seconds). If this interface is not called again within 30 seconds, all pending orders on the `underlying` `contract` you specified will be automatically cancelled. If `underlying` `contract` is not specified, user will be automatically cancelled If `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the automatic order cancellation function will be cancelled. * @param countdownCancelAllOptionsTask (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -3588,7 +3588,7 @@ public ApiResponse countdownCancelAllOptionsWithHttpInfo(CountdownC * @http.response.details - +
Status Code Description Response Headers
200 Set countdown successfully -
200 Countdown set successfully -
*/ public okhttp3.Call countdownCancelAllOptionsAsync(CountdownCancelAllOptionsTask countdownCancelAllOptionsTask, final ApiCallback _callback) throws ApiException { @@ -3700,7 +3700,7 @@ public APIlistMyOptionsTradesRequest contract(String contract) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistMyOptionsTradesRequest */ public APIlistMyOptionsTradesRequest limit(Integer limit) { @@ -3720,7 +3720,7 @@ public APIlistMyOptionsTradesRequest offset(Integer offset) { /** * Set from - * @param from Start timestamp (optional) + * @param 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) (optional) * @return APIlistMyOptionsTradesRequest */ public APIlistMyOptionsTradesRequest from(Long from) { @@ -3730,7 +3730,7 @@ public APIlistMyOptionsTradesRequest from(Long from) { /** * Set to - * @param to End timestamp (optional) + * @param to Termination Timestamp Specify the end time. If not specified, it defaults to the current time, and the time format is a Unix timestamp (optional) * @return APIlistMyOptionsTradesRequest */ public APIlistMyOptionsTradesRequest to(Long to) { @@ -3746,7 +3746,7 @@ public APIlistMyOptionsTradesRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -3760,7 +3760,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -3775,7 +3775,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -3790,7 +3790,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcepti * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -3799,14 +3799,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callba } /** - * List personal trading history + * Query personal trading records * * @param underlying Underlying (Obtained by listing underlying endpoint) (required) * @return APIlistMyOptionsTradesRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistMyOptionsTradesRequest listMyOptionsTrades(String underlying) { @@ -3890,7 +3890,7 @@ public APIgetOptionsMMPRequest underlying(String underlying) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -3904,7 +3904,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -3919,7 +3919,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -3934,7 +3934,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -3943,13 +3943,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) } /** - * MMP Query + * MMP Query. * * @return APIgetOptionsMMPRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIgetOptionsMMPRequest getOptionsMMP() { diff --git a/src/main/java/io/gate/gateapi/api/RebateApi.java b/src/main/java/io/gate/gateapi/api/RebateApi.java index e003871..a0a0246 100644 --- a/src/main/java/io/gate/gateapi/api/RebateApi.java +++ b/src/main/java/io/gate/gateapi/api/RebateApi.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -141,7 +141,7 @@ private APIagencyTransactionHistoryRequest() { /** * Set currencyPair - * @param currencyPair Specify the currency pair, if not specified, return all currency pairs (optional) + * @param currencyPair Specify the trading pair. If not specified, returns all trading pairs (optional) * @return APIagencyTransactionHistoryRequest */ public APIagencyTransactionHistoryRequest currencyPair(String currencyPair) { @@ -161,7 +161,7 @@ public APIagencyTransactionHistoryRequest userId(Long userId) { /** * Set from - * @param from Time range beginning, default to 7 days before current time (optional) + * @param from Start time for querying records, defaults to 7 days before current time if not specified (optional) * @return APIagencyTransactionHistoryRequest */ public APIagencyTransactionHistoryRequest from(Long from) { @@ -171,7 +171,7 @@ public APIagencyTransactionHistoryRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to End timestamp for the query, defaults to current time if not specified (optional) * @return APIagencyTransactionHistoryRequest */ public APIagencyTransactionHistoryRequest to(Long to) { @@ -181,7 +181,7 @@ public APIagencyTransactionHistoryRequest to(Long to) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIagencyTransactionHistoryRequest */ public APIagencyTransactionHistoryRequest limit(Integer limit) { @@ -207,7 +207,7 @@ public APIagencyTransactionHistoryRequest offset(Integer offset) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -221,7 +221,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -236,7 +236,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -251,7 +251,7 @@ public ApiResponse> executeWithHttpInfo() throws * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -260,20 +260,20 @@ public okhttp3.Call executeAsync(final ApiCallback Status Code Description Response Headers - 200 List retrieved - + 200 List retrieved successfully - */ public APIagencyTransactionHistoryRequest agencyTransactionHistory() { return new APIagencyTransactionHistoryRequest(); } - private okhttp3.Call agencyCommissionsHistoryCall(String currency, Long userId, Long from, Long to, Integer limit, Integer offset, final ApiCallback _callback) throws ApiException { + private okhttp3.Call agencyCommissionsHistoryCall(String currency, Integer commissionType, Long userId, Long from, Long to, Integer limit, Integer offset, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables @@ -285,6 +285,10 @@ private okhttp3.Call agencyCommissionsHistoryCall(String currency, Long userId, localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); } + if (commissionType != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("commission_type", commissionType)); + } + if (userId != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("user_id", userId)); } @@ -327,20 +331,20 @@ private okhttp3.Call agencyCommissionsHistoryCall(String currency, Long userId, } @SuppressWarnings("rawtypes") - private okhttp3.Call agencyCommissionsHistoryValidateBeforeCall(String currency, Long userId, Long from, Long to, Integer limit, Integer offset, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = agencyCommissionsHistoryCall(currency, userId, from, to, limit, offset, _callback); + private okhttp3.Call agencyCommissionsHistoryValidateBeforeCall(String currency, Integer commissionType, Long userId, Long from, Long to, Integer limit, Integer offset, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = agencyCommissionsHistoryCall(currency, commissionType, userId, from, to, limit, offset, _callback); return localVarCall; } - private ApiResponse> agencyCommissionsHistoryWithHttpInfo(String currency, Long userId, Long from, Long to, Integer limit, Integer offset) throws ApiException { - okhttp3.Call localVarCall = agencyCommissionsHistoryValidateBeforeCall(currency, userId, from, to, limit, offset, null); + private ApiResponse> agencyCommissionsHistoryWithHttpInfo(String currency, Integer commissionType, Long userId, Long from, Long to, Integer limit, Integer offset) throws ApiException { + okhttp3.Call localVarCall = agencyCommissionsHistoryValidateBeforeCall(currency, commissionType, userId, from, to, limit, offset, null); Type localVarReturnType = new TypeToken>(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } - private okhttp3.Call agencyCommissionsHistoryAsync(String currency, Long userId, Long from, Long to, Integer limit, Integer offset, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = agencyCommissionsHistoryValidateBeforeCall(currency, userId, from, to, limit, offset, _callback); + private okhttp3.Call agencyCommissionsHistoryAsync(String currency, Integer commissionType, Long userId, Long from, Long to, Integer limit, Integer offset, final ApiCallback> _callback) throws ApiException { + okhttp3.Call localVarCall = agencyCommissionsHistoryValidateBeforeCall(currency, commissionType, userId, from, to, limit, offset, _callback); Type localVarReturnType = new TypeToken>(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; @@ -348,6 +352,7 @@ private okhttp3.Call agencyCommissionsHistoryAsync(String currency, Long userId, public class APIagencyCommissionsHistoryRequest { private String currency; + private Integer commissionType; private Long userId; private Long from; private Long to; @@ -359,7 +364,7 @@ private APIagencyCommissionsHistoryRequest() { /** * Set currency - * @param currency Filter by currency. Return all currency records if not specified (optional) + * @param currency Specify the currency. If not specified, returns all currencies (optional) * @return APIagencyCommissionsHistoryRequest */ public APIagencyCommissionsHistoryRequest currency(String currency) { @@ -367,6 +372,16 @@ public APIagencyCommissionsHistoryRequest currency(String currency) { return this; } + /** + * Set commissionType + * @param commissionType Rebate type: 1 - Direct rebate, 2 - Indirect rebate, 3 - Self rebate (optional) + * @return APIagencyCommissionsHistoryRequest + */ + public APIagencyCommissionsHistoryRequest commissionType(Integer commissionType) { + this.commissionType = commissionType; + return this; + } + /** * Set userId * @param userId User ID. If not specified, all user records will be returned (optional) @@ -379,7 +394,7 @@ public APIagencyCommissionsHistoryRequest userId(Long userId) { /** * Set from - * @param from Time range beginning, default to 7 days before current time (optional) + * @param from Start time for querying records, defaults to 7 days before current time if not specified (optional) * @return APIagencyCommissionsHistoryRequest */ public APIagencyCommissionsHistoryRequest from(Long from) { @@ -389,7 +404,7 @@ public APIagencyCommissionsHistoryRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to End timestamp for the query, defaults to current time if not specified (optional) * @return APIagencyCommissionsHistoryRequest */ public APIagencyCommissionsHistoryRequest to(Long to) { @@ -399,7 +414,7 @@ public APIagencyCommissionsHistoryRequest to(Long to) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIagencyCommissionsHistoryRequest */ public APIagencyCommissionsHistoryRequest limit(Integer limit) { @@ -425,11 +440,11 @@ public APIagencyCommissionsHistoryRequest offset(Integer offset) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { - return agencyCommissionsHistoryCall(currency, userId, from, to, limit, offset, _callback); + return agencyCommissionsHistoryCall(currency, commissionType, userId, from, to, limit, offset, _callback); } /** @@ -439,11 +454,11 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { - ApiResponse> localVarResp = agencyCommissionsHistoryWithHttpInfo(currency, userId, from, to, limit, offset); + ApiResponse> localVarResp = agencyCommissionsHistoryWithHttpInfo(currency, commissionType, userId, from, to, limit, offset); return localVarResp.getData(); } @@ -454,11 +469,11 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { - return agencyCommissionsHistoryWithHttpInfo(currency, userId, from, to, limit, offset); + return agencyCommissionsHistoryWithHttpInfo(currency, commissionType, userId, from, to, limit, offset); } /** @@ -469,22 +484,22 @@ public ApiResponse> executeWithHttpInfo() throws A * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { - return agencyCommissionsHistoryAsync(currency, userId, from, to, limit, offset, _callback); + return agencyCommissionsHistoryAsync(currency, commissionType, userId, from, to, limit, offset, _callback); } } /** - * The agency obtains the commission history of the recommended user - * Record time range cannot exceed 30 days + * Broker obtains rebate history of recommended users + * Record query time range cannot exceed 30 days * @return APIagencyCommissionsHistoryRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIagencyCommissionsHistoryRequest agencyCommissionsHistory() { @@ -577,7 +592,7 @@ private APIpartnerTransactionHistoryRequest() { /** * Set currencyPair - * @param currencyPair Specify the currency pair, if not specified, return all currency pairs (optional) + * @param currencyPair Specify the trading pair. If not specified, returns all trading pairs (optional) * @return APIpartnerTransactionHistoryRequest */ public APIpartnerTransactionHistoryRequest currencyPair(String currencyPair) { @@ -597,7 +612,7 @@ public APIpartnerTransactionHistoryRequest userId(Long userId) { /** * Set from - * @param from Time range beginning, default to 7 days before current time (optional) + * @param from Start time for querying records, defaults to 7 days before current time if not specified (optional) * @return APIpartnerTransactionHistoryRequest */ public APIpartnerTransactionHistoryRequest from(Long from) { @@ -607,7 +622,7 @@ public APIpartnerTransactionHistoryRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to End timestamp for the query, defaults to current time if not specified (optional) * @return APIpartnerTransactionHistoryRequest */ public APIpartnerTransactionHistoryRequest to(Long to) { @@ -617,7 +632,7 @@ public APIpartnerTransactionHistoryRequest to(Long to) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIpartnerTransactionHistoryRequest */ public APIpartnerTransactionHistoryRequest limit(Integer limit) { @@ -643,7 +658,7 @@ public APIpartnerTransactionHistoryRequest offset(Integer offset) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -657,7 +672,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public PartnerTransactionHistory execute() throws ApiException { @@ -672,7 +687,7 @@ public PartnerTransactionHistory execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -687,7 +702,7 @@ public ApiResponse executeWithHttpInfo() throws ApiEx * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -696,13 +711,13 @@ public okhttp3.Call executeAsync(final ApiCallback _c } /** - * Partner obtains transaction records of recommended users - * Record time range cannot exceed 30 days + * Partner obtains transaction history of recommended users + * Record query time range cannot exceed 30 days * @return APIpartnerTransactionHistoryRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIpartnerTransactionHistoryRequest partnerTransactionHistory() { @@ -795,7 +810,7 @@ private APIpartnerCommissionsHistoryRequest() { /** * Set currency - * @param currency Filter by currency. Return all currency records if not specified (optional) + * @param currency Specify the currency. If not specified, returns all currencies (optional) * @return APIpartnerCommissionsHistoryRequest */ public APIpartnerCommissionsHistoryRequest currency(String currency) { @@ -815,7 +830,7 @@ public APIpartnerCommissionsHistoryRequest userId(Long userId) { /** * Set from - * @param from Time range beginning, default to 7 days before current time (optional) + * @param from Start time for querying records, defaults to 7 days before current time if not specified (optional) * @return APIpartnerCommissionsHistoryRequest */ public APIpartnerCommissionsHistoryRequest from(Long from) { @@ -825,7 +840,7 @@ public APIpartnerCommissionsHistoryRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to End timestamp for the query, defaults to current time if not specified (optional) * @return APIpartnerCommissionsHistoryRequest */ public APIpartnerCommissionsHistoryRequest to(Long to) { @@ -835,7 +850,7 @@ public APIpartnerCommissionsHistoryRequest to(Long to) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIpartnerCommissionsHistoryRequest */ public APIpartnerCommissionsHistoryRequest limit(Integer limit) { @@ -861,7 +876,7 @@ public APIpartnerCommissionsHistoryRequest offset(Integer offset) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -875,7 +890,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public PartnerCommissionHistory execute() throws ApiException { @@ -890,7 +905,7 @@ public PartnerCommissionHistory execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -905,7 +920,7 @@ public ApiResponse executeWithHttpInfo() throws ApiExc * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -914,13 +929,13 @@ public okhttp3.Call executeAsync(final ApiCallback _ca } /** - * Partner obtains commission records of recommended users - * Record time range cannot exceed 30 days + * Partner obtains rebate records of recommended users + * Record query time range cannot exceed 30 days * @return APIpartnerCommissionsHistoryRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIpartnerCommissionsHistoryRequest partnerCommissionsHistory() { @@ -1008,7 +1023,7 @@ public APIpartnerSubListRequest userId(Long userId) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIpartnerSubListRequest */ public APIpartnerSubListRequest limit(Integer limit) { @@ -1034,7 +1049,7 @@ public APIpartnerSubListRequest offset(Integer offset) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1048,7 +1063,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public PartnerSubList execute() throws ApiException { @@ -1063,7 +1078,7 @@ public PartnerSubList execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -1078,7 +1093,7 @@ public ApiResponse executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -1088,12 +1103,12 @@ public okhttp3.Call executeAsync(final ApiCallback _callback) th /** * Partner subordinate list - * Including sub-agents, direct customers, indirect customers + * Including sub-agents, direct customers, and indirect customers * @return APIpartnerSubListRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIpartnerSubListRequest partnerSubList() { @@ -1181,7 +1196,7 @@ private APIrebateBrokerCommissionHistoryRequest() { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIrebateBrokerCommissionHistoryRequest */ public APIrebateBrokerCommissionHistoryRequest limit(Integer limit) { @@ -1211,7 +1226,7 @@ public APIrebateBrokerCommissionHistoryRequest userId(Long userId) { /** * Set from - * @param from The start time of the query record. If not specified, the default is to push forward 30 days from the current time. (optional) + * @param from Start time of the query record. If not specified, defaults to 30 days before the current time (optional) * @return APIrebateBrokerCommissionHistoryRequest */ public APIrebateBrokerCommissionHistoryRequest from(Long from) { @@ -1221,7 +1236,7 @@ public APIrebateBrokerCommissionHistoryRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to End timestamp for the query, defaults to current time if not specified (optional) * @return APIrebateBrokerCommissionHistoryRequest */ public APIrebateBrokerCommissionHistoryRequest to(Long to) { @@ -1237,7 +1252,7 @@ public APIrebateBrokerCommissionHistoryRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1251,7 +1266,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -1266,7 +1281,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1281,7 +1296,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcep * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1290,13 +1305,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _call } /** - * The broker obtains the user's commission rebate records - * Record time range cannot exceed 30 days + * Broker obtains user's rebate records + * Record query time range cannot exceed 30 days * @return APIrebateBrokerCommissionHistoryRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIrebateBrokerCommissionHistoryRequest rebateBrokerCommissionHistory() { @@ -1384,7 +1399,7 @@ private APIrebateBrokerTransactionHistoryRequest() { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIrebateBrokerTransactionHistoryRequest */ public APIrebateBrokerTransactionHistoryRequest limit(Integer limit) { @@ -1414,7 +1429,7 @@ public APIrebateBrokerTransactionHistoryRequest userId(Long userId) { /** * Set from - * @param from The start time of the query record. If not specified, the default is to push forward 30 days from the current time. (optional) + * @param from Start time of the query record. If not specified, defaults to 30 days before the current time (optional) * @return APIrebateBrokerTransactionHistoryRequest */ public APIrebateBrokerTransactionHistoryRequest from(Long from) { @@ -1424,7 +1439,7 @@ public APIrebateBrokerTransactionHistoryRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to End timestamp for the query, defaults to current time if not specified (optional) * @return APIrebateBrokerTransactionHistoryRequest */ public APIrebateBrokerTransactionHistoryRequest to(Long to) { @@ -1440,7 +1455,7 @@ public APIrebateBrokerTransactionHistoryRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1454,7 +1469,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -1469,7 +1484,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1484,7 +1499,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExce * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1493,13 +1508,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _cal } /** - * The broker obtains the user's trading history - * Record time range cannot exceed 30 days + * Broker obtains user's trading history + * Record query time range cannot exceed 30 days * @return APIrebateBrokerTransactionHistoryRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIrebateBrokerTransactionHistoryRequest rebateBrokerTransactionHistory() { @@ -1514,7 +1529,7 @@ public APIrebateBrokerTransactionHistoryRequest rebateBrokerTransactionHistory() * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call rebateUserInfoCall(final ApiCallback _callback) throws ApiException { @@ -1553,14 +1568,14 @@ private okhttp3.Call rebateUserInfoValidateBeforeCall(final ApiCallback _callbac } /** - * User retrieves rebate information + * User obtains rebate information * * @return List<RebateUserInfo> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List rebateUserInfo() throws ApiException { @@ -1569,14 +1584,14 @@ public List rebateUserInfo() throws ApiException { } /** - * User retrieves rebate information + * User obtains rebate information * * @return ApiResponse<List<RebateUserInfo>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> rebateUserInfoWithHttpInfo() throws ApiException { @@ -1586,7 +1601,7 @@ public ApiResponse> rebateUserInfoWithHttpInfo() throws Api } /** - * User retrieves rebate information (asynchronously) + * User obtains rebate information (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1594,7 +1609,7 @@ public ApiResponse> rebateUserInfoWithHttpInfo() throws Api * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call rebateUserInfoAsync(final ApiCallback> _callback) throws ApiException { @@ -1606,14 +1621,14 @@ public okhttp3.Call rebateUserInfoAsync(final ApiCallback> /** * Build call for userSubRelation - * @param userIdList Query the user's ID list, split by,, if there are more than 100, take 100 (required) + * @param userIdList Query user ID list, separated by commas. If more than 100, only 100 will be returned (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call userSubRelationCall(String userIdList, final ApiCallback _callback) throws ApiException { @@ -1661,15 +1676,15 @@ private okhttp3.Call userSubRelationValidateBeforeCall(String userIdList, final } /** - * User-subordinate relationship - * Query whether the specified user is in the system - * @param userIdList Query the user's ID list, split by,, if there are more than 100, take 100 (required) + * User subordinate relationship + * Query whether the specified user is within the system + * @param userIdList Query user ID list, separated by commas. If more than 100, only 100 will be returned (required) * @return UserSubRelation * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public UserSubRelation userSubRelation(String userIdList) throws ApiException { @@ -1678,15 +1693,15 @@ public UserSubRelation userSubRelation(String userIdList) throws ApiException { } /** - * User-subordinate relationship - * Query whether the specified user is in the system - * @param userIdList Query the user's ID list, split by,, if there are more than 100, take 100 (required) + * User subordinate relationship + * Query whether the specified user is within the system + * @param userIdList Query user ID list, separated by commas. If more than 100, only 100 will be returned (required) * @return ApiResponse<UserSubRelation> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse userSubRelationWithHttpInfo(String userIdList) throws ApiException { @@ -1696,16 +1711,16 @@ public ApiResponse userSubRelationWithHttpInfo(String userIdLis } /** - * User-subordinate relationship (asynchronously) - * Query whether the specified user is in the system - * @param userIdList Query the user's ID list, split by,, if there are more than 100, take 100 (required) + * User subordinate relationship (asynchronously) + * Query whether the specified user is within the system + * @param userIdList Query user ID list, separated by commas. If more than 100, only 100 will be returned (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call userSubRelationAsync(String userIdList, final ApiCallback _callback) throws ApiException { diff --git a/src/main/java/io/gate/gateapi/api/SpotApi.java b/src/main/java/io/gate/gateapi/api/SpotApi.java index a7a7b44..7763fa2 100644 --- a/src/main/java/io/gate/gateapi/api/SpotApi.java +++ b/src/main/java/io/gate/gateapi/api/SpotApi.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -77,7 +77,7 @@ public void setApiClient(ApiClient apiClient) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call listCurrenciesCall(final ApiCallback _callback) throws ApiException { @@ -116,14 +116,14 @@ private okhttp3.Call listCurrenciesValidateBeforeCall(final ApiCallback _callbac } /** - * List all currencies' details - * 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. + * 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 * @return List<Currency> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List listCurrencies() throws ApiException { @@ -132,14 +132,14 @@ public List listCurrencies() throws ApiException { } /** - * List all currencies' details - * 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. + * 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 * @return ApiResponse<List<Currency>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> listCurrenciesWithHttpInfo() throws ApiException { @@ -149,15 +149,15 @@ public ApiResponse> listCurrenciesWithHttpInfo() throws ApiExcept } /** - * List all currencies' details (asynchronously) - * 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. + * Query all currency information (asynchronously) + * 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 * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call listCurrenciesAsync(final ApiCallback> _callback) throws ApiException { @@ -176,7 +176,7 @@ public okhttp3.Call listCurrenciesAsync(final ApiCallback> _callb * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getCurrencyCall(String currency, final ApiCallback _callback) throws ApiException { @@ -221,7 +221,7 @@ private okhttp3.Call getCurrencyValidateBeforeCall(String currency, final ApiCal } /** - * Get details of a specific currency + * Query single currency information * * @param currency Currency name (required) * @return Currency @@ -229,7 +229,7 @@ private okhttp3.Call getCurrencyValidateBeforeCall(String currency, final ApiCal * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public Currency getCurrency(String currency) throws ApiException { @@ -238,7 +238,7 @@ public Currency getCurrency(String currency) throws ApiException { } /** - * Get details of a specific currency + * Query single currency information * * @param currency Currency name (required) * @return ApiResponse<Currency> @@ -246,7 +246,7 @@ public Currency getCurrency(String currency) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse getCurrencyWithHttpInfo(String currency) throws ApiException { @@ -256,7 +256,7 @@ public ApiResponse getCurrencyWithHttpInfo(String currency) throws Api } /** - * Get details of a specific currency (asynchronously) + * Query single currency information (asynchronously) * * @param currency Currency name (required) * @param _callback The callback to be executed when the API call finishes @@ -265,7 +265,7 @@ public ApiResponse getCurrencyWithHttpInfo(String currency) throws Api * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getCurrencyAsync(String currency, final ApiCallback _callback) throws ApiException { @@ -322,7 +322,7 @@ private okhttp3.Call listCurrencyPairsValidateBeforeCall(final ApiCallback _call } /** - * List all currency pairs supported + * Query all supported currency pairs * * @return List<CurrencyPair> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -338,7 +338,7 @@ public List listCurrencyPairs() throws ApiException { } /** - * List all currency pairs supported + * Query all supported currency pairs * * @return ApiResponse<List<CurrencyPair>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -355,7 +355,7 @@ public ApiResponse> listCurrencyPairsWithHttpInfo() throws Ap } /** - * List all currency pairs supported (asynchronously) + * Query all supported currency pairs (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -382,7 +382,7 @@ public okhttp3.Call listCurrencyPairsAsync(final ApiCallback> * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getCurrencyPairCall(String currencyPair, final ApiCallback _callback) throws ApiException { @@ -427,7 +427,7 @@ private okhttp3.Call getCurrencyPairValidateBeforeCall(String currencyPair, fina } /** - * Get details of a specifc currency pair + * Query single currency pair details * * @param currencyPair Currency pair (required) * @return CurrencyPair @@ -435,7 +435,7 @@ private okhttp3.Call getCurrencyPairValidateBeforeCall(String currencyPair, fina * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public CurrencyPair getCurrencyPair(String currencyPair) throws ApiException { @@ -444,7 +444,7 @@ public CurrencyPair getCurrencyPair(String currencyPair) throws ApiException { } /** - * Get details of a specifc currency pair + * Query single currency pair details * * @param currencyPair Currency pair (required) * @return ApiResponse<CurrencyPair> @@ -452,7 +452,7 @@ public CurrencyPair getCurrencyPair(String currencyPair) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse getCurrencyPairWithHttpInfo(String currencyPair) throws ApiException { @@ -462,7 +462,7 @@ public ApiResponse getCurrencyPairWithHttpInfo(String currencyPair } /** - * Get details of a specifc currency pair (asynchronously) + * Query single currency pair details (asynchronously) * * @param currencyPair Currency pair (required) * @param _callback The callback to be executed when the API call finishes @@ -471,7 +471,7 @@ public ApiResponse getCurrencyPairWithHttpInfo(String currencyPair * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getCurrencyPairAsync(String currencyPair, final ApiCallback _callback) throws ApiException { @@ -573,7 +573,7 @@ public APIlistTickersRequest timezone(String timezone) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -587,7 +587,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -602,7 +602,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -617,7 +617,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -626,13 +626,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) thro } /** - * Retrieve ticker information - * Return only related data if `currency_pair` is specified; otherwise return all of them + * Get currency pair ticker information + * If `currency_pair` is specified, only query that currency pair; otherwise return all information * @return APIlistTickersRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIlistTickersRequest listTickers() { @@ -721,7 +721,7 @@ private APIlistOrderBookRequest(String currencyPair) { /** * Set interval - * @param interval Order depth. 0 means no aggregation is applied. default to 0 (optional, default to "0") + * @param interval Price precision for depth aggregation, 0 means no aggregation, defaults to 0 if not specified (optional, default to "0") * @return APIlistOrderBookRequest */ public APIlistOrderBookRequest interval(String interval) { @@ -731,7 +731,7 @@ public APIlistOrderBookRequest interval(String interval) { /** * Set limit - * @param limit Maximum number of order depth data in asks or bids (optional, default to 10) + * @param limit Number of depth levels (optional, default to 10) * @return APIlistOrderBookRequest */ public APIlistOrderBookRequest limit(Integer limit) { @@ -741,7 +741,7 @@ public APIlistOrderBookRequest limit(Integer limit) { /** * Set withId - * @param withId Return order book ID (optional, default to false) + * @param withId Return order book update ID (optional, default to false) * @return APIlistOrderBookRequest */ public APIlistOrderBookRequest withId(Boolean withId) { @@ -757,7 +757,7 @@ public APIlistOrderBookRequest withId(Boolean withId) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -771,7 +771,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public OrderBook execute() throws ApiException { @@ -786,7 +786,7 @@ public OrderBook execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -801,7 +801,7 @@ public ApiResponse executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -810,14 +810,14 @@ public okhttp3.Call executeAsync(final ApiCallback _callback) throws } /** - * Retrieve order book - * Order book will be sorted by price from high to low on bids; low to high on asks + * Get market depth information + * Market depth buy orders are sorted by price from high to low, sell orders are sorted from low to high * @param currencyPair Currency pair (required) * @return APIlistOrderBookRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIlistOrderBookRequest listOrderBook(String currencyPair) { @@ -921,7 +921,7 @@ private APIlistTradesRequest(String currencyPair) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list. Default: 100, Minimum: 1, Maximum: 1000 (optional, default to 100) + * @param limit Maximum number of items returned in list. Default: 100, minimum: 1, maximum: 1000 (optional, default to 100) * @return APIlistTradesRequest */ public APIlistTradesRequest limit(Integer limit) { @@ -931,7 +931,7 @@ public APIlistTradesRequest limit(Integer limit) { /** * Set lastId - * @param lastId Specify list staring point using the `id` of last record in previous list-query results (optional) + * @param lastId 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 APIlistTradesRequest */ public APIlistTradesRequest lastId(String lastId) { @@ -941,7 +941,7 @@ public APIlistTradesRequest lastId(String lastId) { /** * Set reverse - * @param 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. (optional, default to false) + * @param 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. (optional, default to false) * @return APIlistTradesRequest */ public APIlistTradesRequest reverse(Boolean reverse) { @@ -951,7 +951,7 @@ public APIlistTradesRequest reverse(Boolean reverse) { /** * Set from - * @param from Start timestamp of the query (optional) + * @param from Start timestamp for the query (optional) * @return APIlistTradesRequest */ public APIlistTradesRequest from(Long from) { @@ -961,7 +961,7 @@ public APIlistTradesRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to End timestamp for the query, defaults to current time if not specified (optional) * @return APIlistTradesRequest */ public APIlistTradesRequest to(Long to) { @@ -987,7 +987,7 @@ public APIlistTradesRequest page(Integer page) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1001,7 +1001,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -1016,7 +1016,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1031,7 +1031,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1040,14 +1040,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) throw } /** - * Retrieve market trades - * Supports `from` and `to` by time range query or page-turn query based on `last_id`. By default, query by time range 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,000, that is, limit * (page - 1) <= 100,000. + * Query market transaction records + * 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. * @param currencyPair Currency pair (required) * @return APIlistTradesRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistTradesRequest listTrades(String currencyPair) { @@ -1141,7 +1141,7 @@ private APIlistCandlesticksRequest(String currencyPair) { /** * Set limit - * @param 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. (optional, default to 100) + * @param 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. (optional, default to 100) * @return APIlistCandlesticksRequest */ public APIlistCandlesticksRequest limit(Integer limit) { @@ -1161,7 +1161,7 @@ public APIlistCandlesticksRequest from(Long from) { /** * Set to - * @param to End time of candlesticks, formatted in Unix timestamp in seconds. Default to current time (optional) + * @param 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 (optional) * @return APIlistCandlesticksRequest */ public APIlistCandlesticksRequest to(Long to) { @@ -1171,7 +1171,7 @@ public APIlistCandlesticksRequest to(Long to) { /** * Set interval - * @param interval Interval time between data points. Note that `30d` means 1 natual month, not 30 days (optional, default to 30m) + * @param interval Time interval between data points. Note that `30d` represents a calendar month, not aligned to 30 days (optional, default to 30m) * @return APIlistCandlesticksRequest */ public APIlistCandlesticksRequest interval(String interval) { @@ -1187,7 +1187,7 @@ public APIlistCandlesticksRequest interval(String interval) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1201,7 +1201,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List> execute() throws ApiException { @@ -1216,7 +1216,7 @@ public List> execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse>> executeWithHttpInfo() throws ApiException { @@ -1231,7 +1231,7 @@ public ApiResponse>> executeWithHttpInfo() throws ApiException * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback>> _callback) throws ApiException { @@ -1240,14 +1240,14 @@ public okhttp3.Call executeAsync(final ApiCallback>> _callback } /** - * 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 * @param currencyPair Currency pair (required) * @return APIlistCandlesticksRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIlistCandlesticksRequest listCandlesticks(String currencyPair) { @@ -1316,7 +1316,7 @@ private APIgetFeeRequest() { /** * Set currencyPair - * @param currencyPair 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) + * @param currencyPair 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 APIgetFeeRequest */ public APIgetFeeRequest currencyPair(String currencyPair) { @@ -1332,7 +1332,7 @@ public APIgetFeeRequest currencyPair(String currencyPair) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
* @deprecated */ @@ -1348,7 +1348,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
* @deprecated */ @@ -1365,7 +1365,7 @@ public SpotFee execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
* @deprecated */ @@ -1382,7 +1382,7 @@ public ApiResponse executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
* @deprecated */ @@ -1393,13 +1393,13 @@ public okhttp3.Call executeAsync(final ApiCallback _callback) throws Ap } /** - * Query user trading fee rates - * This API is deprecated in favour of new fee retrieving API `/wallet/fee`. + * Query account fee rates + * This API is deprecated. The new fee query API is `/wallet/fee` * @return APIgetFeeRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
* @deprecated */ @@ -1410,14 +1410,14 @@ public APIgetFeeRequest getFee() { /** * Build call for getBatchSpotFee - * @param currencyPairs A request can only query up to 50 currency pairs (required) + * @param currencyPairs Maximum 50 currency pairs per request (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getBatchSpotFeeCall(String currencyPairs, final ApiCallback _callback) throws ApiException { @@ -1465,15 +1465,15 @@ private okhttp3.Call getBatchSpotFeeValidateBeforeCall(String currencyPairs, fin } /** - * Query a batch of user trading fee rates + * Batch query account fee rates * - * @param currencyPairs A request can only query up to 50 currency pairs (required) + * @param currencyPairs Maximum 50 currency pairs per request (required) * @return Map<String, SpotFee> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public Map getBatchSpotFee(String currencyPairs) throws ApiException { @@ -1482,15 +1482,15 @@ public Map getBatchSpotFee(String currencyPairs) throws ApiExce } /** - * Query a batch of user trading fee rates + * Batch query account fee rates * - * @param currencyPairs A request can only query up to 50 currency pairs (required) + * @param currencyPairs Maximum 50 currency pairs per request (required) * @return ApiResponse<Map<String, SpotFee>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> getBatchSpotFeeWithHttpInfo(String currencyPairs) throws ApiException { @@ -1500,16 +1500,16 @@ public ApiResponse> getBatchSpotFeeWithHttpInfo(String curr } /** - * Query a batch of user trading fee rates (asynchronously) + * Batch query account fee rates (asynchronously) * - * @param currencyPairs A request can only query up to 50 currency pairs (required) + * @param currencyPairs Maximum 50 currency pairs per request (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getBatchSpotFeeAsync(String currencyPairs, final ApiCallback> _callback) throws ApiException { @@ -1580,7 +1580,7 @@ private APIlistSpotAccountsRequest() { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Query by specified currency name (optional) * @return APIlistSpotAccountsRequest */ public APIlistSpotAccountsRequest currency(String currency) { @@ -1596,7 +1596,7 @@ public APIlistSpotAccountsRequest currency(String currency) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1610,7 +1610,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -1625,7 +1625,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1640,7 +1640,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1649,13 +1649,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) } /** - * List spot accounts + * List spot trading accounts * * @return APIlistSpotAccountsRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistSpotAccountsRequest listSpotAccounts() { @@ -1753,7 +1753,7 @@ private APIlistSpotAccountBookRequest() { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Query by specified currency name (optional) * @return APIlistSpotAccountBookRequest */ public APIlistSpotAccountBookRequest currency(String currency) { @@ -1763,7 +1763,7 @@ public APIlistSpotAccountBookRequest currency(String currency) { /** * Set from - * @param from Start timestamp of the query (optional) + * @param from Start timestamp for the query (optional) * @return APIlistSpotAccountBookRequest */ public APIlistSpotAccountBookRequest from(Long from) { @@ -1773,7 +1773,7 @@ public APIlistSpotAccountBookRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to End timestamp for the query, defaults to current time if not specified (optional) * @return APIlistSpotAccountBookRequest */ public APIlistSpotAccountBookRequest to(Long to) { @@ -1793,7 +1793,7 @@ public APIlistSpotAccountBookRequest page(Integer page) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistSpotAccountBookRequest */ public APIlistSpotAccountBookRequest limit(Integer limit) { @@ -1803,7 +1803,7 @@ public APIlistSpotAccountBookRequest limit(Integer limit) { /** * Set type - * @param type Only retrieve changes of the specified type. All types will be returned if not specified. (optional) + * @param type Query by specified account change type. If not specified, all change types will be included. (optional) * @return APIlistSpotAccountBookRequest */ public APIlistSpotAccountBookRequest type(String type) { @@ -1813,7 +1813,7 @@ public APIlistSpotAccountBookRequest type(String type) { /** * Set code - * @param code Specify account change code query, if not specified, all change types are included, and the priority is higher than `type` (optional) + * @param code Specify account change code for query. If not specified, all change types are included. This parameter has higher priority than `type` (optional) * @return APIlistSpotAccountBookRequest */ public APIlistSpotAccountBookRequest code(String code) { @@ -1829,7 +1829,7 @@ public APIlistSpotAccountBookRequest code(String code) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1843,7 +1843,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -1858,7 +1858,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1873,7 +1873,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcept * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1882,13 +1882,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callb } /** - * Query account book - * 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,000, that is, limit * (page - 1) <= 100,000. + * Query spot account transaction history + * 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. * @return APIlistSpotAccountBookRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistSpotAccountBookRequest listSpotAccountBook() { @@ -1905,7 +1905,7 @@ public APIlistSpotAccountBookRequest listSpotAccountBook() { * @http.response.details - +
Status Code Description Response Headers
200 Request is completed -
200 Request execution completed -
*/ public okhttp3.Call createBatchOrdersCall(List order, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -1953,8 +1953,8 @@ private okhttp3.Call createBatchOrdersValidateBeforeCall(List order, Stri } /** - * Create a batch of 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 place 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 * @param order (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @return List<BatchOrder> @@ -1962,7 +1962,7 @@ private okhttp3.Call createBatchOrdersValidateBeforeCall(List order, Stri * @http.response.details - +
Status Code Description Response Headers
200 Request is completed -
200 Request execution completed -
*/ public List createBatchOrders(List order, String xGateExptime) throws ApiException { @@ -1971,8 +1971,8 @@ public List createBatchOrders(List order, String xGateExptime } /** - * Create a batch of 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 place 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 * @param order (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @return ApiResponse<List<BatchOrder>> @@ -1980,7 +1980,7 @@ public List createBatchOrders(List order, String xGateExptime * @http.response.details - +
Status Code Description Response Headers
200 Request is completed -
200 Request execution completed -
*/ public ApiResponse> createBatchOrdersWithHttpInfo(List order, String xGateExptime) throws ApiException { @@ -1990,8 +1990,8 @@ public ApiResponse> createBatchOrdersWithHttpInfo(List o } /** - * Create a batch of orders (asynchronously) - * 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 place orders (asynchronously) + * 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 * @param order (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @param _callback The callback to be executed when the API call finishes @@ -2000,7 +2000,7 @@ public ApiResponse> createBatchOrdersWithHttpInfo(List o * @http.response.details - +
Status Code Description Response Headers
200 Request is completed -
200 Request execution completed -
*/ public okhttp3.Call createBatchOrdersAsync(List order, String xGateExptime, final ApiCallback> _callback) throws ApiException { @@ -2101,7 +2101,7 @@ public APIlistAllOpenOrdersRequest limit(Integer limit) { /** * Set account - * @param account Specify query account. (optional) + * @param account Specify query account (optional) * @return APIlistAllOpenOrdersRequest */ public APIlistAllOpenOrdersRequest account(String account) { @@ -2117,7 +2117,7 @@ public APIlistAllOpenOrdersRequest account(String account) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2131,7 +2131,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -2146,7 +2146,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -2161,7 +2161,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2171,12 +2171,12 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) /** * 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 for the number of trading pairs. All trading pairs with pending orders will be returned. + * 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. * @return APIlistAllOpenOrdersRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistAllOpenOrdersRequest listAllOpenOrders() { @@ -2192,7 +2192,7 @@ public APIlistAllOpenOrdersRequest listAllOpenOrders() { * @http.response.details - +
Status Code Description Response Headers
201 order created -
201 Order created successfully -
*/ public okhttp3.Call createCrossLiquidateOrderCall(LiquidateOrder liquidateOrder, final ApiCallback _callback) throws ApiException { @@ -2236,15 +2236,15 @@ private okhttp3.Call createCrossLiquidateOrderValidateBeforeCall(LiquidateOrder } /** - * 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 + * Close position when cross-currency is disabled + * 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 * @param liquidateOrder (required) * @return Order * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
201 order created -
201 Order created successfully -
*/ public Order createCrossLiquidateOrder(LiquidateOrder liquidateOrder) throws ApiException { @@ -2253,15 +2253,15 @@ public Order createCrossLiquidateOrder(LiquidateOrder liquidateOrder) throws Api } /** - * 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 + * Close position when cross-currency is disabled + * 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 * @param liquidateOrder (required) * @return ApiResponse<Order> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
201 order created -
201 Order created successfully -
*/ public ApiResponse createCrossLiquidateOrderWithHttpInfo(LiquidateOrder liquidateOrder) throws ApiException { @@ -2271,8 +2271,8 @@ public ApiResponse createCrossLiquidateOrderWithHttpInfo(LiquidateOrder l } /** - * close position when cross-currency is disabled (asynchronously) - * 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 + * Close position when cross-currency is disabled (asynchronously) + * 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 * @param liquidateOrder (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -2280,7 +2280,7 @@ public ApiResponse createCrossLiquidateOrderWithHttpInfo(LiquidateOrder l * @http.response.details - +
Status Code Description Response Headers
201 order created -
201 Order created successfully -
*/ public okhttp3.Call createCrossLiquidateOrderAsync(LiquidateOrder liquidateOrder, final ApiCallback _callback) throws ApiException { @@ -2418,7 +2418,7 @@ public APIlistOrdersRequest limit(Integer limit) { /** * Set account - * @param account Specify query account. (optional) + * @param account Specify query account (optional) * @return APIlistOrdersRequest */ public APIlistOrdersRequest account(String account) { @@ -2428,7 +2428,7 @@ public APIlistOrdersRequest account(String account) { /** * Set from - * @param from Start timestamp of the query (optional) + * @param from Start timestamp for the query (optional) * @return APIlistOrdersRequest */ public APIlistOrdersRequest from(Long from) { @@ -2438,7 +2438,7 @@ public APIlistOrdersRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to End timestamp for the query, defaults to current time if not specified (optional) * @return APIlistOrdersRequest */ public APIlistOrdersRequest to(Long to) { @@ -2448,7 +2448,7 @@ public APIlistOrdersRequest to(Long to) { /** * Set side - * @param side All bids or asks. Both included if not specified (optional) + * @param side Specify all bids or all asks, both included if not specified (optional) * @return APIlistOrdersRequest */ public APIlistOrdersRequest side(String side) { @@ -2464,7 +2464,7 @@ public APIlistOrdersRequest side(String side) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2478,7 +2478,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -2493,7 +2493,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -2508,7 +2508,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2518,14 +2518,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) throw /** * 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` is set to `finished`, that is, 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. - * @param currencyPair Retrieve results with specified currency pair. It is required for open orders, but optional for finished ones. (required) + * 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. + * @param currencyPair Query by specified currency pair. Required for open orders, optional for filled orders (required) * @param status List orders based on status `open` - order is waiting to be filled `finished` - order has been filled or cancelled (required) * @return APIlistOrdersRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistOrdersRequest listOrders(String currencyPair, String status) { @@ -2542,7 +2542,7 @@ public APIlistOrdersRequest listOrders(String currencyPair, String status) { * @http.response.details - +
Status Code Description Response Headers
201 Order created. -
201 Order created -
*/ public okhttp3.Call createOrderCall(Order order, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -2591,7 +2591,7 @@ private okhttp3.Call createOrderValidateBeforeCall(Order order, String xGateExpt /** * 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 account transactions, that is, when `account` 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 * @param order (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @return Order @@ -2599,7 +2599,7 @@ private okhttp3.Call createOrderValidateBeforeCall(Order order, String xGateExpt * @http.response.details - +
Status Code Description Response Headers
201 Order created. -
201 Order created -
*/ public Order createOrder(Order order, String xGateExptime) throws ApiException { @@ -2609,7 +2609,7 @@ public Order createOrder(Order order, String xGateExptime) throws ApiException { /** * 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 account transactions, that is, when `account` 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 * @param order (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @return ApiResponse<Order> @@ -2617,7 +2617,7 @@ public Order createOrder(Order order, String xGateExptime) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
201 Order created. -
201 Order created -
*/ public ApiResponse createOrderWithHttpInfo(Order order, String xGateExptime) throws ApiException { @@ -2628,7 +2628,7 @@ public ApiResponse createOrderWithHttpInfo(Order order, String xGateExpti /** * Create an order (asynchronously) - * 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 account transactions, that is, when `account` 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 * @param order (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @param _callback The callback to be executed when the API call finishes @@ -2637,7 +2637,7 @@ public ApiResponse createOrderWithHttpInfo(Order order, String xGateExpti * @http.response.details - +
Status Code Description Response Headers
201 Order created. -
201 Order created -
*/ public okhttp3.Call createOrderAsync(Order order, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -2650,9 +2650,9 @@ public okhttp3.Call createOrderAsync(Order order, String xGateExptime, final Api /** * Build call for cancelOrders * @param currencyPair Currency pair (optional) - * @param side All bids or asks. Both included if not specified (optional) - * @param account Specify Account Type - Classic Account: If not specified, all include - Unified Account: Specify `unified` (optional) - * @param actionMode 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) + * @param side Specify all bids or all asks, both included if not specified (optional) + * @param account Specify account type Classic account: All are included if not specified Unified account: Specify `unified` (optional) + * @param actionMode 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) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @param _callback Callback for upload/download progress * @return Call to execute @@ -2660,7 +2660,7 @@ public okhttp3.Call createOrderAsync(Order order, String xGateExptime, final Api * @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 -
*/ public okhttp3.Call cancelOrdersCall(String currencyPair, String side, String account, String actionMode, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -2720,18 +2720,18 @@ private okhttp3.Call cancelOrdersValidateBeforeCall(String currencyPair, String /** * 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 `currency_pair` is not specified, all 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 * @param currencyPair Currency pair (optional) - * @param side All bids or asks. Both included if not specified (optional) - * @param account Specify Account Type - Classic Account: If not specified, all include - Unified Account: Specify `unified` (optional) - * @param actionMode 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) + * @param side Specify all bids or all asks, both included if not specified (optional) + * @param account Specify account type Classic account: All are included if not specified Unified account: Specify `unified` (optional) + * @param actionMode 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) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @return List<OrderCancel> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @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 -
*/ public List cancelOrders(String currencyPair, String side, String account, String actionMode, String xGateExptime) throws ApiException { @@ -2741,18 +2741,18 @@ public List cancelOrders(String currencyPair, String side, String a /** * 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 `currency_pair` is not specified, all 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 * @param currencyPair Currency pair (optional) - * @param side All bids or asks. Both included if not specified (optional) - * @param account Specify Account Type - Classic Account: If not specified, all include - Unified Account: Specify `unified` (optional) - * @param actionMode 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) + * @param side Specify all bids or all asks, both included if not specified (optional) + * @param account Specify account type Classic account: All are included if not specified Unified account: Specify `unified` (optional) + * @param actionMode 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) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @return ApiResponse<List<OrderCancel>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @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 -
*/ public ApiResponse> cancelOrdersWithHttpInfo(String currencyPair, String side, String account, String actionMode, String xGateExptime) throws ApiException { @@ -2763,11 +2763,11 @@ public ApiResponse> cancelOrdersWithHttpInfo(String currencyPa /** * Cancel all `open` orders in specified currency pair (asynchronously) - * When the `account` parameter is not specified, all pending orders including spot, unified account, and position-by-position leverage will be cancelled. When `currency_pair` is not specified, all 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 * @param currencyPair Currency pair (optional) - * @param side All bids or asks. Both included if not specified (optional) - * @param account Specify Account Type - Classic Account: If not specified, all include - Unified Account: Specify `unified` (optional) - * @param actionMode 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) + * @param side Specify all bids or all asks, both included if not specified (optional) + * @param account Specify account type Classic account: All are included if not specified Unified account: Specify `unified` (optional) + * @param actionMode 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) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -2775,7 +2775,7 @@ public ApiResponse> cancelOrdersWithHttpInfo(String currencyPa * @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 -
*/ public okhttp3.Call cancelOrdersAsync(String currencyPair, String side, String account, String actionMode, String xGateExptime, final ApiCallback> _callback) throws ApiException { @@ -2843,7 +2843,7 @@ private okhttp3.Call cancelBatchOrdersValidateBeforeCall(List } /** - * 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 * @param cancelBatchOrder (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) @@ -2861,7 +2861,7 @@ public List cancelBatchOrders(List cancelBa } /** - * 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 * @param cancelBatchOrder (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) @@ -2880,7 +2880,7 @@ public ApiResponse> cancelBatchOrdersWithHttpInfo(List cancelBatchOrd /** * Build call for getOrder * @param orderId 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 currencyPair Specify the transaction pair to query. If you are querying pending order records, this field is required. If you are querying traded records, this field can be left blank. (required) - * @param account Specify query account. (optional) + * @param currencyPair 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 account Specify query account (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -2969,11 +2969,11 @@ private okhttp3.Call getOrderValidateBeforeCall(String orderId, String currencyP } /** - * Get a single order - * By default, orders for spot, unified account and warehouse-by-site leverage account are checked. + * Query single order details + * By default, queries orders for spot, unified account, and isolated margin accounts. * @param orderId 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 currencyPair Specify the transaction pair to query. If you are querying pending order records, this field is required. If you are querying traded records, this field can be left blank. (required) - * @param account Specify query account. (optional) + * @param currencyPair 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 account Specify query account (optional) * @return Order * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -2988,11 +2988,11 @@ public Order getOrder(String orderId, String currencyPair, String account) throw } /** - * Get a single order - * By default, orders for spot, unified account and warehouse-by-site leverage account are checked. + * Query single order details + * By default, queries orders for spot, unified account, and isolated margin accounts. * @param orderId 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 currencyPair Specify the transaction pair to query. If you are querying pending order records, this field is required. If you are querying traded records, this field can be left blank. (required) - * @param account Specify query account. (optional) + * @param currencyPair 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 account Specify query account (optional) * @return ApiResponse<Order> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -3008,11 +3008,11 @@ public ApiResponse getOrderWithHttpInfo(String orderId, String currencyPa } /** - * Get a single order (asynchronously) - * By default, orders for spot, unified account and warehouse-by-site leverage account are checked. + * Query single order details (asynchronously) + * By default, queries orders for spot, unified account, and isolated margin accounts. * @param orderId 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 currencyPair Specify the transaction pair to query. If you are querying pending order records, this field is required. If you are querying traded records, this field can be left blank. (required) - * @param account Specify query account. (optional) + * @param currencyPair 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 account Specify query account (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object @@ -3033,8 +3033,8 @@ public okhttp3.Call getOrderAsync(String orderId, String currencyPair, String ac * Build call for cancelOrder * @param orderId 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 currencyPair Currency pair (required) - * @param account Specify query account. (optional) - * @param actionMode 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) + * @param account Specify query account (optional) + * @param actionMode 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) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @param _callback Callback for upload/download progress * @return Call to execute @@ -3108,12 +3108,12 @@ private okhttp3.Call cancelOrderValidateBeforeCall(String orderId, String curren } /** - * Cancel a single order + * Cancel single order * By default, orders for spot, unified accounts and leveraged accounts are revoked. * @param orderId 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 currencyPair Currency pair (required) - * @param account Specify query account. (optional) - * @param actionMode 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) + * @param account Specify query account (optional) + * @param actionMode 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) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @return Order * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -3129,12 +3129,12 @@ public Order cancelOrder(String orderId, String currencyPair, String account, St } /** - * Cancel a single order + * Cancel single order * By default, orders for spot, unified accounts and leveraged accounts are revoked. * @param orderId 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 currencyPair Currency pair (required) - * @param account Specify query account. (optional) - * @param actionMode 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) + * @param account Specify query account (optional) + * @param actionMode 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) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @return ApiResponse<Order> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -3151,12 +3151,12 @@ public ApiResponse cancelOrderWithHttpInfo(String orderId, String currenc } /** - * Cancel a single order (asynchronously) + * Cancel single order (asynchronously) * By default, orders for spot, unified accounts and leveraged accounts are revoked. * @param orderId 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 currencyPair Currency pair (required) - * @param account Specify query account. (optional) - * @param actionMode 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) + * @param account Specify query account (optional) + * @param actionMode 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) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -3179,7 +3179,7 @@ public okhttp3.Call cancelOrderAsync(String orderId, String currencyPair, String * @param orderId 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 (required) * @param currencyPair Currency pair (optional) - * @param account Specify query account. (optional) + * @param account Specify query account (optional) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @param _callback Callback for upload/download progress * @return Call to execute @@ -3187,7 +3187,7 @@ public okhttp3.Call cancelOrderAsync(String orderId, String currencyPair, String * @http.response.details - +
Status Code Description Response Headers
200 Updated -
200 Updated successfully -
*/ public okhttp3.Call amendOrderCall(String orderId, OrderPatch orderPatch, String currencyPair, String account, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -3249,19 +3249,19 @@ private okhttp3.Call amendOrderValidateBeforeCall(String orderId, OrderPatch ord } /** - * Amend an order - * By default modify orders for spot, unified account and leverage account. At present, both the request body and query support currency_pair and account parameters, but the request body has higher priority currency_pair must be filled in the request body or query Currently, only the price or quantity modification (choose one of two) About speed limit: Modify orders and create orders to share speed limit rules About matching priority: Only modifying the quantity will become smaller and will not affect the priority of matching. If the price is modified or the quantity is modified, the priority will be adjusted to the end of the new price Precautions: Modification quantity is less than the transaction quantity will trigger the order cancellation operation + * 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. * @param orderId 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 (required) * @param currencyPair Currency pair (optional) - * @param account Specify query account. (optional) + * @param account Specify query account (optional) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @return Order * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Updated -
200 Updated successfully -
*/ public Order amendOrder(String orderId, OrderPatch orderPatch, String currencyPair, String account, String xGateExptime) throws ApiException { @@ -3270,19 +3270,19 @@ public Order amendOrder(String orderId, OrderPatch orderPatch, String currencyPa } /** - * Amend an order - * By default modify orders for spot, unified account and leverage account. At present, both the request body and query support currency_pair and account parameters, but the request body has higher priority currency_pair must be filled in the request body or query Currently, only the price or quantity modification (choose one of two) About speed limit: Modify orders and create orders to share speed limit rules About matching priority: Only modifying the quantity will become smaller and will not affect the priority of matching. If the price is modified or the quantity is modified, the priority will be adjusted to the end of the new price Precautions: Modification quantity is less than the transaction quantity will trigger the order cancellation operation + * 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. * @param orderId 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 (required) * @param currencyPair Currency pair (optional) - * @param account Specify query account. (optional) + * @param account Specify query account (optional) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @return ApiResponse<Order> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Updated -
200 Updated successfully -
*/ public ApiResponse amendOrderWithHttpInfo(String orderId, OrderPatch orderPatch, String currencyPair, String account, String xGateExptime) throws ApiException { @@ -3292,12 +3292,12 @@ public ApiResponse amendOrderWithHttpInfo(String orderId, OrderPatch orde } /** - * Amend an order (asynchronously) - * By default modify orders for spot, unified account and leverage account. At present, both the request body and query support currency_pair and account parameters, but the request body has higher priority currency_pair must be filled in the request body or query Currently, only the price or quantity modification (choose one of two) About speed limit: Modify orders and create orders to share speed limit rules About matching priority: Only modifying the quantity will become smaller and will not affect the priority of matching. If the price is modified or the quantity is modified, the priority will be adjusted to the end of the new price Precautions: Modification quantity is less than the transaction quantity will trigger the order cancellation operation + * Amend single order (asynchronously) + * 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. * @param orderId 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 (required) * @param currencyPair Currency pair (optional) - * @param account Specify query account. (optional) + * @param account Specify query account (optional) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -3305,7 +3305,7 @@ public ApiResponse amendOrderWithHttpInfo(String orderId, OrderPatch orde * @http.response.details - +
Status Code Description Response Headers
200 Updated -
200 Updated successfully -
*/ public okhttp3.Call amendOrderAsync(String orderId, OrderPatch orderPatch, String currencyPair, String account, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -3416,7 +3416,7 @@ public APIlistMyTradesRequest currencyPair(String currencyPair) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list. Default: 100, Minimum: 1, Maximum: 1000 (optional, default to 100) + * @param limit Maximum number of items returned in list. Default: 100, minimum: 1, maximum: 1000 (optional, default to 100) * @return APIlistMyTradesRequest */ public APIlistMyTradesRequest limit(Integer limit) { @@ -3446,7 +3446,7 @@ public APIlistMyTradesRequest orderId(String orderId) { /** * Set account - * @param account Specify query account. (optional) + * @param account Specify query account (optional) * @return APIlistMyTradesRequest */ public APIlistMyTradesRequest account(String account) { @@ -3456,7 +3456,7 @@ public APIlistMyTradesRequest account(String account) { /** * Set from - * @param from Start timestamp of the query (optional) + * @param from Start timestamp for the query (optional) * @return APIlistMyTradesRequest */ public APIlistMyTradesRequest from(Long from) { @@ -3466,7 +3466,7 @@ public APIlistMyTradesRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to End timestamp for the query, defaults to current time if not specified (optional) * @return APIlistMyTradesRequest */ public APIlistMyTradesRequest to(Long to) { @@ -3482,7 +3482,7 @@ public APIlistMyTradesRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -3496,7 +3496,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -3511,7 +3511,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -3526,7 +3526,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -3535,13 +3535,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) throw } /** - * List personal trading history - * 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 of `from` and `to` is 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,000, that is, limit * (page - 1) <= 100,000. + * 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. * @return APIlistMyTradesRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistMyTradesRequest listMyTrades() { @@ -3556,7 +3556,7 @@ public APIlistMyTradesRequest listMyTrades() { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getSystemTimeCall(final ApiCallback _callback) throws ApiException { @@ -3602,7 +3602,7 @@ private okhttp3.Call getSystemTimeValidateBeforeCall(final ApiCallback _callback * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public SystemTime getSystemTime() throws ApiException { @@ -3618,7 +3618,7 @@ public SystemTime getSystemTime() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse getSystemTimeWithHttpInfo() throws ApiException { @@ -3636,7 +3636,7 @@ public ApiResponse getSystemTimeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call getSystemTimeAsync(final ApiCallback _callback) throws ApiException { @@ -3655,7 +3655,7 @@ public okhttp3.Call getSystemTimeAsync(final ApiCallback _callback) * @http.response.details - +
Status Code Description Response Headers
200 Set countdown successfully -
200 Countdown set successfully -
*/ public okhttp3.Call countdownCancelAllSpotCall(CountdownCancelAllSpotTask countdownCancelAllSpotTask, final ApiCallback _callback) throws ApiException { @@ -3700,14 +3700,14 @@ private okhttp3.Call countdownCancelAllSpotValidateBeforeCall(CountdownCancelAll /** * Countdown cancel orders - * When the timeout set by the user is reached, if there is no cancel or set a new countdown, the related pending orders will be automatically cancelled. This endpoint can be called repeatedly to set a new countdown or cancel the countdown. For example, call this endpoint at 30s intervals, each countdown`timeout` is set to 30s. If this endpoint is not called again within 30 seconds, all pending orders on the specified `market` will be automatically cancelled, if no `market` is specified, all market pending orders will be cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the cacnel function will be cancelled. + * Spot order heartbeat detection. If there is no \"cancel existing countdown\" or \"set new countdown\" when the user-set `timeout` time is reached, the related `spot pending orders` will be automatically cancelled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at 30s intervals, setting the countdown `timeout` to `30 (seconds)` each time. If this interface is not called again within 30 seconds, all pending orders on the `market` you specified will be automatically cancelled. If no `market` is specified, all market cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will be terminated and the automatic order cancellation function will be cancelled. * @param countdownCancelAllSpotTask (required) * @return TriggerTime * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Set countdown successfully -
200 Countdown set successfully -
*/ public TriggerTime countdownCancelAllSpot(CountdownCancelAllSpotTask countdownCancelAllSpotTask) throws ApiException { @@ -3717,14 +3717,14 @@ public TriggerTime countdownCancelAllSpot(CountdownCancelAllSpotTask countdownCa /** * Countdown cancel orders - * When the timeout set by the user is reached, if there is no cancel or set a new countdown, the related pending orders will be automatically cancelled. This endpoint can be called repeatedly to set a new countdown or cancel the countdown. For example, call this endpoint at 30s intervals, each countdown`timeout` is set to 30s. If this endpoint is not called again within 30 seconds, all pending orders on the specified `market` will be automatically cancelled, if no `market` is specified, all market pending orders will be cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the cacnel function will be cancelled. + * Spot order heartbeat detection. If there is no \"cancel existing countdown\" or \"set new countdown\" when the user-set `timeout` time is reached, the related `spot pending orders` will be automatically cancelled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at 30s intervals, setting the countdown `timeout` to `30 (seconds)` each time. If this interface is not called again within 30 seconds, all pending orders on the `market` you specified will be automatically cancelled. If no `market` is specified, all market cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will be terminated and the automatic order cancellation function will be cancelled. * @param countdownCancelAllSpotTask (required) * @return ApiResponse<TriggerTime> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Set countdown successfully -
200 Countdown set successfully -
*/ public ApiResponse countdownCancelAllSpotWithHttpInfo(CountdownCancelAllSpotTask countdownCancelAllSpotTask) throws ApiException { @@ -3735,7 +3735,7 @@ public ApiResponse countdownCancelAllSpotWithHttpInfo(CountdownCanc /** * Countdown cancel orders (asynchronously) - * When the timeout set by the user is reached, if there is no cancel or set a new countdown, the related pending orders will be automatically cancelled. This endpoint can be called repeatedly to set a new countdown or cancel the countdown. For example, call this endpoint at 30s intervals, each countdown`timeout` is set to 30s. If this endpoint is not called again within 30 seconds, all pending orders on the specified `market` will be automatically cancelled, if no `market` is specified, all market pending orders will be cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the cacnel function will be cancelled. + * Spot order heartbeat detection. If there is no \"cancel existing countdown\" or \"set new countdown\" when the user-set `timeout` time is reached, the related `spot pending orders` will be automatically cancelled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at 30s intervals, setting the countdown `timeout` to `30 (seconds)` each time. If this interface is not called again within 30 seconds, all pending orders on the `market` you specified will be automatically cancelled. If no `market` is specified, all market cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will be terminated and the automatic order cancellation function will be cancelled. * @param countdownCancelAllSpotTask (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -3743,7 +3743,7 @@ public ApiResponse countdownCancelAllSpotWithHttpInfo(CountdownCanc * @http.response.details - +
Status Code Description Response Headers
200 Set countdown successfully -
200 Countdown set successfully -
*/ public okhttp3.Call countdownCancelAllSpotAsync(CountdownCancelAllSpotTask countdownCancelAllSpotTask, final ApiCallback _callback) throws ApiException { @@ -3812,7 +3812,7 @@ private okhttp3.Call amendBatchOrdersValidateBeforeCall(List bat /** * Batch modification of orders - * By default modify orders for spot, unified account and leverage account. Currently, only the price or quantity modification (choose one of two) Modify unfinished orders, up to 5 orders can be modified in batches at a time. The request parameters should be passed in array format. When the order modification fails during batch modification, the modification of the order will continue to be executed. After execution, the failure information of the corresponding order will be carried The order of calling the batch modification order is consistent with the order list The order of return content of batch modification orders is consistent with the order list + * Modify orders in spot, unified account and isolated margin account by default. Modify uncompleted orders, up to 5 orders can be modified at a time. Request parameters should be passed in array format. If there are order modification failures during the batch modification process, the modification of the next order will continue to be executed, and the execution will return with the corresponding order failure information. The call order of batch modification orders is consistent with the order list order. The return content order of batch modification orders is consistent with the order list order. * @param batchAmendItem (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @return List<BatchOrder> @@ -3830,7 +3830,7 @@ public List amendBatchOrders(List batchAmendItem, St /** * Batch modification of orders - * By default modify orders for spot, unified account and leverage account. Currently, only the price or quantity modification (choose one of two) Modify unfinished orders, up to 5 orders can be modified in batches at a time. The request parameters should be passed in array format. When the order modification fails during batch modification, the modification of the order will continue to be executed. After execution, the failure information of the corresponding order will be carried The order of calling the batch modification order is consistent with the order list The order of return content of batch modification orders is consistent with the order list + * Modify orders in spot, unified account and isolated margin account by default. Modify uncompleted orders, up to 5 orders can be modified at a time. Request parameters should be passed in array format. If there are order modification failures during the batch modification process, the modification of the next order will continue to be executed, and the execution will return with the corresponding order failure information. The call order of batch modification orders is consistent with the order list order. The return content order of batch modification orders is consistent with the order list order. * @param batchAmendItem (required) * @param xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) * @return ApiResponse<List<BatchOrder>> @@ -3849,7 +3849,7 @@ public ApiResponse> amendBatchOrdersWithHttpInfo(List Status Code Description Response Headers - 200 Successfully retrieved - + 200 Query successful - */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -4018,7 +4018,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public List execute() throws ApiException { @@ -4033,7 +4033,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -4048,7 +4048,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiE * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -4061,13 +4061,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _ * * @param business Leverage business, margin - position by position; unified - unified account (required) * @param currency Currency (required) - * @param from Start timestamp, seconds (required) - * @param to End timestamp, in seconds (required) + * @param from Start timestamp in seconds (required) + * @param to End timestamp in seconds (required) * @return APIgetSpotInsuranceHistoryRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Query successful -
*/ public APIgetSpotInsuranceHistoryRequest getSpotInsuranceHistory(String business, String currency, Long from, Long to) { @@ -4161,7 +4161,7 @@ private APIlistSpotPriceTriggeredOrdersRequest(String status) { /** * Set market - * @param market Currency pair (optional) + * @param market Trading market (optional) * @return APIlistSpotPriceTriggeredOrdersRequest */ public APIlistSpotPriceTriggeredOrdersRequest market(String market) { @@ -4171,7 +4171,7 @@ public APIlistSpotPriceTriggeredOrdersRequest market(String market) { /** * Set account - * @param account Trading account type. Portfolio margin account must set to `unified` (optional) + * @param account Trading account type. Unified account must be set to `unified` (optional) * @return APIlistSpotPriceTriggeredOrdersRequest */ public APIlistSpotPriceTriggeredOrdersRequest account(String account) { @@ -4181,7 +4181,7 @@ public APIlistSpotPriceTriggeredOrdersRequest account(String account) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistSpotPriceTriggeredOrdersRequest */ public APIlistSpotPriceTriggeredOrdersRequest limit(Integer limit) { @@ -4207,7 +4207,7 @@ public APIlistSpotPriceTriggeredOrdersRequest offset(Integer offset) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -4221,7 +4221,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -4236,7 +4236,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -4251,7 +4251,7 @@ public ApiResponse> executeWithHttpInfo() throws A * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -4260,14 +4260,14 @@ public okhttp3.Call executeAsync(final ApiCallback } /** - * Retrieve running auto order list + * Query running auto order list * - * @param status Only list the orders with this status (required) + * @param status Query order list based on status (required) * @return APIlistSpotPriceTriggeredOrdersRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistSpotPriceTriggeredOrdersRequest listSpotPriceTriggeredOrders(String status) { @@ -4283,7 +4283,7 @@ public APIlistSpotPriceTriggeredOrdersRequest listSpotPriceTriggeredOrders(Strin * @http.response.details - +
Status Code Description Response Headers
201 Order created -
201 Order created successfully -
*/ public okhttp3.Call createSpotPriceTriggeredOrderCall(SpotPriceTriggeredOrder spotPriceTriggeredOrder, final ApiCallback _callback) throws ApiException { @@ -4327,7 +4327,7 @@ private okhttp3.Call createSpotPriceTriggeredOrderValidateBeforeCall(SpotPriceTr } /** - * Create a price-triggered order + * Create price-triggered order * * @param spotPriceTriggeredOrder (required) * @return TriggerOrderResponse @@ -4335,7 +4335,7 @@ private okhttp3.Call createSpotPriceTriggeredOrderValidateBeforeCall(SpotPriceTr * @http.response.details - +
Status Code Description Response Headers
201 Order created -
201 Order created successfully -
*/ public TriggerOrderResponse createSpotPriceTriggeredOrder(SpotPriceTriggeredOrder spotPriceTriggeredOrder) throws ApiException { @@ -4344,7 +4344,7 @@ public TriggerOrderResponse createSpotPriceTriggeredOrder(SpotPriceTriggeredOrde } /** - * Create a price-triggered order + * Create price-triggered order * * @param spotPriceTriggeredOrder (required) * @return ApiResponse<TriggerOrderResponse> @@ -4352,7 +4352,7 @@ public TriggerOrderResponse createSpotPriceTriggeredOrder(SpotPriceTriggeredOrde * @http.response.details - +
Status Code Description Response Headers
201 Order created -
201 Order created successfully -
*/ public ApiResponse createSpotPriceTriggeredOrderWithHttpInfo(SpotPriceTriggeredOrder spotPriceTriggeredOrder) throws ApiException { @@ -4362,7 +4362,7 @@ public ApiResponse createSpotPriceTriggeredOrderWithHttpIn } /** - * Create a price-triggered order (asynchronously) + * Create price-triggered order (asynchronously) * * @param spotPriceTriggeredOrder (required) * @param _callback The callback to be executed when the API call finishes @@ -4371,7 +4371,7 @@ public ApiResponse createSpotPriceTriggeredOrderWithHttpIn * @http.response.details - +
Status Code Description Response Headers
201 Order created -
201 Order created successfully -
*/ public okhttp3.Call createSpotPriceTriggeredOrderAsync(SpotPriceTriggeredOrder spotPriceTriggeredOrder, final ApiCallback _callback) throws ApiException { @@ -4383,15 +4383,15 @@ public okhttp3.Call createSpotPriceTriggeredOrderAsync(SpotPriceTriggeredOrder s /** * Build call for cancelSpotPriceTriggeredOrderList - * @param market Currency pair (optional) - * @param account Trading account type. Portfolio margin account must set to `unified` (optional) + * @param market Trading market (optional) + * @param account Trading account type. Unified account must be set to `unified` (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @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 -
*/ public okhttp3.Call cancelSpotPriceTriggeredOrderListCall(String market, String account, final ApiCallback _callback) throws ApiException { @@ -4438,16 +4438,16 @@ private okhttp3.Call cancelSpotPriceTriggeredOrderListValidateBeforeCall(String } /** - * Cancel All Price-triggered Orders + * Cancel all auto orders * - * @param market Currency pair (optional) - * @param account Trading account type. Portfolio margin account must set to `unified` (optional) + * @param market Trading market (optional) + * @param account Trading account type. Unified account must be set to `unified` (optional) * @return List<SpotPriceTriggeredOrder> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @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 -
*/ public List cancelSpotPriceTriggeredOrderList(String market, String account) throws ApiException { @@ -4456,16 +4456,16 @@ public List cancelSpotPriceTriggeredOrderList(String ma } /** - * Cancel All Price-triggered Orders + * Cancel all auto orders * - * @param market Currency pair (optional) - * @param account Trading account type. Portfolio margin account must set to `unified` (optional) + * @param market Trading market (optional) + * @param account Trading account type. Unified account must be set to `unified` (optional) * @return ApiResponse<List<SpotPriceTriggeredOrder>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @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 -
*/ public ApiResponse> cancelSpotPriceTriggeredOrderListWithHttpInfo(String market, String account) throws ApiException { @@ -4475,17 +4475,17 @@ public ApiResponse> cancelSpotPriceTriggeredOrderL } /** - * Cancel All Price-triggered Orders (asynchronously) + * Cancel all auto orders (asynchronously) * - * @param market Currency pair (optional) - * @param account Trading account type. Portfolio margin account must set to `unified` (optional) + * @param market Trading market (optional) + * @param account Trading account type. Unified account must be set to `unified` (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @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 -
*/ public okhttp3.Call cancelSpotPriceTriggeredOrderListAsync(String market, String account, final ApiCallback> _callback) throws ApiException { @@ -4497,14 +4497,14 @@ public okhttp3.Call cancelSpotPriceTriggeredOrderListAsync(String market, String /** * Build call for getSpotPriceTriggeredOrder - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
Status Code Description Response Headers
200 Auto order detail -
200 Auto order details -
*/ public okhttp3.Call getSpotPriceTriggeredOrderCall(String orderId, final ApiCallback _callback) throws ApiException { @@ -4549,15 +4549,15 @@ private okhttp3.Call getSpotPriceTriggeredOrderValidateBeforeCall(String orderId } /** - * Get a price-triggered order + * Query single auto order details * - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @return SpotPriceTriggeredOrder * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Auto order detail -
200 Auto order details -
*/ public SpotPriceTriggeredOrder getSpotPriceTriggeredOrder(String orderId) throws ApiException { @@ -4566,15 +4566,15 @@ public SpotPriceTriggeredOrder getSpotPriceTriggeredOrder(String orderId) throws } /** - * Get a price-triggered order + * Query single auto order details * - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @return ApiResponse<SpotPriceTriggeredOrder> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Auto order detail -
200 Auto order details -
*/ public ApiResponse getSpotPriceTriggeredOrderWithHttpInfo(String orderId) throws ApiException { @@ -4584,16 +4584,16 @@ public ApiResponse getSpotPriceTriggeredOrderWithHttpIn } /** - * Get a price-triggered order (asynchronously) + * Query single auto order details (asynchronously) * - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 Auto order detail -
200 Auto order details -
*/ public okhttp3.Call getSpotPriceTriggeredOrderAsync(String orderId, final ApiCallback _callback) throws ApiException { @@ -4605,14 +4605,14 @@ public okhttp3.Call getSpotPriceTriggeredOrderAsync(String orderId, final ApiCal /** * Build call for cancelSpotPriceTriggeredOrder - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
Status Code Description Response Headers
200 Auto order detail -
200 Auto order details -
*/ public okhttp3.Call cancelSpotPriceTriggeredOrderCall(String orderId, final ApiCallback _callback) throws ApiException { @@ -4657,15 +4657,15 @@ private okhttp3.Call cancelSpotPriceTriggeredOrderValidateBeforeCall(String orde } /** - * cancel a price-triggered order + * Cancel single auto order * - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @return SpotPriceTriggeredOrder * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Auto order detail -
200 Auto order details -
*/ public SpotPriceTriggeredOrder cancelSpotPriceTriggeredOrder(String orderId) throws ApiException { @@ -4674,15 +4674,15 @@ public SpotPriceTriggeredOrder cancelSpotPriceTriggeredOrder(String orderId) thr } /** - * cancel a price-triggered order + * Cancel single auto order * - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @return ApiResponse<SpotPriceTriggeredOrder> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Auto order detail -
200 Auto order details -
*/ public ApiResponse cancelSpotPriceTriggeredOrderWithHttpInfo(String orderId) throws ApiException { @@ -4692,16 +4692,16 @@ public ApiResponse cancelSpotPriceTriggeredOrderWithHtt } /** - * cancel a price-triggered order (asynchronously) + * Cancel single auto order (asynchronously) * - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId ID returned when order is successfully created (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 Auto order detail -
200 Auto order details -
*/ public okhttp3.Call cancelSpotPriceTriggeredOrderAsync(String orderId, final ApiCallback _callback) throws ApiException { diff --git a/src/main/java/io/gate/gateapi/api/SubAccountApi.java b/src/main/java/io/gate/gateapi/api/SubAccountApi.java index c38c1c7..275e990 100644 --- a/src/main/java/io/gate/gateapi/api/SubAccountApi.java +++ b/src/main/java/io/gate/gateapi/api/SubAccountApi.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -110,7 +110,7 @@ private APIlistSubAccountsRequest() { /** * Set type - * @param 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. (optional) + * @param 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. (optional) * @return APIlistSubAccountsRequest */ public APIlistSubAccountsRequest type(String type) { @@ -126,7 +126,7 @@ public APIlistSubAccountsRequest type(String type) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -140,7 +140,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List execute() throws ApiException { @@ -155,7 +155,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -170,7 +170,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -185,7 +185,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public APIlistSubAccountsRequest listSubAccounts() { @@ -201,7 +201,7 @@ public APIlistSubAccountsRequest listSubAccounts() { * @http.response.details - +
Status Code Description Response Headers
201 Created Successfully -
201 Created successfully -
*/ public okhttp3.Call createSubAccountsCall(SubAccount subAccount, final ApiCallback _callback) throws ApiException { @@ -253,7 +253,7 @@ private okhttp3.Call createSubAccountsValidateBeforeCall(SubAccount subAccount, * @http.response.details - +
Status Code Description Response Headers
201 Created Successfully -
201 Created successfully -
*/ public SubAccount createSubAccounts(SubAccount subAccount) throws ApiException { @@ -270,7 +270,7 @@ public SubAccount createSubAccounts(SubAccount subAccount) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
201 Created Successfully -
201 Created successfully -
*/ public ApiResponse createSubAccountsWithHttpInfo(SubAccount subAccount) throws ApiException { @@ -289,7 +289,7 @@ public ApiResponse createSubAccountsWithHttpInfo(SubAccount subAccou * @http.response.details - +
Status Code Description Response Headers
201 Created Successfully -
201 Created successfully -
*/ public okhttp3.Call createSubAccountsAsync(SubAccount subAccount, final ApiCallback _callback) throws ApiException { @@ -301,14 +301,14 @@ public okhttp3.Call createSubAccountsAsync(SubAccount subAccount, final ApiCallb /** * Build call for getSubAccount - * @param userId Sub-account user id (required) + * @param userId Sub-account user ID (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public okhttp3.Call getSubAccountCall(Long userId, final ApiCallback _callback) throws ApiException { @@ -353,15 +353,15 @@ private okhttp3.Call getSubAccountValidateBeforeCall(Long userId, final ApiCallb } /** - * Get the sub-account + * Get sub-account * - * @param userId Sub-account user id (required) + * @param userId Sub-account user ID (required) * @return SubAccount * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public SubAccount getSubAccount(Long userId) throws ApiException { @@ -370,15 +370,15 @@ public SubAccount getSubAccount(Long userId) throws ApiException { } /** - * Get the sub-account + * Get sub-account * - * @param userId Sub-account user id (required) + * @param userId Sub-account user ID (required) * @return ApiResponse<SubAccount> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public ApiResponse getSubAccountWithHttpInfo(Long userId) throws ApiException { @@ -388,16 +388,16 @@ public ApiResponse getSubAccountWithHttpInfo(Long userId) throws Api } /** - * Get the sub-account (asynchronously) + * Get sub-account (asynchronously) * - * @param userId Sub-account user id (required) + * @param userId Sub-account user ID (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successfully retrieved -
*/ public okhttp3.Call getSubAccountAsync(Long userId, final ApiCallback _callback) throws ApiException { @@ -409,14 +409,14 @@ public okhttp3.Call getSubAccountAsync(Long userId, final ApiCallback Status Code Description Response Headers - 200 List retrieved - + 200 List retrieved successfully - */ public okhttp3.Call listSubAccountKeysCall(Integer userId, final ApiCallback _callback) throws ApiException { @@ -461,15 +461,15 @@ private okhttp3.Call listSubAccountKeysValidateBeforeCall(Integer userId, final } /** - * List all API Key of the sub-account + * List all API key pairs of the sub-account * - * @param userId Sub-account user id (required) + * @param userId Sub-account user ID (required) * @return List<SubAccountKey> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public List listSubAccountKeys(Integer userId) throws ApiException { @@ -478,15 +478,15 @@ public List listSubAccountKeys(Integer userId) throws ApiExceptio } /** - * List all API Key of the sub-account + * List all API key pairs of the sub-account * - * @param userId Sub-account user id (required) + * @param userId Sub-account user ID (required) * @return ApiResponse<List<SubAccountKey>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public ApiResponse> listSubAccountKeysWithHttpInfo(Integer userId) throws ApiException { @@ -496,16 +496,16 @@ public ApiResponse> listSubAccountKeysWithHttpInfo(Integer u } /** - * List all API Key of the sub-account (asynchronously) + * List all API key pairs of the sub-account (asynchronously) * - * @param userId Sub-account user id (required) + * @param userId Sub-account user ID (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved successfully -
*/ public okhttp3.Call listSubAccountKeysAsync(Integer userId, final ApiCallback> _callback) throws ApiException { @@ -517,7 +517,7 @@ public okhttp3.Call listSubAccountKeysAsync(Integer userId, final ApiCallback
  • Status Code Description Response Headers - 200 Created Successfully - + 200 Created successfully - */ public okhttp3.Call createSubAccountKeysCall(Long userId, SubAccountKey subAccountKey, final ApiCallback _callback) throws ApiException { @@ -575,46 +575,46 @@ private okhttp3.Call createSubAccountKeysValidateBeforeCall(Long userId, SubAcco } /** - * Create API Key of the sub-account + * Create new sub-account API key pair * - * @param userId Sub-account user id (required) + * @param userId Sub-account user ID (required) * @param subAccountKey (required) - * @return List<SubAccountKey> + * @return SubAccountKey * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Created Successfully -
    200 Created successfully -
    */ - public List createSubAccountKeys(Long userId, SubAccountKey subAccountKey) throws ApiException { - ApiResponse> localVarResp = createSubAccountKeysWithHttpInfo(userId, subAccountKey); + public SubAccountKey createSubAccountKeys(Long userId, SubAccountKey subAccountKey) throws ApiException { + ApiResponse localVarResp = createSubAccountKeysWithHttpInfo(userId, subAccountKey); return localVarResp.getData(); } /** - * Create API Key of the sub-account + * Create new sub-account API key pair * - * @param userId Sub-account user id (required) + * @param userId Sub-account user ID (required) * @param subAccountKey (required) - * @return ApiResponse<List<SubAccountKey>> + * @return ApiResponse<SubAccountKey> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Created Successfully -
    200 Created successfully -
    */ - public ApiResponse> createSubAccountKeysWithHttpInfo(Long userId, SubAccountKey subAccountKey) throws ApiException { + public ApiResponse createSubAccountKeysWithHttpInfo(Long userId, SubAccountKey subAccountKey) throws ApiException { okhttp3.Call localVarCall = createSubAccountKeysValidateBeforeCall(userId, subAccountKey, null); - Type localVarReturnType = new TypeToken>(){}.getType(); + Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * Create API Key of the sub-account (asynchronously) + * Create new sub-account API key pair (asynchronously) * - * @param userId Sub-account user id (required) + * @param userId Sub-account user ID (required) * @param subAccountKey (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -622,27 +622,27 @@ public ApiResponse> createSubAccountKeysWithHttpInfo(Long us * @http.response.details - +
    Status Code Description Response Headers
    200 Created Successfully -
    200 Created successfully -
    */ - public okhttp3.Call createSubAccountKeysAsync(Long userId, SubAccountKey subAccountKey, final ApiCallback> _callback) throws ApiException { + public okhttp3.Call createSubAccountKeysAsync(Long userId, SubAccountKey subAccountKey, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = createSubAccountKeysValidateBeforeCall(userId, subAccountKey, _callback); - Type localVarReturnType = new TypeToken>(){}.getType(); + Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** * Build call for getSubAccountKey - * @param userId Sub-account user id (required) - * @param key The API Key of the sub-account (required) + * @param userId Sub-account user ID (required) + * @param key Sub-account API key (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
    Status Code Description Response Headers
    200 Successful -
    200 Successfully retrieved -
    */ public okhttp3.Call getSubAccountKeyCall(Integer userId, String key, final ApiCallback _callback) throws ApiException { @@ -693,16 +693,16 @@ private okhttp3.Call getSubAccountKeyValidateBeforeCall(Integer userId, String k } /** - * Get the API Key of the sub-account + * Get specific API key pair of the sub-account * - * @param userId Sub-account user id (required) - * @param key The API Key of the sub-account (required) + * @param userId Sub-account user ID (required) + * @param key Sub-account API key (required) * @return SubAccountKey * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Successful -
    200 Successfully retrieved -
    */ public SubAccountKey getSubAccountKey(Integer userId, String key) throws ApiException { @@ -711,16 +711,16 @@ public SubAccountKey getSubAccountKey(Integer userId, String key) throws ApiExce } /** - * Get the API Key of the sub-account + * Get specific API key pair of the sub-account * - * @param userId Sub-account user id (required) - * @param key The API Key of the sub-account (required) + * @param userId Sub-account user ID (required) + * @param key Sub-account API key (required) * @return ApiResponse<SubAccountKey> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Successful -
    200 Successfully retrieved -
    */ public ApiResponse getSubAccountKeyWithHttpInfo(Integer userId, String key) throws ApiException { @@ -730,17 +730,17 @@ public ApiResponse getSubAccountKeyWithHttpInfo(Integer userId, S } /** - * Get the API Key of the sub-account (asynchronously) + * Get specific API key pair of the sub-account (asynchronously) * - * @param userId Sub-account user id (required) - * @param key The API Key of the sub-account (required) + * @param userId Sub-account user ID (required) + * @param key Sub-account API key (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
    Status Code Description Response Headers
    200 Successful -
    200 Successfully retrieved -
    */ public okhttp3.Call getSubAccountKeyAsync(Integer userId, String key, final ApiCallback _callback) throws ApiException { @@ -752,8 +752,8 @@ public okhttp3.Call getSubAccountKeyAsync(Integer userId, String key, final ApiC /** * Build call for updateSubAccountKeys - * @param userId Sub-account user id (required) - * @param key The API Key of the sub-account (required) + * @param userId Sub-account user ID (required) + * @param key Sub-account API key (required) * @param subAccountKey (required) * @param _callback Callback for upload/download progress * @return Call to execute @@ -761,7 +761,7 @@ public okhttp3.Call getSubAccountKeyAsync(Integer userId, String key, final ApiC * @http.response.details - +
    Status Code Description Response Headers
    204 Updated -
    204 Updated successfully -
    */ public okhttp3.Call updateSubAccountKeysCall(Integer userId, String key, SubAccountKey subAccountKey, final ApiCallback _callback) throws ApiException { @@ -817,16 +817,16 @@ private okhttp3.Call updateSubAccountKeysValidateBeforeCall(Integer userId, Stri } /** - * Update API key of the sub-account + * Update sub-account API key pair * - * @param userId Sub-account user id (required) - * @param key The API Key of the sub-account (required) + * @param userId Sub-account user ID (required) + * @param key Sub-account API key (required) * @param subAccountKey (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    204 Updated -
    204 Updated successfully -
    */ public void updateSubAccountKeys(Integer userId, String key, SubAccountKey subAccountKey) throws ApiException { @@ -834,17 +834,17 @@ public void updateSubAccountKeys(Integer userId, String key, SubAccountKey subAc } /** - * Update API key of the sub-account + * Update sub-account API key pair * - * @param userId Sub-account user id (required) - * @param key The API Key of the sub-account (required) + * @param userId Sub-account user ID (required) + * @param key Sub-account API key (required) * @param subAccountKey (required) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    204 Updated -
    204 Updated successfully -
    */ public ApiResponse updateSubAccountKeysWithHttpInfo(Integer userId, String key, SubAccountKey subAccountKey) throws ApiException { @@ -853,10 +853,10 @@ public ApiResponse updateSubAccountKeysWithHttpInfo(Integer userId, String } /** - * Update API key of the sub-account (asynchronously) + * Update sub-account API key pair (asynchronously) * - * @param userId Sub-account user id (required) - * @param key The API Key of the sub-account (required) + * @param userId Sub-account user ID (required) + * @param key Sub-account API key (required) * @param subAccountKey (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -864,7 +864,7 @@ public ApiResponse updateSubAccountKeysWithHttpInfo(Integer userId, String * @http.response.details - +
    Status Code Description Response Headers
    204 Updated -
    204 Updated successfully -
    */ public okhttp3.Call updateSubAccountKeysAsync(Integer userId, String key, SubAccountKey subAccountKey, final ApiCallback _callback) throws ApiException { @@ -875,15 +875,15 @@ public okhttp3.Call updateSubAccountKeysAsync(Integer userId, String key, SubAcc /** * Build call for deleteSubAccountKeys - * @param userId Sub-account user id (required) - * @param key The API Key of the sub-account (required) + * @param userId Sub-account user ID (required) + * @param key Sub-account API key (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
    Status Code Description Response Headers
    204 Delete successfully -
    204 Deleted successfully -
    */ public okhttp3.Call deleteSubAccountKeysCall(Integer userId, String key, final ApiCallback _callback) throws ApiException { @@ -934,15 +934,15 @@ private okhttp3.Call deleteSubAccountKeysValidateBeforeCall(Integer userId, Stri } /** - * Delete API key of the sub-account + * Delete sub-account API key pair * - * @param userId Sub-account user id (required) - * @param key The API Key of the sub-account (required) + * @param userId Sub-account user ID (required) + * @param key Sub-account API key (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    204 Delete successfully -
    204 Deleted successfully -
    */ public void deleteSubAccountKeys(Integer userId, String key) throws ApiException { @@ -950,16 +950,16 @@ public void deleteSubAccountKeys(Integer userId, String key) throws ApiException } /** - * Delete API key of the sub-account + * Delete sub-account API key pair * - * @param userId Sub-account user id (required) - * @param key The API Key of the sub-account (required) + * @param userId Sub-account user ID (required) + * @param key Sub-account API key (required) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    204 Delete successfully -
    204 Deleted successfully -
    */ public ApiResponse deleteSubAccountKeysWithHttpInfo(Integer userId, String key) throws ApiException { @@ -968,17 +968,17 @@ public ApiResponse deleteSubAccountKeysWithHttpInfo(Integer userId, String } /** - * Delete API key of the sub-account (asynchronously) + * Delete sub-account API key pair (asynchronously) * - * @param userId Sub-account user id (required) - * @param key The API Key of the sub-account (required) + * @param userId Sub-account user ID (required) + * @param key Sub-account API key (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
    Status Code Description Response Headers
    204 Delete successfully -
    204 Deleted successfully -
    */ public okhttp3.Call deleteSubAccountKeysAsync(Integer userId, String key, final ApiCallback _callback) throws ApiException { @@ -989,14 +989,14 @@ public okhttp3.Call deleteSubAccountKeysAsync(Integer userId, String key, final /** * Build call for lockSubAccount - * @param userId The user id of the sub-account (required) + * @param userId Sub-account user ID (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
    Status Code Description Response Headers
    204 Lock successfully -
    204 Locked successfully -
    */ public okhttp3.Call lockSubAccountCall(Long userId, final ApiCallback _callback) throws ApiException { @@ -1041,14 +1041,14 @@ private okhttp3.Call lockSubAccountValidateBeforeCall(Long userId, final ApiCall } /** - * Lock the sub-account + * Lock sub-account * - * @param userId The user id of the sub-account (required) + * @param userId Sub-account user ID (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    204 Lock successfully -
    204 Locked successfully -
    */ public void lockSubAccount(Long userId) throws ApiException { @@ -1056,15 +1056,15 @@ public void lockSubAccount(Long userId) throws ApiException { } /** - * Lock the sub-account + * Lock sub-account * - * @param userId The user id of the sub-account (required) + * @param userId Sub-account user ID (required) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    204 Lock successfully -
    204 Locked successfully -
    */ public ApiResponse lockSubAccountWithHttpInfo(Long userId) throws ApiException { @@ -1073,16 +1073,16 @@ public ApiResponse lockSubAccountWithHttpInfo(Long userId) throws ApiExcep } /** - * Lock the sub-account (asynchronously) + * Lock sub-account (asynchronously) * - * @param userId The user id of the sub-account (required) + * @param userId Sub-account user ID (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
    Status Code Description Response Headers
    204 Lock successfully -
    204 Locked successfully -
    */ public okhttp3.Call lockSubAccountAsync(Long userId, final ApiCallback _callback) throws ApiException { @@ -1093,14 +1093,14 @@ public okhttp3.Call lockSubAccountAsync(Long userId, final ApiCallback _ca /** * Build call for unlockSubAccount - * @param userId The user id of the sub-account (required) + * @param userId Sub-account user ID (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
    Status Code Description Response Headers
    204 Unlock successfully -
    204 Unlocked successfully -
    */ public okhttp3.Call unlockSubAccountCall(Long userId, final ApiCallback _callback) throws ApiException { @@ -1145,14 +1145,14 @@ private okhttp3.Call unlockSubAccountValidateBeforeCall(Long userId, final ApiCa } /** - * Unlock the sub-account + * Unlock sub-account * - * @param userId The user id of the sub-account (required) + * @param userId Sub-account user ID (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    204 Unlock successfully -
    204 Unlocked successfully -
    */ public void unlockSubAccount(Long userId) throws ApiException { @@ -1160,15 +1160,15 @@ public void unlockSubAccount(Long userId) throws ApiException { } /** - * Unlock the sub-account + * Unlock sub-account * - * @param userId The user id of the sub-account (required) + * @param userId Sub-account user ID (required) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    204 Unlock successfully -
    204 Unlocked successfully -
    */ public ApiResponse unlockSubAccountWithHttpInfo(Long userId) throws ApiException { @@ -1177,16 +1177,16 @@ public ApiResponse unlockSubAccountWithHttpInfo(Long userId) throws ApiExc } /** - * Unlock the sub-account (asynchronously) + * Unlock sub-account (asynchronously) * - * @param userId The user id of the sub-account (required) + * @param userId Sub-account user ID (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
    Status Code Description Response Headers
    204 Unlock successfully -
    204 Unlocked successfully -
    */ public okhttp3.Call unlockSubAccountAsync(Long userId, final ApiCallback _callback) throws ApiException { @@ -1203,7 +1203,7 @@ public okhttp3.Call unlockSubAccountAsync(Long userId, final ApiCallback _ * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call listUnifiedModeCall(final ApiCallback _callback) throws ApiException { @@ -1243,13 +1243,13 @@ private okhttp3.Call listUnifiedModeValidateBeforeCall(final ApiCallback _callba /** * 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 * @return List<SubUserMode> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public List listUnifiedMode() throws ApiException { @@ -1259,13 +1259,13 @@ public List listUnifiedMode() throws ApiException { /** * 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 * @return ApiResponse<List<SubUserMode>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public ApiResponse> listUnifiedModeWithHttpInfo() throws ApiException { @@ -1276,14 +1276,14 @@ public ApiResponse> listUnifiedModeWithHttpInfo() throws ApiEx /** * Get sub-account mode (asynchronously) - * 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 * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call listUnifiedModeAsync(final ApiCallback> _callback) throws ApiException { diff --git a/src/main/java/io/gate/gateapi/api/UnifiedApi.java b/src/main/java/io/gate/gateapi/api/UnifiedApi.java index 9bbce68..baf3a73 100644 --- a/src/main/java/io/gate/gateapi/api/UnifiedApi.java +++ b/src/main/java/io/gate/gateapi/api/UnifiedApi.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -26,6 +26,8 @@ import io.gate.gateapi.models.UnifiedAccount; import io.gate.gateapi.models.UnifiedBorrowable; import io.gate.gateapi.models.UnifiedBorrowable1; +import io.gate.gateapi.models.UnifiedCollateralReq; +import io.gate.gateapi.models.UnifiedCollateralRes; import io.gate.gateapi.models.UnifiedCurrency; import io.gate.gateapi.models.UnifiedDiscount; import io.gate.gateapi.models.UnifiedHistoryLoanRate; @@ -132,7 +134,7 @@ private APIlistUnifiedAccountsRequest() { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Query by specified currency name (optional) * @return APIlistUnifiedAccountsRequest */ public APIlistUnifiedAccountsRequest currency(String currency) { @@ -158,7 +160,7 @@ public APIlistUnifiedAccountsRequest subUid(String subUid) { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -172,7 +174,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public UnifiedAccount execute() throws ApiException { @@ -187,7 +189,7 @@ public UnifiedAccount execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -202,7 +204,7 @@ public ApiResponse executeWithHttpInfo() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -212,12 +214,12 @@ public okhttp3.Call executeAsync(final ApiCallback _callback) th /** * 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) * @return APIlistUnifiedAccountsRequest * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public APIlistUnifiedAccountsRequest listUnifiedAccounts() { @@ -226,14 +228,14 @@ public APIlistUnifiedAccountsRequest listUnifiedAccounts() { /** * Build call for getUnifiedBorrowable - * @param currency Retrieve data of the specified currency (required) + * @param currency Query by specified currency name (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call getUnifiedBorrowableCall(String currency, final ApiCallback _callback) throws ApiException { @@ -281,15 +283,15 @@ private okhttp3.Call getUnifiedBorrowableValidateBeforeCall(String currency, fin } /** - * Query about the maximum borrowing for the unified account + * Query maximum borrowable amount for unified account * - * @param currency Retrieve data of the specified currency (required) + * @param currency Query by specified currency name (required) * @return UnifiedBorrowable * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public UnifiedBorrowable getUnifiedBorrowable(String currency) throws ApiException { @@ -298,15 +300,15 @@ public UnifiedBorrowable getUnifiedBorrowable(String currency) throws ApiExcepti } /** - * Query about the maximum borrowing for the unified account + * Query maximum borrowable amount for unified account * - * @param currency Retrieve data of the specified currency (required) + * @param currency Query by specified currency name (required) * @return ApiResponse<UnifiedBorrowable> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public ApiResponse getUnifiedBorrowableWithHttpInfo(String currency) throws ApiException { @@ -316,16 +318,16 @@ public ApiResponse getUnifiedBorrowableWithHttpInfo(String cu } /** - * Query about the maximum borrowing for the unified account (asynchronously) + * Query maximum borrowable amount for unified account (asynchronously) * - * @param currency Retrieve data of the specified currency (required) + * @param currency Query by specified currency name (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call getUnifiedBorrowableAsync(String currency, final ApiCallback _callback) throws ApiException { @@ -337,14 +339,14 @@ public okhttp3.Call getUnifiedBorrowableAsync(String currency, final ApiCallback /** * Build call for getUnifiedTransferable - * @param currency Retrieve data of the specified currency (required) + * @param currency Query by specified currency name (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call getUnifiedTransferableCall(String currency, final ApiCallback _callback) throws ApiException { @@ -392,15 +394,15 @@ private okhttp3.Call getUnifiedTransferableValidateBeforeCall(String currency, f } /** - * Query about the maximum transferable for the unified account + * Query maximum transferable amount for unified account * - * @param currency Retrieve data of the specified currency (required) + * @param currency Query by specified currency name (required) * @return UnifiedTransferable * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public UnifiedTransferable getUnifiedTransferable(String currency) throws ApiException { @@ -409,15 +411,15 @@ public UnifiedTransferable getUnifiedTransferable(String currency) throws ApiExc } /** - * Query about the maximum transferable for the unified account + * Query maximum transferable amount for unified account * - * @param currency Retrieve data of the specified currency (required) + * @param currency Query by specified currency name (required) * @return ApiResponse<UnifiedTransferable> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public ApiResponse getUnifiedTransferableWithHttpInfo(String currency) throws ApiException { @@ -427,16 +429,16 @@ public ApiResponse getUnifiedTransferableWithHttpInfo(Strin } /** - * Query about the maximum transferable for the unified account (asynchronously) + * Query maximum transferable amount for unified account (asynchronously) * - * @param currency Retrieve data of the specified currency (required) + * @param currency Query by specified currency name (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call getUnifiedTransferableAsync(String currency, final ApiCallback _callback) throws ApiException { @@ -448,14 +450,14 @@ public okhttp3.Call getUnifiedTransferableAsync(String currency, final ApiCallba /** * Build call for getUnifiedTransferables - * @param currencies Specify the currency name to query in batches, and support up to 100 pass parameters at a time. (required) + * @param currencies Specify the currency name to query in batches, and support up to 100 pass parameters at a time (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call getUnifiedTransferablesCall(String currencies, final ApiCallback _callback) throws ApiException { @@ -503,15 +505,15 @@ private okhttp3.Call getUnifiedTransferablesValidateBeforeCall(String 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 * - * @param currencies Specify the currency name to query in batches, and support up to 100 pass parameters at a time. (required) + * @param currencies Specify the currency name to query in batches, and support up to 100 pass parameters at a time (required) * @return List<TransferablesResult> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public List getUnifiedTransferables(String currencies) throws ApiException { @@ -520,15 +522,15 @@ public List getUnifiedTransferables(String currencies) thro } /** - * 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 * - * @param currencies Specify the currency name to query in batches, and support up to 100 pass parameters at a time. (required) + * @param currencies Specify the currency name to query in batches, and support up to 100 pass parameters at a time (required) * @return ApiResponse<List<TransferablesResult>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public ApiResponse> getUnifiedTransferablesWithHttpInfo(String currencies) throws ApiException { @@ -538,16 +540,16 @@ public ApiResponse> getUnifiedTransferablesWithHttpInf } /** - * 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. (asynchronously) + * 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 (asynchronously) * - * @param currencies Specify the currency name to query in batches, and support up to 100 pass parameters at a time. (required) + * @param currencies Specify the currency name to query in batches, and support up to 100 pass parameters at a time (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call getUnifiedTransferablesAsync(String currencies, final ApiCallback> _callback) throws ApiException { @@ -559,14 +561,14 @@ public okhttp3.Call getUnifiedTransferablesAsync(String currencies, final ApiCal /** * Build call for getUnifiedBorrowableList - * @param currencies Specify the currency names for querying in an array, separated by commas, with a maximum of 10 currencies. (required) + * @param currencies Specify currency names for querying in an array, separated by commas, maximum 10 currencies (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call getUnifiedBorrowableListCall(List currencies, final ApiCallback _callback) throws ApiException { @@ -614,15 +616,15 @@ private okhttp3.Call getUnifiedBorrowableListValidateBeforeCall(List cur } /** - * Batch query unified account can be borrowed up to a maximum + * Batch query unified account maximum borrowable amount * - * @param currencies Specify the currency names for querying in an array, separated by commas, with a maximum of 10 currencies. (required) + * @param currencies Specify currency names for querying in an array, separated by commas, maximum 10 currencies (required) * @return List<UnifiedBorrowable1> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public List getUnifiedBorrowableList(List currencies) throws ApiException { @@ -631,15 +633,15 @@ public List getUnifiedBorrowableList(List currencies } /** - * Batch query unified account can be borrowed up to a maximum + * Batch query unified account maximum borrowable amount * - * @param currencies Specify the currency names for querying in an array, separated by commas, with a maximum of 10 currencies. (required) + * @param currencies Specify currency names for querying in an array, separated by commas, maximum 10 currencies (required) * @return ApiResponse<List<UnifiedBorrowable1>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public ApiResponse> getUnifiedBorrowableListWithHttpInfo(List currencies) throws ApiException { @@ -649,16 +651,16 @@ public ApiResponse> getUnifiedBorrowableListWithHttpInf } /** - * Batch query unified account can be borrowed up to a maximum (asynchronously) + * Batch query unified account maximum borrowable amount (asynchronously) * - * @param currencies Specify the currency names for querying in an array, separated by commas, with a maximum of 10 currencies. (required) + * @param currencies Specify currency names for querying in an array, separated by commas, maximum 10 currencies (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call getUnifiedBorrowableListAsync(List currencies, final ApiCallback> _callback) throws ApiException { @@ -744,7 +746,7 @@ private APIlistUnifiedLoansRequest() { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Query by specified currency name (optional) * @return APIlistUnifiedLoansRequest */ public APIlistUnifiedLoansRequest currency(String currency) { @@ -764,7 +766,7 @@ public APIlistUnifiedLoansRequest page(Integer page) { /** * Set limit - * @param limit Maximum response items. Default: 100, minimum: 1, Maximum: 100 (optional, default to 100) + * @param limit Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 (optional, default to 100) * @return APIlistUnifiedLoansRequest */ public APIlistUnifiedLoansRequest limit(Integer limit) { @@ -774,7 +776,7 @@ public APIlistUnifiedLoansRequest limit(Integer limit) { /** * Set type - * @param type Loan type, platform - platform, margin - margin (optional) + * @param type Loan type: platform borrowing - platform, margin borrowing - margin (optional) * @return APIlistUnifiedLoansRequest */ public APIlistUnifiedLoansRequest type(String type) { @@ -790,7 +792,7 @@ public APIlistUnifiedLoansRequest type(String type) { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -804,7 +806,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public List execute() throws ApiException { @@ -819,7 +821,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -834,7 +836,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -843,13 +845,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) thr } /** - * List loans + * Query loans * * @return APIlistUnifiedLoansRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public APIlistUnifiedLoansRequest listUnifiedLoans() { @@ -865,7 +867,7 @@ public APIlistUnifiedLoansRequest listUnifiedLoans() { * @http.response.details - +
    Status Code Description Response Headers
    200 Operated successfully -
    200 Operation successful -
    */ public okhttp3.Call createUnifiedLoanCall(UnifiedLoan unifiedLoan, final ApiCallback _callback) throws ApiException { @@ -910,14 +912,14 @@ private okhttp3.Call createUnifiedLoanValidateBeforeCall(UnifiedLoan unifiedLoan /** * Borrow or repay - * When borrowing, it is essential to ensure that the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and the user. The interest on the loan will be automatically deducted from the account at regular intervals. It is the user's responsibility to manage the repayment of the borrowed amount. For repayment, the option to repay the entire borrowed amount is available by setting the parameter `repaid_all=true` + * When borrowing, ensure the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and user. Loan interest will be automatically deducted from the account at regular intervals. Users are responsible for managing repayment of borrowed amounts. For repayment, use `repaid_all=true` to repay all available amounts * @param unifiedLoan (required) * @return UnifiedLoanResult * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Operated successfully -
    200 Operation successful -
    */ public UnifiedLoanResult createUnifiedLoan(UnifiedLoan unifiedLoan) throws ApiException { @@ -927,14 +929,14 @@ public UnifiedLoanResult createUnifiedLoan(UnifiedLoan unifiedLoan) throws ApiEx /** * Borrow or repay - * When borrowing, it is essential to ensure that the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and the user. The interest on the loan will be automatically deducted from the account at regular intervals. It is the user's responsibility to manage the repayment of the borrowed amount. For repayment, the option to repay the entire borrowed amount is available by setting the parameter `repaid_all=true` + * When borrowing, ensure the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and user. Loan interest will be automatically deducted from the account at regular intervals. Users are responsible for managing repayment of borrowed amounts. For repayment, use `repaid_all=true` to repay all available amounts * @param unifiedLoan (required) * @return ApiResponse<UnifiedLoanResult> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Operated successfully -
    200 Operation successful -
    */ public ApiResponse createUnifiedLoanWithHttpInfo(UnifiedLoan unifiedLoan) throws ApiException { @@ -945,7 +947,7 @@ public ApiResponse createUnifiedLoanWithHttpInfo(UnifiedLoan /** * Borrow or repay (asynchronously) - * When borrowing, it is essential to ensure that the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and the user. The interest on the loan will be automatically deducted from the account at regular intervals. It is the user's responsibility to manage the repayment of the borrowed amount. For repayment, the option to repay the entire borrowed amount is available by setting the parameter `repaid_all=true` + * When borrowing, ensure the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and user. Loan interest will be automatically deducted from the account at regular intervals. Users are responsible for managing repayment of borrowed amounts. For repayment, use `repaid_all=true` to repay all available amounts * @param unifiedLoan (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -953,7 +955,7 @@ public ApiResponse createUnifiedLoanWithHttpInfo(UnifiedLoan * @http.response.details - +
    Status Code Description Response Headers
    200 Operated successfully -
    200 Operation successful -
    */ public okhttp3.Call createUnifiedLoanAsync(UnifiedLoan unifiedLoan, final ApiCallback _callback) throws ApiException { @@ -1039,7 +1041,7 @@ private APIlistUnifiedLoanRecordsRequest() { /** * Set type - * @param type The types of lending records, borrow - indicates the action of borrowing funds, repay - indicates the action of repaying the borrowed funds (optional) + * @param type Loan record type: borrow - borrowing, repay - repayment (optional) * @return APIlistUnifiedLoanRecordsRequest */ public APIlistUnifiedLoanRecordsRequest type(String type) { @@ -1049,7 +1051,7 @@ public APIlistUnifiedLoanRecordsRequest type(String type) { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Query by specified currency name (optional) * @return APIlistUnifiedLoanRecordsRequest */ public APIlistUnifiedLoanRecordsRequest currency(String currency) { @@ -1069,7 +1071,7 @@ public APIlistUnifiedLoanRecordsRequest page(Integer page) { /** * Set limit - * @param limit Maximum response items. Default: 100, minimum: 1, Maximum: 100 (optional, default to 100) + * @param limit Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 (optional, default to 100) * @return APIlistUnifiedLoanRecordsRequest */ public APIlistUnifiedLoanRecordsRequest limit(Integer limit) { @@ -1085,7 +1087,7 @@ public APIlistUnifiedLoanRecordsRequest limit(Integer limit) { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1099,7 +1101,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public List execute() throws ApiException { @@ -1114,7 +1116,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1129,7 +1131,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExce * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1138,13 +1140,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _cal } /** - * Get load records + * Query loan records * * @return APIlistUnifiedLoanRecordsRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public APIlistUnifiedLoanRecordsRequest listUnifiedLoanRecords() { @@ -1237,7 +1239,7 @@ private APIlistUnifiedLoanInterestRecordsRequest() { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Query by specified currency name (optional) * @return APIlistUnifiedLoanInterestRecordsRequest */ public APIlistUnifiedLoanInterestRecordsRequest currency(String currency) { @@ -1257,7 +1259,7 @@ public APIlistUnifiedLoanInterestRecordsRequest page(Integer page) { /** * Set limit - * @param limit Maximum response items. Default: 100, minimum: 1, Maximum: 100 (optional, default to 100) + * @param limit Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 (optional, default to 100) * @return APIlistUnifiedLoanInterestRecordsRequest */ public APIlistUnifiedLoanInterestRecordsRequest limit(Integer limit) { @@ -1267,7 +1269,7 @@ public APIlistUnifiedLoanInterestRecordsRequest limit(Integer limit) { /** * Set from - * @param from Start timestamp of the query (optional) + * @param from Start timestamp for the query (optional) * @return APIlistUnifiedLoanInterestRecordsRequest */ public APIlistUnifiedLoanInterestRecordsRequest from(Long from) { @@ -1277,7 +1279,7 @@ public APIlistUnifiedLoanInterestRecordsRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to End timestamp for the query, defaults to current time if not specified (optional) * @return APIlistUnifiedLoanInterestRecordsRequest */ public APIlistUnifiedLoanInterestRecordsRequest to(Long to) { @@ -1287,7 +1289,7 @@ public APIlistUnifiedLoanInterestRecordsRequest to(Long to) { /** * Set type - * @param type Loan type, platform loan - platform, leverage loan - margin, if not passed, defaults to margin (optional) + * @param type Loan type: platform borrowing - platform, margin borrowing - margin. Defaults to margin if not specified (optional) * @return APIlistUnifiedLoanInterestRecordsRequest */ public APIlistUnifiedLoanInterestRecordsRequest type(String type) { @@ -1303,7 +1305,7 @@ public APIlistUnifiedLoanInterestRecordsRequest type(String type) { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1317,7 +1319,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public List execute() throws ApiException { @@ -1332,7 +1334,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1347,7 +1349,7 @@ public ApiResponse> executeWithHttpInfo() throws Api * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1356,13 +1358,13 @@ public okhttp3.Call executeAsync(final ApiCallback> } /** - * List interest records + * Query interest deduction records * * @return APIlistUnifiedLoanInterestRecordsRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public APIlistUnifiedLoanInterestRecordsRequest listUnifiedLoanInterestRecords() { @@ -1377,7 +1379,7 @@ public APIlistUnifiedLoanInterestRecordsRequest listUnifiedLoanInterestRecords() * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call getUnifiedRiskUnitsCall(final ApiCallback _callback) throws ApiException { @@ -1417,13 +1419,13 @@ private okhttp3.Call getUnifiedRiskUnitsValidateBeforeCall(final ApiCallback _ca /** * 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 * @return UnifiedRiskUnits * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public UnifiedRiskUnits getUnifiedRiskUnits() throws ApiException { @@ -1433,13 +1435,13 @@ public UnifiedRiskUnits getUnifiedRiskUnits() throws ApiException { /** * 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 * @return ApiResponse<UnifiedRiskUnits> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public ApiResponse getUnifiedRiskUnitsWithHttpInfo() throws ApiException { @@ -1450,14 +1452,14 @@ public ApiResponse getUnifiedRiskUnitsWithHttpInfo() throws Ap /** * Get user risk unit details (asynchronously) - * Retrieve user risk unit details, only valid in portfolio margin mode + * Get user risk unit details, only valid in portfolio margin mode * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call getUnifiedRiskUnitsAsync(final ApiCallback _callback) throws ApiException { @@ -1475,7 +1477,7 @@ public okhttp3.Call getUnifiedRiskUnitsAsync(final ApiCallback * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call getUnifiedModeCall(final ApiCallback _callback) throws ApiException { @@ -1521,7 +1523,7 @@ private okhttp3.Call getUnifiedModeValidateBeforeCall(final ApiCallback _callbac * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public UnifiedModeSet getUnifiedMode() throws ApiException { @@ -1537,7 +1539,7 @@ public UnifiedModeSet getUnifiedMode() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public ApiResponse getUnifiedModeWithHttpInfo() throws ApiException { @@ -1555,7 +1557,7 @@ public ApiResponse getUnifiedModeWithHttpInfo() throws ApiExcept * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call getUnifiedModeAsync(final ApiCallback _callback) throws ApiException { @@ -1574,7 +1576,7 @@ public okhttp3.Call getUnifiedModeAsync(final ApiCallback _callb * @http.response.details - +
    Status Code Description Response Headers
    204 Success -
    204 Set successfully -
    */ public okhttp3.Call setUnifiedModeCall(UnifiedModeSet unifiedModeSet, final ApiCallback _callback) throws ApiException { @@ -1618,14 +1620,14 @@ private okhttp3.Call setUnifiedModeValidateBeforeCall(UnifiedModeSet unifiedMode } /** - * Set mode of the unified account - * Switching each account mode only requires passing the parameters of the corresponding account mode, and supports turning on or off the configuration switch in the corresponding account mode when switching the account mode - When opening the classic account mode, mode=classic ``` PUT /unified/unified_mode { \"mode\": \"classic\" } ``` - Open the cross-currency margin mode, mode=multi_currency ``` PUT /unified/unified_mode { \"mode\": \"multi_currency\", \"settings\": { \"usdt_futures\": true } } ``` - When the portfolio margin mode is enabled, mode=portfolio ``` PUT /unified/unified_mode { \"mode\": \"portfolio\", \"settings\": { \"spot_hedge\": true } } ``` - When opening a single currency margin mode, mode=single_currency ``` PUT /unified/unified_mode { \"mode\": \"single_currency\" } ``` + * 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\" } ``` * @param unifiedModeSet (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    204 Success -
    204 Set successfully -
    */ public void setUnifiedMode(UnifiedModeSet unifiedModeSet) throws ApiException { @@ -1633,15 +1635,15 @@ public void setUnifiedMode(UnifiedModeSet unifiedModeSet) throws ApiException { } /** - * Set mode of the unified account - * Switching each account mode only requires passing the parameters of the corresponding account mode, and supports turning on or off the configuration switch in the corresponding account mode when switching the account mode - When opening the classic account mode, mode=classic ``` PUT /unified/unified_mode { \"mode\": \"classic\" } ``` - Open the cross-currency margin mode, mode=multi_currency ``` PUT /unified/unified_mode { \"mode\": \"multi_currency\", \"settings\": { \"usdt_futures\": true } } ``` - When the portfolio margin mode is enabled, mode=portfolio ``` PUT /unified/unified_mode { \"mode\": \"portfolio\", \"settings\": { \"spot_hedge\": true } } ``` - When opening a single currency margin mode, mode=single_currency ``` PUT /unified/unified_mode { \"mode\": \"single_currency\" } ``` + * 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\" } ``` * @param unifiedModeSet (required) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    204 Success -
    204 Set successfully -
    */ public ApiResponse setUnifiedModeWithHttpInfo(UnifiedModeSet unifiedModeSet) throws ApiException { @@ -1650,8 +1652,8 @@ public ApiResponse setUnifiedModeWithHttpInfo(UnifiedModeSet unifiedModeSe } /** - * Set mode of the unified account (asynchronously) - * Switching each account mode only requires passing the parameters of the corresponding account mode, and supports turning on or off the configuration switch in the corresponding account mode when switching the account mode - When opening the classic account mode, mode=classic ``` PUT /unified/unified_mode { \"mode\": \"classic\" } ``` - Open the cross-currency margin mode, mode=multi_currency ``` PUT /unified/unified_mode { \"mode\": \"multi_currency\", \"settings\": { \"usdt_futures\": true } } ``` - When the portfolio margin mode is enabled, mode=portfolio ``` PUT /unified/unified_mode { \"mode\": \"portfolio\", \"settings\": { \"spot_hedge\": true } } ``` - When opening a single currency margin mode, mode=single_currency ``` PUT /unified/unified_mode { \"mode\": \"single_currency\" } ``` + * Set unified account mode (asynchronously) + * 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\" } ``` * @param unifiedModeSet (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1659,7 +1661,7 @@ public ApiResponse setUnifiedModeWithHttpInfo(UnifiedModeSet unifiedModeSe * @http.response.details - +
    Status Code Description Response Headers
    204 Success -
    204 Set successfully -
    */ public okhttp3.Call setUnifiedModeAsync(UnifiedModeSet unifiedModeSet, final ApiCallback _callback) throws ApiException { @@ -1670,14 +1672,14 @@ public okhttp3.Call setUnifiedModeAsync(UnifiedModeSet unifiedModeSet, final Api /** * Build call for getUnifiedEstimateRate - * @param currencies Specify the currency names for querying in an array, separated by commas, with a maximum of 10 currencies. (required) + * @param currencies Specify currency names for querying in an array, separated by commas, maximum 10 currencies (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call getUnifiedEstimateRateCall(List currencies, final ApiCallback _callback) throws ApiException { @@ -1725,15 +1727,15 @@ private okhttp3.Call getUnifiedEstimateRateValidateBeforeCall(List curre } /** - * Get unified estimate 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. - * @param currencies Specify the currency names for querying in an array, separated by commas, with a maximum of 10 currencies. (required) + * Query unified account estimated interest rate + * 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 + * @param currencies Specify currency names for querying in an array, separated by commas, maximum 10 currencies (required) * @return Map<String, String> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public Map getUnifiedEstimateRate(List currencies) throws ApiException { @@ -1742,15 +1744,15 @@ public Map getUnifiedEstimateRate(List currencies) throw } /** - * Get unified estimate 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. - * @param currencies Specify the currency names for querying in an array, separated by commas, with a maximum of 10 currencies. (required) + * Query unified account estimated interest rate + * 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 + * @param currencies Specify currency names for querying in an array, separated by commas, maximum 10 currencies (required) * @return ApiResponse<Map<String, String>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public ApiResponse> getUnifiedEstimateRateWithHttpInfo(List currencies) throws ApiException { @@ -1760,16 +1762,16 @@ public ApiResponse> getUnifiedEstimateRateWithHttpInfo(List< } /** - * Get unified estimate rate (asynchronously) - * 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. - * @param currencies Specify the currency names for querying in an array, separated by commas, with a maximum of 10 currencies. (required) + * Query unified account estimated interest rate (asynchronously) + * 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 + * @param currencies Specify currency names for querying in an array, separated by commas, maximum 10 currencies (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call getUnifiedEstimateRateAsync(List currencies, final ApiCallback> _callback) throws ApiException { @@ -1787,7 +1789,7 @@ public okhttp3.Call getUnifiedEstimateRateAsync(List currencies, final A * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call listCurrencyDiscountTiersCall(final ApiCallback _callback) throws ApiException { @@ -1826,14 +1828,14 @@ private okhttp3.Call listCurrencyDiscountTiersValidateBeforeCall(final ApiCallba } /** - * List currency discount tiers + * Query unified account tiered * * @return List<UnifiedDiscount> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public List listCurrencyDiscountTiers() throws ApiException { @@ -1842,14 +1844,14 @@ public List listCurrencyDiscountTiers() throws ApiException { } /** - * List currency discount tiers + * Query unified account tiered * * @return ApiResponse<List<UnifiedDiscount>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public ApiResponse> listCurrencyDiscountTiersWithHttpInfo() throws ApiException { @@ -1859,7 +1861,7 @@ public ApiResponse> listCurrencyDiscountTiersWithHttpInfo( } /** - * List currency discount tiers (asynchronously) + * Query unified account tiered (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1867,7 +1869,7 @@ public ApiResponse> listCurrencyDiscountTiersWithHttpInfo( * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call listCurrencyDiscountTiersAsync(final ApiCallback> _callback) throws ApiException { @@ -1885,7 +1887,7 @@ public okhttp3.Call listCurrencyDiscountTiersAsync(final ApiCallback Status Code Description Response Headers - 200 Successfully retrieved - + 200 Query successful - */ public okhttp3.Call listLoanMarginTiersCall(final ApiCallback _callback) throws ApiException { @@ -1924,14 +1926,14 @@ private okhttp3.Call listLoanMarginTiersValidateBeforeCall(final ApiCallback _ca } /** - * List loan margin tiers + * Query unified account tiered loan margin * * @return List<UnifiedMarginTiers> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public List listLoanMarginTiers() throws ApiException { @@ -1940,14 +1942,14 @@ public List listLoanMarginTiers() throws ApiException { } /** - * List loan margin tiers + * Query unified account tiered loan margin * * @return ApiResponse<List<UnifiedMarginTiers>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public ApiResponse> listLoanMarginTiersWithHttpInfo() throws ApiException { @@ -1957,7 +1959,7 @@ public ApiResponse> listLoanMarginTiersWithHttpInfo() t } /** - * List loan margin tiers (asynchronously) + * Query unified account tiered loan margin (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1965,7 +1967,7 @@ public ApiResponse> listLoanMarginTiersWithHttpInfo() t * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call listLoanMarginTiersAsync(final ApiCallback> _callback) throws ApiException { @@ -1984,7 +1986,7 @@ public okhttp3.Call listLoanMarginTiersAsync(final ApiCallback Status Code Description Response Headers - 200 Successfully retrieved - + 200 Query successful - */ public okhttp3.Call calculatePortfolioMarginCall(UnifiedPortfolioInput unifiedPortfolioInput, final ApiCallback _callback) throws ApiException { @@ -2029,14 +2031,14 @@ private okhttp3.Call calculatePortfolioMarginValidateBeforeCall(UnifiedPortfolio /** * Portfolio margin calculator - * Portfolio Margin Calculator When inputting a simulated position portfolio, each position includes the position name and quantity held, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. When inputting simulated orders, each order includes the market identifier, order price, and order quantity, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. Market orders are not included. + * Portfolio Margin Calculator When inputting simulated position portfolios, each position includes the position name and quantity held, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. When inputting simulated orders, each order includes the market identifier, order price, and order quantity, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. Market orders are not included. * @param unifiedPortfolioInput (required) * @return UnifiedPortfolioOutput * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public UnifiedPortfolioOutput calculatePortfolioMargin(UnifiedPortfolioInput unifiedPortfolioInput) throws ApiException { @@ -2046,14 +2048,14 @@ public UnifiedPortfolioOutput calculatePortfolioMargin(UnifiedPortfolioInput uni /** * Portfolio margin calculator - * Portfolio Margin Calculator When inputting a simulated position portfolio, each position includes the position name and quantity held, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. When inputting simulated orders, each order includes the market identifier, order price, and order quantity, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. Market orders are not included. + * Portfolio Margin Calculator When inputting simulated position portfolios, each position includes the position name and quantity held, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. When inputting simulated orders, each order includes the market identifier, order price, and order quantity, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. Market orders are not included. * @param unifiedPortfolioInput (required) * @return ApiResponse<UnifiedPortfolioOutput> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public ApiResponse calculatePortfolioMarginWithHttpInfo(UnifiedPortfolioInput unifiedPortfolioInput) throws ApiException { @@ -2064,7 +2066,7 @@ public ApiResponse calculatePortfolioMarginWithHttpInfo( /** * Portfolio margin calculator (asynchronously) - * Portfolio Margin Calculator When inputting a simulated position portfolio, each position includes the position name and quantity held, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. When inputting simulated orders, each order includes the market identifier, order price, and order quantity, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. Market orders are not included. + * Portfolio Margin Calculator When inputting simulated position portfolios, each position includes the position name and quantity held, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. When inputting simulated orders, each order includes the market identifier, order price, and order quantity, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. Market orders are not included. * @param unifiedPortfolioInput (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -2072,7 +2074,7 @@ public ApiResponse calculatePortfolioMarginWithHttpInfo( * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call calculatePortfolioMarginAsync(UnifiedPortfolioInput unifiedPortfolioInput, final ApiCallback _callback) throws ApiException { @@ -2091,7 +2093,7 @@ public okhttp3.Call calculatePortfolioMarginAsync(UnifiedPortfolioInput unifiedP * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call getUserLeverageCurrencyConfigCall(String currency, final ApiCallback _callback) throws ApiException { @@ -2139,7 +2141,7 @@ private okhttp3.Call getUserLeverageCurrencyConfigValidateBeforeCall(String curr } /** - * Minimum currency leverage that can be set + * Maximum and minimum currency leverage that can be set * * @param currency Currency (required) * @return UnifiedLeverageConfig @@ -2147,7 +2149,7 @@ private okhttp3.Call getUserLeverageCurrencyConfigValidateBeforeCall(String curr * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public UnifiedLeverageConfig getUserLeverageCurrencyConfig(String currency) throws ApiException { @@ -2156,7 +2158,7 @@ public UnifiedLeverageConfig getUserLeverageCurrencyConfig(String currency) thro } /** - * Minimum currency leverage that can be set + * Maximum and minimum currency leverage that can be set * * @param currency Currency (required) * @return ApiResponse<UnifiedLeverageConfig> @@ -2164,7 +2166,7 @@ public UnifiedLeverageConfig getUserLeverageCurrencyConfig(String currency) thro * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public ApiResponse getUserLeverageCurrencyConfigWithHttpInfo(String currency) throws ApiException { @@ -2174,7 +2176,7 @@ public ApiResponse getUserLeverageCurrencyConfigWithHttpI } /** - * Minimum currency leverage that can be set (asynchronously) + * Maximum and minimum currency leverage that can be set (asynchronously) * * @param currency Currency (required) * @param _callback The callback to be executed when the API call finishes @@ -2183,7 +2185,7 @@ public ApiResponse getUserLeverageCurrencyConfigWithHttpI * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call getUserLeverageCurrencyConfigAsync(String currency, final ApiCallback _callback) throws ApiException { @@ -2233,15 +2235,15 @@ private okhttp3.Call getUserLeverageCurrencySettingValidateBeforeCall(String cur } - private ApiResponse getUserLeverageCurrencySettingWithHttpInfo(String currency) throws ApiException { + private ApiResponse> getUserLeverageCurrencySettingWithHttpInfo(String currency) throws ApiException { okhttp3.Call localVarCall = getUserLeverageCurrencySettingValidateBeforeCall(currency, null); - Type localVarReturnType = new TypeToken(){}.getType(); + Type localVarReturnType = new TypeToken>(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } - private okhttp3.Call getUserLeverageCurrencySettingAsync(String currency, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getUserLeverageCurrencySettingAsync(String currency, final ApiCallback> _callback) throws ApiException { okhttp3.Call localVarCall = getUserLeverageCurrencySettingValidateBeforeCall(currency, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); + Type localVarReturnType = new TypeToken>(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } @@ -2270,7 +2272,7 @@ public APIgetUserLeverageCurrencySettingRequest currency(String currency) { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2279,30 +2281,30 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { /** * Execute getUserLeverageCurrencySetting request - * @return UnifiedLeverageSetting + * @return List<UnifiedLeverageSetting> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ - public UnifiedLeverageSetting execute() throws ApiException { - ApiResponse localVarResp = getUserLeverageCurrencySettingWithHttpInfo(currency); + public List execute() throws ApiException { + ApiResponse> localVarResp = getUserLeverageCurrencySettingWithHttpInfo(currency); return localVarResp.getData(); } /** * Execute getUserLeverageCurrencySetting request with HTTP info returned - * @return ApiResponse<UnifiedLeverageSetting> + * @return ApiResponse<List<UnifiedLeverageSetting>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ - public ApiResponse executeWithHttpInfo() throws ApiException { + public ApiResponse> executeWithHttpInfo() throws ApiException { return getUserLeverageCurrencySettingWithHttpInfo(currency); } @@ -2314,22 +2316,22 @@ public ApiResponse executeWithHttpInfo() throws ApiExcep * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ - public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { + public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { return getUserLeverageCurrencySettingAsync(currency, _callback); } } /** - * Get the leverage multiple of the user currency - * Get the user's currency leverage. If currency is not passed, query all currencies. + * Get user currency leverage + * Get user currency leverage. If currency is not specified, query all currencies * @return APIgetUserLeverageCurrencySettingRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public APIgetUserLeverageCurrencySettingRequest getUserLeverageCurrencySetting() { @@ -2345,7 +2347,7 @@ public APIgetUserLeverageCurrencySettingRequest getUserLeverageCurrencySetting() * @http.response.details - +
    Status Code Description Response Headers
    204 Success -
    204 Set successfully -
    */ public okhttp3.Call setUserLeverageCurrencySettingCall(UnifiedLeverageSetting unifiedLeverageSetting, final ApiCallback _callback) throws ApiException { @@ -2389,14 +2391,14 @@ private okhttp3.Call setUserLeverageCurrencySettingValidateBeforeCall(UnifiedLev } /** - * Set the loan currency leverage + * Set loan currency leverage * * @param unifiedLeverageSetting (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    204 Success -
    204 Set successfully -
    */ public void setUserLeverageCurrencySetting(UnifiedLeverageSetting unifiedLeverageSetting) throws ApiException { @@ -2404,7 +2406,7 @@ public void setUserLeverageCurrencySetting(UnifiedLeverageSetting unifiedLeverag } /** - * Set the loan currency leverage + * Set loan currency leverage * * @param unifiedLeverageSetting (required) * @return ApiResponse<Void> @@ -2412,7 +2414,7 @@ public void setUserLeverageCurrencySetting(UnifiedLeverageSetting unifiedLeverag * @http.response.details - +
    Status Code Description Response Headers
    204 Success -
    204 Set successfully -
    */ public ApiResponse setUserLeverageCurrencySettingWithHttpInfo(UnifiedLeverageSetting unifiedLeverageSetting) throws ApiException { @@ -2421,7 +2423,7 @@ public ApiResponse setUserLeverageCurrencySettingWithHttpInfo(UnifiedLever } /** - * Set the loan currency leverage (asynchronously) + * Set loan currency leverage (asynchronously) * * @param unifiedLeverageSetting (required) * @param _callback The callback to be executed when the API call finishes @@ -2430,7 +2432,7 @@ public ApiResponse setUserLeverageCurrencySettingWithHttpInfo(UnifiedLever * @http.response.details - +
    Status Code Description Response Headers
    204 Success -
    204 Set successfully -
    */ public okhttp3.Call setUserLeverageCurrencySettingAsync(UnifiedLeverageSetting unifiedLeverageSetting, final ApiCallback _callback) throws ApiException { @@ -2516,7 +2518,7 @@ public APIlistUnifiedCurrenciesRequest currency(String currency) { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2530,7 +2532,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public List execute() throws ApiException { @@ -2545,7 +2547,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -2560,7 +2562,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcept * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2575,7 +2577,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _callb * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public APIlistUnifiedCurrenciesRequest listUnifiedCurrencies() { @@ -2664,7 +2666,7 @@ private APIgetHistoryLoanRateRequest(String currency) { /** * Set tier - * @param tier The VIP level of the floating rate that needs to be queried (optional) + * @param tier VIP level for the floating rate to be queried (optional) * @return APIgetHistoryLoanRateRequest */ public APIgetHistoryLoanRateRequest tier(String tier) { @@ -2684,7 +2686,7 @@ public APIgetHistoryLoanRateRequest page(Integer page) { /** * Set limit - * @param limit Maximum response items. Default: 100, minimum: 1, Maximum: 100 (optional, default to 100) + * @param limit Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 (optional, default to 100) * @return APIgetHistoryLoanRateRequest */ public APIgetHistoryLoanRateRequest limit(Integer limit) { @@ -2700,7 +2702,7 @@ public APIgetHistoryLoanRateRequest limit(Integer limit) { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2714,7 +2716,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public UnifiedHistoryLoanRate execute() throws ApiException { @@ -2729,7 +2731,7 @@ public UnifiedHistoryLoanRate execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -2744,7 +2746,7 @@ public ApiResponse executeWithHttpInfo() throws ApiExcep * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -2753,18 +2755,125 @@ public okhttp3.Call executeAsync(final ApiCallback _call } /** - * get historical lending rates + * Get historical lending rates * * @param currency Currency (required) * @return APIgetHistoryLoanRateRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public APIgetHistoryLoanRateRequest getHistoryLoanRate(String currency) { return new APIgetHistoryLoanRateRequest(currency); } + /** + * Build call for setUnifiedCollateral + * @param unifiedCollateralReq (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + +
    Status Code Description Response Headers
    200 Updated successfully -
    + */ + public okhttp3.Call setUnifiedCollateralCall(UnifiedCollateralReq unifiedCollateralReq, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = unifiedCollateralReq; + + // create path and map variables + String localVarPath = "/unified/collateral_currencies"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + String[] localVarAuthNames = new String[] { "apiv4" }; + return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call setUnifiedCollateralValidateBeforeCall(UnifiedCollateralReq unifiedCollateralReq, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'unifiedCollateralReq' is set + if (unifiedCollateralReq == null) { + throw new ApiException("Missing the required parameter 'unifiedCollateralReq' when calling setUnifiedCollateral(Async)"); + } + + okhttp3.Call localVarCall = setUnifiedCollateralCall(unifiedCollateralReq, _callback); + return localVarCall; + } + + /** + * Set collateral currency + * + * @param unifiedCollateralReq (required) + * @return UnifiedCollateralRes + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + +
    Status Code Description Response Headers
    200 Updated successfully -
    + */ + public UnifiedCollateralRes setUnifiedCollateral(UnifiedCollateralReq unifiedCollateralReq) throws ApiException { + ApiResponse localVarResp = setUnifiedCollateralWithHttpInfo(unifiedCollateralReq); + return localVarResp.getData(); + } + + /** + * Set collateral currency + * + * @param unifiedCollateralReq (required) + * @return ApiResponse<UnifiedCollateralRes> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + +
    Status Code Description Response Headers
    200 Updated successfully -
    + */ + public ApiResponse setUnifiedCollateralWithHttpInfo(UnifiedCollateralReq unifiedCollateralReq) throws ApiException { + okhttp3.Call localVarCall = setUnifiedCollateralValidateBeforeCall(unifiedCollateralReq, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Set collateral currency (asynchronously) + * + * @param unifiedCollateralReq (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + +
    Status Code Description Response Headers
    200 Updated successfully -
    + */ + public okhttp3.Call setUnifiedCollateralAsync(UnifiedCollateralReq unifiedCollateralReq, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = setUnifiedCollateralValidateBeforeCall(unifiedCollateralReq, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + } diff --git a/src/main/java/io/gate/gateapi/api/WalletApi.java b/src/main/java/io/gate/gateapi/api/WalletApi.java index d2d06df..aecf419 100644 --- a/src/main/java/io/gate/gateapi/api/WalletApi.java +++ b/src/main/java/io/gate/gateapi/api/WalletApi.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -33,6 +33,7 @@ import io.gate.gateapi.models.SubAccountMarginBalance; import io.gate.gateapi.models.SubAccountToSubAccount; import io.gate.gateapi.models.SubAccountTransfer; +import io.gate.gateapi.models.SubAccountTransferRecordItem; import io.gate.gateapi.models.TotalBalance; import io.gate.gateapi.models.TradeFee; import io.gate.gateapi.models.TransactionID; @@ -76,7 +77,7 @@ public void setApiClient(ApiClient apiClient) { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call listCurrencyChainsCall(String currency, final ApiCallback _callback) throws ApiException { @@ -124,7 +125,7 @@ private okhttp3.Call listCurrencyChainsValidateBeforeCall(String currency, final } /** - * List chains supported for specified currency + * Query chains supported for specified currency * * @param currency Currency name (required) * @return List<CurrencyChain> @@ -132,7 +133,7 @@ private okhttp3.Call listCurrencyChainsValidateBeforeCall(String currency, final * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public List listCurrencyChains(String currency) throws ApiException { @@ -141,7 +142,7 @@ public List listCurrencyChains(String currency) throws ApiExcepti } /** - * List chains supported for specified currency + * Query chains supported for specified currency * * @param currency Currency name (required) * @return ApiResponse<List<CurrencyChain>> @@ -149,7 +150,7 @@ public List listCurrencyChains(String currency) throws ApiExcepti * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public ApiResponse> listCurrencyChainsWithHttpInfo(String currency) throws ApiException { @@ -159,7 +160,7 @@ public ApiResponse> listCurrencyChainsWithHttpInfo(String cu } /** - * List chains supported for specified currency (asynchronously) + * Query chains supported for specified currency (asynchronously) * * @param currency Currency name (required) * @param _callback The callback to be executed when the API call finishes @@ -168,7 +169,7 @@ public ApiResponse> listCurrencyChainsWithHttpInfo(String cu * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call listCurrencyChainsAsync(String currency, final ApiCallback> _callback) throws ApiException { @@ -385,7 +386,7 @@ private APIlistWithdrawalsRequest() { /** * Set currency - * @param currency Filter by currency. Return all currency records if not specified (optional) + * @param currency Specify the currency. If not specified, returns all currencies (optional) * @return APIlistWithdrawalsRequest */ public APIlistWithdrawalsRequest currency(String currency) { @@ -395,7 +396,7 @@ public APIlistWithdrawalsRequest currency(String currency) { /** * Set withdrawId - * @param withdrawId 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) + * @param withdrawId 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) * @return APIlistWithdrawalsRequest */ public APIlistWithdrawalsRequest withdrawId(String withdrawId) { @@ -405,7 +406,7 @@ public APIlistWithdrawalsRequest withdrawId(String withdrawId) { /** * Set assetClass - * @param assetClass 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) + * @param assetClass 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) * @return APIlistWithdrawalsRequest */ public APIlistWithdrawalsRequest assetClass(String assetClass) { @@ -415,7 +416,7 @@ public APIlistWithdrawalsRequest assetClass(String assetClass) { /** * Set withdrawOrderId - * @param withdrawOrderId User-defined order number when withdrawing. Default is empty. When not empty, the specified user-defined order number record will be queried (optional) + * @param withdrawOrderId User-defined order number for withdrawal. Default is empty. When not empty, the specified user-defined order number record will be queried (optional) * @return APIlistWithdrawalsRequest */ public APIlistWithdrawalsRequest withdrawOrderId(String withdrawOrderId) { @@ -425,7 +426,7 @@ public APIlistWithdrawalsRequest withdrawOrderId(String withdrawOrderId) { /** * Set from - * @param from Time range beginning, default to 7 days before current time (optional) + * @param from Start time for querying records, defaults to 7 days before current time if not specified (optional) * @return APIlistWithdrawalsRequest */ public APIlistWithdrawalsRequest from(Long from) { @@ -435,7 +436,7 @@ public APIlistWithdrawalsRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to End timestamp for the query, defaults to current time if not specified (optional) * @return APIlistWithdrawalsRequest */ public APIlistWithdrawalsRequest to(Long to) { @@ -445,7 +446,7 @@ public APIlistWithdrawalsRequest to(Long to) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistWithdrawalsRequest */ public APIlistWithdrawalsRequest limit(Integer limit) { @@ -471,7 +472,7 @@ public APIlistWithdrawalsRequest offset(Integer offset) { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -485,7 +486,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public List execute() throws ApiException { @@ -500,7 +501,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -515,7 +516,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcep * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -524,13 +525,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _call } /** - * Retrieve withdrawal records - * Record time range cannot exceed 30 days + * Get withdrawal records + * Record query time range cannot exceed 30 days * @return APIlistWithdrawalsRequest * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public APIlistWithdrawalsRequest listWithdrawals() { @@ -618,7 +619,7 @@ private APIlistDepositsRequest() { /** * Set currency - * @param currency Filter by currency. Return all currency records if not specified (optional) + * @param currency Specify the currency. If not specified, returns all currencies (optional) * @return APIlistDepositsRequest */ public APIlistDepositsRequest currency(String currency) { @@ -628,7 +629,7 @@ public APIlistDepositsRequest currency(String currency) { /** * Set from - * @param from Time range beginning, default to 7 days before current time (optional) + * @param from Start time for querying records, defaults to 7 days before current time if not specified (optional) * @return APIlistDepositsRequest */ public APIlistDepositsRequest from(Long from) { @@ -638,7 +639,7 @@ public APIlistDepositsRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to End timestamp for the query, defaults to current time if not specified (optional) * @return APIlistDepositsRequest */ public APIlistDepositsRequest to(Long to) { @@ -648,7 +649,7 @@ public APIlistDepositsRequest to(Long to) { /** * Set limit - * @param limit The maximum number of entries returned in the list is limited to 500 transactions. (optional, default to 100) + * @param limit Maximum number of entries returned in the list, limited to 500 transactions (optional, default to 100) * @return APIlistDepositsRequest */ public APIlistDepositsRequest limit(Integer limit) { @@ -674,7 +675,7 @@ public APIlistDepositsRequest offset(Integer offset) { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -688,7 +689,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public List execute() throws ApiException { @@ -703,7 +704,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -718,7 +719,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExceptio * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -727,13 +728,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callbac } /** - * Retrieve deposit records - * Record time range cannot exceed 30 days + * Get deposit records + * Record query time range cannot exceed 30 days * @return APIlistDepositsRequest * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public APIlistDepositsRequest listDeposits() { @@ -749,7 +750,7 @@ public APIlistDepositsRequest listDeposits() { * @http.response.details - +
    Status Code Description Response Headers
    200 Balance transferred -
    200 Transfer operation successful -
    */ public okhttp3.Call transferCall(Transfer transfer, final ApiCallback _callback) throws ApiException { @@ -794,14 +795,14 @@ private okhttp3.Call transferValidateBeforeCall(Transfer transfer, final ApiCall /** * Transfer between trading accounts - * Transfer between different accounts. Currently support transfers between the following: 1. spot - margin 2. spot - futures(perpetual) 3. spot - delivery 4. spot - options + * Balance transfers between personal trading accounts. Currently supports the following transfer operations: 1. Spot account - Margin account 2. Spot account - Perpetual futures account 3. Spot account - Delivery futures account 4. Spot account - Options account * @param transfer (required) * @return TransactionID * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Balance transferred -
    200 Transfer operation successful -
    */ public TransactionID transfer(Transfer transfer) throws ApiException { @@ -811,14 +812,14 @@ public TransactionID transfer(Transfer transfer) throws ApiException { /** * Transfer between trading accounts - * Transfer between different accounts. Currently support transfers between the following: 1. spot - margin 2. spot - futures(perpetual) 3. spot - delivery 4. spot - options + * Balance transfers between personal trading accounts. Currently supports the following transfer operations: 1. Spot account - Margin account 2. Spot account - Perpetual futures account 3. Spot account - Delivery futures account 4. Spot account - Options account * @param transfer (required) * @return ApiResponse<TransactionID> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Balance transferred -
    200 Transfer operation successful -
    */ public ApiResponse transferWithHttpInfo(Transfer transfer) throws ApiException { @@ -829,7 +830,7 @@ public ApiResponse transferWithHttpInfo(Transfer transfer) throws /** * Transfer between trading accounts (asynchronously) - * Transfer between different accounts. Currently support transfers between the following: 1. spot - margin 2. spot - futures(perpetual) 3. spot - delivery 4. spot - options + * Balance transfers between personal trading accounts. Currently supports the following transfer operations: 1. Spot account - Margin account 2. Spot account - Perpetual futures account 3. Spot account - Delivery futures account 4. Spot account - Options account * @param transfer (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -837,7 +838,7 @@ public ApiResponse transferWithHttpInfo(Transfer transfer) throws * @http.response.details - +
    Status Code Description Response Headers
    200 Balance transferred -
    200 Transfer operation successful -
    */ public okhttp3.Call transferAsync(Transfer transfer, final ApiCallback _callback) throws ApiException { @@ -903,15 +904,15 @@ private okhttp3.Call listSubAccountTransfersValidateBeforeCall(String subUid, Lo } - private ApiResponse> listSubAccountTransfersWithHttpInfo(String subUid, Long from, Long to, Integer limit, Integer offset) throws ApiException { + private ApiResponse> listSubAccountTransfersWithHttpInfo(String subUid, Long from, Long to, Integer limit, Integer offset) throws ApiException { okhttp3.Call localVarCall = listSubAccountTransfersValidateBeforeCall(subUid, from, to, limit, offset, null); - Type localVarReturnType = new TypeToken>(){}.getType(); + Type localVarReturnType = new TypeToken>(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } - private okhttp3.Call listSubAccountTransfersAsync(String subUid, Long from, Long to, Integer limit, Integer offset, final ApiCallback> _callback) throws ApiException { + private okhttp3.Call listSubAccountTransfersAsync(String subUid, Long from, Long to, Integer limit, Integer offset, final ApiCallback> _callback) throws ApiException { okhttp3.Call localVarCall = listSubAccountTransfersValidateBeforeCall(subUid, from, to, limit, offset, _callback); - Type localVarReturnType = new TypeToken>(){}.getType(); + Type localVarReturnType = new TypeToken>(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } @@ -928,7 +929,7 @@ private APIlistSubAccountTransfersRequest() { /** * Set subUid - * @param subUid 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) + * @param subUid Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts (optional) * @return APIlistSubAccountTransfersRequest */ public APIlistSubAccountTransfersRequest subUid(String subUid) { @@ -938,7 +939,7 @@ public APIlistSubAccountTransfersRequest subUid(String subUid) { /** * Set from - * @param from Time range beginning, default to 7 days before current time (optional) + * @param from Start time for querying records, defaults to 7 days before current time if not specified (optional) * @return APIlistSubAccountTransfersRequest */ public APIlistSubAccountTransfersRequest from(Long from) { @@ -948,7 +949,7 @@ public APIlistSubAccountTransfersRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to End timestamp for the query, defaults to current time if not specified (optional) * @return APIlistSubAccountTransfersRequest */ public APIlistSubAccountTransfersRequest to(Long to) { @@ -958,7 +959,7 @@ public APIlistSubAccountTransfersRequest to(Long to) { /** * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @param limit Maximum number of records returned in a single list (optional, default to 100) * @return APIlistSubAccountTransfersRequest */ public APIlistSubAccountTransfersRequest limit(Integer limit) { @@ -984,7 +985,7 @@ public APIlistSubAccountTransfersRequest offset(Integer offset) { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -993,30 +994,30 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { /** * Execute listSubAccountTransfers request - * @return List<SubAccountTransfer> + * @return List<SubAccountTransferRecordItem> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ - public List execute() throws ApiException { - ApiResponse> localVarResp = listSubAccountTransfersWithHttpInfo(subUid, from, to, limit, offset); + public List execute() throws ApiException { + ApiResponse> localVarResp = listSubAccountTransfersWithHttpInfo(subUid, from, to, limit, offset); return localVarResp.getData(); } /** * Execute listSubAccountTransfers request with HTTP info returned - * @return ApiResponse<List<SubAccountTransfer>> + * @return ApiResponse<List<SubAccountTransferRecordItem>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ - public ApiResponse> executeWithHttpInfo() throws ApiException { + public ApiResponse> executeWithHttpInfo() throws ApiException { return listSubAccountTransfersWithHttpInfo(subUid, from, to, limit, offset); } @@ -1028,22 +1029,22 @@ public ApiResponse> executeWithHttpInfo() throws ApiExc * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ - public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { + public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { return listSubAccountTransfersAsync(subUid, from, to, limit, offset, _callback); } } /** - * Retrieve transfer records between main and sub accounts - * Record time range cannot exceed 30 days > Note: only records after 2020-04-10 can be retrieved + * Get transfer records between main and sub accounts + * Record query time range cannot exceed 30 days > Note: Only records after 2020-04-10 can be retrieved * @return APIlistSubAccountTransfersRequest * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public APIlistSubAccountTransfersRequest listSubAccountTransfers() { @@ -1059,7 +1060,7 @@ public APIlistSubAccountTransfersRequest listSubAccountTransfers() { * @http.response.details - +
    Status Code Description Response Headers
    200 Balance transferred -
    200 Transfer operation successful -
    */ public okhttp3.Call transferWithSubAccountCall(SubAccountTransfer subAccountTransfer, final ApiCallback _callback) throws ApiException { @@ -1104,14 +1105,14 @@ private okhttp3.Call transferWithSubAccountValidateBeforeCall(SubAccountTransfer /** * 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 * @param subAccountTransfer (required) * @return TransactionID * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Balance transferred -
    200 Transfer operation successful -
    */ public TransactionID transferWithSubAccount(SubAccountTransfer subAccountTransfer) throws ApiException { @@ -1121,14 +1122,14 @@ public TransactionID transferWithSubAccount(SubAccountTransfer subAccountTransfe /** * 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 * @param subAccountTransfer (required) * @return ApiResponse<TransactionID> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Balance transferred -
    200 Transfer operation successful -
    */ public ApiResponse transferWithSubAccountWithHttpInfo(SubAccountTransfer subAccountTransfer) throws ApiException { @@ -1139,7 +1140,7 @@ public ApiResponse transferWithSubAccountWithHttpInfo(SubAccountT /** * Transfer between main and sub accounts (asynchronously) - * 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 * @param subAccountTransfer (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1147,7 +1148,7 @@ public ApiResponse transferWithSubAccountWithHttpInfo(SubAccountT * @http.response.details - +
    Status Code Description Response Headers
    200 Balance transferred -
    200 Transfer operation successful -
    */ public okhttp3.Call transferWithSubAccountAsync(SubAccountTransfer subAccountTransfer, final ApiCallback _callback) throws ApiException { @@ -1166,7 +1167,7 @@ public okhttp3.Call transferWithSubAccountAsync(SubAccountTransfer subAccountTra * @http.response.details - +
    Status Code Description Response Headers
    200 Balance transferred -
    200 Transfer operation successful -
    */ public okhttp3.Call subAccountToSubAccountCall(SubAccountToSubAccount subAccountToSubAccount, final ApiCallback _callback) throws ApiException { @@ -1210,15 +1211,15 @@ private okhttp3.Call subAccountToSubAccountValidateBeforeCall(SubAccountToSubAcc } /** - * Sub-account transfers to sub-account - * It is possible to perform balance transfers between two sub-accounts under the same main account. You can use either the API Key of the main account or the API Key of the sub-account to initiate the transfer. + * Transfer between sub-accounts + * 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 * @param subAccountToSubAccount (required) * @return TransactionID * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Balance transferred -
    200 Transfer operation successful -
    */ public TransactionID subAccountToSubAccount(SubAccountToSubAccount subAccountToSubAccount) throws ApiException { @@ -1227,15 +1228,15 @@ public TransactionID subAccountToSubAccount(SubAccountToSubAccount subAccountToS } /** - * Sub-account transfers to sub-account - * It is possible to perform balance transfers between two sub-accounts under the same main account. You can use either the API Key of the main account or the API Key of the sub-account to initiate the transfer. + * Transfer between sub-accounts + * 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 * @param subAccountToSubAccount (required) * @return ApiResponse<TransactionID> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details - +
    Status Code Description Response Headers
    200 Balance transferred -
    200 Transfer operation successful -
    */ public ApiResponse subAccountToSubAccountWithHttpInfo(SubAccountToSubAccount subAccountToSubAccount) throws ApiException { @@ -1245,8 +1246,8 @@ public ApiResponse subAccountToSubAccountWithHttpInfo(SubAccountT } /** - * Sub-account transfers to sub-account (asynchronously) - * It is possible to perform balance transfers between two sub-accounts under the same main account. You can use either the API Key of the main account or the API Key of the sub-account to initiate the transfer. + * Transfer between sub-accounts (asynchronously) + * 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 * @param subAccountToSubAccount (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1254,7 +1255,7 @@ public ApiResponse subAccountToSubAccountWithHttpInfo(SubAccountT * @http.response.details - +
    Status Code Description Response Headers
    200 Balance transferred -
    200 Transfer operation successful -
    */ public okhttp3.Call subAccountToSubAccountAsync(SubAccountToSubAccount subAccountToSubAccount, final ApiCallback _callback) throws ApiException { @@ -1330,7 +1331,7 @@ private APIgetTransferOrderStatusRequest() { /** * Set clientOrderId - * @param clientOrderId 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) + * @param clientOrderId 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) * @return APIgetTransferOrderStatusRequest */ public APIgetTransferOrderStatusRequest clientOrderId(String clientOrderId) { @@ -1340,7 +1341,7 @@ public APIgetTransferOrderStatusRequest clientOrderId(String clientOrderId) { /** * Set txId - * @param txId The transfer operation number and client_order_id cannot be empty at the same time (optional) + * @param txId Transfer operation number, cannot be empty at the same time as client_order_id (optional) * @return APIgetTransferOrderStatusRequest */ public APIgetTransferOrderStatusRequest txId(String txId) { @@ -1356,7 +1357,7 @@ public APIgetTransferOrderStatusRequest txId(String txId) { * @http.response.details - +
    Status Code Description Response Headers
    200 Transfer status obtained successfully -
    200 Transfer status retrieved successfully -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1370,7 +1371,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Transfer status obtained successfully -
    200 Transfer status retrieved successfully -
    */ public TransferOrderStatus execute() throws ApiException { @@ -1385,7 +1386,7 @@ public TransferOrderStatus execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Transfer status obtained successfully -
    200 Transfer status retrieved successfully -
    */ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -1400,7 +1401,7 @@ public ApiResponse executeWithHttpInfo() throws ApiExceptio * @http.response.details - +
    Status Code Description Response Headers
    200 Transfer status obtained successfully -
    200 Transfer status retrieved successfully -
    */ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -1410,12 +1411,12 @@ public okhttp3.Call executeAsync(final ApiCallback _callbac /** * 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 * @return APIgetTransferOrderStatusRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Transfer status obtained successfully -
    200 Transfer status retrieved successfully -
    */ public APIgetTransferOrderStatusRequest getTransferOrderStatus() { @@ -1483,7 +1484,7 @@ private APIlistWithdrawStatusRequest() { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Query by specified currency name (optional) * @return APIlistWithdrawStatusRequest */ public APIlistWithdrawStatusRequest currency(String currency) { @@ -1499,7 +1500,7 @@ public APIlistWithdrawStatusRequest currency(String currency) { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1513,7 +1514,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public List execute() throws ApiException { @@ -1528,7 +1529,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1543,7 +1544,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcepti * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1552,13 +1553,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callba } /** - * Retrieve withdrawal status + * Query withdrawal status * * @return APIlistWithdrawStatusRequest * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public APIlistWithdrawStatusRequest listWithdrawStatus() { @@ -1626,7 +1627,7 @@ private APIlistSubAccountBalancesRequest() { /** * Set subUid - * @param subUid 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) + * @param subUid Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts (optional) * @return APIlistSubAccountBalancesRequest */ public APIlistSubAccountBalancesRequest subUid(String subUid) { @@ -1642,7 +1643,7 @@ public APIlistSubAccountBalancesRequest subUid(String subUid) { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1656,7 +1657,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public List execute() throws ApiException { @@ -1671,7 +1672,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1686,7 +1687,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExce * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1695,13 +1696,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _cal } /** - * Retrieve sub account balances + * Query sub-account balance information * * @return APIlistSubAccountBalancesRequest * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public APIlistSubAccountBalancesRequest listSubAccountBalances() { @@ -1769,7 +1770,7 @@ private APIlistSubAccountMarginBalancesRequest() { /** * Set subUid - * @param subUid 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) + * @param subUid Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts (optional) * @return APIlistSubAccountMarginBalancesRequest */ public APIlistSubAccountMarginBalancesRequest subUid(String subUid) { @@ -1785,7 +1786,7 @@ public APIlistSubAccountMarginBalancesRequest subUid(String subUid) { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1799,7 +1800,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public List execute() throws ApiException { @@ -1814,7 +1815,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1829,7 +1830,7 @@ public ApiResponse> executeWithHttpInfo() throws A * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1838,13 +1839,13 @@ public okhttp3.Call executeAsync(final ApiCallback } /** - * Query sub accounts' margin balances + * Query sub-account isolated margin account balance information * * @return APIlistSubAccountMarginBalancesRequest * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public APIlistSubAccountMarginBalancesRequest listSubAccountMarginBalances() { @@ -1917,7 +1918,7 @@ private APIlistSubAccountFuturesBalancesRequest() { /** * Set subUid - * @param subUid 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) + * @param subUid Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts (optional) * @return APIlistSubAccountFuturesBalancesRequest */ public APIlistSubAccountFuturesBalancesRequest subUid(String subUid) { @@ -1927,7 +1928,7 @@ public APIlistSubAccountFuturesBalancesRequest subUid(String subUid) { /** * Set settle - * @param settle Query only balances of specified settle currency (optional) + * @param settle Query balance of specified settlement currency (optional) * @return APIlistSubAccountFuturesBalancesRequest */ public APIlistSubAccountFuturesBalancesRequest settle(String settle) { @@ -1943,7 +1944,7 @@ public APIlistSubAccountFuturesBalancesRequest settle(String settle) { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1957,7 +1958,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public List execute() throws ApiException { @@ -1972,7 +1973,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1987,7 +1988,7 @@ public ApiResponse> executeWithHttpInfo() throws * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1996,13 +1997,13 @@ public okhttp3.Call executeAsync(final ApiCallback Status Code Description Response Headers - 200 List retrieved - + 200 List retrieved successfully - */ public APIlistSubAccountFuturesBalancesRequest listSubAccountFuturesBalances() { @@ -2070,7 +2071,7 @@ private APIlistSubAccountCrossMarginBalancesRequest() { /** * Set subUid - * @param subUid 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) + * @param subUid Sub-account user ID, you can query multiple records separated by `,`. If not specified, it will return records of all sub-accounts (optional) * @return APIlistSubAccountCrossMarginBalancesRequest */ public APIlistSubAccountCrossMarginBalancesRequest subUid(String subUid) { @@ -2086,7 +2087,7 @@ public APIlistSubAccountCrossMarginBalancesRequest subUid(String subUid) { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2100,7 +2101,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public List execute() throws ApiException { @@ -2115,7 +2116,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -2130,7 +2131,7 @@ public ApiResponse> executeWithHttpInfo() thr * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2139,13 +2140,13 @@ public okhttp3.Call executeAsync(final ApiCallback Status Code Description Response Headers - 200 List retrieved - + 200 List retrieved successfully - */ public APIlistSubAccountCrossMarginBalancesRequest listSubAccountCrossMarginBalances() { @@ -2244,7 +2245,7 @@ public APIlistSavedAddressRequest chain(String chain) { /** * Set limit - * @param limit Maximum number returned, 100 at most (optional, default to "50") + * @param limit Maximum number returned, up to 100 (optional, default to "50") * @return APIlistSavedAddressRequest */ public APIlistSavedAddressRequest limit(String limit) { @@ -2270,7 +2271,7 @@ public APIlistSavedAddressRequest page(Integer page) { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2284,7 +2285,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public List execute() throws ApiException { @@ -2299,7 +2300,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -2314,7 +2315,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2323,14 +2324,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * Query saved address + * Query withdrawal address whitelist * * @param currency Currency (required) * @return APIlistSavedAddressRequest * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved successfully -
    */ public APIlistSavedAddressRequest listSavedAddress(String currency) { @@ -2403,7 +2404,7 @@ private APIgetTradeFeeRequest() { /** * Set currencyPair - * @param currencyPair 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) + * @param currencyPair 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 APIgetTradeFeeRequest */ public APIgetTradeFeeRequest currencyPair(String currencyPair) { @@ -2413,7 +2414,7 @@ public APIgetTradeFeeRequest currencyPair(String currencyPair) { /** * Set settle - * @param 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. (optional) + * @param 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. (optional) * @return APIgetTradeFeeRequest */ public APIgetTradeFeeRequest settle(String settle) { @@ -2429,7 +2430,7 @@ public APIgetTradeFeeRequest settle(String settle) { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2443,7 +2444,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public TradeFee execute() throws ApiException { @@ -2458,7 +2459,7 @@ public TradeFee execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -2473,7 +2474,7 @@ public ApiResponse executeWithHttpInfo() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -2482,13 +2483,13 @@ public okhttp3.Call executeAsync(final ApiCallback _callback) throws A } /** - * Retrieve personal trading fee + * Query personal trading fees * * @return APIgetTradeFeeRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Query successful -
    */ public APIgetTradeFeeRequest getTradeFee() { @@ -2556,7 +2557,7 @@ private APIgetTotalBalanceRequest() { /** * Set currency - * @param currency Currency unit used to calculate the balance amount. BTC, CNY, USD and USDT are allowed. USDT is the default. (optional, default to "USDT") + * @param currency Target currency type for statistical conversion. Accepts BTC, CNY, USD, and USDT. USDT is the default value (optional, default to "USDT") * @return APIgetTotalBalanceRequest */ public APIgetTotalBalanceRequest currency(String currency) { @@ -2572,7 +2573,7 @@ public APIgetTotalBalanceRequest currency(String currency) { * @http.response.details - +
    Status Code Description Response Headers
    200 Request is valid and is successfully responded -
    200 Request is valid and successfully returned -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2586,7 +2587,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Request is valid and is successfully responded -
    200 Request is valid and successfully returned -
    */ public TotalBalance execute() throws ApiException { @@ -2601,7 +2602,7 @@ public TotalBalance execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Request is valid and is successfully responded -
    200 Request is valid and successfully returned -
    */ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -2616,7 +2617,7 @@ public ApiResponse executeWithHttpInfo() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Request is valid and is successfully responded -
    200 Request is valid and successfully returned -
    */ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -2625,13 +2626,13 @@ public okhttp3.Call executeAsync(final ApiCallback _callback) thro } /** - * Retrieve user's total balances - * This endpoint returns an approximate sum of exchanged amount from all currencies to input currency for each account.The exchange rate and account balance could have been cached for at most 1 minute. It is not recommended to use its result for any trading calculation. For trading calculation, use the corresponding account query endpoint for each account type. For example: - `GET /spot/accounts` to query spot account balance - `GET /margin/accounts` to query margin account balance - `GET /futures/{settle}/accounts` to query futures account balance + * Query personal account totals + * 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 * @return APIgetTotalBalanceRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Request is valid and is successfully responded -
    200 Request is valid and successfully returned -
    */ public APIgetTotalBalanceRequest getTotalBalance() { @@ -2685,7 +2686,7 @@ private okhttp3.Call listSmallBalanceValidateBeforeCall(final ApiCallback _callb } /** - * List small balance + * Get list of convertible small balance currencies * * @return List<SmallBalance> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -2701,7 +2702,7 @@ public List listSmallBalance() throws ApiException { } /** - * List small balance + * Get list of convertible small balance currencies * * @return ApiResponse<List<SmallBalance>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -2718,7 +2719,7 @@ public ApiResponse> listSmallBalanceWithHttpInfo() throws Api } /** - * List small balance (asynchronously) + * Get list of convertible small balance currencies (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -2789,7 +2790,7 @@ private okhttp3.Call convertSmallBalanceValidateBeforeCall(ConvertSmallBalance c } /** - * Convert small balance + * Convert small balance currency * * @param convertSmallBalance (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -2804,7 +2805,7 @@ public void convertSmallBalance(ConvertSmallBalance convertSmallBalance) throws } /** - * Convert small balance + * Convert small balance currency * * @param convertSmallBalance (required) * @return ApiResponse<Void> @@ -2821,7 +2822,7 @@ public ApiResponse convertSmallBalanceWithHttpInfo(ConvertSmallBalance con } /** - * Convert small balance (asynchronously) + * Convert small balance currency (asynchronously) * * @param convertSmallBalance (required) * @param _callback The callback to be executed when the API call finishes @@ -2910,7 +2911,7 @@ private APIlistSmallBalanceHistoryRequest() { /** * Set currency - * @param currency Currency (optional) + * @param currency Currency to convert (optional) * @return APIlistSmallBalanceHistoryRequest */ public APIlistSmallBalanceHistoryRequest currency(String currency) { @@ -2930,7 +2931,7 @@ public APIlistSmallBalanceHistoryRequest page(Integer page) { /** * Set limit - * @param limit Maximum response items. Default: 100, minimum: 1, Maximum: 100 (optional, default to 100) + * @param limit Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 (optional, default to 100) * @return APIlistSmallBalanceHistoryRequest */ public APIlistSmallBalanceHistoryRequest limit(Integer limit) { @@ -2999,7 +3000,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _c } /** - * List small balance history + * Get convertible small balance currency history * * @return APIlistSmallBalanceHistoryRequest * @http.response.details @@ -3108,7 +3109,7 @@ public APIlistPushOrdersRequest id(Integer id) { /** * Set from - * @param 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 (optional) + * @param from Start time for querying records. If not specified, defaults to 7 days before the current time. Unix timestamp in seconds (optional) * @return APIlistPushOrdersRequest */ public APIlistPushOrdersRequest from(Integer from) { @@ -3118,7 +3119,7 @@ public APIlistPushOrdersRequest from(Integer from) { /** * Set to - * @param to The end time of the query record. If not specified, the default is the current time, which is a Unix timestamp in seconds. (optional) + * @param to End time for querying records. If not specified, defaults to the current time. Unix timestamp in seconds (optional) * @return APIlistPushOrdersRequest */ public APIlistPushOrdersRequest to(Integer to) { @@ -3128,7 +3129,7 @@ public APIlistPushOrdersRequest to(Integer to) { /** * Set limit - * @param limit The maximum number of items returned in the list, the default value is 100 (optional, default to 100) + * @param limit Maximum number of items returned in the list, default value is 100 (optional, default to 100) * @return APIlistPushOrdersRequest */ public APIlistPushOrdersRequest limit(Integer limit) { @@ -3148,7 +3149,7 @@ public APIlistPushOrdersRequest offset(Integer offset) { /** * Set transactionType - * @param transactionType The list returns the order type `withdraw`, `deposit`, the default is `withdraw`. (optional, default to "withdraw") + * @param transactionType Order type returned in the list: `withdraw`, `deposit`. Default is `withdraw`. (optional, default to "withdraw") * @return APIlistPushOrdersRequest */ public APIlistPushOrdersRequest transactionType(String transactionType) { @@ -3217,7 +3218,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * Retrieve the UID transfer history + * Get UID transfer history * * @return APIlistPushOrdersRequest * @http.response.details diff --git a/src/main/java/io/gate/gateapi/api/WithdrawalApi.java b/src/main/java/io/gate/gateapi/api/WithdrawalApi.java index da7aace..0d87ac1 100644 --- a/src/main/java/io/gate/gateapi/api/WithdrawalApi.java +++ b/src/main/java/io/gate/gateapi/api/WithdrawalApi.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -58,7 +58,7 @@ public void setApiClient(ApiClient apiClient) { * @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 -
    */ public okhttp3.Call withdrawCall(LedgerRecord ledgerRecord, final ApiCallback _callback) throws ApiException { @@ -103,14 +103,14 @@ private okhttp3.Call withdrawValidateBeforeCall(LedgerRecord ledgerRecord, final /** * 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 * @param ledgerRecord (required) * @return LedgerRecord * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @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 -
    */ public LedgerRecord withdraw(LedgerRecord ledgerRecord) throws ApiException { @@ -120,14 +120,14 @@ public LedgerRecord withdraw(LedgerRecord ledgerRecord) throws ApiException { /** * 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 * @param ledgerRecord (required) * @return ApiResponse<LedgerRecord> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @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 -
    */ public ApiResponse withdrawWithHttpInfo(LedgerRecord ledgerRecord) throws ApiException { @@ -138,7 +138,7 @@ public ApiResponse withdrawWithHttpInfo(LedgerRecord ledgerRecord) /** * Withdraw (asynchronously) - * 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 * @param ledgerRecord (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -146,7 +146,7 @@ public ApiResponse withdrawWithHttpInfo(LedgerRecord ledgerRecord) * @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 -
    */ public okhttp3.Call withdrawAsync(LedgerRecord ledgerRecord, final ApiCallback _callback) throws ApiException { @@ -165,7 +165,7 @@ public okhttp3.Call withdrawAsync(LedgerRecord ledgerRecord, final ApiCallback 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 - */ public okhttp3.Call withdrawPushOrderCall(UidPushWithdrawal uidPushWithdrawal, final ApiCallback _callback) throws ApiException { @@ -210,14 +210,14 @@ private okhttp3.Call withdrawPushOrderValidateBeforeCall(UidPushWithdrawal uidPu /** * 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 * @param uidPushWithdrawal (required) * @return UidPushWithdrawalResp * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @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 -
    */ public UidPushWithdrawalResp withdrawPushOrder(UidPushWithdrawal uidPushWithdrawal) throws ApiException { @@ -227,14 +227,14 @@ public UidPushWithdrawalResp withdrawPushOrder(UidPushWithdrawal uidPushWithdraw /** * 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 * @param uidPushWithdrawal (required) * @return ApiResponse<UidPushWithdrawalResp> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @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 -
    */ public ApiResponse withdrawPushOrderWithHttpInfo(UidPushWithdrawal uidPushWithdrawal) throws ApiException { @@ -245,7 +245,7 @@ public ApiResponse withdrawPushOrderWithHttpInfo(UidPushW /** * UID transfer (asynchronously) - * 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 * @param uidPushWithdrawal (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -253,7 +253,7 @@ public ApiResponse withdrawPushOrderWithHttpInfo(UidPushW * @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 -
    */ public okhttp3.Call withdrawPushOrderAsync(UidPushWithdrawal uidPushWithdrawal, final ApiCallback _callback) throws ApiException { @@ -272,7 +272,7 @@ public okhttp3.Call withdrawPushOrderAsync(UidPushWithdrawal uidPushWithdrawal, * @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 -
    */ public okhttp3.Call cancelWithdrawalCall(String withdrawalId, final ApiCallback _callback) throws ApiException { @@ -325,7 +325,7 @@ private okhttp3.Call cancelWithdrawalValidateBeforeCall(String withdrawalId, fin * @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 -
    */ public LedgerRecord cancelWithdrawal(String withdrawalId) throws ApiException { @@ -342,7 +342,7 @@ public LedgerRecord cancelWithdrawal(String withdrawalId) throws ApiException { * @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 -
    */ public ApiResponse cancelWithdrawalWithHttpInfo(String withdrawalId) throws ApiException { @@ -361,7 +361,7 @@ public ApiResponse cancelWithdrawalWithHttpInfo(String withdrawalI * @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 -
    */ public okhttp3.Call cancelWithdrawalAsync(String withdrawalId, final ApiCallback _callback) throws ApiException { diff --git a/src/main/java/io/gate/gateapi/auth/ApiKeyAuth.java b/src/main/java/io/gate/gateapi/auth/ApiKeyAuth.java index 6343a66..e60924a 100644 --- a/src/main/java/io/gate/gateapi/auth/ApiKeyAuth.java +++ b/src/main/java/io/gate/gateapi/auth/ApiKeyAuth.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/auth/Authentication.java b/src/main/java/io/gate/gateapi/auth/Authentication.java index c5f00a3..6191f46 100644 --- a/src/main/java/io/gate/gateapi/auth/Authentication.java +++ b/src/main/java/io/gate/gateapi/auth/Authentication.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/auth/GateApiV4Auth.java b/src/main/java/io/gate/gateapi/auth/GateApiV4Auth.java index f9fcad8..3eca118 100644 --- a/src/main/java/io/gate/gateapi/auth/GateApiV4Auth.java +++ b/src/main/java/io/gate/gateapi/auth/GateApiV4Auth.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/auth/HttpBasicAuth.java b/src/main/java/io/gate/gateapi/auth/HttpBasicAuth.java index ad2d6ac..6ea4fd8 100644 --- a/src/main/java/io/gate/gateapi/auth/HttpBasicAuth.java +++ b/src/main/java/io/gate/gateapi/auth/HttpBasicAuth.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/auth/HttpBearerAuth.java b/src/main/java/io/gate/gateapi/auth/HttpBearerAuth.java index cead920..738e743 100644 --- a/src/main/java/io/gate/gateapi/auth/HttpBearerAuth.java +++ b/src/main/java/io/gate/gateapi/auth/HttpBearerAuth.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/AccountBalance.java b/src/main/java/io/gate/gateapi/models/AccountBalance.java index 80f6227..ce94690 100644 --- a/src/main/java/io/gate/gateapi/models/AccountBalance.java +++ b/src/main/java/io/gate/gateapi/models/AccountBalance.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -158,7 +158,7 @@ public AccountBalance borrowed(String borrowed) { } /** - * Borrowed，this field will only appear in margin and cross_margin accounts + * Total borrowed amount, this field will only appear in margin and cross_margin accounts * @return borrowed **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/AccountDetail.java b/src/main/java/io/gate/gateapi/models/AccountDetail.java index cb88f43..a54edce 100644 --- a/src/main/java/io/gate/gateapi/models/AccountDetail.java +++ b/src/main/java/io/gate/gateapi/models/AccountDetail.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -23,7 +23,7 @@ import java.util.List; /** - * Account detail + * Account details */ public class AccountDetail { public static final String SERIALIZED_NAME_IP_WHITELIST = "ip_whitelist"; @@ -66,7 +66,7 @@ public AccountDetail addIpWhitelistItem(String ipWhitelistItem) { } /** - * IP whitelist + * IP Whitelist * @return ipWhitelist **/ @javax.annotation.Nullable @@ -94,7 +94,7 @@ public AccountDetail addCurrencyPairsItem(String currencyPairsItem) { } /** - * CurrencyPair whitelisting + * Trading pair whitelist * @return currencyPairs **/ @javax.annotation.Nullable @@ -174,7 +174,7 @@ public AccountDetail copyTradingRole(Integer copyTradingRole) { } /** - * User role: 0 - Ordinary user 1 - Order leader 2 - Follower 3 - Order leader and follower + * User role: 0 - Normal user, 1 - Copy trading leader, 2 - Follower, 3 - Both leader and follower * @return copyTradingRole **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/AccountDetailKey.java b/src/main/java/io/gate/gateapi/models/AccountDetailKey.java index 2c6f05e..6a329b8 100644 --- a/src/main/java/io/gate/gateapi/models/AccountDetailKey.java +++ b/src/main/java/io/gate/gateapi/models/AccountDetailKey.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * API Key detail + * API Key details */ public class AccountDetailKey { public static final String SERIALIZED_NAME_MODE = "mode"; @@ -35,7 +35,7 @@ public AccountDetailKey mode(Integer mode) { } /** - * mode: 1 - classic account 2 - portfolio margin account + * Mode: 1 - Classic mode, 2 - Legacy unified mode * @return mode **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/AccountRateLimit.java b/src/main/java/io/gate/gateapi/models/AccountRateLimit.java index d6a4513..bdf68e8 100644 --- a/src/main/java/io/gate/gateapi/models/AccountRateLimit.java +++ b/src/main/java/io/gate/gateapi/models/AccountRateLimit.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -67,7 +67,7 @@ public AccountRateLimit ratio(String ratio) { } /** - * Transaction rate + * Fill rate * @return ratio **/ @javax.annotation.Nullable @@ -87,7 +87,7 @@ public AccountRateLimit mainRatio(String mainRatio) { } /** - * Total transaction ratio of main account + * Total fill ratio of main account * @return mainRatio **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/AgencyCommission.java b/src/main/java/io/gate/gateapi/models/AgencyCommission.java index d3320fc..787fe67 100644 --- a/src/main/java/io/gate/gateapi/models/AgencyCommission.java +++ b/src/main/java/io/gate/gateapi/models/AgencyCommission.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -55,7 +55,7 @@ public AgencyCommission commissionTime(Long commissionTime) { } /** - * Commission Time. (unix timestamp) + * Commission time (Unix timestamp in seconds) * @return commissionTime **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public AgencyCommission commissionAmount(String commissionAmount) { } /** - * Commission Amount + * Transaction amount * @return commissionAmount **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public AgencyCommission source(String source) { } /** - * Source. SPOT - SPOT Rebate, FUTURES - Futures Rebate + * Commission source: SPOT - Spot commission, FUTURES - Futures commission * @return source **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/AgencyCommissionHistory.java b/src/main/java/io/gate/gateapi/models/AgencyCommissionHistory.java index dd4e664..957a770 100644 --- a/src/main/java/io/gate/gateapi/models/AgencyCommissionHistory.java +++ b/src/main/java/io/gate/gateapi/models/AgencyCommissionHistory.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -94,7 +94,7 @@ public AgencyCommissionHistory addListItem(AgencyCommission listItem) { } /** - * List of comission history + * List of commission history * @return list **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/AgencyTransaction.java b/src/main/java/io/gate/gateapi/models/AgencyTransaction.java index d540e15..56eb68c 100644 --- a/src/main/java/io/gate/gateapi/models/AgencyTransaction.java +++ b/src/main/java/io/gate/gateapi/models/AgencyTransaction.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -187,7 +187,7 @@ public AgencyTransaction amount(String amount) { } /** - * Commission Amount + * Transaction amount * @return amount **/ @javax.annotation.Nullable @@ -227,7 +227,7 @@ public AgencyTransaction source(String source) { } /** - * Source. SPOT - SPOT Rebate, FUTURES - Futures Rebate + * Commission source: SPOT - Spot commission, FUTURES - Futures commission * @return source **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/AgencyTransactionHistory.java b/src/main/java/io/gate/gateapi/models/AgencyTransactionHistory.java index 0f7c5ab..6dce95a 100644 --- a/src/main/java/io/gate/gateapi/models/AgencyTransactionHistory.java +++ b/src/main/java/io/gate/gateapi/models/AgencyTransactionHistory.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/AutoRepaySetting.java b/src/main/java/io/gate/gateapi/models/AutoRepaySetting.java index 288eae2..9250647 100644 --- a/src/main/java/io/gate/gateapi/models/AutoRepaySetting.java +++ b/src/main/java/io/gate/gateapi/models/AutoRepaySetting.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -24,7 +24,7 @@ */ public class AutoRepaySetting { /** - * Auto repayment status. `on` - enabled, `off` - disabled + * Auto repayment status: `on` - enabled, `off` - disabled */ @JsonAdapter(StatusEnum.Adapter.class) public enum StatusEnum { @@ -82,7 +82,7 @@ public AutoRepaySetting status(StatusEnum status) { } /** - * Auto repayment status. `on` - enabled, `off` - disabled + * Auto repayment status: `on` - enabled, `off` - disabled * @return status **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/BatchAmendItem.java b/src/main/java/io/gate/gateapi/models/BatchAmendItem.java index 0f9c4d4..258e946 100644 --- a/src/main/java/io/gate/gateapi/models/BatchAmendItem.java +++ b/src/main/java/io/gate/gateapi/models/BatchAmendItem.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -59,7 +59,7 @@ public BatchAmendItem orderId(String orderId) { } /** - * The order ID returned upon successful creation or the custom ID specified by the user during creation (i.e., the 'text' field). + * The order ID returned upon successful creation or the custom ID specified by the user during creation (i.e., the 'text' field) * @return orderId **/ public String getOrderId() { @@ -97,7 +97,7 @@ public BatchAmendItem account(String account) { } /** - * Default spot, unified account and warehouse-by-store leverage account. + * Default spot, unified account and warehouse-by-store leverage account * @return account **/ @javax.annotation.Nullable @@ -117,7 +117,7 @@ public BatchAmendItem amount(String amount) { } /** - * trade amount, only one of amount and price can be specified + * Trading Quantity. Only one of `amount` or `price` can be specified * @return amount **/ @javax.annotation.Nullable @@ -137,7 +137,7 @@ public BatchAmendItem price(String price) { } /** - * trade price, only one of amount and price can be specified + * Trading Price. Only one of `amount` or `price` can be specified * @return price **/ @javax.annotation.Nullable @@ -157,7 +157,7 @@ public BatchAmendItem amendText(String amendText) { } /** - * Custom info during amending order + * Custom info during order amendment * @return amendText **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/BatchAmendOrderReq.java b/src/main/java/io/gate/gateapi/models/BatchAmendOrderReq.java index 96e4d05..2a29ac1 100644 --- a/src/main/java/io/gate/gateapi/models/BatchAmendOrderReq.java +++ b/src/main/java/io/gate/gateapi/models/BatchAmendOrderReq.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -91,7 +91,7 @@ public BatchAmendOrderReq size(Long size) { } /** - * The new order size, including the executed order size. - If it is less than or equal to the executed quantity, the order will be cancelled. - The new order direction must be consistent with the original one. - The size of the closing order cannot be modified. - For orders that only reduce positions, if the size is increased, other orders that only reduce positions may be kicked out. - If the price is not modified, reducing the size will not affect the depth of the queue, and increasing the size will place it at the end of the current price. + * 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. * @return size **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public BatchAmendOrderReq price(String price) { } /** - * New order price. + * New order price * @return price **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public BatchAmendOrderReq amendText(String amendText) { } /** - * Custom info during amending order + * Custom info during order amendment * @return amendText **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/BatchFuturesOrder.java b/src/main/java/io/gate/gateapi/models/BatchFuturesOrder.java index 02a7b10..15649ba 100644 --- a/src/main/java/io/gate/gateapi/models/BatchFuturesOrder.java +++ b/src/main/java/io/gate/gateapi/models/BatchFuturesOrder.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -52,7 +52,7 @@ public class BatchFuturesOrder { private Double finishTime; /** - * How the order was finished. - filled: all filled - cancelled: manually cancelled - liquidated: cancelled because of liquidation - ioc: time in force is `IOC`, finish immediately - auto_deleveraged: finished by ADL - reduce_only: cancelled because of increasing position while `reduce-only` set- position_closed: cancelled because of position close - position_closed: canceled because the position was closed - reduce_out: only reduce positions by excluding hard-to-fill orders - stp: cancelled because self trade prevention + * 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 */ @JsonAdapter(FinishAsEnum.Adapter.class) public enum FinishAsEnum { @@ -117,7 +117,7 @@ public FinishAsEnum read(final JsonReader jsonReader) throws IOException { private FinishAsEnum finishAs; /** - * Order status - `open`: waiting to be traded - `finished`: finished + * Order status - `open`: Pending - `finished`: Completed */ @JsonAdapter(StatusEnum.Adapter.class) public enum StatusEnum { @@ -334,7 +334,7 @@ public AutoSizeEnum read(final JsonReader jsonReader) throws IOException { private AutoSizeEnum autoSize; /** - * Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled + * 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 */ @JsonAdapter(StpActEnum.Adapter.class) public enum StpActEnum { @@ -400,7 +400,7 @@ public BatchFuturesOrder succeeded(Boolean succeeded) { } /** - * Whether the batch of orders succeeded + * Request execution result * @return succeeded **/ @javax.annotation.Nullable @@ -494,7 +494,7 @@ public Double getFinishTime() { /** - * How the order was finished. - filled: all filled - cancelled: manually cancelled - liquidated: cancelled because of liquidation - ioc: time in force is `IOC`, finish immediately - auto_deleveraged: finished by ADL - reduce_only: cancelled because of increasing position while `reduce-only` set- position_closed: cancelled because of position close - position_closed: canceled because the position was closed - reduce_out: only reduce positions by excluding hard-to-fill orders - stp: cancelled because self trade prevention + * 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 * @return finishAs **/ @javax.annotation.Nullable @@ -504,7 +504,7 @@ public FinishAsEnum getFinishAs() { /** - * Order status - `open`: waiting to be traded - `finished`: finished + * Order status - `open`: Pending - `finished`: Completed * @return status **/ @javax.annotation.Nullable @@ -540,7 +540,7 @@ public BatchFuturesOrder size(Long size) { } /** - * Order size. Specify positive number to make a bid, and negative number to ask + * Required. Trading quantity. Positive for buy, negative for sell. Set to 0 for close position orders. * @return size **/ @javax.annotation.Nullable @@ -560,7 +560,7 @@ public BatchFuturesOrder iceberg(Long iceberg) { } /** - * Display size for iceberg order. 0 for non-iceberg. Note that you will have to pay the taker fee for the hidden size + * Display size for iceberg orders. 0 for non-iceberg orders. Note that hidden portions are charged taker fees. * @return iceberg **/ @javax.annotation.Nullable @@ -580,7 +580,7 @@ public BatchFuturesOrder price(String price) { } /** - * Order price. 0 for market order with `tif` set as `ioc` + * Order price. Price of 0 with `tif` set to `ioc` represents a market order. * @return price **/ @javax.annotation.Nullable @@ -684,7 +684,7 @@ public void setTif(TifEnum tif) { } /** - * Size left to be traded + * Unfilled quantity * @return left **/ @javax.annotation.Nullable @@ -694,7 +694,7 @@ public Long getLeft() { /** - * Fill price of the order + * Fill price * @return fillPrice **/ @javax.annotation.Nullable @@ -744,7 +744,7 @@ public String getMkfr() { /** - * Reference user ID + * Referrer user ID * @return refu **/ @javax.annotation.Nullable @@ -780,7 +780,7 @@ public BatchFuturesOrder stpAct(StpActEnum stpAct) { } /** - * Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled + * 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 * @return stpAct **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/BatchOrder.java b/src/main/java/io/gate/gateapi/models/BatchOrder.java index f3d7ef3..7c81ea1 100644 --- a/src/main/java/io/gate/gateapi/models/BatchOrder.java +++ b/src/main/java/io/gate/gateapi/models/BatchOrder.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -125,7 +125,7 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { private String currencyPair; /** - * Order Type - limit : Limit Order - market : Market Order + * Order Type - limit : Limit Order - market : Market Order */ @JsonAdapter(TypeEnum.Adapter.class) public enum TypeEnum { @@ -231,7 +231,7 @@ public AccountEnum read(final JsonReader jsonReader) throws IOException { private AccountEnum account = AccountEnum.SPOT; /** - * Order side + * Buy or sell order */ @JsonAdapter(SideEnum.Adapter.class) public enum SideEnum { @@ -409,7 +409,7 @@ public TimeInForceEnum read(final JsonReader jsonReader) throws IOException { private Integer stpId; /** - * Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled + * 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 */ @JsonAdapter(StpActEnum.Adapter.class) public enum StpActEnum { @@ -568,7 +568,7 @@ public BatchOrder text(String text) { } /** - * 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(.) + * 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(.) * @return text **/ @javax.annotation.Nullable @@ -588,7 +588,7 @@ public BatchOrder succeeded(Boolean succeeded) { } /** - * Whether the batch of orders succeeded + * Request execution result * @return succeeded **/ @javax.annotation.Nullable @@ -728,7 +728,7 @@ public BatchOrder type(TypeEnum type) { } /** - * Order Type - limit : Limit Order - market : Market Order + * Order Type - limit : Limit Order - market : Market Order * @return type **/ @javax.annotation.Nullable @@ -768,7 +768,7 @@ public BatchOrder side(SideEnum side) { } /** - * Order side + * Buy or sell order * @return side **/ @javax.annotation.Nullable @@ -848,7 +848,7 @@ public BatchOrder iceberg(String iceberg) { } /** - * Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported. + * Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported * @return iceberg **/ @javax.annotation.Nullable @@ -868,7 +868,7 @@ public BatchOrder autoBorrow(Boolean autoBorrow) { } /** - * Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough. + * Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough * @return autoBorrow **/ @javax.annotation.Nullable @@ -888,7 +888,7 @@ public BatchOrder autoRepay(Boolean autoRepay) { } /** - * 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. + * 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 * @return autoRepay **/ @javax.annotation.Nullable @@ -912,7 +912,7 @@ public String getLeft() { /** - * Amount traded to fill + * Amount filled * @return filledAmount **/ @javax.annotation.Nullable @@ -992,7 +992,7 @@ public String getGtFee() { /** - * Whether GT fee discount is used + * Whether GT fee deduction is enabled * @return gtDiscount **/ @javax.annotation.Nullable @@ -1038,7 +1038,7 @@ public BatchOrder stpAct(StpActEnum stpAct) { } /** - * Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled + * 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 * @return stpAct **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/BorrowCurrencyInfo.java b/src/main/java/io/gate/gateapi/models/BorrowCurrencyInfo.java index c10a506..644f7f4 100644 --- a/src/main/java/io/gate/gateapi/models/BorrowCurrencyInfo.java +++ b/src/main/java/io/gate/gateapi/models/BorrowCurrencyInfo.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -91,7 +91,7 @@ public BorrowCurrencyInfo leftRepayPrincipal(String leftRepayPrincipal) { } /** - * outstanding principal + * Outstanding principal * @return leftRepayPrincipal **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public BorrowCurrencyInfo leftRepayInterest(String leftRepayInterest) { } /** - * outstanding interest + * Outstanding interest * @return leftRepayInterest **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public BorrowCurrencyInfo leftRepayUsdt(String leftRepayUsdt) { } /** - * Value of left total repayments amount in USDT + * Remaining total outstanding value converted to USDT * @return leftRepayUsdt **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/BrokerCommission.java b/src/main/java/io/gate/gateapi/models/BrokerCommission.java index c2cb3d1..7ba6e12 100644 --- a/src/main/java/io/gate/gateapi/models/BrokerCommission.java +++ b/src/main/java/io/gate/gateapi/models/BrokerCommission.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -70,7 +70,7 @@ public BrokerCommission addListItem(BrokerCommission1 listItem) { } /** - * List of comission history + * List of commission history * @return list **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/BrokerCommission1.java b/src/main/java/io/gate/gateapi/models/BrokerCommission1.java index fe4d793..3d11d7a 100644 --- a/src/main/java/io/gate/gateapi/models/BrokerCommission1.java +++ b/src/main/java/io/gate/gateapi/models/BrokerCommission1.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -17,6 +17,7 @@ import com.google.gson.annotations.SerializedName; import com.google.gson.stream.JsonReader; import com.google.gson.stream.JsonWriter; +import io.gate.gateapi.models.BrokerCommissionSubBrokerInfo; import java.io.IOException; /** @@ -59,6 +60,14 @@ public class BrokerCommission1 { @SerializedName(SERIALIZED_NAME_CURRENCY_PAIR) private String currencyPair; + public static final String SERIALIZED_NAME_SUB_BROKER_INFO = "sub_broker_info"; + @SerializedName(SERIALIZED_NAME_SUB_BROKER_INFO) + private BrokerCommissionSubBrokerInfo subBrokerInfo; + + public static final String SERIALIZED_NAME_ALPHA_CONTRACT_ADDR = "alpha_contract_addr"; + @SerializedName(SERIALIZED_NAME_ALPHA_CONTRACT_ADDR) + private String alphaContractAddr; + public BrokerCommission1 commissionTime(Long commissionTime) { @@ -67,7 +76,7 @@ public BrokerCommission1 commissionTime(Long commissionTime) { } /** - * Commission Time. (unix timestamp) + * Commission time (Unix timestamp in seconds) * @return commissionTime **/ @javax.annotation.Nullable @@ -207,7 +216,7 @@ public BrokerCommission1 source(String source) { } /** - * Rebate Type: Spot、Futures、Options + * Commission transaction type: Spot, Futures, Options, Alpha * @return source **/ @javax.annotation.Nullable @@ -239,6 +248,46 @@ public String getCurrencyPair() { public void setCurrencyPair(String currencyPair) { this.currencyPair = currencyPair; } + + public BrokerCommission1 subBrokerInfo(BrokerCommissionSubBrokerInfo subBrokerInfo) { + + this.subBrokerInfo = subBrokerInfo; + return this; + } + + /** + * Get subBrokerInfo + * @return subBrokerInfo + **/ + @javax.annotation.Nullable + public BrokerCommissionSubBrokerInfo getSubBrokerInfo() { + return subBrokerInfo; + } + + + public void setSubBrokerInfo(BrokerCommissionSubBrokerInfo subBrokerInfo) { + this.subBrokerInfo = subBrokerInfo; + } + + public BrokerCommission1 alphaContractAddr(String alphaContractAddr) { + + this.alphaContractAddr = alphaContractAddr; + return this; + } + + /** + * Alpha contract address + * @return alphaContractAddr + **/ + @javax.annotation.Nullable + public String getAlphaContractAddr() { + return alphaContractAddr; + } + + + public void setAlphaContractAddr(String alphaContractAddr) { + this.alphaContractAddr = alphaContractAddr; + } @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -256,12 +305,14 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.feeAsset, brokerCommission1.feeAsset) && Objects.equals(this.rebateFee, brokerCommission1.rebateFee) && Objects.equals(this.source, brokerCommission1.source) && - Objects.equals(this.currencyPair, brokerCommission1.currencyPair); + Objects.equals(this.currencyPair, brokerCommission1.currencyPair) && + Objects.equals(this.subBrokerInfo, brokerCommission1.subBrokerInfo) && + Objects.equals(this.alphaContractAddr, brokerCommission1.alphaContractAddr); } @Override public int hashCode() { - return Objects.hash(commissionTime, userId, groupName, amount, fee, feeAsset, rebateFee, source, currencyPair); + return Objects.hash(commissionTime, userId, groupName, amount, fee, feeAsset, rebateFee, source, currencyPair, subBrokerInfo, alphaContractAddr); } @@ -278,6 +329,8 @@ public String toString() { sb.append(" rebateFee: ").append(toIndentedString(rebateFee)).append("\n"); sb.append(" source: ").append(toIndentedString(source)).append("\n"); sb.append(" currencyPair: ").append(toIndentedString(currencyPair)).append("\n"); + sb.append(" subBrokerInfo: ").append(toIndentedString(subBrokerInfo)).append("\n"); + sb.append(" alphaContractAddr: ").append(toIndentedString(alphaContractAddr)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/gate/gateapi/models/BrokerCommissionSubBrokerInfo.java b/src/main/java/io/gate/gateapi/models/BrokerCommissionSubBrokerInfo.java new file mode 100644 index 0000000..11b720c --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/BrokerCommissionSubBrokerInfo.java @@ -0,0 +1,167 @@ +/* + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package io.gate.gateapi.models; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; + +/** + * Sub-broker information + */ +public class BrokerCommissionSubBrokerInfo { + public static final String SERIALIZED_NAME_USER_ID = "user_id"; + @SerializedName(SERIALIZED_NAME_USER_ID) + private Long userId; + + public static final String SERIALIZED_NAME_ORIGINAL_COMMISSION_RATE = "original_commission_rate"; + @SerializedName(SERIALIZED_NAME_ORIGINAL_COMMISSION_RATE) + private String originalCommissionRate; + + public static final String SERIALIZED_NAME_RELATIVE_COMMISSION_RATE = "relative_commission_rate"; + @SerializedName(SERIALIZED_NAME_RELATIVE_COMMISSION_RATE) + private String relativeCommissionRate; + + public static final String SERIALIZED_NAME_COMMISSION_RATE = "commission_rate"; + @SerializedName(SERIALIZED_NAME_COMMISSION_RATE) + private String commissionRate; + + + public BrokerCommissionSubBrokerInfo userId(Long userId) { + + this.userId = userId; + return this; + } + + /** + * Sub-broker user ID + * @return userId + **/ + @javax.annotation.Nullable + public Long getUserId() { + return userId; + } + + + public void setUserId(Long userId) { + this.userId = userId; + } + + public BrokerCommissionSubBrokerInfo originalCommissionRate(String originalCommissionRate) { + + this.originalCommissionRate = originalCommissionRate; + return this; + } + + /** + * Sub-broker original commission rate + * @return originalCommissionRate + **/ + @javax.annotation.Nullable + public String getOriginalCommissionRate() { + return originalCommissionRate; + } + + + public void setOriginalCommissionRate(String originalCommissionRate) { + this.originalCommissionRate = originalCommissionRate; + } + + public BrokerCommissionSubBrokerInfo relativeCommissionRate(String relativeCommissionRate) { + + this.relativeCommissionRate = relativeCommissionRate; + return this; + } + + /** + * Sub-broker relative commission rate + * @return relativeCommissionRate + **/ + @javax.annotation.Nullable + public String getRelativeCommissionRate() { + return relativeCommissionRate; + } + + + public void setRelativeCommissionRate(String relativeCommissionRate) { + this.relativeCommissionRate = relativeCommissionRate; + } + + public BrokerCommissionSubBrokerInfo commissionRate(String commissionRate) { + + this.commissionRate = commissionRate; + return this; + } + + /** + * Sub-broker actual commission rate + * @return commissionRate + **/ + @javax.annotation.Nullable + public String getCommissionRate() { + return commissionRate; + } + + + public void setCommissionRate(String commissionRate) { + this.commissionRate = commissionRate; + } + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + BrokerCommissionSubBrokerInfo brokerCommissionSubBrokerInfo = (BrokerCommissionSubBrokerInfo) o; + return Objects.equals(this.userId, brokerCommissionSubBrokerInfo.userId) && + Objects.equals(this.originalCommissionRate, brokerCommissionSubBrokerInfo.originalCommissionRate) && + Objects.equals(this.relativeCommissionRate, brokerCommissionSubBrokerInfo.relativeCommissionRate) && + Objects.equals(this.commissionRate, brokerCommissionSubBrokerInfo.commissionRate); + } + + @Override + public int hashCode() { + return Objects.hash(userId, originalCommissionRate, relativeCommissionRate, commissionRate); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class BrokerCommissionSubBrokerInfo {\n"); + sb.append(" userId: ").append(toIndentedString(userId)).append("\n"); + sb.append(" originalCommissionRate: ").append(toIndentedString(originalCommissionRate)).append("\n"); + sb.append(" relativeCommissionRate: ").append(toIndentedString(relativeCommissionRate)).append("\n"); + sb.append(" commissionRate: ").append(toIndentedString(commissionRate)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/gate/gateapi/models/BrokerTransaction.java b/src/main/java/io/gate/gateapi/models/BrokerTransaction.java index 99b427f..73886cb 100644 --- a/src/main/java/io/gate/gateapi/models/BrokerTransaction.java +++ b/src/main/java/io/gate/gateapi/models/BrokerTransaction.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/BrokerTransaction1.java b/src/main/java/io/gate/gateapi/models/BrokerTransaction1.java index 4e38a49..b76e252 100644 --- a/src/main/java/io/gate/gateapi/models/BrokerTransaction1.java +++ b/src/main/java/io/gate/gateapi/models/BrokerTransaction1.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -17,6 +17,7 @@ import com.google.gson.annotations.SerializedName; import com.google.gson.stream.JsonReader; import com.google.gson.stream.JsonWriter; +import io.gate.gateapi.models.BrokerCommissionSubBrokerInfo; import java.io.IOException; /** @@ -55,6 +56,14 @@ public class BrokerTransaction1 { @SerializedName(SERIALIZED_NAME_SOURCE) private String source; + public static final String SERIALIZED_NAME_SUB_BROKER_INFO = "sub_broker_info"; + @SerializedName(SERIALIZED_NAME_SUB_BROKER_INFO) + private BrokerCommissionSubBrokerInfo subBrokerInfo; + + public static final String SERIALIZED_NAME_ALPHA_CONTRACT_ADDR = "alpha_contract_addr"; + @SerializedName(SERIALIZED_NAME_ALPHA_CONTRACT_ADDR) + private String alphaContractAddr; + public BrokerTransaction1 transactionTime(Long transactionTime) { @@ -123,7 +132,7 @@ public BrokerTransaction1 fee(String fee) { } /** - * fee (usdt) + * Fee amount (USDT) * @return fee **/ @javax.annotation.Nullable @@ -163,7 +172,7 @@ public BrokerTransaction1 amount(String amount) { } /** - * Commission Amount + * Transaction amount * @return amount **/ @javax.annotation.Nullable @@ -203,7 +212,7 @@ public BrokerTransaction1 source(String source) { } /** - * Rebate Type: Spot、Futures、Options + * Commission transaction type: Spot, Futures, Options, Alpha * @return source **/ @javax.annotation.Nullable @@ -215,6 +224,46 @@ public String getSource() { public void setSource(String source) { this.source = source; } + + public BrokerTransaction1 subBrokerInfo(BrokerCommissionSubBrokerInfo subBrokerInfo) { + + this.subBrokerInfo = subBrokerInfo; + return this; + } + + /** + * Get subBrokerInfo + * @return subBrokerInfo + **/ + @javax.annotation.Nullable + public BrokerCommissionSubBrokerInfo getSubBrokerInfo() { + return subBrokerInfo; + } + + + public void setSubBrokerInfo(BrokerCommissionSubBrokerInfo subBrokerInfo) { + this.subBrokerInfo = subBrokerInfo; + } + + public BrokerTransaction1 alphaContractAddr(String alphaContractAddr) { + + this.alphaContractAddr = alphaContractAddr; + return this; + } + + /** + * Alpha contract address + * @return alphaContractAddr + **/ + @javax.annotation.Nullable + public String getAlphaContractAddr() { + return alphaContractAddr; + } + + + public void setAlphaContractAddr(String alphaContractAddr) { + this.alphaContractAddr = alphaContractAddr; + } @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -231,12 +280,14 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.currencyPair, brokerTransaction1.currencyPair) && Objects.equals(this.amount, brokerTransaction1.amount) && Objects.equals(this.feeAsset, brokerTransaction1.feeAsset) && - Objects.equals(this.source, brokerTransaction1.source); + Objects.equals(this.source, brokerTransaction1.source) && + Objects.equals(this.subBrokerInfo, brokerTransaction1.subBrokerInfo) && + Objects.equals(this.alphaContractAddr, brokerTransaction1.alphaContractAddr); } @Override public int hashCode() { - return Objects.hash(transactionTime, userId, groupName, fee, currencyPair, amount, feeAsset, source); + return Objects.hash(transactionTime, userId, groupName, fee, currencyPair, amount, feeAsset, source, subBrokerInfo, alphaContractAddr); } @@ -252,6 +303,8 @@ public String toString() { sb.append(" amount: ").append(toIndentedString(amount)).append("\n"); sb.append(" feeAsset: ").append(toIndentedString(feeAsset)).append("\n"); sb.append(" source: ").append(toIndentedString(source)).append("\n"); + sb.append(" subBrokerInfo: ").append(toIndentedString(subBrokerInfo)).append("\n"); + sb.append(" alphaContractAddr: ").append(toIndentedString(alphaContractAddr)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/gate/gateapi/models/CancelBatchOrder.java b/src/main/java/io/gate/gateapi/models/CancelBatchOrder.java index 0ceea4c..fd2ba0c 100644 --- a/src/main/java/io/gate/gateapi/models/CancelBatchOrder.java +++ b/src/main/java/io/gate/gateapi/models/CancelBatchOrder.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/CancelOrderResult.java b/src/main/java/io/gate/gateapi/models/CancelOrderResult.java index 7e5bb4e..7871575 100644 --- a/src/main/java/io/gate/gateapi/models/CancelOrderResult.java +++ b/src/main/java/io/gate/gateapi/models/CancelOrderResult.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -159,7 +159,7 @@ public CancelOrderResult message(String message) { } /** - * Error message when failed to cancel the order; empty if succeeded + * Error description when cancellation fails, empty if successful * @return message **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CollateralAdjust.java b/src/main/java/io/gate/gateapi/models/CollateralAdjust.java index ce56342..74855e8 100644 --- a/src/main/java/io/gate/gateapi/models/CollateralAdjust.java +++ b/src/main/java/io/gate/gateapi/models/CollateralAdjust.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -65,7 +65,7 @@ public CollateralAdjust type(String type) { } /** - * Operation types: append - for adding collateral, redeem - for withdrawing collateral + * Operation type: append - add collateral, redeem - withdraw collateral * @return type **/ public String getType() { @@ -92,7 +92,7 @@ public CollateralAdjust addCollateralsItem(CollateralCurrency collateralsItem) { } /** - * Collateral Currency List + * Collateral currency list * @return collaterals **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CollateralAdjustRes.java b/src/main/java/io/gate/gateapi/models/CollateralAdjustRes.java index e8cd013..89d4326 100644 --- a/src/main/java/io/gate/gateapi/models/CollateralAdjustRes.java +++ b/src/main/java/io/gate/gateapi/models/CollateralAdjustRes.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -23,7 +23,7 @@ import java.util.List; /** - * Result of multi-collateral adjustment + * Multi-collateral adjustment result */ public class CollateralAdjustRes { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; @@ -70,7 +70,7 @@ public CollateralAdjustRes addCollateralCurrenciesItem(CollateralCurrencyRes col } /** - * Collateral Currency Information + * Collateral currency information * @return collateralCurrencies **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CollateralAlign.java b/src/main/java/io/gate/gateapi/models/CollateralAlign.java index 3dd0aed..19c02b9 100644 --- a/src/main/java/io/gate/gateapi/models/CollateralAlign.java +++ b/src/main/java/io/gate/gateapi/models/CollateralAlign.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -66,7 +66,7 @@ public CollateralAlign collateralCurrency(String collateralCurrency) { } /** - * Collateral + * Collateral currency * @return collateralCurrency **/ public String getCollateralCurrency() { @@ -104,7 +104,7 @@ public CollateralAlign type(String type) { } /** - * Operation types: append - for adding collateral, redeem - for withdrawing collateral + * Operation type: append - add collateral, redeem - withdraw collateral * @return type **/ public String getType() { diff --git a/src/main/java/io/gate/gateapi/models/CollateralCurrency.java b/src/main/java/io/gate/gateapi/models/CollateralCurrency.java index 042a3a3..734c4bc 100644 --- a/src/main/java/io/gate/gateapi/models/CollateralCurrency.java +++ b/src/main/java/io/gate/gateapi/models/CollateralCurrency.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/CollateralCurrencyInfo.java b/src/main/java/io/gate/gateapi/models/CollateralCurrencyInfo.java index f692695..25c5dc6 100644 --- a/src/main/java/io/gate/gateapi/models/CollateralCurrencyInfo.java +++ b/src/main/java/io/gate/gateapi/models/CollateralCurrencyInfo.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -87,7 +87,7 @@ public CollateralCurrencyInfo leftCollateral(String leftCollateral) { } /** - * Left Collateral Amount + * Remaining collateral amount * @return leftCollateral **/ @javax.annotation.Nullable @@ -107,7 +107,7 @@ public CollateralCurrencyInfo leftCollateralUsdt(String leftCollateralUsdt) { } /** - * Value of left collateral amount in USDT + * Remaining collateral value converted to USDT * @return leftCollateralUsdt **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CollateralCurrencyRes.java b/src/main/java/io/gate/gateapi/models/CollateralCurrencyRes.java index 29d3547..59862a6 100644 --- a/src/main/java/io/gate/gateapi/models/CollateralCurrencyRes.java +++ b/src/main/java/io/gate/gateapi/models/CollateralCurrencyRes.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -71,7 +71,7 @@ public CollateralCurrencyRes label(String label) { } /** - * Error identifier for unsuccessful operations; empty for successful. + * Error identifier for failed operations; empty when successful * @return label **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public CollateralCurrencyRes message(String message) { } /** - * Error description in case of operation failure; empty when successful. + * Error description for failed operations; empty when successful * @return message **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public CollateralCurrencyRes amount(String amount) { } /** - * Quantity of successful collateral operation; 0 if the operation fails. + * Successfully operated collateral quantity; 0 if operation fails * @return amount **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CollateralCurrentRate.java b/src/main/java/io/gate/gateapi/models/CollateralCurrentRate.java index 0f3a7b1..265b86d 100644 --- a/src/main/java/io/gate/gateapi/models/CollateralCurrentRate.java +++ b/src/main/java/io/gate/gateapi/models/CollateralCurrentRate.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Multi-currency pledge current interest rate + * Multi-collateral current interest rate */ public class CollateralCurrentRate { public static final String SERIALIZED_NAME_CURRENCY = "currency"; diff --git a/src/main/java/io/gate/gateapi/models/CollateralFixRate.java b/src/main/java/io/gate/gateapi/models/CollateralFixRate.java index 4ec9869..5dbf7e7 100644 --- a/src/main/java/io/gate/gateapi/models/CollateralFixRate.java +++ b/src/main/java/io/gate/gateapi/models/CollateralFixRate.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -67,7 +67,7 @@ public CollateralFixRate rate7d(String rate7d) { } /** - * Fixed interest rate for a lending period of 7 days + * Fixed interest rate for 7-day lending period * @return rate7d **/ @javax.annotation.Nullable @@ -87,7 +87,7 @@ public CollateralFixRate rate30d(String rate30d) { } /** - * Fixed interest rate for a lending period of 30 days + * Fixed interest rate for 30-day lending period * @return rate30d **/ @javax.annotation.Nullable @@ -107,7 +107,7 @@ public CollateralFixRate updateTime(Long updateTime) { } /** - * Update time, timestamp, unit in seconds + * Update time, timestamp in seconds * @return updateTime **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CollateralLoanCurrency.java b/src/main/java/io/gate/gateapi/models/CollateralLoanCurrency.java index eec6011..19b216d 100644 --- a/src/main/java/io/gate/gateapi/models/CollateralLoanCurrency.java +++ b/src/main/java/io/gate/gateapi/models/CollateralLoanCurrency.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/CollateralLtv.java b/src/main/java/io/gate/gateapi/models/CollateralLtv.java index 28c753c..641342b 100644 --- a/src/main/java/io/gate/gateapi/models/CollateralLtv.java +++ b/src/main/java/io/gate/gateapi/models/CollateralLtv.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Collateral Ratio + * Multi-collateral ratio */ public class CollateralLtv { public static final String SERIALIZED_NAME_INIT_LTV = "init_ltv"; @@ -43,7 +43,7 @@ public CollateralLtv initLtv(String initLtv) { } /** - * The initial collateralization rate + * Initial collateralization rate * @return initLtv **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public CollateralLtv alertLtv(String alertLtv) { } /** - * Warning collateralization ratio + * Warning collateralization rate * @return alertLtv **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public CollateralLtv liquidateLtv(String liquidateLtv) { } /** - * The liquidation collateralization rate + * Liquidation collateralization rate * @return liquidateLtv **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CollateralOrder.java b/src/main/java/io/gate/gateapi/models/CollateralOrder.java index f1defb4..f707431 100644 --- a/src/main/java/io/gate/gateapi/models/CollateralOrder.java +++ b/src/main/java/io/gate/gateapi/models/CollateralOrder.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Collateral Order + * Collateral order */ public class CollateralOrder { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; @@ -115,7 +115,7 @@ public CollateralOrder collateralCurrency(String collateralCurrency) { } /** - * Collateral + * Collateral currency * @return collateralCurrency **/ @javax.annotation.Nullable @@ -175,7 +175,7 @@ public CollateralOrder borrowAmount(String borrowAmount) { } /** - * Borrowing amount + * Borrowed amount * @return borrowAmount **/ @javax.annotation.Nullable @@ -255,7 +255,7 @@ public CollateralOrder initLtv(String initLtv) { } /** - * The initial collateralization rate + * Initial collateralization rate * @return initLtv **/ @javax.annotation.Nullable @@ -275,7 +275,7 @@ public CollateralOrder currentLtv(String currentLtv) { } /** - * The current collateralization rate + * Current collateralization rate * @return currentLtv **/ @javax.annotation.Nullable @@ -295,7 +295,7 @@ public CollateralOrder liquidateLtv(String liquidateLtv) { } /** - * The liquidation collateralization rate + * Liquidation collateralization rate * @return liquidateLtv **/ @javax.annotation.Nullable @@ -375,7 +375,7 @@ public CollateralOrder leftRepayPrincipal(String leftRepayPrincipal) { } /** - * outstanding principal + * Outstanding principal * @return leftRepayPrincipal **/ @javax.annotation.Nullable @@ -395,7 +395,7 @@ public CollateralOrder leftRepayInterest(String leftRepayInterest) { } /** - * outstanding interest + * Outstanding interest * @return leftRepayInterest **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CollateralRecord.java b/src/main/java/io/gate/gateapi/models/CollateralRecord.java index 9b505cb..58d2288 100644 --- a/src/main/java/io/gate/gateapi/models/CollateralRecord.java +++ b/src/main/java/io/gate/gateapi/models/CollateralRecord.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -131,7 +131,7 @@ public CollateralRecord borrowAmount(String borrowAmount) { } /** - * Borrowing amount + * Borrowed amount * @return borrowAmount **/ @javax.annotation.Nullable @@ -151,7 +151,7 @@ public CollateralRecord collateralCurrency(String collateralCurrency) { } /** - * Collateral + * Collateral currency * @return collateralCurrency **/ @javax.annotation.Nullable @@ -171,7 +171,7 @@ public CollateralRecord beforeCollateral(String beforeCollateral) { } /** - * The collateral amount before adjustment + * Collateral amount before adjustment * @return beforeCollateral **/ @javax.annotation.Nullable @@ -191,7 +191,7 @@ public CollateralRecord afterCollateral(String afterCollateral) { } /** - * The collateral amount after adjustment + * Collateral amount after adjustment * @return afterCollateral **/ @javax.annotation.Nullable @@ -211,7 +211,7 @@ public CollateralRecord beforeLtv(String beforeLtv) { } /** - * The collateral ratio before adjustment + * Collateral ratio before adjustment * @return beforeLtv **/ @javax.annotation.Nullable @@ -231,7 +231,7 @@ public CollateralRecord afterLtv(String afterLtv) { } /** - * The collateral ratio after adjustment + * Collateral ratio after adjustment * @return afterLtv **/ @javax.annotation.Nullable @@ -251,7 +251,7 @@ public CollateralRecord operateTime(Long operateTime) { } /** - * Timestamp of the operation, in seconds + * Operation time, timestamp in seconds * @return operateTime **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/Contract.java b/src/main/java/io/gate/gateapi/models/Contract.java index df9c60c..f61545c 100644 --- a/src/main/java/io/gate/gateapi/models/Contract.java +++ b/src/main/java/io/gate/gateapi/models/Contract.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -28,7 +28,7 @@ public class Contract { private String name; /** - * Futures contract type + * Contract type: inverse - inverse contract, direct - direct contract */ @JsonAdapter(TypeEnum.Adapter.class) public enum TypeEnum { @@ -95,7 +95,7 @@ public TypeEnum read(final JsonReader jsonReader) throws IOException { private String maintenanceRate; /** - * Mark price type, internal - based on internal trading, index - based on external index price + * Mark price type: internal - internal trading price, index - external index price */ @JsonAdapter(MarkTypeEnum.Adapter.class) public enum MarkTypeEnum { @@ -261,6 +261,22 @@ public MarkTypeEnum read(final JsonReader jsonReader) throws IOException { @SerializedName(SERIALIZED_NAME_FUNDING_CAP_RATIO) private String fundingCapRatio; + public static final String SERIALIZED_NAME_STATUS = "status"; + @SerializedName(SERIALIZED_NAME_STATUS) + private String status; + + public static final String SERIALIZED_NAME_LAUNCH_TIME = "launch_time"; + @SerializedName(SERIALIZED_NAME_LAUNCH_TIME) + private Long launchTime; + + public static final String SERIALIZED_NAME_DELISTING_TIME = "delisting_time"; + @SerializedName(SERIALIZED_NAME_DELISTING_TIME) + private Long delistingTime; + + public static final String SERIALIZED_NAME_DELISTED_TIME = "delisted_time"; + @SerializedName(SERIALIZED_NAME_DELISTED_TIME) + private Long delistedTime; + public Contract name(String name) { @@ -289,7 +305,7 @@ public Contract type(TypeEnum type) { } /** - * Futures contract type + * Contract type: inverse - inverse contract, direct - direct contract * @return type **/ @javax.annotation.Nullable @@ -389,7 +405,7 @@ public Contract markType(MarkTypeEnum markType) { } /** - * Mark price type, internal - based on internal trading, index - based on external index price + * Mark price type: internal - internal trading price, index - external index price * @return markType **/ @javax.annotation.Nullable @@ -469,7 +485,7 @@ public Contract makerFeeRate(String makerFeeRate) { } /** - * Maker fee rate, where negative means rebate + * Maker fee rate, negative values indicate rebates * @return makerFeeRate **/ @javax.annotation.Nullable @@ -609,7 +625,7 @@ public Contract riskLimitBase(String riskLimitBase) { } /** - * Risk limit base,deprecated + * Base risk limit (deprecated) * @return riskLimitBase **/ @javax.annotation.Nullable @@ -629,7 +645,7 @@ public Contract riskLimitStep(String riskLimitStep) { } /** - * Step of adjusting risk limit,deprecated + * Risk limit adjustment step (deprecated) * @return riskLimitStep **/ @javax.annotation.Nullable @@ -649,7 +665,7 @@ public Contract riskLimitMax(String riskLimitMax) { } /** - * Maximum risk limit the contract allowed,deprecated,It is recommended to use /futures/{settle}/risk_limit_tiers to query risk limits. + * Maximum risk limit allowed by the contract (deprecated). It is recommended to use /futures/{settle}/risk_limit_tiers to query risk limits * @return riskLimitMax **/ @javax.annotation.Nullable @@ -669,7 +685,7 @@ public Contract orderSizeMin(Long orderSizeMin) { } /** - * Minimum order size the contract allowed + * Minimum order size allowed by the contract * @return orderSizeMin **/ @javax.annotation.Nullable @@ -689,7 +705,7 @@ public Contract orderSizeMax(Long orderSizeMax) { } /** - * Maximum order size the contract allowed + * Maximum order size allowed by the contract * @return orderSizeMax **/ @javax.annotation.Nullable @@ -709,7 +725,7 @@ public Contract orderPriceDeviate(String orderPriceDeviate) { } /** - * 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 + * 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 * @return orderPriceDeviate **/ @javax.annotation.Nullable @@ -729,7 +745,7 @@ public Contract refDiscountRate(String refDiscountRate) { } /** - * Referral fee rate discount + * Trading fee discount for referred users * @return refDiscountRate **/ @javax.annotation.Nullable @@ -749,7 +765,7 @@ public Contract refRebateRate(String refRebateRate) { } /** - * Referrer commission rate + * Commission rate for referrers * @return refRebateRate **/ @javax.annotation.Nullable @@ -769,7 +785,7 @@ public Contract orderbookId(Long orderbookId) { } /** - * Current orderbook ID + * Orderbook update ID * @return orderbookId **/ @javax.annotation.Nullable @@ -809,7 +825,7 @@ public Contract tradeSize(Long tradeSize) { } /** - * Historical accumulated trade size + * Historical cumulative trading volume * @return tradeSize **/ @javax.annotation.Nullable @@ -849,7 +865,7 @@ public Contract configChangeTime(Double configChangeTime) { } /** - * Last changed time of configuration + * Last configuration update time * @return configChangeTime **/ @javax.annotation.Nullable @@ -869,7 +885,7 @@ public Contract inDelisting(Boolean inDelisting) { } /** - * `in_delisting=true` And when position_size>0, it means the contract is in the offline transition period `in_delisting=true` And when position_size=0, it means the contract is offline + * `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 * @return inDelisting **/ @javax.annotation.Nullable @@ -889,7 +905,7 @@ public Contract ordersLimit(Integer ordersLimit) { } /** - * Maximum number of open orders + * Maximum number of pending orders * @return ordersLimit **/ @javax.annotation.Nullable @@ -909,7 +925,7 @@ public Contract enableBonus(Boolean enableBonus) { } /** - * Whether bouns is enabled + * Whether bonus is enabled * @return enableBonus **/ @javax.annotation.Nullable @@ -981,6 +997,86 @@ public String getFundingCapRatio() { public void setFundingCapRatio(String fundingCapRatio) { this.fundingCapRatio = fundingCapRatio; } + + public Contract status(String status) { + + this.status = status; + return this; + } + + /** + * Contract status types include: prelaunch (pre-launch), trading (active), delisting (delisting), delisted (delisted), circuit_breaker (circuit breaker) + * @return status + **/ + @javax.annotation.Nullable + public String getStatus() { + return status; + } + + + public void setStatus(String status) { + this.status = status; + } + + public Contract launchTime(Long launchTime) { + + this.launchTime = launchTime; + return this; + } + + /** + * Contract expiry timestamp + * @return launchTime + **/ + @javax.annotation.Nullable + public Long getLaunchTime() { + return launchTime; + } + + + public void setLaunchTime(Long launchTime) { + this.launchTime = launchTime; + } + + public Contract delistingTime(Long delistingTime) { + + this.delistingTime = delistingTime; + return this; + } + + /** + * Timestamp when contract enters reduce-only state + * @return delistingTime + **/ + @javax.annotation.Nullable + public Long getDelistingTime() { + return delistingTime; + } + + + public void setDelistingTime(Long delistingTime) { + this.delistingTime = delistingTime; + } + + public Contract delistedTime(Long delistedTime) { + + this.delistedTime = delistedTime; + return this; + } + + /** + * Contract delisting time + * @return delistedTime + **/ + @javax.annotation.Nullable + public Long getDelistedTime() { + return delistedTime; + } + + + public void setDelistedTime(Long delistedTime) { + this.delistedTime = delistedTime; + } @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -1025,12 +1121,16 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.enableBonus, contract.enableBonus) && Objects.equals(this.enableCredit, contract.enableCredit) && Objects.equals(this.createTime, contract.createTime) && - Objects.equals(this.fundingCapRatio, contract.fundingCapRatio); + Objects.equals(this.fundingCapRatio, contract.fundingCapRatio) && + Objects.equals(this.status, contract.status) && + Objects.equals(this.launchTime, contract.launchTime) && + Objects.equals(this.delistingTime, contract.delistingTime) && + Objects.equals(this.delistedTime, contract.delistedTime); } @Override public int hashCode() { - return Objects.hash(name, type, quantoMultiplier, leverageMin, leverageMax, maintenanceRate, markType, markPrice, indexPrice, lastPrice, makerFeeRate, takerFeeRate, orderPriceRound, markPriceRound, fundingRate, fundingInterval, fundingNextApply, riskLimitBase, riskLimitStep, riskLimitMax, orderSizeMin, orderSizeMax, orderPriceDeviate, refDiscountRate, refRebateRate, orderbookId, tradeId, tradeSize, positionSize, configChangeTime, inDelisting, ordersLimit, enableBonus, enableCredit, createTime, fundingCapRatio); + return Objects.hash(name, type, quantoMultiplier, leverageMin, leverageMax, maintenanceRate, markType, markPrice, indexPrice, lastPrice, makerFeeRate, takerFeeRate, orderPriceRound, markPriceRound, fundingRate, fundingInterval, fundingNextApply, riskLimitBase, riskLimitStep, riskLimitMax, orderSizeMin, orderSizeMax, orderPriceDeviate, refDiscountRate, refRebateRate, orderbookId, tradeId, tradeSize, positionSize, configChangeTime, inDelisting, ordersLimit, enableBonus, enableCredit, createTime, fundingCapRatio, status, launchTime, delistingTime, delistedTime); } @@ -1074,6 +1174,10 @@ public String toString() { sb.append(" enableCredit: ").append(toIndentedString(enableCredit)).append("\n"); sb.append(" createTime: ").append(toIndentedString(createTime)).append("\n"); sb.append(" fundingCapRatio: ").append(toIndentedString(fundingCapRatio)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).append("\n"); + sb.append(" launchTime: ").append(toIndentedString(launchTime)).append("\n"); + sb.append(" delistingTime: ").append(toIndentedString(delistingTime)).append("\n"); + sb.append(" delistedTime: ").append(toIndentedString(delistedTime)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/gate/gateapi/models/ContractStat.java b/src/main/java/io/gate/gateapi/models/ContractStat.java index 00c7a3a..2d948b9 100644 --- a/src/main/java/io/gate/gateapi/models/ContractStat.java +++ b/src/main/java/io/gate/gateapi/models/ContractStat.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -76,6 +76,10 @@ public class ContractStat { @SerializedName(SERIALIZED_NAME_TOP_LSR_SIZE) private Double topLsrSize; + public static final String SERIALIZED_NAME_MARK_PRICE = "mark_price"; + @SerializedName(SERIALIZED_NAME_MARK_PRICE) + private Double markPrice; + public ContractStat time(Long time) { @@ -104,7 +108,7 @@ public ContractStat lsrTaker(BigDecimal lsrTaker) { } /** - * Long/short account number ratio + * Long/short taker ratio * @return lsrTaker **/ @javax.annotation.Nullable @@ -124,7 +128,7 @@ public ContractStat lsrAccount(BigDecimal lsrAccount) { } /** - * Long/short taker size ratio + * Long/short position user ratio * @return lsrAccount **/ @javax.annotation.Nullable @@ -144,7 +148,7 @@ public ContractStat longLiqSize(Long longLiqSize) { } /** - * Long liquidation size + * Long liquidation size (contracts) * @return longLiqSize **/ @javax.annotation.Nullable @@ -164,7 +168,7 @@ public ContractStat longLiqAmount(Double longLiqAmount) { } /** - * Long liquidation amount(base currency) + * Long liquidation amount (base currency) * @return longLiqAmount **/ @javax.annotation.Nullable @@ -184,7 +188,7 @@ public ContractStat longLiqUsd(Double longLiqUsd) { } /** - * Long liquidation volume(quote currency) + * Long liquidation volume (quote currency) * @return longLiqUsd **/ @javax.annotation.Nullable @@ -204,7 +208,7 @@ public ContractStat shortLiqSize(Long shortLiqSize) { } /** - * Short liquidation size + * Short liquidation size (contracts) * @return shortLiqSize **/ @javax.annotation.Nullable @@ -224,7 +228,7 @@ public ContractStat shortLiqAmount(Double shortLiqAmount) { } /** - * Short liquidation amount(base currency) + * Short liquidation amount (base currency) * @return shortLiqAmount **/ @javax.annotation.Nullable @@ -244,7 +248,7 @@ public ContractStat shortLiqUsd(Double shortLiqUsd) { } /** - * Short liquidation volume(quote currency) + * Short liquidation volume (quote currency) * @return shortLiqUsd **/ @javax.annotation.Nullable @@ -264,7 +268,7 @@ public ContractStat openInterest(Long openInterest) { } /** - * Open interest size + * Total open interest size (contracts) * @return openInterest **/ @javax.annotation.Nullable @@ -284,7 +288,7 @@ public ContractStat openInterestUsd(Double openInterestUsd) { } /** - * Open interest volume(quote currency) + * Total open interest volume (quote currency) * @return openInterestUsd **/ @javax.annotation.Nullable @@ -336,6 +340,26 @@ public Double getTopLsrSize() { public void setTopLsrSize(Double topLsrSize) { this.topLsrSize = topLsrSize; } + + public ContractStat markPrice(Double markPrice) { + + this.markPrice = markPrice; + return this; + } + + /** + * Mark price + * @return markPrice + **/ + @javax.annotation.Nullable + public Double getMarkPrice() { + return markPrice; + } + + + public void setMarkPrice(Double markPrice) { + this.markPrice = markPrice; + } @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -357,12 +381,13 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.openInterest, contractStat.openInterest) && Objects.equals(this.openInterestUsd, contractStat.openInterestUsd) && Objects.equals(this.topLsrAccount, contractStat.topLsrAccount) && - Objects.equals(this.topLsrSize, contractStat.topLsrSize); + Objects.equals(this.topLsrSize, contractStat.topLsrSize) && + Objects.equals(this.markPrice, contractStat.markPrice); } @Override public int hashCode() { - return Objects.hash(time, lsrTaker, lsrAccount, longLiqSize, longLiqAmount, longLiqUsd, shortLiqSize, shortLiqAmount, shortLiqUsd, openInterest, openInterestUsd, topLsrAccount, topLsrSize); + return Objects.hash(time, lsrTaker, lsrAccount, longLiqSize, longLiqAmount, longLiqUsd, shortLiqSize, shortLiqAmount, shortLiqUsd, openInterest, openInterestUsd, topLsrAccount, topLsrSize, markPrice); } @@ -383,6 +408,7 @@ public String toString() { sb.append(" openInterestUsd: ").append(toIndentedString(openInterestUsd)).append("\n"); sb.append(" topLsrAccount: ").append(toIndentedString(topLsrAccount)).append("\n"); sb.append(" topLsrSize: ").append(toIndentedString(topLsrSize)).append("\n"); + sb.append(" markPrice: ").append(toIndentedString(markPrice)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/gate/gateapi/models/ConvertSmallBalance.java b/src/main/java/io/gate/gateapi/models/ConvertSmallBalance.java index 0ac22b9..5e85852 100644 --- a/src/main/java/io/gate/gateapi/models/ConvertSmallBalance.java +++ b/src/main/java/io/gate/gateapi/models/ConvertSmallBalance.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -22,7 +22,7 @@ import java.util.List; /** - * Convert Small Balance + * Small Balance Conversion */ public class ConvertSmallBalance { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -49,7 +49,7 @@ public ConvertSmallBalance addCurrencyItem(String currencyItem) { } /** - * Currency + * Currency to be converted * @return currency **/ @javax.annotation.Nullable @@ -69,7 +69,7 @@ public ConvertSmallBalance isAll(Boolean isAll) { } /** - * Whether to exchange all + * Whether to convert all * @return isAll **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CountdownCancelAllFuturesTask.java b/src/main/java/io/gate/gateapi/models/CountdownCancelAllFuturesTask.java index 380e9af..235f681 100644 --- a/src/main/java/io/gate/gateapi/models/CountdownCancelAllFuturesTask.java +++ b/src/main/java/io/gate/gateapi/models/CountdownCancelAllFuturesTask.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Countdown cancel task detail + * Countdown cancel task details */ public class CountdownCancelAllFuturesTask { public static final String SERIALIZED_NAME_TIMEOUT = "timeout"; @@ -39,7 +39,7 @@ public CountdownCancelAllFuturesTask timeout(Integer timeout) { } /** - * Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown + * Countdown time in seconds At least 5 seconds, 0 means cancel countdown * @return timeout **/ public Integer getTimeout() { diff --git a/src/main/java/io/gate/gateapi/models/CountdownCancelAllOptionsTask.java b/src/main/java/io/gate/gateapi/models/CountdownCancelAllOptionsTask.java index f42eaa9..978411e 100644 --- a/src/main/java/io/gate/gateapi/models/CountdownCancelAllOptionsTask.java +++ b/src/main/java/io/gate/gateapi/models/CountdownCancelAllOptionsTask.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Countdown cancel task detail + * Countdown cancel task details */ public class CountdownCancelAllOptionsTask { public static final String SERIALIZED_NAME_TIMEOUT = "timeout"; @@ -43,7 +43,7 @@ public CountdownCancelAllOptionsTask timeout(Integer timeout) { } /** - * Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown + * Countdown time in seconds At least 5 seconds, 0 means cancel countdown * @return timeout **/ public Integer getTimeout() { diff --git a/src/main/java/io/gate/gateapi/models/CountdownCancelAllSpotTask.java b/src/main/java/io/gate/gateapi/models/CountdownCancelAllSpotTask.java index 8aaf766..feb268e 100644 --- a/src/main/java/io/gate/gateapi/models/CountdownCancelAllSpotTask.java +++ b/src/main/java/io/gate/gateapi/models/CountdownCancelAllSpotTask.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Countdown cancel task detail + * Countdown cancel task details */ public class CountdownCancelAllSpotTask { public static final String SERIALIZED_NAME_TIMEOUT = "timeout"; @@ -39,7 +39,7 @@ public CountdownCancelAllSpotTask timeout(Integer timeout) { } /** - * Countdown time, in seconds At least 5 seconds, 0 means cancel the countdown + * Countdown time in seconds At least 5 seconds, 0 means cancel countdown * @return timeout **/ public Integer getTimeout() { diff --git a/src/main/java/io/gate/gateapi/models/CreateCollateralOrder.java b/src/main/java/io/gate/gateapi/models/CreateCollateralOrder.java index d174174..1535e79 100644 --- a/src/main/java/io/gate/gateapi/models/CreateCollateralOrder.java +++ b/src/main/java/io/gate/gateapi/models/CreateCollateralOrder.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -66,7 +66,7 @@ public CreateCollateralOrder collateralCurrency(String collateralCurrency) { } /** - * Collateral + * Collateral currency * @return collateralCurrency **/ public String getCollateralCurrency() { @@ -85,7 +85,7 @@ public CreateCollateralOrder borrowAmount(String borrowAmount) { } /** - * Borrowing amount + * Borrowed amount * @return borrowAmount **/ public String getBorrowAmount() { diff --git a/src/main/java/io/gate/gateapi/models/CreateMultiCollateralOrder.java b/src/main/java/io/gate/gateapi/models/CreateMultiCollateralOrder.java index 27d1986..724ad1d 100644 --- a/src/main/java/io/gate/gateapi/models/CreateMultiCollateralOrder.java +++ b/src/main/java/io/gate/gateapi/models/CreateMultiCollateralOrder.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -90,7 +90,7 @@ public CreateMultiCollateralOrder orderType(String orderType) { } /** - * current - current, fixed - fixed, if not specified, default to current + * current - current rate, fixed - fixed rate, defaults to current if not specified * @return orderType **/ @javax.annotation.Nullable @@ -110,7 +110,7 @@ public CreateMultiCollateralOrder fixedType(String fixedType) { } /** - * Fixed interest rate loan period: 7d - 7 days, 30d - 30 days. Must be provided for fixed + * Fixed interest rate lending period: 7d - 7 days, 30d - 30 days. Required for fixed rate * @return fixedType **/ @javax.annotation.Nullable @@ -130,7 +130,7 @@ public CreateMultiCollateralOrder fixedRate(String fixedRate) { } /** - * Fixed interest rate, must be specified for fixed + * Fixed interest rate, required for fixed rate * @return fixedRate **/ @javax.annotation.Nullable @@ -150,7 +150,7 @@ public CreateMultiCollateralOrder autoRenew(Boolean autoRenew) { } /** - * Fixed interest rate, automatic renewal + * Fixed interest rate, auto-renewal * @return autoRenew **/ @javax.annotation.Nullable @@ -170,7 +170,7 @@ public CreateMultiCollateralOrder autoRepay(Boolean autoRepay) { } /** - * Fixed interest rate, automatic repayment + * Fixed interest rate, auto-repayment * @return autoRepay **/ @javax.annotation.Nullable @@ -209,7 +209,7 @@ public CreateMultiCollateralOrder borrowAmount(String borrowAmount) { } /** - * Borrowing amount + * Borrowed amount * @return borrowAmount **/ public String getBorrowAmount() { diff --git a/src/main/java/io/gate/gateapi/models/CreateUniLend.java b/src/main/java/io/gate/gateapi/models/CreateUniLend.java index a88136e..73974c1 100644 --- a/src/main/java/io/gate/gateapi/models/CreateUniLend.java +++ b/src/main/java/io/gate/gateapi/models/CreateUniLend.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Lend or redeem + * Create lending or redemption */ public class CreateUniLend { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -32,7 +32,7 @@ public class CreateUniLend { private String amount; /** - * type: lend - lend, redeem - redeem + * Operation type: lend - Lend, redeem - Redeem */ @JsonAdapter(TypeEnum.Adapter.class) public enum TypeEnum { @@ -113,7 +113,7 @@ public CreateUniLend amount(String amount) { } /** - * The amount of currency could be lent + * Amount to deposit into lending pool * @return amount **/ public String getAmount() { @@ -132,7 +132,7 @@ public CreateUniLend type(TypeEnum type) { } /** - * type: lend - lend, redeem - redeem + * Operation type: lend - Lend, redeem - Redeem * @return type **/ public TypeEnum getType() { @@ -151,7 +151,7 @@ public CreateUniLend minRate(String minRate) { } /** - * 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. + * Minimum interest rate. If set too high, lending may fail and no interest will be earned. Required for lending operations. * @return minRate **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CreateUniLoan.java b/src/main/java/io/gate/gateapi/models/CreateUniLoan.java index 9404043..f11bf67 100644 --- a/src/main/java/io/gate/gateapi/models/CreateUniLoan.java +++ b/src/main/java/io/gate/gateapi/models/CreateUniLoan.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -28,7 +28,7 @@ public class CreateUniLoan { private String currency; /** - * type: borrow - borrow, repay - repay + * Type: `borrow` - borrow, `repay` - repay */ @JsonAdapter(TypeEnum.Adapter.class) public enum TypeEnum { @@ -117,7 +117,7 @@ public CreateUniLoan type(TypeEnum type) { } /** - * type: borrow - borrow, repay - repay + * Type: `borrow` - borrow, `repay` - repay * @return type **/ public TypeEnum getType() { @@ -136,7 +136,7 @@ public CreateUniLoan amount(String amount) { } /** - * The amount of lending or repaying + * Borrow or repayment amount * @return amount **/ public String getAmount() { @@ -155,7 +155,7 @@ public CreateUniLoan repaidAll(Boolean repaidAll) { } /** - * Full repayment. Repay operation only. If the value is `true`, the amount will be ignored and the loan will be repaid in full. + * Full repayment. For repayment operations only. When `true`, overrides `amount` and repays the full amount * @return repaidAll **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CrossMarginAccount.java b/src/main/java/io/gate/gateapi/models/CrossMarginAccount.java deleted file mode 100644 index bd11a7a..0000000 --- a/src/main/java/io/gate/gateapi/models/CrossMarginAccount.java +++ /dev/null @@ -1,517 +0,0 @@ -/* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package io.gate.gateapi.models; - -import java.util.Objects; -import java.util.Arrays; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.gate.gateapi.models.CrossMarginBalance; -import java.io.IOException; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * CrossMarginAccount - */ -public class CrossMarginAccount { - public static final String SERIALIZED_NAME_USER_ID = "user_id"; - @SerializedName(SERIALIZED_NAME_USER_ID) - private Long userId; - - public static final String SERIALIZED_NAME_REFRESH_TIME = "refresh_time"; - @SerializedName(SERIALIZED_NAME_REFRESH_TIME) - private Long refreshTime; - - public static final String SERIALIZED_NAME_LOCKED = "locked"; - @SerializedName(SERIALIZED_NAME_LOCKED) - private Boolean locked; - - public static final String SERIALIZED_NAME_BALANCES = "balances"; - @SerializedName(SERIALIZED_NAME_BALANCES) - private Map balances = null; - - public static final String SERIALIZED_NAME_TOTAL = "total"; - @SerializedName(SERIALIZED_NAME_TOTAL) - private String total; - - public static final String SERIALIZED_NAME_BORROWED = "borrowed"; - @SerializedName(SERIALIZED_NAME_BORROWED) - private String borrowed; - - public static final String SERIALIZED_NAME_INTEREST = "interest"; - @SerializedName(SERIALIZED_NAME_INTEREST) - private String interest; - - public static final String SERIALIZED_NAME_RISK = "risk"; - @SerializedName(SERIALIZED_NAME_RISK) - private String risk; - - public static final String SERIALIZED_NAME_TOTAL_INITIAL_MARGIN = "total_initial_margin"; - @SerializedName(SERIALIZED_NAME_TOTAL_INITIAL_MARGIN) - private String totalInitialMargin; - - public static final String SERIALIZED_NAME_TOTAL_MARGIN_BALANCE = "total_margin_balance"; - @SerializedName(SERIALIZED_NAME_TOTAL_MARGIN_BALANCE) - private String totalMarginBalance; - - public static final String SERIALIZED_NAME_TOTAL_MAINTENANCE_MARGIN = "total_maintenance_margin"; - @SerializedName(SERIALIZED_NAME_TOTAL_MAINTENANCE_MARGIN) - private String totalMaintenanceMargin; - - public static final String SERIALIZED_NAME_TOTAL_INITIAL_MARGIN_RATE = "total_initial_margin_rate"; - @SerializedName(SERIALIZED_NAME_TOTAL_INITIAL_MARGIN_RATE) - private String totalInitialMarginRate; - - public static final String SERIALIZED_NAME_TOTAL_MAINTENANCE_MARGIN_RATE = "total_maintenance_margin_rate"; - @SerializedName(SERIALIZED_NAME_TOTAL_MAINTENANCE_MARGIN_RATE) - private String totalMaintenanceMarginRate; - - public static final String SERIALIZED_NAME_TOTAL_AVAILABLE_MARGIN = "total_available_margin"; - @SerializedName(SERIALIZED_NAME_TOTAL_AVAILABLE_MARGIN) - private String totalAvailableMargin; - - public static final String SERIALIZED_NAME_PORTFOLIO_MARGIN_TOTAL = "portfolio_margin_total"; - @SerializedName(SERIALIZED_NAME_PORTFOLIO_MARGIN_TOTAL) - private String portfolioMarginTotal; - - public static final String SERIALIZED_NAME_PORTFOLIO_MARGIN_TOTAL_LIAB = "portfolio_margin_total_liab"; - @SerializedName(SERIALIZED_NAME_PORTFOLIO_MARGIN_TOTAL_LIAB) - private String portfolioMarginTotalLiab; - - public static final String SERIALIZED_NAME_PORTFOLIO_MARGIN_TOTAL_EQUITY = "portfolio_margin_total_equity"; - @SerializedName(SERIALIZED_NAME_PORTFOLIO_MARGIN_TOTAL_EQUITY) - private String portfolioMarginTotalEquity; - - - public CrossMarginAccount userId(Long userId) { - - this.userId = userId; - return this; - } - - /** - * User ID - * @return userId - **/ - @javax.annotation.Nullable - public Long getUserId() { - return userId; - } - - - public void setUserId(Long userId) { - this.userId = userId; - } - - public CrossMarginAccount refreshTime(Long refreshTime) { - - this.refreshTime = refreshTime; - return this; - } - - /** - * Time of the most recent refresh - * @return refreshTime - **/ - @javax.annotation.Nullable - public Long getRefreshTime() { - return refreshTime; - } - - - public void setRefreshTime(Long refreshTime) { - this.refreshTime = refreshTime; - } - - public CrossMarginAccount locked(Boolean locked) { - - this.locked = locked; - return this; - } - - /** - * Whether account is locked - * @return locked - **/ - @javax.annotation.Nullable - public Boolean getLocked() { - return locked; - } - - - public void setLocked(Boolean locked) { - this.locked = locked; - } - - public CrossMarginAccount balances(Map balances) { - - this.balances = balances; - return this; - } - - public CrossMarginAccount putBalancesItem(String key, CrossMarginBalance balancesItem) { - if (this.balances == null) { - this.balances = new HashMap<>(); - } - this.balances.put(key, balancesItem); - return this; - } - - /** - * Get balances - * @return balances - **/ - @javax.annotation.Nullable - public Map getBalances() { - return balances; - } - - - public void setBalances(Map balances) { - this.balances = balances; - } - - public CrossMarginAccount total(String total) { - - this.total = total; - return this; - } - - /** - * Total account value in USDT, i.e., the sum of all currencies' `(available+freeze)*price*discount` - * @return total - **/ - @javax.annotation.Nullable - public String getTotal() { - return total; - } - - - public void setTotal(String total) { - this.total = total; - } - - public CrossMarginAccount borrowed(String borrowed) { - - this.borrowed = borrowed; - return this; - } - - /** - * Total borrowed value in USDT, i.e., the sum of all currencies' `borrowed*price*discount` - * @return borrowed - **/ - @javax.annotation.Nullable - public String getBorrowed() { - return borrowed; - } - - - public void setBorrowed(String borrowed) { - this.borrowed = borrowed; - } - - public CrossMarginAccount interest(String interest) { - - this.interest = interest; - return this; - } - - /** - * Total unpaid interests in USDT, i.e., the sum of all currencies' `interest*price*discount` - * @return interest - **/ - @javax.annotation.Nullable - public String getInterest() { - return interest; - } - - - public void setInterest(String interest) { - this.interest = interest; - } - - public CrossMarginAccount risk(String risk) { - - this.risk = risk; - return this; - } - - /** - * Risk rate. When it belows 110%, liquidation will be triggered. Calculation formula: `total / (borrowed+interest)` - * @return risk - **/ - @javax.annotation.Nullable - public String getRisk() { - return risk; - } - - - public void setRisk(String risk) { - this.risk = risk; - } - - public CrossMarginAccount totalInitialMargin(String totalInitialMargin) { - - this.totalInitialMargin = totalInitialMargin; - return this; - } - - /** - * Total initial margin - * @return totalInitialMargin - **/ - @javax.annotation.Nullable - public String getTotalInitialMargin() { - return totalInitialMargin; - } - - - public void setTotalInitialMargin(String totalInitialMargin) { - this.totalInitialMargin = totalInitialMargin; - } - - public CrossMarginAccount totalMarginBalance(String totalMarginBalance) { - - this.totalMarginBalance = totalMarginBalance; - return this; - } - - /** - * Total Margin Balance (∑(positive equity ＊ index price * discount) + ∑(negative equity * index price)) - * @return totalMarginBalance - **/ - @javax.annotation.Nullable - public String getTotalMarginBalance() { - return totalMarginBalance; - } - - - public void setTotalMarginBalance(String totalMarginBalance) { - this.totalMarginBalance = totalMarginBalance; - } - - public CrossMarginAccount totalMaintenanceMargin(String totalMaintenanceMargin) { - - this.totalMaintenanceMargin = totalMaintenanceMargin; - return this; - } - - /** - * Total maintenance margin - * @return totalMaintenanceMargin - **/ - @javax.annotation.Nullable - public String getTotalMaintenanceMargin() { - return totalMaintenanceMargin; - } - - - public void setTotalMaintenanceMargin(String totalMaintenanceMargin) { - this.totalMaintenanceMargin = totalMaintenanceMargin; - } - - public CrossMarginAccount totalInitialMarginRate(String totalInitialMarginRate) { - - this.totalInitialMarginRate = totalInitialMarginRate; - return this; - } - - /** - * Total initial margin rate - * @return totalInitialMarginRate - **/ - @javax.annotation.Nullable - public String getTotalInitialMarginRate() { - return totalInitialMarginRate; - } - - - public void setTotalInitialMarginRate(String totalInitialMarginRate) { - this.totalInitialMarginRate = totalInitialMarginRate; - } - - public CrossMarginAccount totalMaintenanceMarginRate(String totalMaintenanceMarginRate) { - - this.totalMaintenanceMarginRate = totalMaintenanceMarginRate; - return this; - } - - /** - * Total maintenance margin rate - * @return totalMaintenanceMarginRate - **/ - @javax.annotation.Nullable - public String getTotalMaintenanceMarginRate() { - return totalMaintenanceMarginRate; - } - - - public void setTotalMaintenanceMarginRate(String totalMaintenanceMarginRate) { - this.totalMaintenanceMarginRate = totalMaintenanceMarginRate; - } - - public CrossMarginAccount totalAvailableMargin(String totalAvailableMargin) { - - this.totalAvailableMargin = totalAvailableMargin; - return this; - } - - /** - * Total available margin - * @return totalAvailableMargin - **/ - @javax.annotation.Nullable - public String getTotalAvailableMargin() { - return totalAvailableMargin; - } - - - public void setTotalAvailableMargin(String totalAvailableMargin) { - this.totalAvailableMargin = totalAvailableMargin; - } - - public CrossMarginAccount portfolioMarginTotal(String portfolioMarginTotal) { - - this.portfolioMarginTotal = portfolioMarginTotal; - return this; - } - - /** - * Total amount of the portfolio margin account - * @return portfolioMarginTotal - **/ - @javax.annotation.Nullable - public String getPortfolioMarginTotal() { - return portfolioMarginTotal; - } - - - public void setPortfolioMarginTotal(String portfolioMarginTotal) { - this.portfolioMarginTotal = portfolioMarginTotal; - } - - public CrossMarginAccount portfolioMarginTotalLiab(String portfolioMarginTotalLiab) { - - this.portfolioMarginTotalLiab = portfolioMarginTotalLiab; - return this; - } - - /** - * Total liabilities of the portfolio margin account - * @return portfolioMarginTotalLiab - **/ - @javax.annotation.Nullable - public String getPortfolioMarginTotalLiab() { - return portfolioMarginTotalLiab; - } - - - public void setPortfolioMarginTotalLiab(String portfolioMarginTotalLiab) { - this.portfolioMarginTotalLiab = portfolioMarginTotalLiab; - } - - public CrossMarginAccount portfolioMarginTotalEquity(String portfolioMarginTotalEquity) { - - this.portfolioMarginTotalEquity = portfolioMarginTotalEquity; - return this; - } - - /** - * Total equity of the portfolio margin account - * @return portfolioMarginTotalEquity - **/ - @javax.annotation.Nullable - public String getPortfolioMarginTotalEquity() { - return portfolioMarginTotalEquity; - } - - - public void setPortfolioMarginTotalEquity(String portfolioMarginTotalEquity) { - this.portfolioMarginTotalEquity = portfolioMarginTotalEquity; - } - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - CrossMarginAccount crossMarginAccount = (CrossMarginAccount) o; - return Objects.equals(this.userId, crossMarginAccount.userId) && - Objects.equals(this.refreshTime, crossMarginAccount.refreshTime) && - Objects.equals(this.locked, crossMarginAccount.locked) && - Objects.equals(this.balances, crossMarginAccount.balances) && - Objects.equals(this.total, crossMarginAccount.total) && - Objects.equals(this.borrowed, crossMarginAccount.borrowed) && - Objects.equals(this.interest, crossMarginAccount.interest) && - Objects.equals(this.risk, crossMarginAccount.risk) && - Objects.equals(this.totalInitialMargin, crossMarginAccount.totalInitialMargin) && - Objects.equals(this.totalMarginBalance, crossMarginAccount.totalMarginBalance) && - Objects.equals(this.totalMaintenanceMargin, crossMarginAccount.totalMaintenanceMargin) && - Objects.equals(this.totalInitialMarginRate, crossMarginAccount.totalInitialMarginRate) && - Objects.equals(this.totalMaintenanceMarginRate, crossMarginAccount.totalMaintenanceMarginRate) && - Objects.equals(this.totalAvailableMargin, crossMarginAccount.totalAvailableMargin) && - Objects.equals(this.portfolioMarginTotal, crossMarginAccount.portfolioMarginTotal) && - Objects.equals(this.portfolioMarginTotalLiab, crossMarginAccount.portfolioMarginTotalLiab) && - Objects.equals(this.portfolioMarginTotalEquity, crossMarginAccount.portfolioMarginTotalEquity); - } - - @Override - public int hashCode() { - return Objects.hash(userId, refreshTime, locked, balances, total, borrowed, interest, risk, totalInitialMargin, totalMarginBalance, totalMaintenanceMargin, totalInitialMarginRate, totalMaintenanceMarginRate, totalAvailableMargin, portfolioMarginTotal, portfolioMarginTotalLiab, portfolioMarginTotalEquity); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class CrossMarginAccount {\n"); - sb.append(" userId: ").append(toIndentedString(userId)).append("\n"); - sb.append(" refreshTime: ").append(toIndentedString(refreshTime)).append("\n"); - sb.append(" locked: ").append(toIndentedString(locked)).append("\n"); - sb.append(" balances: ").append(toIndentedString(balances)).append("\n"); - sb.append(" total: ").append(toIndentedString(total)).append("\n"); - sb.append(" borrowed: ").append(toIndentedString(borrowed)).append("\n"); - sb.append(" interest: ").append(toIndentedString(interest)).append("\n"); - sb.append(" risk: ").append(toIndentedString(risk)).append("\n"); - sb.append(" totalInitialMargin: ").append(toIndentedString(totalInitialMargin)).append("\n"); - sb.append(" totalMarginBalance: ").append(toIndentedString(totalMarginBalance)).append("\n"); - sb.append(" totalMaintenanceMargin: ").append(toIndentedString(totalMaintenanceMargin)).append("\n"); - sb.append(" totalInitialMarginRate: ").append(toIndentedString(totalInitialMarginRate)).append("\n"); - sb.append(" totalMaintenanceMarginRate: ").append(toIndentedString(totalMaintenanceMarginRate)).append("\n"); - sb.append(" totalAvailableMargin: ").append(toIndentedString(totalAvailableMargin)).append("\n"); - sb.append(" portfolioMarginTotal: ").append(toIndentedString(portfolioMarginTotal)).append("\n"); - sb.append(" portfolioMarginTotalLiab: ").append(toIndentedString(portfolioMarginTotalLiab)).append("\n"); - sb.append(" portfolioMarginTotalEquity: ").append(toIndentedString(portfolioMarginTotalEquity)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/io/gate/gateapi/models/CrossMarginAccountBook.java b/src/main/java/io/gate/gateapi/models/CrossMarginAccountBook.java deleted file mode 100644 index 9f86f37..0000000 --- a/src/main/java/io/gate/gateapi/models/CrossMarginAccountBook.java +++ /dev/null @@ -1,219 +0,0 @@ -/* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package io.gate.gateapi.models; - -import java.util.Objects; -import java.util.Arrays; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; - -/** - * CrossMarginAccountBook - */ -public class CrossMarginAccountBook { - public static final String SERIALIZED_NAME_ID = "id"; - @SerializedName(SERIALIZED_NAME_ID) - private String id; - - public static final String SERIALIZED_NAME_TIME = "time"; - @SerializedName(SERIALIZED_NAME_TIME) - private Long time; - - public static final String SERIALIZED_NAME_CURRENCY = "currency"; - @SerializedName(SERIALIZED_NAME_CURRENCY) - private String currency; - - public static final String SERIALIZED_NAME_CHANGE = "change"; - @SerializedName(SERIALIZED_NAME_CHANGE) - private String change; - - public static final String SERIALIZED_NAME_BALANCE = "balance"; - @SerializedName(SERIALIZED_NAME_BALANCE) - private String balance; - - public static final String SERIALIZED_NAME_TYPE = "type"; - @SerializedName(SERIALIZED_NAME_TYPE) - private String type; - - - public CrossMarginAccountBook id(String id) { - - this.id = id; - return this; - } - - /** - * Balance change record ID - * @return id - **/ - @javax.annotation.Nullable - public String getId() { - return id; - } - - - public void setId(String id) { - this.id = id; - } - - public CrossMarginAccountBook time(Long time) { - - this.time = time; - return this; - } - - /** - * The timestamp of the change (in milliseconds) - * @return time - **/ - @javax.annotation.Nullable - public Long getTime() { - return time; - } - - - public void setTime(Long time) { - this.time = time; - } - - public CrossMarginAccountBook currency(String currency) { - - this.currency = currency; - return this; - } - - /** - * Currency changed - * @return currency - **/ - @javax.annotation.Nullable - public String getCurrency() { - return currency; - } - - - public void setCurrency(String currency) { - this.currency = currency; - } - - public CrossMarginAccountBook change(String change) { - - this.change = change; - return this; - } - - /** - * Amount changed. Positive value means transferring in, while negative out - * @return change - **/ - @javax.annotation.Nullable - public String getChange() { - return change; - } - - - public void setChange(String change) { - this.change = change; - } - - public CrossMarginAccountBook balance(String balance) { - - this.balance = balance; - return this; - } - - /** - * Balance after change - * @return balance - **/ - @javax.annotation.Nullable - public String getBalance() { - return balance; - } - - - public void setBalance(String balance) { - this.balance = balance; - } - - public CrossMarginAccountBook type(String type) { - - this.type = type; - return this; - } - - /** - * Account book type. Please refer to [account book type](#accountbook-type) for more detail - * @return type - **/ - @javax.annotation.Nullable - public String getType() { - return type; - } - - - public void setType(String type) { - this.type = type; - } - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - CrossMarginAccountBook crossMarginAccountBook = (CrossMarginAccountBook) o; - return Objects.equals(this.id, crossMarginAccountBook.id) && - Objects.equals(this.time, crossMarginAccountBook.time) && - Objects.equals(this.currency, crossMarginAccountBook.currency) && - Objects.equals(this.change, crossMarginAccountBook.change) && - Objects.equals(this.balance, crossMarginAccountBook.balance) && - Objects.equals(this.type, crossMarginAccountBook.type); - } - - @Override - public int hashCode() { - return Objects.hash(id, time, currency, change, balance, type); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class CrossMarginAccountBook {\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" time: ").append(toIndentedString(time)).append("\n"); - sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); - sb.append(" change: ").append(toIndentedString(change)).append("\n"); - sb.append(" balance: ").append(toIndentedString(balance)).append("\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/io/gate/gateapi/models/CrossMarginBalance.java b/src/main/java/io/gate/gateapi/models/CrossMarginBalance.java index 8380cc8..e98877f 100644 --- a/src/main/java/io/gate/gateapi/models/CrossMarginBalance.java +++ b/src/main/java/io/gate/gateapi/models/CrossMarginBalance.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -39,26 +39,6 @@ public class CrossMarginBalance { @SerializedName(SERIALIZED_NAME_INTEREST) private String interest; - public static final String SERIALIZED_NAME_NEGATIVE_LIAB = "negative_liab"; - @SerializedName(SERIALIZED_NAME_NEGATIVE_LIAB) - private String negativeLiab; - - public static final String SERIALIZED_NAME_FUTURES_POS_LIAB = "futures_pos_liab"; - @SerializedName(SERIALIZED_NAME_FUTURES_POS_LIAB) - private String futuresPosLiab; - - public static final String SERIALIZED_NAME_EQUITY = "equity"; - @SerializedName(SERIALIZED_NAME_EQUITY) - private String equity; - - public static final String SERIALIZED_NAME_TOTAL_FREEZE = "total_freeze"; - @SerializedName(SERIALIZED_NAME_TOTAL_FREEZE) - private String totalFreeze; - - public static final String SERIALIZED_NAME_TOTAL_LIAB = "total_liab"; - @SerializedName(SERIALIZED_NAME_TOTAL_LIAB) - private String totalLiab; - public CrossMarginBalance available(String available) { @@ -67,7 +47,7 @@ public CrossMarginBalance available(String available) { } /** - * Available amount + * Available balance * @return available **/ @javax.annotation.Nullable @@ -87,7 +67,7 @@ public CrossMarginBalance freeze(String freeze) { } /** - * Locked amount + * Locked balance * @return freeze **/ @javax.annotation.Nullable @@ -107,7 +87,7 @@ public CrossMarginBalance borrowed(String borrowed) { } /** - * Borrowed amount + * Borrowed balance * @return borrowed **/ @javax.annotation.Nullable @@ -127,7 +107,7 @@ public CrossMarginBalance interest(String interest) { } /** - * Unpaid interests + * Unpaid interest * @return interest **/ @javax.annotation.Nullable @@ -139,106 +119,6 @@ public String getInterest() { public void setInterest(String interest) { this.interest = interest; } - - public CrossMarginBalance negativeLiab(String negativeLiab) { - - this.negativeLiab = negativeLiab; - return this; - } - - /** - * Negative Liabilities. Formula:Min[available+total+unrealized_pnl,0] - * @return negativeLiab - **/ - @javax.annotation.Nullable - public String getNegativeLiab() { - return negativeLiab; - } - - - public void setNegativeLiab(String negativeLiab) { - this.negativeLiab = negativeLiab; - } - - public CrossMarginBalance futuresPosLiab(String futuresPosLiab) { - - this.futuresPosLiab = futuresPosLiab; - return this; - } - - /** - * Borrowing to Open Positions in Futures - * @return futuresPosLiab - **/ - @javax.annotation.Nullable - public String getFuturesPosLiab() { - return futuresPosLiab; - } - - - public void setFuturesPosLiab(String futuresPosLiab) { - this.futuresPosLiab = futuresPosLiab; - } - - public CrossMarginBalance equity(String equity) { - - this.equity = equity; - return this; - } - - /** - * Equity. Formula: available + freeze - borrowed + futures account's total + unrealized_pnl - * @return equity - **/ - @javax.annotation.Nullable - public String getEquity() { - return equity; - } - - - public void setEquity(String equity) { - this.equity = equity; - } - - public CrossMarginBalance totalFreeze(String totalFreeze) { - - this.totalFreeze = totalFreeze; - return this; - } - - /** - * Total freeze. Formula: freeze + position_initial_margin + order_margin - * @return totalFreeze - **/ - @javax.annotation.Nullable - public String getTotalFreeze() { - return totalFreeze; - } - - - public void setTotalFreeze(String totalFreeze) { - this.totalFreeze = totalFreeze; - } - - public CrossMarginBalance totalLiab(String totalLiab) { - - this.totalLiab = totalLiab; - return this; - } - - /** - * Total liabilities. Formula: Max[Abs[Min[quity - total_freeze,0], borrowed]] - futures_pos_liab - * @return totalLiab - **/ - @javax.annotation.Nullable - public String getTotalLiab() { - return totalLiab; - } - - - public void setTotalLiab(String totalLiab) { - this.totalLiab = totalLiab; - } @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -251,17 +131,12 @@ public boolean equals(java.lang.Object o) { return Objects.equals(this.available, crossMarginBalance.available) && Objects.equals(this.freeze, crossMarginBalance.freeze) && Objects.equals(this.borrowed, crossMarginBalance.borrowed) && - Objects.equals(this.interest, crossMarginBalance.interest) && - Objects.equals(this.negativeLiab, crossMarginBalance.negativeLiab) && - Objects.equals(this.futuresPosLiab, crossMarginBalance.futuresPosLiab) && - Objects.equals(this.equity, crossMarginBalance.equity) && - Objects.equals(this.totalFreeze, crossMarginBalance.totalFreeze) && - Objects.equals(this.totalLiab, crossMarginBalance.totalLiab); + Objects.equals(this.interest, crossMarginBalance.interest); } @Override public int hashCode() { - return Objects.hash(available, freeze, borrowed, interest, negativeLiab, futuresPosLiab, equity, totalFreeze, totalLiab); + return Objects.hash(available, freeze, borrowed, interest); } @@ -273,11 +148,6 @@ public String toString() { sb.append(" freeze: ").append(toIndentedString(freeze)).append("\n"); sb.append(" borrowed: ").append(toIndentedString(borrowed)).append("\n"); sb.append(" interest: ").append(toIndentedString(interest)).append("\n"); - sb.append(" negativeLiab: ").append(toIndentedString(negativeLiab)).append("\n"); - sb.append(" futuresPosLiab: ").append(toIndentedString(futuresPosLiab)).append("\n"); - sb.append(" equity: ").append(toIndentedString(equity)).append("\n"); - sb.append(" totalFreeze: ").append(toIndentedString(totalFreeze)).append("\n"); - sb.append(" totalLiab: ").append(toIndentedString(totalLiab)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/gate/gateapi/models/CrossMarginBalance1.java b/src/main/java/io/gate/gateapi/models/CrossMarginBalance1.java deleted file mode 100644 index 16d452f..0000000 --- a/src/main/java/io/gate/gateapi/models/CrossMarginBalance1.java +++ /dev/null @@ -1,167 +0,0 @@ -/* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package io.gate.gateapi.models; - -import java.util.Objects; -import java.util.Arrays; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; - -/** - * CrossMarginBalance1 - */ -public class CrossMarginBalance1 { - public static final String SERIALIZED_NAME_AVAILABLE = "available"; - @SerializedName(SERIALIZED_NAME_AVAILABLE) - private String available; - - public static final String SERIALIZED_NAME_FREEZE = "freeze"; - @SerializedName(SERIALIZED_NAME_FREEZE) - private String freeze; - - public static final String SERIALIZED_NAME_BORROWED = "borrowed"; - @SerializedName(SERIALIZED_NAME_BORROWED) - private String borrowed; - - public static final String SERIALIZED_NAME_INTEREST = "interest"; - @SerializedName(SERIALIZED_NAME_INTEREST) - private String interest; - - - public CrossMarginBalance1 available(String available) { - - this.available = available; - return this; - } - - /** - * Available amount - * @return available - **/ - @javax.annotation.Nullable - public String getAvailable() { - return available; - } - - - public void setAvailable(String available) { - this.available = available; - } - - public CrossMarginBalance1 freeze(String freeze) { - - this.freeze = freeze; - return this; - } - - /** - * Locked amount - * @return freeze - **/ - @javax.annotation.Nullable - public String getFreeze() { - return freeze; - } - - - public void setFreeze(String freeze) { - this.freeze = freeze; - } - - public CrossMarginBalance1 borrowed(String borrowed) { - - this.borrowed = borrowed; - return this; - } - - /** - * Borrowed amount - * @return borrowed - **/ - @javax.annotation.Nullable - public String getBorrowed() { - return borrowed; - } - - - public void setBorrowed(String borrowed) { - this.borrowed = borrowed; - } - - public CrossMarginBalance1 interest(String interest) { - - this.interest = interest; - return this; - } - - /** - * Unpaid interests - * @return interest - **/ - @javax.annotation.Nullable - public String getInterest() { - return interest; - } - - - public void setInterest(String interest) { - this.interest = interest; - } - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - CrossMarginBalance1 crossMarginBalance1 = (CrossMarginBalance1) o; - return Objects.equals(this.available, crossMarginBalance1.available) && - Objects.equals(this.freeze, crossMarginBalance1.freeze) && - Objects.equals(this.borrowed, crossMarginBalance1.borrowed) && - Objects.equals(this.interest, crossMarginBalance1.interest); - } - - @Override - public int hashCode() { - return Objects.hash(available, freeze, borrowed, interest); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class CrossMarginBalance1 {\n"); - sb.append(" available: ").append(toIndentedString(available)).append("\n"); - sb.append(" freeze: ").append(toIndentedString(freeze)).append("\n"); - sb.append(" borrowed: ").append(toIndentedString(borrowed)).append("\n"); - sb.append(" interest: ").append(toIndentedString(interest)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/io/gate/gateapi/models/CrossMarginCurrency.java b/src/main/java/io/gate/gateapi/models/CrossMarginCurrency.java deleted file mode 100644 index f68e5f4..0000000 --- a/src/main/java/io/gate/gateapi/models/CrossMarginCurrency.java +++ /dev/null @@ -1,323 +0,0 @@ -/* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package io.gate.gateapi.models; - -import java.util.Objects; -import java.util.Arrays; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; - -/** - * CrossMarginCurrency - */ -public class CrossMarginCurrency { - public static final String SERIALIZED_NAME_NAME = "name"; - @SerializedName(SERIALIZED_NAME_NAME) - private String name; - - public static final String SERIALIZED_NAME_RATE = "rate"; - @SerializedName(SERIALIZED_NAME_RATE) - private String rate; - - public static final String SERIALIZED_NAME_PREC = "prec"; - @SerializedName(SERIALIZED_NAME_PREC) - private String prec; - - public static final String SERIALIZED_NAME_DISCOUNT = "discount"; - @SerializedName(SERIALIZED_NAME_DISCOUNT) - private String discount; - - public static final String SERIALIZED_NAME_MIN_BORROW_AMOUNT = "min_borrow_amount"; - @SerializedName(SERIALIZED_NAME_MIN_BORROW_AMOUNT) - private String minBorrowAmount; - - public static final String SERIALIZED_NAME_USER_MAX_BORROW_AMOUNT = "user_max_borrow_amount"; - @SerializedName(SERIALIZED_NAME_USER_MAX_BORROW_AMOUNT) - private String userMaxBorrowAmount; - - public static final String SERIALIZED_NAME_TOTAL_MAX_BORROW_AMOUNT = "total_max_borrow_amount"; - @SerializedName(SERIALIZED_NAME_TOTAL_MAX_BORROW_AMOUNT) - private String totalMaxBorrowAmount; - - public static final String SERIALIZED_NAME_PRICE = "price"; - @SerializedName(SERIALIZED_NAME_PRICE) - private String price; - - public static final String SERIALIZED_NAME_LOANABLE = "loanable"; - @SerializedName(SERIALIZED_NAME_LOANABLE) - private Boolean loanable; - - public static final String SERIALIZED_NAME_STATUS = "status"; - @SerializedName(SERIALIZED_NAME_STATUS) - private Integer status; - - - public CrossMarginCurrency name(String name) { - - this.name = name; - return this; - } - - /** - * Currency name - * @return name - **/ - @javax.annotation.Nullable - public String getName() { - return name; - } - - - public void setName(String name) { - this.name = name; - } - - public CrossMarginCurrency rate(String rate) { - - this.rate = rate; - return this; - } - - /** - * Minimum lending rate (hourly rate) - * @return rate - **/ - @javax.annotation.Nullable - public String getRate() { - return rate; - } - - - public void setRate(String rate) { - this.rate = rate; - } - - public CrossMarginCurrency prec(String prec) { - - this.prec = prec; - return this; - } - - /** - * Currency precision - * @return prec - **/ - @javax.annotation.Nullable - public String getPrec() { - return prec; - } - - - public void setPrec(String prec) { - this.prec = prec; - } - - public CrossMarginCurrency discount(String discount) { - - this.discount = discount; - return this; - } - - /** - * Currency value discount, which is used in total value calculation - * @return discount - **/ - @javax.annotation.Nullable - public String getDiscount() { - return discount; - } - - - public void setDiscount(String discount) { - this.discount = discount; - } - - public CrossMarginCurrency minBorrowAmount(String minBorrowAmount) { - - this.minBorrowAmount = minBorrowAmount; - return this; - } - - /** - * Minimum currency borrow amount. Unit is currency itself - * @return minBorrowAmount - **/ - @javax.annotation.Nullable - public String getMinBorrowAmount() { - return minBorrowAmount; - } - - - public void setMinBorrowAmount(String minBorrowAmount) { - this.minBorrowAmount = minBorrowAmount; - } - - public CrossMarginCurrency userMaxBorrowAmount(String userMaxBorrowAmount) { - - this.userMaxBorrowAmount = userMaxBorrowAmount; - return this; - } - - /** - * Maximum borrow value allowed per user, in USDT - * @return userMaxBorrowAmount - **/ - @javax.annotation.Nullable - public String getUserMaxBorrowAmount() { - return userMaxBorrowAmount; - } - - - public void setUserMaxBorrowAmount(String userMaxBorrowAmount) { - this.userMaxBorrowAmount = userMaxBorrowAmount; - } - - public CrossMarginCurrency totalMaxBorrowAmount(String totalMaxBorrowAmount) { - - this.totalMaxBorrowAmount = totalMaxBorrowAmount; - return this; - } - - /** - * Maximum borrow value allowed for this currency, in USDT - * @return totalMaxBorrowAmount - **/ - @javax.annotation.Nullable - public String getTotalMaxBorrowAmount() { - return totalMaxBorrowAmount; - } - - - public void setTotalMaxBorrowAmount(String totalMaxBorrowAmount) { - this.totalMaxBorrowAmount = totalMaxBorrowAmount; - } - - public CrossMarginCurrency price(String price) { - - this.price = price; - return this; - } - - /** - * Price change between this currency and USDT - * @return price - **/ - @javax.annotation.Nullable - public String getPrice() { - return price; - } - - - public void setPrice(String price) { - this.price = price; - } - - public CrossMarginCurrency loanable(Boolean loanable) { - - this.loanable = loanable; - return this; - } - - /** - * Whether currency is borrowed - * @return loanable - **/ - @javax.annotation.Nullable - public Boolean getLoanable() { - return loanable; - } - - - public void setLoanable(Boolean loanable) { - this.loanable = loanable; - } - - public CrossMarginCurrency status(Integer status) { - - this.status = status; - return this; - } - - /** - * status - `0` : disable - `1` : enable - * @return status - **/ - @javax.annotation.Nullable - public Integer getStatus() { - return status; - } - - - public void setStatus(Integer status) { - this.status = status; - } - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - CrossMarginCurrency crossMarginCurrency = (CrossMarginCurrency) o; - return Objects.equals(this.name, crossMarginCurrency.name) && - Objects.equals(this.rate, crossMarginCurrency.rate) && - Objects.equals(this.prec, crossMarginCurrency.prec) && - Objects.equals(this.discount, crossMarginCurrency.discount) && - Objects.equals(this.minBorrowAmount, crossMarginCurrency.minBorrowAmount) && - Objects.equals(this.userMaxBorrowAmount, crossMarginCurrency.userMaxBorrowAmount) && - Objects.equals(this.totalMaxBorrowAmount, crossMarginCurrency.totalMaxBorrowAmount) && - Objects.equals(this.price, crossMarginCurrency.price) && - Objects.equals(this.loanable, crossMarginCurrency.loanable) && - Objects.equals(this.status, crossMarginCurrency.status); - } - - @Override - public int hashCode() { - return Objects.hash(name, rate, prec, discount, minBorrowAmount, userMaxBorrowAmount, totalMaxBorrowAmount, price, loanable, status); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class CrossMarginCurrency {\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" rate: ").append(toIndentedString(rate)).append("\n"); - sb.append(" prec: ").append(toIndentedString(prec)).append("\n"); - sb.append(" discount: ").append(toIndentedString(discount)).append("\n"); - sb.append(" minBorrowAmount: ").append(toIndentedString(minBorrowAmount)).append("\n"); - sb.append(" userMaxBorrowAmount: ").append(toIndentedString(userMaxBorrowAmount)).append("\n"); - sb.append(" totalMaxBorrowAmount: ").append(toIndentedString(totalMaxBorrowAmount)).append("\n"); - sb.append(" price: ").append(toIndentedString(price)).append("\n"); - sb.append(" loanable: ").append(toIndentedString(loanable)).append("\n"); - sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/io/gate/gateapi/models/CrossMarginLoan.java b/src/main/java/io/gate/gateapi/models/CrossMarginLoan.java index 879166c..cb2862d 100644 --- a/src/main/java/io/gate/gateapi/models/CrossMarginLoan.java +++ b/src/main/java/io/gate/gateapi/models/CrossMarginLoan.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -232,7 +232,7 @@ public String getRepaidInterest() { /** - * Outstanding interest yet to be paid + * Unpaid interest * @return unpaidInterest **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CrossMarginRepayRequest.java b/src/main/java/io/gate/gateapi/models/CrossMarginRepayRequest.java deleted file mode 100644 index 305cc54..0000000 --- a/src/main/java/io/gate/gateapi/models/CrossMarginRepayRequest.java +++ /dev/null @@ -1,113 +0,0 @@ -/* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package io.gate.gateapi.models; - -import java.util.Objects; -import java.util.Arrays; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; - -/** - * CrossMarginRepayRequest - */ -public class CrossMarginRepayRequest { - public static final String SERIALIZED_NAME_CURRENCY = "currency"; - @SerializedName(SERIALIZED_NAME_CURRENCY) - private String currency; - - public static final String SERIALIZED_NAME_AMOUNT = "amount"; - @SerializedName(SERIALIZED_NAME_AMOUNT) - private String amount; - - - public CrossMarginRepayRequest currency(String currency) { - - this.currency = currency; - return this; - } - - /** - * Repayment currency - * @return currency - **/ - public String getCurrency() { - return currency; - } - - - public void setCurrency(String currency) { - this.currency = currency; - } - - public CrossMarginRepayRequest amount(String amount) { - - this.amount = amount; - return this; - } - - /** - * Repayment amount - * @return amount - **/ - public String getAmount() { - return amount; - } - - - public void setAmount(String amount) { - this.amount = amount; - } - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - CrossMarginRepayRequest crossMarginRepayRequest = (CrossMarginRepayRequest) o; - return Objects.equals(this.currency, crossMarginRepayRequest.currency) && - Objects.equals(this.amount, crossMarginRepayRequest.amount); - } - - @Override - public int hashCode() { - return Objects.hash(currency, amount); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class CrossMarginRepayRequest {\n"); - sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); - sb.append(" amount: ").append(toIndentedString(amount)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/io/gate/gateapi/models/CrossMarginRepayment.java b/src/main/java/io/gate/gateapi/models/CrossMarginRepayment.java index 25fe006..8a390af 100644 --- a/src/main/java/io/gate/gateapi/models/CrossMarginRepayment.java +++ b/src/main/java/io/gate/gateapi/models/CrossMarginRepayment.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -173,7 +173,7 @@ public void setInterest(String interest) { } /** - * Repayment type: none - no repayment type, manual_repay - manual repayment, auto_repay - automatic repayment, cancel_auto_repay - automatic repayment after cancellation + * Repayment type: none - no repayment type, manual_repay - manual repayment, auto_repay - automatic repayment after cancellation * @return repaymentType **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CrossMarginTransferable.java b/src/main/java/io/gate/gateapi/models/CrossMarginTransferable.java deleted file mode 100644 index f75e94a..0000000 --- a/src/main/java/io/gate/gateapi/models/CrossMarginTransferable.java +++ /dev/null @@ -1,115 +0,0 @@ -/* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package io.gate.gateapi.models; - -import java.util.Objects; -import java.util.Arrays; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; - -/** - * CrossMarginTransferable - */ -public class CrossMarginTransferable { - public static final String SERIALIZED_NAME_CURRENCY = "currency"; - @SerializedName(SERIALIZED_NAME_CURRENCY) - private String currency; - - public static final String SERIALIZED_NAME_AMOUNT = "amount"; - @SerializedName(SERIALIZED_NAME_AMOUNT) - private String amount; - - - public CrossMarginTransferable currency(String currency) { - - this.currency = currency; - return this; - } - - /** - * Currency detail - * @return currency - **/ - @javax.annotation.Nullable - public String getCurrency() { - return currency; - } - - - public void setCurrency(String currency) { - this.currency = currency; - } - - public CrossMarginTransferable amount(String amount) { - - this.amount = amount; - return this; - } - - /** - * Max transferable amount - * @return amount - **/ - @javax.annotation.Nullable - public String getAmount() { - return amount; - } - - - public void setAmount(String amount) { - this.amount = amount; - } - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - CrossMarginTransferable crossMarginTransferable = (CrossMarginTransferable) o; - return Objects.equals(this.currency, crossMarginTransferable.currency) && - Objects.equals(this.amount, crossMarginTransferable.amount); - } - - @Override - public int hashCode() { - return Objects.hash(currency, amount); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class CrossMarginTransferable {\n"); - sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); - sb.append(" amount: ").append(toIndentedString(amount)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/io/gate/gateapi/models/Currency.java b/src/main/java/io/gate/gateapi/models/Currency.java index 8a9faca..89b2eda 100644 --- a/src/main/java/io/gate/gateapi/models/Currency.java +++ b/src/main/java/io/gate/gateapi/models/Currency.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/CurrencyChain.java b/src/main/java/io/gate/gateapi/models/CurrencyChain.java index 367f38c..6abbb94 100644 --- a/src/main/java/io/gate/gateapi/models/CurrencyChain.java +++ b/src/main/java/io/gate/gateapi/models/CurrencyChain.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -163,7 +163,7 @@ public CurrencyChain isDepositDisabled(Integer isDepositDisabled) { } /** - * Is deposit disabled. 0 means not + * Is deposit disabled. 0 means not disabled * @return isDepositDisabled **/ @javax.annotation.Nullable @@ -183,7 +183,7 @@ public CurrencyChain isWithdrawDisabled(Integer isWithdrawDisabled) { } /** - * Is withdrawal disabled. 0 means not + * Is withdrawal disabled. 0 means not disabled * @return isWithdrawDisabled **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CurrencyPair.java b/src/main/java/io/gate/gateapi/models/CurrencyPair.java index fbce991..90ff0fb 100644 --- a/src/main/java/io/gate/gateapi/models/CurrencyPair.java +++ b/src/main/java/io/gate/gateapi/models/CurrencyPair.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -72,7 +72,7 @@ public class CurrencyPair { private Integer precision; /** - * How currency pair can be traded - untradable: cannot be bought or sold - buyable: can be bought - sellable: can be sold - tradable: can be bought or sold + * Trading status - untradable: cannot be traded - buyable: can be bought - sellable: can be sold - tradable: can be bought and sold */ @JsonAdapter(TradeStatusEnum.Adapter.class) public enum TradeStatusEnum { @@ -146,6 +146,10 @@ public TradeStatusEnum read(final JsonReader jsonReader) throws IOException { @SerializedName(SERIALIZED_NAME_TRADE_URL) private String tradeUrl; + public static final String SERIALIZED_NAME_ST_TAG = "st_tag"; + @SerializedName(SERIALIZED_NAME_ST_TAG) + private Boolean stTag; + public CurrencyPair id(String id) { @@ -194,7 +198,7 @@ public CurrencyPair baseName(String baseName) { } /** - * Transaction currency name + * Base currency name * @return baseName **/ @javax.annotation.Nullable @@ -234,7 +238,7 @@ public CurrencyPair quoteName(String quoteName) { } /** - * Name of the denominated currency + * Quote currency name * @return quoteName **/ @javax.annotation.Nullable @@ -254,7 +258,7 @@ public CurrencyPair fee(String fee) { } /** - * Trading fee + * Trading fee rate * @return fee **/ @javax.annotation.Nullable @@ -394,7 +398,7 @@ public CurrencyPair tradeStatus(TradeStatusEnum tradeStatus) { } /** - * How currency pair can be traded - untradable: cannot be bought or sold - buyable: can be bought - sellable: can be sold - tradable: can be bought or sold + * Trading status - untradable: cannot be traded - buyable: can be bought - sellable: can be sold - tradable: can be bought and sold * @return tradeStatus **/ @javax.annotation.Nullable @@ -506,6 +510,26 @@ public String getTradeUrl() { public void setTradeUrl(String tradeUrl) { this.tradeUrl = tradeUrl; } + + public CurrencyPair stTag(Boolean stTag) { + + this.stTag = stTag; + return this; + } + + /** + * Whether the trading pair is in ST risk assessment, false - No, true - Yes + * @return stTag + **/ + @javax.annotation.Nullable + public Boolean getStTag() { + return stTag; + } + + + public void setStTag(Boolean stTag) { + this.stTag = stTag; + } @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -532,12 +556,13 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.buyStart, currencyPair.buyStart) && Objects.equals(this.delistingTime, currencyPair.delistingTime) && Objects.equals(this.type, currencyPair.type) && - Objects.equals(this.tradeUrl, currencyPair.tradeUrl); + Objects.equals(this.tradeUrl, currencyPair.tradeUrl) && + Objects.equals(this.stTag, currencyPair.stTag); } @Override public int hashCode() { - return Objects.hash(id, base, baseName, quote, quoteName, fee, minBaseAmount, minQuoteAmount, maxBaseAmount, maxQuoteAmount, amountPrecision, precision, tradeStatus, sellStart, buyStart, delistingTime, type, tradeUrl); + return Objects.hash(id, base, baseName, quote, quoteName, fee, minBaseAmount, minQuoteAmount, maxBaseAmount, maxQuoteAmount, amountPrecision, precision, tradeStatus, sellStart, buyStart, delistingTime, type, tradeUrl, stTag); } @@ -563,6 +588,7 @@ public String toString() { sb.append(" delistingTime: ").append(toIndentedString(delistingTime)).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" tradeUrl: ").append(toIndentedString(tradeUrl)).append("\n"); + sb.append(" stTag: ").append(toIndentedString(stTag)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/gate/gateapi/models/CurrencyQuota.java b/src/main/java/io/gate/gateapi/models/CurrencyQuota.java index 273670e..cbf31f1 100644 --- a/src/main/java/io/gate/gateapi/models/CurrencyQuota.java +++ b/src/main/java/io/gate/gateapi/models/CurrencyQuota.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -91,7 +91,7 @@ public CurrencyQuota minQuota(String minQuota) { } /** - * Minimum borrowing/collateral quota for the currency + * Minimum borrowing/collateral limit for the currency * @return minQuota **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public CurrencyQuota leftQuota(String leftQuota) { } /** - * Remaining borrowing/collateral limit for the currency + * Remaining borrowing/collateral quota for the currency * @return leftQuota **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/DebitFee.java b/src/main/java/io/gate/gateapi/models/DebitFee.java index 08bde04..ce575cb 100644 --- a/src/main/java/io/gate/gateapi/models/DebitFee.java +++ b/src/main/java/io/gate/gateapi/models/DebitFee.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -35,7 +35,7 @@ public DebitFee enabled(Boolean enabled) { } /** - * Whether GT fee discount is used + * Whether GT fee deduction is enabled * @return enabled **/ public Boolean getEnabled() { diff --git a/src/main/java/io/gate/gateapi/models/DeliveryCandlestick.java b/src/main/java/io/gate/gateapi/models/DeliveryCandlestick.java index 199db5c..bd66a5c 100644 --- a/src/main/java/io/gate/gateapi/models/DeliveryCandlestick.java +++ b/src/main/java/io/gate/gateapi/models/DeliveryCandlestick.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/DeliveryContract.java b/src/main/java/io/gate/gateapi/models/DeliveryContract.java index 6e25bdc..73962bb 100644 --- a/src/main/java/io/gate/gateapi/models/DeliveryContract.java +++ b/src/main/java/io/gate/gateapi/models/DeliveryContract.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -87,7 +87,7 @@ public CycleEnum read(final JsonReader jsonReader) throws IOException { private CycleEnum cycle; /** - * Futures contract type + * Contract type: inverse - inverse contract, direct - direct contract */ @JsonAdapter(TypeEnum.Adapter.class) public enum TypeEnum { @@ -154,7 +154,7 @@ public TypeEnum read(final JsonReader jsonReader) throws IOException { private String maintenanceRate; /** - * Mark price type, internal - based on internal trading, index - based on external index price + * Mark price type: internal - internal trading price, index - external index price */ @JsonAdapter(MarkTypeEnum.Adapter.class) public enum MarkTypeEnum { @@ -388,7 +388,7 @@ public DeliveryContract type(TypeEnum type) { } /** - * Futures contract type + * Contract type: inverse - inverse contract, direct - direct contract * @return type **/ @javax.annotation.Nullable @@ -488,7 +488,7 @@ public DeliveryContract markType(MarkTypeEnum markType) { } /** - * Mark price type, internal - based on internal trading, index - based on external index price + * Mark price type: internal - internal trading price, index - external index price * @return markType **/ @javax.annotation.Nullable @@ -568,7 +568,7 @@ public DeliveryContract makerFeeRate(String makerFeeRate) { } /** - * Maker fee rate, where negative means rebate + * Maker fee rate, negative values indicate rebates * @return makerFeeRate **/ @javax.annotation.Nullable @@ -848,7 +848,7 @@ public DeliveryContract orderSizeMin(Long orderSizeMin) { } /** - * Minimum order size the contract allowed + * Minimum order size allowed by the contract * @return orderSizeMin **/ @javax.annotation.Nullable @@ -868,7 +868,7 @@ public DeliveryContract orderSizeMax(Long orderSizeMax) { } /** - * Maximum order size the contract allowed + * Maximum order size allowed by the contract * @return orderSizeMax **/ @javax.annotation.Nullable @@ -888,7 +888,7 @@ public DeliveryContract orderPriceDeviate(String orderPriceDeviate) { } /** - * 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 + * 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 * @return orderPriceDeviate **/ @javax.annotation.Nullable @@ -908,7 +908,7 @@ public DeliveryContract refDiscountRate(String refDiscountRate) { } /** - * Referral fee rate discount + * Trading fee discount for referred users * @return refDiscountRate **/ @javax.annotation.Nullable @@ -928,7 +928,7 @@ public DeliveryContract refRebateRate(String refRebateRate) { } /** - * Referrer commission rate + * Commission rate for referrers * @return refRebateRate **/ @javax.annotation.Nullable @@ -948,7 +948,7 @@ public DeliveryContract orderbookId(Long orderbookId) { } /** - * Current orderbook ID + * Orderbook update ID * @return orderbookId **/ @javax.annotation.Nullable @@ -988,7 +988,7 @@ public DeliveryContract tradeSize(Long tradeSize) { } /** - * Historical accumulated trade size + * Historical cumulative trading volume * @return tradeSize **/ @javax.annotation.Nullable @@ -1028,7 +1028,7 @@ public DeliveryContract configChangeTime(Double configChangeTime) { } /** - * Last changed time of configuration + * Last configuration update time * @return configChangeTime **/ @javax.annotation.Nullable @@ -1068,7 +1068,7 @@ public DeliveryContract ordersLimit(Integer ordersLimit) { } /** - * Maximum number of open orders + * Maximum number of pending orders * @return ordersLimit **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/DeliverySettlement.java b/src/main/java/io/gate/gateapi/models/DeliverySettlement.java index 47bed56..d2c68c8 100644 --- a/src/main/java/io/gate/gateapi/models/DeliverySettlement.java +++ b/src/main/java/io/gate/gateapi/models/DeliverySettlement.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/DeliveryTicker.java b/src/main/java/io/gate/gateapi/models/DeliveryTicker.java index a6d9403..e67f322 100644 --- a/src/main/java/io/gate/gateapi/models/DeliveryTicker.java +++ b/src/main/java/io/gate/gateapi/models/DeliveryTicker.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -163,7 +163,7 @@ public DeliveryTicker changePercentage(String changePercentage) { } /** - * Change percentage. + * Price change percentage. Negative values indicate price decrease, e.g. -7.45 * @return changePercentage **/ @javax.annotation.Nullable @@ -203,7 +203,7 @@ public DeliveryTicker low24h(String low24h) { } /** - * Lowest trading price in recent 24h + * 24-hour lowest price * @return low24h **/ @javax.annotation.Nullable @@ -223,7 +223,7 @@ public DeliveryTicker high24h(String high24h) { } /** - * Highest trading price in recent 24h + * 24-hour highest price * @return high24h **/ @javax.annotation.Nullable @@ -243,7 +243,7 @@ public DeliveryTicker volume24h(String volume24h) { } /** - * Trade size in recent 24h + * 24-hour trading volume * @return volume24h **/ @javax.annotation.Nullable @@ -263,7 +263,7 @@ public DeliveryTicker volume24hBtc(String volume24hBtc) { } /** - * Trade volumes in recent 24h in BTC(deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) + * 24-hour trading volume in BTC (deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) * @return volume24hBtc **/ @javax.annotation.Nullable @@ -283,7 +283,7 @@ public DeliveryTicker volume24hUsd(String volume24hUsd) { } /** - * Trade volumes in recent 24h in USD(deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) + * 24-hour trading volume in USD (deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) * @return volume24hUsd **/ @javax.annotation.Nullable @@ -303,7 +303,7 @@ public DeliveryTicker volume24hBase(String volume24hBase) { } /** - * Trade volume in recent 24h, in base currency + * 24-hour trading volume in base currency * @return volume24hBase **/ @javax.annotation.Nullable @@ -323,7 +323,7 @@ public DeliveryTicker volume24hQuote(String volume24hQuote) { } /** - * Trade volume in recent 24h, in quote currency + * 24-hour trading volume in quote currency * @return volume24hQuote **/ @javax.annotation.Nullable @@ -343,7 +343,7 @@ public DeliveryTicker volume24hSettle(String volume24hSettle) { } /** - * Trade volume in recent 24h, in settle currency + * 24-hour trading volume in settle currency * @return volume24hSettle **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/DepositAddress.java b/src/main/java/io/gate/gateapi/models/DepositAddress.java index 3d78fb4..1228957 100644 --- a/src/main/java/io/gate/gateapi/models/DepositAddress.java +++ b/src/main/java/io/gate/gateapi/models/DepositAddress.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/DepositRecord.java b/src/main/java/io/gate/gateapi/models/DepositRecord.java index 74a75bf..83408ea 100644 --- a/src/main/java/io/gate/gateapi/models/DepositRecord.java +++ b/src/main/java/io/gate/gateapi/models/DepositRecord.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -121,7 +121,7 @@ public DepositRecord amount(String amount) { } /** - * Currency amount + * Token amount * @return amount **/ public String getAmount() { diff --git a/src/main/java/io/gate/gateapi/models/DualGetOrders.java b/src/main/java/io/gate/gateapi/models/DualGetOrders.java index 9fb2630..615ffb1 100644 --- a/src/main/java/io/gate/gateapi/models/DualGetOrders.java +++ b/src/main/java/io/gate/gateapi/models/DualGetOrders.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -119,7 +119,7 @@ public DualGetOrders planId(Integer planId) { } /** - * Plan ID + * Product ID * @return planId **/ @javax.annotation.Nullable @@ -139,7 +139,7 @@ public DualGetOrders copies(String copies) { } /** - * Copies + * Units * @return copies **/ @javax.annotation.Nullable @@ -159,7 +159,7 @@ public DualGetOrders investAmount(String investAmount) { } /** - * Investment Amount + * Investment Quantity * @return investAmount **/ @javax.annotation.Nullable @@ -179,7 +179,7 @@ public DualGetOrders settlementAmount(String settlementAmount) { } /** - * Settlement Amount + * Settlement Quantity * @return settlementAmount **/ @javax.annotation.Nullable @@ -199,7 +199,7 @@ public DualGetOrders createTime(Integer createTime) { } /** - * Creation time + * Created time * @return createTime **/ @javax.annotation.Nullable @@ -219,7 +219,7 @@ public DualGetOrders completeTime(Integer completeTime) { } /** - * Completion Time + * Completed Time * @return completeTime **/ @javax.annotation.Nullable @@ -239,7 +239,7 @@ public DualGetOrders status(String status) { } /** - * Status: `INIT`-INIT `SETTLEMENT_SUCCESS`-Settlement Success `SETTLEMENT_PROCESSING`-SEttlement Processing `CANCELED`-Canceled `FAILED`-Failed + * Status: `INIT`-Created `SETTLEMENT_SUCCESS`-Settlement Success `SETTLEMENT_PROCESSING`-Settlement Processing `CANCELED`-Canceled `FAILED`-Failed * @return status **/ @javax.annotation.Nullable @@ -259,7 +259,7 @@ public DualGetOrders investCurrency(String investCurrency) { } /** - * Investment Currency + * Investment Token * @return investCurrency **/ @javax.annotation.Nullable @@ -279,7 +279,7 @@ public DualGetOrders exerciseCurrency(String exerciseCurrency) { } /** - * Strike Currency + * Strike Token * @return exerciseCurrency **/ @javax.annotation.Nullable @@ -319,7 +319,7 @@ public DualGetOrders settlementPrice(String settlementPrice) { } /** - * settlement price + * Settlement price * @return settlementPrice **/ @javax.annotation.Nullable @@ -339,7 +339,7 @@ public DualGetOrders settlementCurrency(String settlementCurrency) { } /** - * Settle currency + * Settlement currency * @return settlementCurrency **/ @javax.annotation.Nullable @@ -359,7 +359,7 @@ public DualGetOrders apyDisplay(String apyDisplay) { } /** - * APY + * Annual Yield * @return apyDisplay **/ @javax.annotation.Nullable @@ -379,7 +379,7 @@ public DualGetOrders apySettlement(String apySettlement) { } /** - * Settlement APY + * Settlement Annual Yield * @return apySettlement **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/DualGetPlans.java b/src/main/java/io/gate/gateapi/models/DualGetPlans.java index 695d92e..5d61961 100644 --- a/src/main/java/io/gate/gateapi/models/DualGetPlans.java +++ b/src/main/java/io/gate/gateapi/models/DualGetPlans.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -83,7 +83,7 @@ public DualGetPlans id(Integer id) { } /** - * Plan ID + * Product ID * @return id **/ @javax.annotation.Nullable @@ -103,7 +103,7 @@ public DualGetPlans instrumentName(String instrumentName) { } /** - * Instrument Name + * Product Name * @return instrumentName **/ @javax.annotation.Nullable @@ -123,7 +123,7 @@ public DualGetPlans investCurrency(String investCurrency) { } /** - * Investment Currency + * Investment Token * @return investCurrency **/ @javax.annotation.Nullable @@ -143,7 +143,7 @@ public DualGetPlans exerciseCurrency(String exerciseCurrency) { } /** - * Strike Currency + * Strike Token * @return exerciseCurrency **/ @javax.annotation.Nullable @@ -203,7 +203,7 @@ public DualGetPlans minCopies(Integer minCopies) { } /** - * Minimum Copies + * Minimum Units * @return minCopies **/ @javax.annotation.Nullable @@ -223,7 +223,7 @@ public DualGetPlans maxCopies(Integer maxCopies) { } /** - * Maximum Copies + * Maximum Units * @return maxCopies **/ @javax.annotation.Nullable @@ -243,7 +243,7 @@ public DualGetPlans perValue(String perValue) { } /** - * Per Unit Value + * Value Per Unit * @return perValue **/ @javax.annotation.Nullable @@ -263,7 +263,7 @@ public DualGetPlans apyDisplay(String apyDisplay) { } /** - * APY + * Annual Yield * @return apyDisplay **/ @javax.annotation.Nullable @@ -283,7 +283,7 @@ public DualGetPlans startTime(Integer startTime) { } /** - * start time + * Start Time * @return startTime **/ @javax.annotation.Nullable @@ -303,7 +303,7 @@ public DualGetPlans endTime(Integer endTime) { } /** - * Finished time + * End time * @return endTime **/ @javax.annotation.Nullable @@ -323,7 +323,7 @@ public DualGetPlans status(String status) { } /** - * Status: `NOTSTARTED`-not started `ONGOING`-ongoing `ENDED`-ended + * Status: `NOTSTARTED`-Not Started `ONGOING`-In Progress `ENDED`-Ended * @return status **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/Eth2RateList.java b/src/main/java/io/gate/gateapi/models/Eth2RateList.java index 2dfb0f9..91e764f 100644 --- a/src/main/java/io/gate/gateapi/models/Eth2RateList.java +++ b/src/main/java/io/gate/gateapi/models/Eth2RateList.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -43,7 +43,7 @@ public Eth2RateList dateTime(Long dateTime) { } /** - * Date and Time Stamp + * Date Timestamp * @return dateTime **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public Eth2RateList rate(String rate) { } /** - * percentage + * Percentage Rate * @return rate **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/Eth2Swap.java b/src/main/java/io/gate/gateapi/models/Eth2Swap.java index 2f1e9d3..0e9ec91 100644 --- a/src/main/java/io/gate/gateapi/models/Eth2Swap.java +++ b/src/main/java/io/gate/gateapi/models/Eth2Swap.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * ETH2 Staking + * ETH2 Mining */ public class Eth2Swap { public static final String SERIALIZED_NAME_SIDE = "side"; @@ -39,7 +39,7 @@ public Eth2Swap side(String side) { } /** - * 1-Forward Swap（ETH -> ETH2）, 2-Reverse Swap（ETH2 -> ETH） + * 1-Forward Swap (ETH -> ETH2), 2-Reverse Swap (ETH2 -> ETH) * @return side **/ public String getSide() { @@ -58,7 +58,7 @@ public Eth2Swap amount(String amount) { } /** - * amount + * Swap Amount * @return amount **/ public String getAmount() { diff --git a/src/main/java/io/gate/gateapi/models/FindCoin.java b/src/main/java/io/gate/gateapi/models/FindCoin.java new file mode 100644 index 0000000..829f1d4 --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/FindCoin.java @@ -0,0 +1,89 @@ +/* + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package io.gate.gateapi.models; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; + +/** + * FindCoin + */ +public class FindCoin { + public static final String SERIALIZED_NAME_COINTYPE = "cointype"; + @SerializedName(SERIALIZED_NAME_COINTYPE) + private String cointype; + + + public FindCoin cointype(String cointype) { + + this.cointype = cointype; + return this; + } + + /** + * Currency type: swap - voucher; lock - locked position; debt - US Treasury bond. + * @return cointype + **/ + @javax.annotation.Nullable + public String getCointype() { + return cointype; + } + + + public void setCointype(String cointype) { + this.cointype = cointype; + } + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FindCoin findCoin = (FindCoin) o; + return Objects.equals(this.cointype, findCoin.cointype); + } + + @Override + public int hashCode() { + return Objects.hash(cointype); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FindCoin {\n"); + sb.append(" cointype: ").append(toIndentedString(cointype)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/gate/gateapi/models/FlashSwapCurrencyPair.java b/src/main/java/io/gate/gateapi/models/FlashSwapCurrencyPair.java index 4db9867..a54725a 100644 --- a/src/main/java/io/gate/gateapi/models/FlashSwapCurrencyPair.java +++ b/src/main/java/io/gate/gateapi/models/FlashSwapCurrencyPair.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -53,7 +53,7 @@ public class FlashSwapCurrencyPair { /** - * The currency pair, BTC_USDT represents selling Bitcoin (BTC) and buying Tether (USDT). + * Currency pair, `BTC_USDT` represents selling `BTC` and buying `USDT` * @return currencyPair **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public String getCurrencyPair() { /** - * The currency to be sold + * Currency to sell * @return sellCurrency **/ @javax.annotation.Nullable @@ -73,7 +73,7 @@ public String getSellCurrency() { /** - * The currency to be bought + * Currency to buy * @return buyCurrency **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public String getBuyCurrency() { /** - * The minimum quantity required for selling + * Minimum sell quantity * @return sellMinAmount **/ @javax.annotation.Nullable @@ -93,7 +93,7 @@ public String getSellMinAmount() { /** - * The maximum quantity allowed for selling + * Maximum sell quantity * @return sellMaxAmount **/ @javax.annotation.Nullable @@ -103,7 +103,7 @@ public String getSellMaxAmount() { /** - * The minimum quantity required for buying + * Minimum buy quantity * @return buyMinAmount **/ @javax.annotation.Nullable @@ -113,7 +113,7 @@ public String getBuyMinAmount() { /** - * The maximum quantity allowed for buying + * Maximum buy quantity * @return buyMaxAmount **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FlashSwapOrder.java b/src/main/java/io/gate/gateapi/models/FlashSwapOrder.java index 33a18db..3985804 100644 --- a/src/main/java/io/gate/gateapi/models/FlashSwapOrder.java +++ b/src/main/java/io/gate/gateapi/models/FlashSwapOrder.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/FlashSwapOrderPreview.java b/src/main/java/io/gate/gateapi/models/FlashSwapOrderPreview.java index e56fdbd..00f49a4 100644 --- a/src/main/java/io/gate/gateapi/models/FlashSwapOrderPreview.java +++ b/src/main/java/io/gate/gateapi/models/FlashSwapOrderPreview.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Initiate a flash swap order preview + * Flash swap order preview */ public class FlashSwapOrderPreview { public static final String SERIALIZED_NAME_PREVIEW_ID = "preview_id"; @@ -75,7 +75,7 @@ public FlashSwapOrderPreview sellCurrency(String sellCurrency) { } /** - * Currency to sell which can be retrieved from supported currency list API `GET /flash_swap/currencies` + * Name of the sold asset, Refer to the interface Query the list of currencies supported for flash swap GET /flash_swap/currenciesto obtain * @return sellCurrency **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public FlashSwapOrderPreview buyCurrency(String buyCurrency) { } /** - * Currency to buy which can be retrieved from supported currency list API `GET /flash_swap/currencies` + * Name of the purchased asset, Refer to the interface Query the list of currencies supported for flash swap GET /flash_swap/currenciesto obtain * @return buyCurrency **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FlashSwapOrderRequest.java b/src/main/java/io/gate/gateapi/models/FlashSwapOrderRequest.java index 7ab95d9..da58ff1 100644 --- a/src/main/java/io/gate/gateapi/models/FlashSwapOrderRequest.java +++ b/src/main/java/io/gate/gateapi/models/FlashSwapOrderRequest.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -70,7 +70,7 @@ public FlashSwapOrderRequest sellCurrency(String sellCurrency) { } /** - * 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. + * 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 * @return sellCurrency **/ public String getSellCurrency() { @@ -108,7 +108,7 @@ public FlashSwapOrderRequest buyCurrency(String buyCurrency) { } /** - * 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. + * 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 * @return buyCurrency **/ public String getBuyCurrency() { diff --git a/src/main/java/io/gate/gateapi/models/FlashSwapPreviewRequest.java b/src/main/java/io/gate/gateapi/models/FlashSwapPreviewRequest.java index 1e8d918..3f3de68 100644 --- a/src/main/java/io/gate/gateapi/models/FlashSwapPreviewRequest.java +++ b/src/main/java/io/gate/gateapi/models/FlashSwapPreviewRequest.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -47,7 +47,7 @@ public FlashSwapPreviewRequest sellCurrency(String sellCurrency) { } /** - * 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. + * 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 * @return sellCurrency **/ public String getSellCurrency() { @@ -86,7 +86,7 @@ public FlashSwapPreviewRequest buyCurrency(String buyCurrency) { } /** - * 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. + * 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 * @return buyCurrency **/ public String getBuyCurrency() { diff --git a/src/main/java/io/gate/gateapi/models/FundingAccount.java b/src/main/java/io/gate/gateapi/models/FundingAccount.java index 18f63b7..6255c12 100644 --- a/src/main/java/io/gate/gateapi/models/FundingAccount.java +++ b/src/main/java/io/gate/gateapi/models/FundingAccount.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/FundingRateRecord.java b/src/main/java/io/gate/gateapi/models/FundingRateRecord.java index 2170456..4c8bdc7 100644 --- a/src/main/java/io/gate/gateapi/models/FundingRateRecord.java +++ b/src/main/java/io/gate/gateapi/models/FundingRateRecord.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/FutureCancelOrderResult.java b/src/main/java/io/gate/gateapi/models/FutureCancelOrderResult.java index cf7a71f..45ef9e3 100644 --- a/src/main/java/io/gate/gateapi/models/FutureCancelOrderResult.java +++ b/src/main/java/io/gate/gateapi/models/FutureCancelOrderResult.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -107,7 +107,7 @@ public FutureCancelOrderResult message(String message) { } /** - * Error message when failed to cancel the order; empty if succeeded + * Error description when cancellation fails, empty if successful * @return message **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesAccount.java b/src/main/java/io/gate/gateapi/models/FuturesAccount.java index 50bfe77..ca7395d 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesAccount.java +++ b/src/main/java/io/gate/gateapi/models/FuturesAccount.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -56,6 +56,10 @@ public class FuturesAccount { @SerializedName(SERIALIZED_NAME_IN_DUAL_MODE) private Boolean inDualMode; + public static final String SERIALIZED_NAME_POSITION_MODE = "position_mode"; + @SerializedName(SERIALIZED_NAME_POSITION_MODE) + private String positionMode; + public static final String SERIALIZED_NAME_ENABLE_CREDIT = "enable_credit"; @SerializedName(SERIALIZED_NAME_ENABLE_CREDIT) private Boolean enableCredit; @@ -120,6 +124,10 @@ public class FuturesAccount { @SerializedName(SERIALIZED_NAME_MARGIN_MODE) private Integer marginMode; + public static final String SERIALIZED_NAME_ENABLE_TIERED_MM = "enable_tiered_mm"; + @SerializedName(SERIALIZED_NAME_ENABLE_TIERED_MM) + private Boolean enableTieredMm; + public static final String SERIALIZED_NAME_HISTORY = "history"; @SerializedName(SERIALIZED_NAME_HISTORY) private FuturesAccountHistory history; @@ -212,7 +220,7 @@ public FuturesAccount available(String available) { } /** - * The available balance for transferring or trading(including bonus. Bonus can't be be withdrawn. The transfer amount needs to deduct the bonus) + * Available balance for transferring or trading (including bonus. Bonus cannot be withdrawn, so transfer amount needs to deduct bonus) * @return available **/ @javax.annotation.Nullable @@ -232,7 +240,7 @@ public FuturesAccount point(String point) { } /** - * POINT amount + * Point card amount * @return point **/ @javax.annotation.Nullable @@ -252,7 +260,7 @@ public FuturesAccount currency(String currency) { } /** - * Settle currency + * Settlement currency * @return currency **/ @javax.annotation.Nullable @@ -285,6 +293,26 @@ public void setInDualMode(Boolean inDualMode) { this.inDualMode = inDualMode; } + public FuturesAccount positionMode(String positionMode) { + + this.positionMode = positionMode; + return this; + } + + /** + * Position mode: single - one-way, dual - dual-side, split - sub-positions (in_dual_mode is deprecated) + * @return positionMode + **/ + @javax.annotation.Nullable + public String getPositionMode() { + return positionMode; + } + + + public void setPositionMode(String positionMode) { + this.positionMode = positionMode; + } + public FuturesAccount enableCredit(Boolean enableCredit) { this.enableCredit = enableCredit; @@ -312,7 +340,7 @@ public FuturesAccount positionInitialMargin(String positionInitialMargin) { } /** - * Initial margin position, applicable to the portfolio margin account model + * Initial margin occupied by positions, applicable to unified account mode * @return positionInitialMargin **/ @javax.annotation.Nullable @@ -332,7 +360,7 @@ public FuturesAccount maintenanceMargin(String maintenanceMargin) { } /** - * The maintenance deposit occupied by the position is suitable for the new classic account margin model and unified account model + * Maintenance margin occupied by positions, applicable to new classic account margin mode and unified account mode * @return maintenanceMargin **/ @javax.annotation.Nullable @@ -352,7 +380,7 @@ public FuturesAccount bonus(String bonus) { } /** - * Perpetual Contract Bonus + * Bonus * @return bonus **/ @javax.annotation.Nullable @@ -392,7 +420,7 @@ public FuturesAccount crossOrderMargin(String crossOrderMargin) { } /** - * Full -warehouse hanging order deposit, suitable for the new classic account margin model + * Cross margin order margin, applicable to new classic account margin mode * @return crossOrderMargin **/ @javax.annotation.Nullable @@ -412,7 +440,7 @@ public FuturesAccount crossInitialMargin(String crossInitialMargin) { } /** - * The initial security deposit of the full warehouse is suitable for the new classic account margin model + * Cross margin initial margin, applicable to new classic account margin mode * @return crossInitialMargin **/ @javax.annotation.Nullable @@ -432,7 +460,7 @@ public FuturesAccount crossMaintenanceMargin(String crossMaintenanceMargin) { } /** - * Maintain deposit in full warehouse, suitable for new classic account margin models + * Cross margin maintenance margin, applicable to new classic account margin mode * @return crossMaintenanceMargin **/ @javax.annotation.Nullable @@ -452,7 +480,7 @@ public FuturesAccount crossUnrealisedPnl(String crossUnrealisedPnl) { } /** - * The full warehouse does not achieve profit and loss, suitable for the new classic account margin model + * Cross margin unrealized P&L, applicable to new classic account margin mode * @return crossUnrealisedPnl **/ @javax.annotation.Nullable @@ -472,7 +500,7 @@ public FuturesAccount crossAvailable(String crossAvailable) { } /** - * Full warehouse available amount, suitable for the new classic account margin model + * Cross margin available balance, applicable to new classic account margin mode * @return crossAvailable **/ @javax.annotation.Nullable @@ -492,7 +520,7 @@ public FuturesAccount crossMarginBalance(String crossMarginBalance) { } /** - * Full margin balance, suitable for the new classic account margin model + * Cross margin balance, applicable to new classic account margin mode * @return crossMarginBalance **/ @javax.annotation.Nullable @@ -512,7 +540,7 @@ public FuturesAccount crossMmr(String crossMmr) { } /** - * Maintain margin ratio for the full position, suitable for the new classic account margin model + * Cross margin maintenance margin rate, applicable to new classic account margin mode * @return crossMmr **/ @javax.annotation.Nullable @@ -532,7 +560,7 @@ public FuturesAccount crossImr(String crossImr) { } /** - * The initial margin rate of the full position is suitable for the new classic account margin model + * Cross margin initial margin rate, applicable to new classic account margin mode * @return crossImr **/ @javax.annotation.Nullable @@ -552,7 +580,7 @@ public FuturesAccount isolatedPositionMargin(String isolatedPositionMargin) { } /** - * Ware -position margin, suitable for the new classic account margin model + * Isolated position margin, applicable to new classic account margin mode * @return isolatedPositionMargin **/ @javax.annotation.Nullable @@ -605,6 +633,26 @@ public void setMarginMode(Integer marginMode) { this.marginMode = marginMode; } + public FuturesAccount enableTieredMm(Boolean enableTieredMm) { + + this.enableTieredMm = enableTieredMm; + return this; + } + + /** + * Whether to enable tiered maintenance margin calculation + * @return enableTieredMm + **/ + @javax.annotation.Nullable + public Boolean getEnableTieredMm() { + return enableTieredMm; + } + + + public void setEnableTieredMm(Boolean enableTieredMm) { + this.enableTieredMm = enableTieredMm; + } + public FuturesAccount history(FuturesAccountHistory history) { this.history = history; @@ -641,6 +689,7 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.point, futuresAccount.point) && Objects.equals(this.currency, futuresAccount.currency) && Objects.equals(this.inDualMode, futuresAccount.inDualMode) && + Objects.equals(this.positionMode, futuresAccount.positionMode) && Objects.equals(this.enableCredit, futuresAccount.enableCredit) && Objects.equals(this.positionInitialMargin, futuresAccount.positionInitialMargin) && Objects.equals(this.maintenanceMargin, futuresAccount.maintenanceMargin) && @@ -657,12 +706,13 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.isolatedPositionMargin, futuresAccount.isolatedPositionMargin) && Objects.equals(this.enableNewDualMode, futuresAccount.enableNewDualMode) && Objects.equals(this.marginMode, futuresAccount.marginMode) && + Objects.equals(this.enableTieredMm, futuresAccount.enableTieredMm) && Objects.equals(this.history, futuresAccount.history); } @Override public int hashCode() { - return Objects.hash(total, unrealisedPnl, positionMargin, orderMargin, available, point, currency, inDualMode, enableCredit, positionInitialMargin, maintenanceMargin, bonus, enableEvolvedClassic, crossOrderMargin, crossInitialMargin, crossMaintenanceMargin, crossUnrealisedPnl, crossAvailable, crossMarginBalance, crossMmr, crossImr, isolatedPositionMargin, enableNewDualMode, marginMode, history); + return Objects.hash(total, unrealisedPnl, positionMargin, orderMargin, available, point, currency, inDualMode, positionMode, enableCredit, positionInitialMargin, maintenanceMargin, bonus, enableEvolvedClassic, crossOrderMargin, crossInitialMargin, crossMaintenanceMargin, crossUnrealisedPnl, crossAvailable, crossMarginBalance, crossMmr, crossImr, isolatedPositionMargin, enableNewDualMode, marginMode, enableTieredMm, history); } @@ -678,6 +728,7 @@ public String toString() { sb.append(" point: ").append(toIndentedString(point)).append("\n"); sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); sb.append(" inDualMode: ").append(toIndentedString(inDualMode)).append("\n"); + sb.append(" positionMode: ").append(toIndentedString(positionMode)).append("\n"); sb.append(" enableCredit: ").append(toIndentedString(enableCredit)).append("\n"); sb.append(" positionInitialMargin: ").append(toIndentedString(positionInitialMargin)).append("\n"); sb.append(" maintenanceMargin: ").append(toIndentedString(maintenanceMargin)).append("\n"); @@ -694,6 +745,7 @@ public String toString() { sb.append(" isolatedPositionMargin: ").append(toIndentedString(isolatedPositionMargin)).append("\n"); sb.append(" enableNewDualMode: ").append(toIndentedString(enableNewDualMode)).append("\n"); sb.append(" marginMode: ").append(toIndentedString(marginMode)).append("\n"); + sb.append(" enableTieredMm: ").append(toIndentedString(enableTieredMm)).append("\n"); sb.append(" history: ").append(toIndentedString(history)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/gate/gateapi/models/FuturesAccountBook.java b/src/main/java/io/gate/gateapi/models/FuturesAccountBook.java index dd79e08..bcf6332 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesAccountBook.java +++ b/src/main/java/io/gate/gateapi/models/FuturesAccountBook.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -36,7 +36,7 @@ public class FuturesAccountBook { private String balance; /** - * Changing Type： - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction + * 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 */ @JsonAdapter(TypeEnum.Adapter.class) public enum TypeEnum { @@ -184,7 +184,7 @@ public FuturesAccountBook type(TypeEnum type) { } /** - * Changing Type： - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction + * 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 * @return type **/ @javax.annotation.Nullable @@ -224,7 +224,7 @@ public FuturesAccountBook contract(String contract) { } /** - * Futures contract, the field is only available for data after 2023-10-30. + * Futures contract, the field is only available for data after 2023-10-30 * @return contract **/ @javax.annotation.Nullable @@ -264,7 +264,7 @@ public FuturesAccountBook id(String id) { } /** - * 账户变更记录 id + * Account change record ID * @return id **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesAccountHistory.java b/src/main/java/io/gate/gateapi/models/FuturesAccountHistory.java index 4d04443..0b76d2d 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesAccountHistory.java +++ b/src/main/java/io/gate/gateapi/models/FuturesAccountHistory.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/FuturesAutoDeleverage.java b/src/main/java/io/gate/gateapi/models/FuturesAutoDeleverage.java index da5ed89..9ac4f6b 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesAutoDeleverage.java +++ b/src/main/java/io/gate/gateapi/models/FuturesAutoDeleverage.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -115,7 +115,7 @@ public String getLeverage() { /** - * Cross margin leverage(valid only when `leverage` is 0) + * Cross margin leverage (valid only when `leverage` is 0) * @return crossLeverageLimit **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesBatchAmendOrderRequest.java b/src/main/java/io/gate/gateapi/models/FuturesBatchAmendOrderRequest.java index afa7427..0d96319 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesBatchAmendOrderRequest.java +++ b/src/main/java/io/gate/gateapi/models/FuturesBatchAmendOrderRequest.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -91,7 +91,7 @@ public FuturesBatchAmendOrderRequest size(Long size) { } /** - * The new order size, including the executed order size. - If it is less than or equal to the executed quantity, the order will be cancelled. - The new order direction must be consistent with the original one. - The size of the closing order cannot be modified. - For orders that only reduce positions, if the size is increased, other orders that only reduce positions may be kicked out. - If the price is not modified, reducing the size will not affect the depth of the queue, and increasing the size will place it at the end of the current price. + * 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. * @return size **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public FuturesBatchAmendOrderRequest price(String price) { } /** - * New order price. + * New order price * @return price **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public FuturesBatchAmendOrderRequest amendText(String amendText) { } /** - * Custom info during amending order + * Custom info during order amendment * @return amendText **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesCandlestick.java b/src/main/java/io/gate/gateapi/models/FuturesCandlestick.java index 9c9a5d4..e454844 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesCandlestick.java +++ b/src/main/java/io/gate/gateapi/models/FuturesCandlestick.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/FuturesFee.java b/src/main/java/io/gate/gateapi/models/FuturesFee.java index cfd014d..37690a3 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesFee.java +++ b/src/main/java/io/gate/gateapi/models/FuturesFee.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * The returned result is a map type, where the key represents the market and the value represents the taker and maker fee rates. + * The returned result is a map type, where the key represents the market and taker and maker fee rates */ public class FuturesFee { public static final String SERIALIZED_NAME_TAKER_FEE = "taker_fee"; diff --git a/src/main/java/io/gate/gateapi/models/FuturesIndexConstituents.java b/src/main/java/io/gate/gateapi/models/FuturesIndexConstituents.java index d377622..1453045 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesIndexConstituents.java +++ b/src/main/java/io/gate/gateapi/models/FuturesIndexConstituents.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/FuturesInitialOrder.java b/src/main/java/io/gate/gateapi/models/FuturesInitialOrder.java index 12ac61b..86311ab 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesInitialOrder.java +++ b/src/main/java/io/gate/gateapi/models/FuturesInitialOrder.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -40,7 +40,7 @@ public class FuturesInitialOrder { private Boolean close = false; /** - * Time in force strategy, default is gtc, market order currently only supports ioc mode Market order currently only supports ioc mode - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled + * Time in force strategy, default is gtc, market orders currently only support ioc mode - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled */ @JsonAdapter(TifEnum.Adapter.class) public enum TifEnum { @@ -196,7 +196,7 @@ public FuturesInitialOrder tif(TifEnum tif) { } /** - * Time in force strategy, default is gtc, market order currently only supports ioc mode Market order currently only supports ioc mode - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled + * Time in force strategy, default is gtc, market orders currently only support ioc mode - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled * @return tif **/ @javax.annotation.Nullable @@ -216,7 +216,7 @@ public FuturesInitialOrder text(String text) { } /** - * The source of the order, including: - web: web - api: api - app: app + * The source of the order, including: - web: Web - api: API call - app: Mobile app * @return text **/ @javax.annotation.Nullable @@ -256,7 +256,7 @@ public FuturesInitialOrder autoSize(String autoSize) { } /** - * 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 + * 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 * @return autoSize **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesLimitRiskTiers.java b/src/main/java/io/gate/gateapi/models/FuturesLimitRiskTiers.java index 0dee8a3..7c23377 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesLimitRiskTiers.java +++ b/src/main/java/io/gate/gateapi/models/FuturesLimitRiskTiers.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Retrieve risk limit configurations for different tiers under a specified contract. + * Retrieve risk limit configurations for different tiers under a specified contract */ public class FuturesLimitRiskTiers { public static final String SERIALIZED_NAME_TIER = "tier"; @@ -47,6 +47,10 @@ public class FuturesLimitRiskTiers { @SerializedName(SERIALIZED_NAME_CONTRACT) private String contract; + public static final String SERIALIZED_NAME_DEDUCTION = "deduction"; + @SerializedName(SERIALIZED_NAME_DEDUCTION) + private String deduction; + public FuturesLimitRiskTiers tier(Integer tier) { @@ -155,7 +159,7 @@ public FuturesLimitRiskTiers contract(String contract) { } /** - * Markets, visible only during market pagination requests + * Market, only visible when market pagination is requested * @return contract **/ @javax.annotation.Nullable @@ -167,6 +171,26 @@ public String getContract() { public void setContract(String contract) { this.contract = contract; } + + public FuturesLimitRiskTiers deduction(String deduction) { + + this.deduction = deduction; + return this; + } + + /** + * Maintenance margin quick calculation deduction amount + * @return deduction + **/ + @javax.annotation.Nullable + public String getDeduction() { + return deduction; + } + + + public void setDeduction(String deduction) { + this.deduction = deduction; + } @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -181,12 +205,13 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.initialRate, futuresLimitRiskTiers.initialRate) && Objects.equals(this.maintenanceRate, futuresLimitRiskTiers.maintenanceRate) && Objects.equals(this.leverageMax, futuresLimitRiskTiers.leverageMax) && - Objects.equals(this.contract, futuresLimitRiskTiers.contract); + Objects.equals(this.contract, futuresLimitRiskTiers.contract) && + Objects.equals(this.deduction, futuresLimitRiskTiers.deduction); } @Override public int hashCode() { - return Objects.hash(tier, riskLimit, initialRate, maintenanceRate, leverageMax, contract); + return Objects.hash(tier, riskLimit, initialRate, maintenanceRate, leverageMax, contract, deduction); } @@ -200,6 +225,7 @@ public String toString() { sb.append(" maintenanceRate: ").append(toIndentedString(maintenanceRate)).append("\n"); sb.append(" leverageMax: ").append(toIndentedString(leverageMax)).append("\n"); sb.append(" contract: ").append(toIndentedString(contract)).append("\n"); + sb.append(" deduction: ").append(toIndentedString(deduction)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/gate/gateapi/models/FuturesLiqOrder.java b/src/main/java/io/gate/gateapi/models/FuturesLiqOrder.java index fc06872..fc632db 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesLiqOrder.java +++ b/src/main/java/io/gate/gateapi/models/FuturesLiqOrder.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/FuturesLiquidate.java b/src/main/java/io/gate/gateapi/models/FuturesLiquidate.java index a313b7e..bc39c5e 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesLiquidate.java +++ b/src/main/java/io/gate/gateapi/models/FuturesLiquidate.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -93,7 +93,7 @@ public String getContract() { /** - * Position leverage. Not returned in public endpoints. + * Position leverage. Not returned in public endpoints * @return leverage **/ @javax.annotation.Nullable @@ -113,7 +113,7 @@ public Long getSize() { /** - * Position margin. Not returned in public endpoints. + * Position margin. Not returned in public endpoints * @return margin **/ @javax.annotation.Nullable @@ -123,7 +123,7 @@ public String getMargin() { /** - * Average entry price. Not returned in public endpoints. + * Average entry price. Not returned in public endpoints * @return entryPrice **/ @javax.annotation.Nullable @@ -133,7 +133,7 @@ public String getEntryPrice() { /** - * Liquidation price. Not returned in public endpoints. + * Liquidation price. Not returned in public endpoints * @return liqPrice **/ @javax.annotation.Nullable @@ -143,7 +143,7 @@ public String getLiqPrice() { /** - * Mark price. Not returned in public endpoints. + * Mark price. Not returned in public endpoints * @return markPrice **/ @javax.annotation.Nullable @@ -153,7 +153,7 @@ public String getMarkPrice() { /** - * Liquidation order ID. Not returned in public endpoints. + * Liquidation order ID. Not returned in public endpoints * @return orderId **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesOrder.java b/src/main/java/io/gate/gateapi/models/FuturesOrder.java index 29dfdbd..2dcef73 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesOrder.java +++ b/src/main/java/io/gate/gateapi/models/FuturesOrder.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -35,12 +35,16 @@ public class FuturesOrder { @SerializedName(SERIALIZED_NAME_CREATE_TIME) private Double createTime; + public static final String SERIALIZED_NAME_UPDATE_TIME = "update_time"; + @SerializedName(SERIALIZED_NAME_UPDATE_TIME) + private Double updateTime; + public static final String SERIALIZED_NAME_FINISH_TIME = "finish_time"; @SerializedName(SERIALIZED_NAME_FINISH_TIME) private Double finishTime; /** - * How the order was finished. - filled: all filled - cancelled: manually cancelled - liquidated: cancelled because of liquidation - ioc: time in force is `IOC`, finish immediately - auto_deleveraged: finished by ADL - reduce_only: cancelled because of increasing position while `reduce-only` set- position_closed: cancelled because of position close - position_closed: canceled because the position was closed - reduce_out: only reduce positions by excluding hard-to-fill orders - stp: cancelled because self trade prevention + * 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 */ @JsonAdapter(FinishAsEnum.Adapter.class) public enum FinishAsEnum { @@ -105,7 +109,7 @@ public FinishAsEnum read(final JsonReader jsonReader) throws IOException { private FinishAsEnum finishAs; /** - * Order status - `open`: waiting to be traded - `finished`: finished + * Order status - `open`: Pending - `finished`: Completed */ @JsonAdapter(StatusEnum.Adapter.class) public enum StatusEnum { @@ -326,7 +330,7 @@ public AutoSizeEnum read(final JsonReader jsonReader) throws IOException { private Integer stpId; /** - * Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled + * 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 */ @JsonAdapter(StpActEnum.Adapter.class) public enum StpActEnum { @@ -384,9 +388,13 @@ public StpActEnum read(final JsonReader jsonReader) throws IOException { @SerializedName(SERIALIZED_NAME_AMEND_TEXT) private String amendText; - public static final String SERIALIZED_NAME_BIZ_INFO = "biz_info"; - @SerializedName(SERIALIZED_NAME_BIZ_INFO) - private String bizInfo; + public static final String SERIALIZED_NAME_LIMIT_VIP = "limit_vip"; + @SerializedName(SERIALIZED_NAME_LIMIT_VIP) + private Long limitVip; + + public static final String SERIALIZED_NAME_PID = "pid"; + @SerializedName(SERIALIZED_NAME_PID) + private Long pid; /** @@ -419,6 +427,16 @@ public Double getCreateTime() { } + /** + * OrderUpdateTime + * @return updateTime + **/ + @javax.annotation.Nullable + public Double getUpdateTime() { + return updateTime; + } + + /** * Order finished time. Not returned if order is open * @return finishTime @@ -430,7 +448,7 @@ public Double getFinishTime() { /** - * How the order was finished. - filled: all filled - cancelled: manually cancelled - liquidated: cancelled because of liquidation - ioc: time in force is `IOC`, finish immediately - auto_deleveraged: finished by ADL - reduce_only: cancelled because of increasing position while `reduce-only` set- position_closed: cancelled because of position close - position_closed: canceled because the position was closed - reduce_out: only reduce positions by excluding hard-to-fill orders - stp: cancelled because self trade prevention + * 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 * @return finishAs **/ @javax.annotation.Nullable @@ -440,7 +458,7 @@ public FinishAsEnum getFinishAs() { /** - * Order status - `open`: waiting to be traded - `finished`: finished + * Order status - `open`: Pending - `finished`: Completed * @return status **/ @javax.annotation.Nullable @@ -475,7 +493,7 @@ public FuturesOrder size(Long size) { } /** - * Order size. Specify positive number to make a bid, and negative number to ask + * Required. Trading quantity. Positive for buy, negative for sell. Set to 0 for close position orders. * @return size **/ public Long getSize() { @@ -494,7 +512,7 @@ public FuturesOrder iceberg(Long iceberg) { } /** - * Display size for iceberg order. 0 for non-iceberg. Note that you will have to pay the taker fee for the hidden size + * Display size for iceberg orders. 0 for non-iceberg orders. Note that hidden portions are charged taker fees. * @return iceberg **/ @javax.annotation.Nullable @@ -514,7 +532,7 @@ public FuturesOrder price(String price) { } /** - * Order price. 0 for market order with `tif` set as `ioc` + * Order price. Price of 0 with `tif` set to `ioc` represents a market order. * @return price **/ @javax.annotation.Nullable @@ -618,7 +636,7 @@ public void setTif(TifEnum tif) { } /** - * Size left to be traded + * Unfilled quantity * @return left **/ @javax.annotation.Nullable @@ -628,7 +646,7 @@ public Long getLeft() { /** - * Fill price of the order + * Fill price * @return fillPrice **/ @javax.annotation.Nullable @@ -644,7 +662,7 @@ public FuturesOrder text(String text) { } /** - * 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-xxx: a. Liquidation under the classic account’s 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-xxx: 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 + * 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 * @return text **/ @javax.annotation.Nullable @@ -678,7 +696,7 @@ public String getMkfr() { /** - * Reference user ID + * Referrer user ID * @return refu **/ @javax.annotation.Nullable @@ -724,7 +742,7 @@ public FuturesOrder stpAct(StpActEnum stpAct) { } /** - * Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled + * 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 * @return stpAct **/ @javax.annotation.Nullable @@ -747,15 +765,45 @@ public String getAmendText() { } + public FuturesOrder limitVip(Long limitVip) { + + this.limitVip = limitVip; + return this; + } + + /** + * 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 + * @return limitVip + **/ + @javax.annotation.Nullable + public Long getLimitVip() { + return limitVip; + } + + + public void setLimitVip(Long limitVip) { + this.limitVip = limitVip; + } + + public FuturesOrder pid(Long pid) { + + this.pid = pid; + return this; + } + /** - * Additional information - * @return bizInfo + * Position ID + * @return pid **/ @javax.annotation.Nullable - public String getBizInfo() { - return bizInfo; + public Long getPid() { + return pid; } + + public void setPid(Long pid) { + this.pid = pid; + } @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -768,6 +816,7 @@ public boolean equals(java.lang.Object o) { return Objects.equals(this.id, futuresOrder.id) && Objects.equals(this.user, futuresOrder.user) && Objects.equals(this.createTime, futuresOrder.createTime) && + Objects.equals(this.updateTime, futuresOrder.updateTime) && Objects.equals(this.finishTime, futuresOrder.finishTime) && Objects.equals(this.finishAs, futuresOrder.finishAs) && Objects.equals(this.status, futuresOrder.status) && @@ -791,12 +840,13 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.stpId, futuresOrder.stpId) && Objects.equals(this.stpAct, futuresOrder.stpAct) && Objects.equals(this.amendText, futuresOrder.amendText) && - Objects.equals(this.bizInfo, futuresOrder.bizInfo); + Objects.equals(this.limitVip, futuresOrder.limitVip) && + Objects.equals(this.pid, futuresOrder.pid); } @Override public int hashCode() { - return Objects.hash(id, user, createTime, finishTime, finishAs, status, contract, size, iceberg, price, close, isClose, reduceOnly, isReduceOnly, isLiq, tif, left, fillPrice, text, tkfr, mkfr, refu, autoSize, stpId, stpAct, amendText, bizInfo); + return Objects.hash(id, user, createTime, updateTime, finishTime, finishAs, status, contract, size, iceberg, price, close, isClose, reduceOnly, isReduceOnly, isLiq, tif, left, fillPrice, text, tkfr, mkfr, refu, autoSize, stpId, stpAct, amendText, limitVip, pid); } @@ -807,6 +857,7 @@ public String toString() { sb.append(" id: ").append(toIndentedString(id)).append("\n"); sb.append(" user: ").append(toIndentedString(user)).append("\n"); sb.append(" createTime: ").append(toIndentedString(createTime)).append("\n"); + sb.append(" updateTime: ").append(toIndentedString(updateTime)).append("\n"); sb.append(" finishTime: ").append(toIndentedString(finishTime)).append("\n"); sb.append(" finishAs: ").append(toIndentedString(finishAs)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); @@ -830,7 +881,8 @@ public String toString() { sb.append(" stpId: ").append(toIndentedString(stpId)).append("\n"); sb.append(" stpAct: ").append(toIndentedString(stpAct)).append("\n"); sb.append(" amendText: ").append(toIndentedString(amendText)).append("\n"); - sb.append(" bizInfo: ").append(toIndentedString(bizInfo)).append("\n"); + sb.append(" limitVip: ").append(toIndentedString(limitVip)).append("\n"); + sb.append(" pid: ").append(toIndentedString(pid)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/gate/gateapi/models/FuturesOrderAmendment.java b/src/main/java/io/gate/gateapi/models/FuturesOrderAmendment.java index 52d5c0e..32f273c 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesOrderAmendment.java +++ b/src/main/java/io/gate/gateapi/models/FuturesOrderAmendment.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -35,13 +35,9 @@ public class FuturesOrderAmendment { @SerializedName(SERIALIZED_NAME_AMEND_TEXT) private String amendText; - public static final String SERIALIZED_NAME_BIZ_INFO = "biz_info"; - @SerializedName(SERIALIZED_NAME_BIZ_INFO) - private String bizInfo; - - public static final String SERIALIZED_NAME_BBO = "bbo"; - @SerializedName(SERIALIZED_NAME_BBO) - private String bbo; + public static final String SERIALIZED_NAME_TEXT = "text"; + @SerializedName(SERIALIZED_NAME_TEXT) + private String text; public FuturesOrderAmendment size(Long size) { @@ -71,7 +67,7 @@ public FuturesOrderAmendment price(String price) { } /** - * New order price. + * New order price * @return price **/ @javax.annotation.Nullable @@ -91,7 +87,7 @@ public FuturesOrderAmendment amendText(String amendText) { } /** - * Custom info during amending order + * Custom info during order amendment * @return amendText **/ @javax.annotation.Nullable @@ -104,44 +100,24 @@ public void setAmendText(String amendText) { this.amendText = amendText; } - public FuturesOrderAmendment bizInfo(String bizInfo) { - - this.bizInfo = bizInfo; - return this; - } - - /** - * Users can annotate this modification with information. - * @return bizInfo - **/ - @javax.annotation.Nullable - public String getBizInfo() { - return bizInfo; - } - - - public void setBizInfo(String bizInfo) { - this.bizInfo = bizInfo; - } - - public FuturesOrderAmendment bbo(String bbo) { + public FuturesOrderAmendment text(String text) { - this.bbo = bbo; + this.text = text; return this; } /** - * Users are able to modify the offer price manually. - * @return bbo + * Internal users can modify information in the text field. + * @return text **/ @javax.annotation.Nullable - public String getBbo() { - return bbo; + public String getText() { + return text; } - public void setBbo(String bbo) { - this.bbo = bbo; + public void setText(String text) { + this.text = text; } @Override public boolean equals(java.lang.Object o) { @@ -155,13 +131,12 @@ public boolean equals(java.lang.Object o) { return Objects.equals(this.size, futuresOrderAmendment.size) && Objects.equals(this.price, futuresOrderAmendment.price) && Objects.equals(this.amendText, futuresOrderAmendment.amendText) && - Objects.equals(this.bizInfo, futuresOrderAmendment.bizInfo) && - Objects.equals(this.bbo, futuresOrderAmendment.bbo); + Objects.equals(this.text, futuresOrderAmendment.text); } @Override public int hashCode() { - return Objects.hash(size, price, amendText, bizInfo, bbo); + return Objects.hash(size, price, amendText, text); } @@ -172,8 +147,7 @@ public String toString() { sb.append(" size: ").append(toIndentedString(size)).append("\n"); sb.append(" price: ").append(toIndentedString(price)).append("\n"); sb.append(" amendText: ").append(toIndentedString(amendText)).append("\n"); - sb.append(" bizInfo: ").append(toIndentedString(bizInfo)).append("\n"); - sb.append(" bbo: ").append(toIndentedString(bbo)).append("\n"); + sb.append(" text: ").append(toIndentedString(text)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/gate/gateapi/models/FuturesOrderBook.java b/src/main/java/io/gate/gateapi/models/FuturesOrderBook.java index d8e0834..1978042 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesOrderBook.java +++ b/src/main/java/io/gate/gateapi/models/FuturesOrderBook.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -119,7 +119,7 @@ public FuturesOrderBook addAsksItem(FuturesOrderBookItem asksItem) { } /** - * Asks order depth + * Ask Depth * @return asks **/ public List getAsks() { @@ -143,7 +143,7 @@ public FuturesOrderBook addBidsItem(FuturesOrderBookItem bidsItem) { } /** - * Bids order depth + * Bid Depth * @return bids **/ public List getBids() { diff --git a/src/main/java/io/gate/gateapi/models/FuturesOrderBookItem.java b/src/main/java/io/gate/gateapi/models/FuturesOrderBookItem.java index f935930..962c4cf 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesOrderBookItem.java +++ b/src/main/java/io/gate/gateapi/models/FuturesOrderBookItem.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/FuturesPositionCrossMode.java b/src/main/java/io/gate/gateapi/models/FuturesPositionCrossMode.java new file mode 100644 index 0000000..36cb173 --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/FuturesPositionCrossMode.java @@ -0,0 +1,113 @@ +/* + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package io.gate.gateapi.models; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; + +/** + * FuturesPositionCrossMode + */ +public class FuturesPositionCrossMode { + public static final String SERIALIZED_NAME_MODE = "mode"; + @SerializedName(SERIALIZED_NAME_MODE) + private String mode; + + public static final String SERIALIZED_NAME_CONTRACT = "contract"; + @SerializedName(SERIALIZED_NAME_CONTRACT) + private String contract; + + + public FuturesPositionCrossMode mode(String mode) { + + this.mode = mode; + return this; + } + + /** + * Cross margin or isolated margin mode. ISOLATED - isolated margin mode, CROSS - cross margin mode + * @return mode + **/ + public String getMode() { + return mode; + } + + + public void setMode(String mode) { + this.mode = mode; + } + + public FuturesPositionCrossMode contract(String contract) { + + this.contract = contract; + return this; + } + + /** + * Futures market + * @return contract + **/ + public String getContract() { + return contract; + } + + + public void setContract(String contract) { + this.contract = contract; + } + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FuturesPositionCrossMode futuresPositionCrossMode = (FuturesPositionCrossMode) o; + return Objects.equals(this.mode, futuresPositionCrossMode.mode) && + Objects.equals(this.contract, futuresPositionCrossMode.contract); + } + + @Override + public int hashCode() { + return Objects.hash(mode, contract); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FuturesPositionCrossMode {\n"); + sb.append(" mode: ").append(toIndentedString(mode)).append("\n"); + sb.append(" contract: ").append(toIndentedString(contract)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/gate/gateapi/models/FuturesPremiumIndex.java b/src/main/java/io/gate/gateapi/models/FuturesPremiumIndex.java index 065ec47..cd1b743 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesPremiumIndex.java +++ b/src/main/java/io/gate/gateapi/models/FuturesPremiumIndex.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -111,7 +111,7 @@ public FuturesPremiumIndex l(String l) { } /** - * Lowest price` + * Lowest price * @return l **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesPriceTrigger.java b/src/main/java/io/gate/gateapi/models/FuturesPriceTrigger.java index 4e478ea..543d436 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesPriceTrigger.java +++ b/src/main/java/io/gate/gateapi/models/FuturesPriceTrigger.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -24,7 +24,7 @@ */ public class 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 + * 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) */ @JsonAdapter(StrategyTypeEnum.Adapter.class) public enum StrategyTypeEnum { @@ -75,7 +75,7 @@ public StrategyTypeEnum read(final JsonReader jsonReader) throws IOException { private StrategyTypeEnum strategyType; /** - * Price type. 0 - latest deal price, 1 - mark price, 2 - index price + * Reference price type. 0 - Latest trade price, 1 - Mark price, 2 - Index price */ @JsonAdapter(PriceTypeEnum.Adapter.class) public enum PriceTypeEnum { @@ -132,7 +132,7 @@ public PriceTypeEnum read(final JsonReader jsonReader) throws IOException { private String price; /** - * 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 - 2: Indicates that the price calculated based on `strategy_type` and `price_type` is less than or equal to `Trigger.Price` Trigger, and Trigger.Price must < last_price + * 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 */ @JsonAdapter(RuleEnum.Adapter.class) public enum RuleEnum { @@ -194,7 +194,7 @@ public FuturesPriceTrigger strategyType(StrategyTypeEnum strategyType) { } /** - * 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 + * 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) * @return strategyType **/ @javax.annotation.Nullable @@ -214,7 +214,7 @@ public FuturesPriceTrigger priceType(PriceTypeEnum priceType) { } /** - * Price type. 0 - latest deal price, 1 - mark price, 2 - index price + * Reference price type. 0 - Latest trade price, 1 - Mark price, 2 - Index price * @return priceType **/ @javax.annotation.Nullable @@ -234,7 +234,7 @@ public FuturesPriceTrigger price(String price) { } /** - * Value of price on price triggered, or price gap on price gap triggered + * Price value for price trigger, or spread value for spread trigger * @return price **/ @javax.annotation.Nullable @@ -254,7 +254,7 @@ public FuturesPriceTrigger rule(RuleEnum rule) { } /** - * 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 - 2: Indicates that the price calculated based on `strategy_type` and `price_type` is less than or equal to `Trigger.Price` Trigger, and Trigger.Price must < last_price + * 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 * @return rule **/ @javax.annotation.Nullable @@ -274,7 +274,7 @@ public FuturesPriceTrigger expiration(Integer expiration) { } /** - * How long (in seconds) to wait for the condition to be triggered before cancelling the order. + * Maximum wait time for trigger condition (in seconds). Order will be cancelled if timeout * @return expiration **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesPriceTriggeredOrder.java b/src/main/java/io/gate/gateapi/models/FuturesPriceTriggeredOrder.java index a4a740a..c1daa6d 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesPriceTriggeredOrder.java +++ b/src/main/java/io/gate/gateapi/models/FuturesPriceTriggeredOrder.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -22,7 +22,7 @@ import java.io.IOException; /** - * Futures order details + * Futures price-triggered order details */ public class FuturesPriceTriggeredOrder { public static final String SERIALIZED_NAME_INITIAL = "initial"; @@ -54,7 +54,7 @@ public class FuturesPriceTriggeredOrder { private Long tradeId; /** - * Auto order status - `open`: order is active - `finished`: order is finished - `inactive`: order is not active, only for close-long-order or close-short-order - `invalid`: order is invalid, only for close-long-order or close-short-order + * 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 */ @JsonAdapter(StatusEnum.Adapter.class) public enum StatusEnum { @@ -109,7 +109,7 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { private StatusEnum status; /** - * How order is finished + * Finish status: cancelled - Cancelled; succeeded - Succeeded; failed - Failed; expired - Expired */ @JsonAdapter(FinishAsEnum.Adapter.class) public enum FinishAsEnum { @@ -235,7 +235,7 @@ public Integer getUser() { /** - * Creation time + * Created time * @return createTime **/ @javax.annotation.Nullable @@ -245,7 +245,7 @@ public Double getCreateTime() { /** - * Finished time + * End time * @return finishTime **/ @javax.annotation.Nullable @@ -255,7 +255,7 @@ public Double getFinishTime() { /** - * ID of the newly created order on condition triggered + * ID of the order created after trigger * @return tradeId **/ @javax.annotation.Nullable @@ -265,7 +265,7 @@ public Long getTradeId() { /** - * Auto order status - `open`: order is active - `finished`: order is finished - `inactive`: order is not active, only for close-long-order or close-short-order - `invalid`: order is invalid, only for close-long-order or close-short-order + * 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 * @return status **/ @javax.annotation.Nullable @@ -275,7 +275,7 @@ public StatusEnum getStatus() { /** - * How order is finished + * Finish status: cancelled - Cancelled; succeeded - Succeeded; failed - Failed; expired - Expired * @return finishAs **/ @javax.annotation.Nullable @@ -285,7 +285,7 @@ public FinishAsEnum getFinishAs() { /** - * Additional remarks on how the order was finished + * Additional description of how the order was completed * @return reason **/ @javax.annotation.Nullable @@ -301,7 +301,7 @@ public FuturesPriceTriggeredOrder orderType(String orderType) { } /** - * Types of stop-profit and stop-loss, including: - `close-long-order`: Entrusting order stop profit and stop loss, flat long position - `close-short-order`: Entrusted order stop profit and stop 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 + * 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 * @return orderType **/ @javax.annotation.Nullable @@ -315,7 +315,7 @@ public void setOrderType(String orderType) { } /** - * Corresponding order ID of order take-profit/stop-loss. + * Corresponding order ID for order take-profit/stop-loss orders * @return meOrderId **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesRiskLimitTier.java b/src/main/java/io/gate/gateapi/models/FuturesRiskLimitTier.java new file mode 100644 index 0000000..9b5f387 --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/FuturesRiskLimitTier.java @@ -0,0 +1,219 @@ +/* + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package io.gate.gateapi.models; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; + +/** + * Information for each tier of the gradient risk limit table + */ +public class FuturesRiskLimitTier { + public static final String SERIALIZED_NAME_TIER = "tier"; + @SerializedName(SERIALIZED_NAME_TIER) + private Integer tier; + + public static final String SERIALIZED_NAME_RISK_LIMIT = "risk_limit"; + @SerializedName(SERIALIZED_NAME_RISK_LIMIT) + private String riskLimit; + + public static final String SERIALIZED_NAME_INITIAL_RATE = "initial_rate"; + @SerializedName(SERIALIZED_NAME_INITIAL_RATE) + private String initialRate; + + public static final String SERIALIZED_NAME_MAINTENANCE_RATE = "maintenance_rate"; + @SerializedName(SERIALIZED_NAME_MAINTENANCE_RATE) + private String maintenanceRate; + + public static final String SERIALIZED_NAME_LEVERAGE_MAX = "leverage_max"; + @SerializedName(SERIALIZED_NAME_LEVERAGE_MAX) + private String leverageMax; + + public static final String SERIALIZED_NAME_DEDUCTION = "deduction"; + @SerializedName(SERIALIZED_NAME_DEDUCTION) + private String deduction; + + + public FuturesRiskLimitTier tier(Integer tier) { + + this.tier = tier; + return this; + } + + /** + * Tier + * @return tier + **/ + @javax.annotation.Nullable + public Integer getTier() { + return tier; + } + + + public void setTier(Integer tier) { + this.tier = tier; + } + + public FuturesRiskLimitTier riskLimit(String riskLimit) { + + this.riskLimit = riskLimit; + return this; + } + + /** + * Position risk limit + * @return riskLimit + **/ + @javax.annotation.Nullable + public String getRiskLimit() { + return riskLimit; + } + + + public void setRiskLimit(String riskLimit) { + this.riskLimit = riskLimit; + } + + public FuturesRiskLimitTier initialRate(String initialRate) { + + this.initialRate = initialRate; + return this; + } + + /** + * Initial margin rate + * @return initialRate + **/ + @javax.annotation.Nullable + public String getInitialRate() { + return initialRate; + } + + + public void setInitialRate(String initialRate) { + this.initialRate = initialRate; + } + + public FuturesRiskLimitTier maintenanceRate(String maintenanceRate) { + + this.maintenanceRate = maintenanceRate; + return this; + } + + /** + * Maintenance margin rate + * @return maintenanceRate + **/ + @javax.annotation.Nullable + public String getMaintenanceRate() { + return maintenanceRate; + } + + + public void setMaintenanceRate(String maintenanceRate) { + this.maintenanceRate = maintenanceRate; + } + + public FuturesRiskLimitTier leverageMax(String leverageMax) { + + this.leverageMax = leverageMax; + return this; + } + + /** + * Maximum leverage + * @return leverageMax + **/ + @javax.annotation.Nullable + public String getLeverageMax() { + return leverageMax; + } + + + public void setLeverageMax(String leverageMax) { + this.leverageMax = leverageMax; + } + + public FuturesRiskLimitTier deduction(String deduction) { + + this.deduction = deduction; + return this; + } + + /** + * Maintenance margin quick calculation deduction amount + * @return deduction + **/ + @javax.annotation.Nullable + public String getDeduction() { + return deduction; + } + + + public void setDeduction(String deduction) { + this.deduction = deduction; + } + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FuturesRiskLimitTier futuresRiskLimitTier = (FuturesRiskLimitTier) o; + return Objects.equals(this.tier, futuresRiskLimitTier.tier) && + Objects.equals(this.riskLimit, futuresRiskLimitTier.riskLimit) && + Objects.equals(this.initialRate, futuresRiskLimitTier.initialRate) && + Objects.equals(this.maintenanceRate, futuresRiskLimitTier.maintenanceRate) && + Objects.equals(this.leverageMax, futuresRiskLimitTier.leverageMax) && + Objects.equals(this.deduction, futuresRiskLimitTier.deduction); + } + + @Override + public int hashCode() { + return Objects.hash(tier, riskLimit, initialRate, maintenanceRate, leverageMax, deduction); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FuturesRiskLimitTier {\n"); + sb.append(" tier: ").append(toIndentedString(tier)).append("\n"); + sb.append(" riskLimit: ").append(toIndentedString(riskLimit)).append("\n"); + sb.append(" initialRate: ").append(toIndentedString(initialRate)).append("\n"); + sb.append(" maintenanceRate: ").append(toIndentedString(maintenanceRate)).append("\n"); + sb.append(" leverageMax: ").append(toIndentedString(leverageMax)).append("\n"); + sb.append(" deduction: ").append(toIndentedString(deduction)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/gate/gateapi/models/FuturesTicker.java b/src/main/java/io/gate/gateapi/models/FuturesTicker.java index 139fe72..b2ae960 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesTicker.java +++ b/src/main/java/io/gate/gateapi/models/FuturesTicker.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -107,6 +107,26 @@ public class FuturesTicker { @SerializedName(SERIALIZED_NAME_HIGHEST_SIZE) private String highestSize; + public static final String SERIALIZED_NAME_CHANGE_UTC0 = "change_utc0"; + @SerializedName(SERIALIZED_NAME_CHANGE_UTC0) + private String changeUtc0; + + public static final String SERIALIZED_NAME_CHANGE_UTC8 = "change_utc8"; + @SerializedName(SERIALIZED_NAME_CHANGE_UTC8) + private String changeUtc8; + + public static final String SERIALIZED_NAME_CHANGE_PRICE = "change_price"; + @SerializedName(SERIALIZED_NAME_CHANGE_PRICE) + private String changePrice; + + public static final String SERIALIZED_NAME_CHANGE_UTC0_PRICE = "change_utc0_price"; + @SerializedName(SERIALIZED_NAME_CHANGE_UTC0_PRICE) + private String changeUtc0Price; + + public static final String SERIALIZED_NAME_CHANGE_UTC8_PRICE = "change_utc8_price"; + @SerializedName(SERIALIZED_NAME_CHANGE_UTC8_PRICE) + private String changeUtc8Price; + public FuturesTicker contract(String contract) { @@ -155,7 +175,7 @@ public FuturesTicker changePercentage(String changePercentage) { } /** - * Change percentage. + * Price change percentage. Negative values indicate price decrease, e.g. -7.45 * @return changePercentage **/ @javax.annotation.Nullable @@ -195,7 +215,7 @@ public FuturesTicker low24h(String low24h) { } /** - * Lowest trading price in recent 24h + * 24-hour lowest price * @return low24h **/ @javax.annotation.Nullable @@ -215,7 +235,7 @@ public FuturesTicker high24h(String high24h) { } /** - * Highest trading price in recent 24h + * 24-hour highest price * @return high24h **/ @javax.annotation.Nullable @@ -235,7 +255,7 @@ public FuturesTicker volume24h(String volume24h) { } /** - * Trade size in recent 24h + * 24-hour trading volume * @return volume24h **/ @javax.annotation.Nullable @@ -255,7 +275,7 @@ public FuturesTicker volume24hBtc(String volume24hBtc) { } /** - * Trade volumes in recent 24h in BTC(deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) + * 24-hour trading volume in BTC (deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) * @return volume24hBtc **/ @javax.annotation.Nullable @@ -275,7 +295,7 @@ public FuturesTicker volume24hUsd(String volume24hUsd) { } /** - * Trade volumes in recent 24h in USD(deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) + * 24-hour trading volume in USD (deprecated, use `volume_24h_base`, `volume_24h_quote`, `volume_24h_settle` instead) * @return volume24hUsd **/ @javax.annotation.Nullable @@ -295,7 +315,7 @@ public FuturesTicker volume24hBase(String volume24hBase) { } /** - * Trade volume in recent 24h, in base currency + * 24-hour trading volume in base currency * @return volume24hBase **/ @javax.annotation.Nullable @@ -315,7 +335,7 @@ public FuturesTicker volume24hQuote(String volume24hQuote) { } /** - * Trade volume in recent 24h, in quote currency + * 24-hour trading volume in quote currency * @return volume24hQuote **/ @javax.annotation.Nullable @@ -335,7 +355,7 @@ public FuturesTicker volume24hSettle(String volume24hSettle) { } /** - * Trade volume in recent 24h, in settle currency + * 24-hour trading volume in settle currency * @return volume24hSettle **/ @javax.annotation.Nullable @@ -527,6 +547,106 @@ public String getHighestSize() { public void setHighestSize(String highestSize) { this.highestSize = highestSize; } + + public FuturesTicker changeUtc0(String changeUtc0) { + + this.changeUtc0 = changeUtc0; + return this; + } + + /** + * Percentage change at utc0. Negative values indicate a drop, e.g., -7.45% + * @return changeUtc0 + **/ + @javax.annotation.Nullable + public String getChangeUtc0() { + return changeUtc0; + } + + + public void setChangeUtc0(String changeUtc0) { + this.changeUtc0 = changeUtc0; + } + + public FuturesTicker changeUtc8(String changeUtc8) { + + this.changeUtc8 = changeUtc8; + return this; + } + + /** + * Percentage change at utc8. Negative values indicate a drop, e.g., -7.45% + * @return changeUtc8 + **/ + @javax.annotation.Nullable + public String getChangeUtc8() { + return changeUtc8; + } + + + public void setChangeUtc8(String changeUtc8) { + this.changeUtc8 = changeUtc8; + } + + public FuturesTicker changePrice(String changePrice) { + + this.changePrice = changePrice; + return this; + } + + /** + * 24h change amount. Negative values indicate a drop, e.g., -7.45 + * @return changePrice + **/ + @javax.annotation.Nullable + public String getChangePrice() { + return changePrice; + } + + + public void setChangePrice(String changePrice) { + this.changePrice = changePrice; + } + + public FuturesTicker changeUtc0Price(String changeUtc0Price) { + + this.changeUtc0Price = changeUtc0Price; + return this; + } + + /** + * Change amount at utc0. Negative values indicate a drop, e.g., -7.45 + * @return changeUtc0Price + **/ + @javax.annotation.Nullable + public String getChangeUtc0Price() { + return changeUtc0Price; + } + + + public void setChangeUtc0Price(String changeUtc0Price) { + this.changeUtc0Price = changeUtc0Price; + } + + public FuturesTicker changeUtc8Price(String changeUtc8Price) { + + this.changeUtc8Price = changeUtc8Price; + return this; + } + + /** + * Change amount at utc8. Negative values indicate a drop, e.g., -7.45 + * @return changeUtc8Price + **/ + @javax.annotation.Nullable + public String getChangeUtc8Price() { + return changeUtc8Price; + } + + + public void setChangeUtc8Price(String changeUtc8Price) { + this.changeUtc8Price = changeUtc8Price; + } @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -556,12 +676,17 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.lowestAsk, futuresTicker.lowestAsk) && Objects.equals(this.lowestSize, futuresTicker.lowestSize) && Objects.equals(this.highestBid, futuresTicker.highestBid) && - Objects.equals(this.highestSize, futuresTicker.highestSize); + Objects.equals(this.highestSize, futuresTicker.highestSize) && + Objects.equals(this.changeUtc0, futuresTicker.changeUtc0) && + Objects.equals(this.changeUtc8, futuresTicker.changeUtc8) && + Objects.equals(this.changePrice, futuresTicker.changePrice) && + Objects.equals(this.changeUtc0Price, futuresTicker.changeUtc0Price) && + Objects.equals(this.changeUtc8Price, futuresTicker.changeUtc8Price); } @Override public int hashCode() { - return Objects.hash(contract, last, changePercentage, totalSize, low24h, high24h, volume24h, volume24hBtc, volume24hUsd, volume24hBase, volume24hQuote, volume24hSettle, markPrice, fundingRate, fundingRateIndicative, indexPrice, quantoBaseRate, lowestAsk, lowestSize, highestBid, highestSize); + return Objects.hash(contract, last, changePercentage, totalSize, low24h, high24h, volume24h, volume24hBtc, volume24hUsd, volume24hBase, volume24hQuote, volume24hSettle, markPrice, fundingRate, fundingRateIndicative, indexPrice, quantoBaseRate, lowestAsk, lowestSize, highestBid, highestSize, changeUtc0, changeUtc8, changePrice, changeUtc0Price, changeUtc8Price); } @@ -590,6 +715,11 @@ public String toString() { sb.append(" lowestSize: ").append(toIndentedString(lowestSize)).append("\n"); sb.append(" highestBid: ").append(toIndentedString(highestBid)).append("\n"); sb.append(" highestSize: ").append(toIndentedString(highestSize)).append("\n"); + sb.append(" changeUtc0: ").append(toIndentedString(changeUtc0)).append("\n"); + sb.append(" changeUtc8: ").append(toIndentedString(changeUtc8)).append("\n"); + sb.append(" changePrice: ").append(toIndentedString(changePrice)).append("\n"); + sb.append(" changeUtc0Price: ").append(toIndentedString(changeUtc0Price)).append("\n"); + sb.append(" changeUtc8Price: ").append(toIndentedString(changeUtc8Price)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/gate/gateapi/models/FuturesTrade.java b/src/main/java/io/gate/gateapi/models/FuturesTrade.java index f5efbb5..21c29f8 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesTrade.java +++ b/src/main/java/io/gate/gateapi/models/FuturesTrade.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -59,7 +59,7 @@ public FuturesTrade id(Long id) { } /** - * Trade ID + * Fill ID * @return id **/ @javax.annotation.Nullable @@ -79,7 +79,7 @@ public FuturesTrade createTime(Double createTime) { } /** - * Trading time + * Fill Time * @return createTime **/ @javax.annotation.Nullable @@ -99,7 +99,7 @@ public FuturesTrade createTimeMs(Double createTimeMs) { } /** - * Trading time, with milliseconds set to 3 decimal places. + * Trade time, with millisecond precision to 3 decimal places * @return createTimeMs **/ @javax.annotation.Nullable @@ -159,7 +159,7 @@ public FuturesTrade price(String price) { } /** - * Trading price (quote currency) + * Trade price (quote currency) * @return price **/ @javax.annotation.Nullable @@ -179,7 +179,7 @@ public FuturesTrade isInternal(Boolean isInternal) { } /** - * Whether internal trade. Internal trade refers to the takeover of liquidation orders by the insurance fund and ADL users. Since it is not a normal matching on the market depth, the transaction price may deviate, and it will not be recorded in the K-line. If it is not an internal trade, this field will not be returned. + * 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 * @return isInternal **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/IndexConstituent.java b/src/main/java/io/gate/gateapi/models/IndexConstituent.java index f32e40e..02170af 100644 --- a/src/main/java/io/gate/gateapi/models/IndexConstituent.java +++ b/src/main/java/io/gate/gateapi/models/IndexConstituent.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/InlineObject.java b/src/main/java/io/gate/gateapi/models/InlineObject.java index fda33b4..359efaf 100644 --- a/src/main/java/io/gate/gateapi/models/InlineObject.java +++ b/src/main/java/io/gate/gateapi/models/InlineObject.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -39,7 +39,7 @@ public InlineObject mode(String mode) { } /** - * Full position-by-position model, ISOLATED-by-position, CROSS-full position + * Cross margin or isolated margin mode. ISOLATED - isolated margin mode, CROSS - cross margin mode * @return mode **/ public String getMode() { @@ -58,7 +58,7 @@ public InlineObject contract(String contract) { } /** - * Contract Market + * Futures market * @return contract **/ public String getContract() { diff --git a/src/main/java/io/gate/gateapi/models/InlineResponse200.java b/src/main/java/io/gate/gateapi/models/InlineResponse200.java index 429503b..7d6f3e7 100644 --- a/src/main/java/io/gate/gateapi/models/InlineResponse200.java +++ b/src/main/java/io/gate/gateapi/models/InlineResponse200.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/InlineResponse2001.java b/src/main/java/io/gate/gateapi/models/InlineResponse2001.java index 6e5d827..c30ea78 100644 --- a/src/main/java/io/gate/gateapi/models/InlineResponse2001.java +++ b/src/main/java/io/gate/gateapi/models/InlineResponse2001.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/InsuranceRecord.java b/src/main/java/io/gate/gateapi/models/InsuranceRecord.java index e498705..1a3846b 100644 --- a/src/main/java/io/gate/gateapi/models/InsuranceRecord.java +++ b/src/main/java/io/gate/gateapi/models/InsuranceRecord.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/LedgerRecord.java b/src/main/java/io/gate/gateapi/models/LedgerRecord.java index f7436e3..86a4a6a 100644 --- a/src/main/java/io/gate/gateapi/models/LedgerRecord.java +++ b/src/main/java/io/gate/gateapi/models/LedgerRecord.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -99,7 +99,7 @@ public LedgerRecord withdrawOrderId(String withdrawOrderId) { } /** - * User-defined order number when withdrawing. Default is empty. When not empty, the specified user-defined order number record will be queried + * User-defined order number for withdrawal. Default is empty. When not empty, the specified user-defined order number record will be queried * @return withdrawOrderId **/ @javax.annotation.Nullable @@ -129,7 +129,7 @@ public LedgerRecord amount(String amount) { } /** - * Currency amount + * Token amount * @return amount **/ public String getAmount() { @@ -207,7 +207,7 @@ public LedgerRecord withdrawId(String withdrawId) { } /** - * 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 + * 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 * @return withdrawId **/ @javax.annotation.Nullable @@ -227,7 +227,7 @@ public LedgerRecord assetClass(String assetClass) { } /** - * 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 + * 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 * @return assetClass **/ @javax.annotation.Nullable @@ -241,7 +241,7 @@ public void setAssetClass(String assetClass) { } /** - * 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 + * 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 * @return status **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/LiquidateOrder.java b/src/main/java/io/gate/gateapi/models/LiquidateOrder.java index dbf7868..de18094 100644 --- a/src/main/java/io/gate/gateapi/models/LiquidateOrder.java +++ b/src/main/java/io/gate/gateapi/models/LiquidateOrder.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Liquidate Order detail + * Spot liquidation order details */ public class LiquidateOrder { public static final String SERIALIZED_NAME_TEXT = "text"; @@ -51,7 +51,7 @@ public LiquidateOrder text(String text) { } /** - * 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(.) + * 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(.) * @return text **/ @javax.annotation.Nullable @@ -128,7 +128,7 @@ public LiquidateOrder actionMode(String actionMode) { } /** - * 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) + * 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) * @return actionMode **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MarginAccount.java b/src/main/java/io/gate/gateapi/models/MarginAccount.java index e4fbe49..d744e56 100644 --- a/src/main/java/io/gate/gateapi/models/MarginAccount.java +++ b/src/main/java/io/gate/gateapi/models/MarginAccount.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -21,7 +21,7 @@ import java.io.IOException; /** - * 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 */ public class MarginAccount { public static final String SERIALIZED_NAME_CURRENCY_PAIR = "currency_pair"; @@ -84,7 +84,7 @@ public MarginAccount accountType(String accountType) { } /** - * Account type, risk - risk rate account, mmr - maintenance margin rate account, inactive - market not activated + * Account type: risk - risk rate account, mmr - maintenance margin rate account, inactive - market not activated * @return accountType **/ @javax.annotation.Nullable @@ -104,7 +104,7 @@ public MarginAccount leverage(String leverage) { } /** - * User current market leverage multiple + * User's current market leverage multiplier * @return leverage **/ @javax.annotation.Nullable @@ -124,7 +124,7 @@ public MarginAccount locked(Boolean locked) { } /** - * Whether account is locked + * Whether the account is locked * @return locked **/ @javax.annotation.Nullable @@ -144,7 +144,7 @@ public MarginAccount risk(String risk) { } /** - * Leveraged Account Current Risk Rate (Returned when the Account is a Risk Rate Account) + * Current risk rate of the margin account (returned when the account is a risk rate account) * @return risk **/ @javax.annotation.Nullable @@ -164,7 +164,7 @@ public MarginAccount mmr(String mmr) { } /** - * Leveraged Account Current Maintenance Margin Rate (returned when the Account is a Maintenance Margin Rate Account) + * Leveraged Account Current Maintenance Margin Rate (returned when the Account is Account) * @return mmr **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MarginAccountBook.java b/src/main/java/io/gate/gateapi/models/MarginAccountBook.java index e6f0d28..365e6ba 100644 --- a/src/main/java/io/gate/gateapi/models/MarginAccountBook.java +++ b/src/main/java/io/gate/gateapi/models/MarginAccountBook.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -83,7 +83,7 @@ public MarginAccountBook time(String time) { } /** - * Balance changed timestamp + * Account change timestamp * @return time **/ @javax.annotation.Nullable @@ -143,7 +143,7 @@ public MarginAccountBook currencyPair(String currencyPair) { } /** - * Account currency pair + * Account trading pair * @return currencyPair **/ @javax.annotation.Nullable @@ -203,7 +203,7 @@ public MarginAccountBook type(String type) { } /** - * Account book type. Please refer to [account book type](#accountbook-type) for more detail + * Account book type. Please refer to [account book type](#accountbook-type) for more detail * @return type **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MarginAccountCurrency.java b/src/main/java/io/gate/gateapi/models/MarginAccountCurrency.java index 93d76a0..9087032 100644 --- a/src/main/java/io/gate/gateapi/models/MarginAccountCurrency.java +++ b/src/main/java/io/gate/gateapi/models/MarginAccountCurrency.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Account currency details + * Currency account information */ public class MarginAccountCurrency { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -71,7 +71,7 @@ public MarginAccountCurrency available(String available) { } /** - * Amount suitable for margin trading. + * Amount available for margin trading, available = margin + borrowed * @return available **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public MarginAccountCurrency locked(String locked) { } /** - * Locked amount, used in margin trading + * Frozen funds, such as amounts already placed in margin market for order trading * @return locked **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public MarginAccountCurrency borrowed(String borrowed) { } /** - * Borrowed amount + * Borrowed funds * @return borrowed **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public MarginAccountCurrency interest(String interest) { } /** - * Unpaid interests + * Unpaid interest * @return interest **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MarginLeverageTier.java b/src/main/java/io/gate/gateapi/models/MarginLeverageTier.java index 96b5802..ef20fa7 100644 --- a/src/main/java/io/gate/gateapi/models/MarginLeverageTier.java +++ b/src/main/java/io/gate/gateapi/models/MarginLeverageTier.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/MarginMarketLeverage.java b/src/main/java/io/gate/gateapi/models/MarginMarketLeverage.java index 5f76d1a..a379beb 100644 --- a/src/main/java/io/gate/gateapi/models/MarginMarketLeverage.java +++ b/src/main/java/io/gate/gateapi/models/MarginMarketLeverage.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -39,7 +39,7 @@ public MarginMarketLeverage currencyPair(String currencyPair) { } /** - * Currency pair + * Market * @return currencyPair **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MarginTiers.java b/src/main/java/io/gate/gateapi/models/MarginTiers.java index cd000bd..436d011 100644 --- a/src/main/java/io/gate/gateapi/models/MarginTiers.java +++ b/src/main/java/io/gate/gateapi/models/MarginTiers.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/MarginTransferable.java b/src/main/java/io/gate/gateapi/models/MarginTransferable.java index ac3701a..aa9dc33 100644 --- a/src/main/java/io/gate/gateapi/models/MarginTransferable.java +++ b/src/main/java/io/gate/gateapi/models/MarginTransferable.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/MaxUniBorrowable.java b/src/main/java/io/gate/gateapi/models/MaxUniBorrowable.java index e7a1d07..7c03c11 100644 --- a/src/main/java/io/gate/gateapi/models/MaxUniBorrowable.java +++ b/src/main/java/io/gate/gateapi/models/MaxUniBorrowable.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/MockFuturesOrder.java b/src/main/java/io/gate/gateapi/models/MockFuturesOrder.java index 0cf585b..9d13c33 100644 --- a/src/main/java/io/gate/gateapi/models/MockFuturesOrder.java +++ b/src/main/java/io/gate/gateapi/models/MockFuturesOrder.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -43,7 +43,7 @@ public MockFuturesOrder contract(String contract) { } /** - * Futures name, currently only supports perpetual futures for BTC and ETH with USDT. + * Futures name, currently only supports USDT perpetual contracts for BTC and ETH * @return contract **/ public String getContract() { @@ -62,7 +62,7 @@ public MockFuturesOrder size(String size) { } /** - * Futures quantity, representing the initial order quantity, not involved in actual settlement. + * Contract quantity, representing the initial order quantity, not involved in actual settlement * @return size **/ public String getSize() { diff --git a/src/main/java/io/gate/gateapi/models/MockFuturesPosition.java b/src/main/java/io/gate/gateapi/models/MockFuturesPosition.java index 1d4c1ea..3db4e9d 100644 --- a/src/main/java/io/gate/gateapi/models/MockFuturesPosition.java +++ b/src/main/java/io/gate/gateapi/models/MockFuturesPosition.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -39,7 +39,7 @@ public MockFuturesPosition contract(String contract) { } /** - * Futures name, currently only supports perpetual futures for BTC and ETH with USDT. + * Futures name, currently only supports USDT perpetual contracts for BTC and ETH * @return contract **/ public String getContract() { @@ -58,7 +58,7 @@ public MockFuturesPosition size(String size) { } /** - * Position size, measured in contract units. + * Position size, measured in contract quantity * @return size **/ public String getSize() { diff --git a/src/main/java/io/gate/gateapi/models/MockMarginResult.java b/src/main/java/io/gate/gateapi/models/MockMarginResult.java index 93c9f35..d8cf32d 100644 --- a/src/main/java/io/gate/gateapi/models/MockMarginResult.java +++ b/src/main/java/io/gate/gateapi/models/MockMarginResult.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -90,7 +90,7 @@ public MockMarginResult addProfitLossRangesItem(ProfitLossRange profitLossRanges } /** - * The results of 33 pressure scenarios for MR1 + * Results of 33 stress scenarios for MR1 * @return profitLossRanges **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MockOptionsOrder.java b/src/main/java/io/gate/gateapi/models/MockOptionsOrder.java index e2873af..f59652d 100644 --- a/src/main/java/io/gate/gateapi/models/MockOptionsOrder.java +++ b/src/main/java/io/gate/gateapi/models/MockOptionsOrder.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -43,7 +43,7 @@ public MockOptionsOrder optionsName(String optionsName) { } /** - * Option name, currently only supports options for BTC and ETH with USDT. + * Option name, currently only supports USDT options for BTC and ETH * @return optionsName **/ public String getOptionsName() { diff --git a/src/main/java/io/gate/gateapi/models/MockOptionsPosition.java b/src/main/java/io/gate/gateapi/models/MockOptionsPosition.java index 8b2e63d..69d9e55 100644 --- a/src/main/java/io/gate/gateapi/models/MockOptionsPosition.java +++ b/src/main/java/io/gate/gateapi/models/MockOptionsPosition.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -39,7 +39,7 @@ public MockOptionsPosition optionsName(String optionsName) { } /** - * Option name, currently only supports options for BTC and ETH with USDT. + * Option name, currently only supports USDT options for BTC and ETH * @return optionsName **/ public String getOptionsName() { @@ -58,7 +58,7 @@ public MockOptionsPosition size(String size) { } /** - * Position size, measured in contract units. + * Position size, measured in contract quantity * @return size **/ public String getSize() { diff --git a/src/main/java/io/gate/gateapi/models/MockRiskUnit.java b/src/main/java/io/gate/gateapi/models/MockRiskUnit.java index 571bce5..4770f74 100644 --- a/src/main/java/io/gate/gateapi/models/MockRiskUnit.java +++ b/src/main/java/io/gate/gateapi/models/MockRiskUnit.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -90,7 +90,7 @@ public MockRiskUnit spotInUse(String spotInUse) { } /** - * Spot usage + * Spot hedge usage * @return spotInUse **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MockSpotBalance.java b/src/main/java/io/gate/gateapi/models/MockSpotBalance.java index 12352f4..f7b8389 100644 --- a/src/main/java/io/gate/gateapi/models/MockSpotBalance.java +++ b/src/main/java/io/gate/gateapi/models/MockSpotBalance.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -58,7 +58,7 @@ public MockSpotBalance equity(String equity) { } /** - * 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 equity, where equity = balance - borrowed, represents the net delta exposure of your spot positions, which can be negative. Currently only supports BTC and ETH * @return equity **/ public String getEquity() { diff --git a/src/main/java/io/gate/gateapi/models/MockSpotOrder.java b/src/main/java/io/gate/gateapi/models/MockSpotOrder.java index 02773f2..29c20e5 100644 --- a/src/main/java/io/gate/gateapi/models/MockSpotOrder.java +++ b/src/main/java/io/gate/gateapi/models/MockSpotOrder.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -51,7 +51,7 @@ public MockSpotOrder currencyPairs(String currencyPairs) { } /** - * Currency pair + * Market * @return currencyPairs **/ public String getCurrencyPairs() { @@ -89,7 +89,7 @@ public MockSpotOrder count(String count) { } /** - * Initial order quantity for spot trading pairs, not involved in actual calculation. Currently only supports three currencies: BTC, ETH. + * 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 * @return count **/ @javax.annotation.Nullable @@ -109,7 +109,7 @@ public MockSpotOrder left(String left) { } /** - * Unfilled quantity, involved in actual calculation. + * Unfilled quantity, involved in actual calculation * @return left **/ public String getLeft() { @@ -128,7 +128,7 @@ public MockSpotOrder type(String type) { } /** - * Order type, sell - sell order, buy - buy order. + * Order type, sell - sell order, buy - buy order * @return type **/ public String getType() { diff --git a/src/main/java/io/gate/gateapi/models/MultiChainAddressItem.java b/src/main/java/io/gate/gateapi/models/MultiChainAddressItem.java index aa94839..8152c82 100644 --- a/src/main/java/io/gate/gateapi/models/MultiChainAddressItem.java +++ b/src/main/java/io/gate/gateapi/models/MultiChainAddressItem.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/MultiCollateralCurrency.java b/src/main/java/io/gate/gateapi/models/MultiCollateralCurrency.java index fc0fca9..646c2b4 100644 --- a/src/main/java/io/gate/gateapi/models/MultiCollateralCurrency.java +++ b/src/main/java/io/gate/gateapi/models/MultiCollateralCurrency.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -24,7 +24,7 @@ import java.util.List; /** - * Borrowing and collateral currencies supported for Multi-Collateral. + * Borrowing and collateral currencies supported for Multi-Collateral */ public class MultiCollateralCurrency { public static final String SERIALIZED_NAME_LOAN_CURRENCIES = "loan_currencies"; diff --git a/src/main/java/io/gate/gateapi/models/MultiCollateralItem.java b/src/main/java/io/gate/gateapi/models/MultiCollateralItem.java index 349f0de..14a372e 100644 --- a/src/main/java/io/gate/gateapi/models/MultiCollateralItem.java +++ b/src/main/java/io/gate/gateapi/models/MultiCollateralItem.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/MultiCollateralOrder.java b/src/main/java/io/gate/gateapi/models/MultiCollateralOrder.java index a1bdf8c..863c40a 100644 --- a/src/main/java/io/gate/gateapi/models/MultiCollateralOrder.java +++ b/src/main/java/io/gate/gateapi/models/MultiCollateralOrder.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -131,7 +131,7 @@ public MultiCollateralOrder fixedType(String fixedType) { } /** - * Fixed interest rate loan periods: 7d - 7 days, 30d - 30 days. + * Fixed interest rate loan periods: 7d - 7 days, 30d - 30 days * @return fixedType **/ @javax.annotation.Nullable @@ -171,7 +171,7 @@ public MultiCollateralOrder expireTime(Long expireTime) { } /** - * Expiration time, timestamp, unit in seconds. + * Expiration time, timestamp, unit in seconds * @return expireTime **/ @javax.annotation.Nullable @@ -191,7 +191,7 @@ public MultiCollateralOrder autoRenew(Boolean autoRenew) { } /** - * Fixed interest rate, automatic renewal + * Fixed interest rate, auto-renewal * @return autoRenew **/ @javax.annotation.Nullable @@ -211,7 +211,7 @@ public MultiCollateralOrder autoRepay(Boolean autoRepay) { } /** - * Fixed interest rate, automatic repayment + * Fixed interest rate, auto-repayment * @return autoRepay **/ @javax.annotation.Nullable @@ -231,7 +231,7 @@ public MultiCollateralOrder currentLtv(String currentLtv) { } /** - * The current collateralization rate + * Current collateralization rate * @return currentLtv **/ @javax.annotation.Nullable @@ -291,7 +291,7 @@ public MultiCollateralOrder totalLeftRepayUsdt(String totalLeftRepayUsdt) { } /** - * Value of Left repay amount converted in USDT + * Total outstanding value converted to USDT * @return totalLeftRepayUsdt **/ @javax.annotation.Nullable @@ -311,7 +311,7 @@ public MultiCollateralOrder totalLeftCollateralUsdt(String totalLeftCollateralUs } /** - * Value of Collateral amount in USDT + * Total collateral value converted to USDT * @return totalLeftCollateralUsdt **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MultiCollateralRecord.java b/src/main/java/io/gate/gateapi/models/MultiCollateralRecord.java index 7aba73c..b5e8601 100644 --- a/src/main/java/io/gate/gateapi/models/MultiCollateralRecord.java +++ b/src/main/java/io/gate/gateapi/models/MultiCollateralRecord.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -23,7 +23,7 @@ import java.util.List; /** - * Multi-Collateral adjustment record. + * Multi-Collateral adjustment record */ public class MultiCollateralRecord { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; @@ -102,7 +102,7 @@ public MultiCollateralRecord beforeLtv(String beforeLtv) { } /** - * The collateral ratio before adjustment + * Collateral ratio before adjustment * @return beforeLtv **/ @javax.annotation.Nullable @@ -122,7 +122,7 @@ public MultiCollateralRecord afterLtv(String afterLtv) { } /** - * The collateral ratio before adjustment + * Collateral ratio before adjustment * @return afterLtv **/ @javax.annotation.Nullable @@ -142,7 +142,7 @@ public MultiCollateralRecord operateTime(Long operateTime) { } /** - * Operation time, timestamp in seconds. + * Operation time, timestamp in seconds * @return operateTime **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MultiCollateralRecordCurrency.java b/src/main/java/io/gate/gateapi/models/MultiCollateralRecordCurrency.java index 42de936..2ed3adf 100644 --- a/src/main/java/io/gate/gateapi/models/MultiCollateralRecordCurrency.java +++ b/src/main/java/io/gate/gateapi/models/MultiCollateralRecordCurrency.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -115,7 +115,7 @@ public MultiCollateralRecordCurrency beforeAmountUsdt(String beforeAmountUsdt) { } /** - * USDT Amount before the operation. + * USDT Amount before the operation * @return beforeAmountUsdt **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public MultiCollateralRecordCurrency afterAmount(String afterAmount) { } /** - * Amount after the operation. + * Amount after the operation * @return afterAmount **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public MultiCollateralRecordCurrency afterAmountUsdt(String afterAmountUsdt) { } /** - * USDT Amount after the operation. + * USDT Amount after the operation * @return afterAmountUsdt **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MultiLoanItem.java b/src/main/java/io/gate/gateapi/models/MultiLoanItem.java index 8662414..0231292 100644 --- a/src/main/java/io/gate/gateapi/models/MultiLoanItem.java +++ b/src/main/java/io/gate/gateapi/models/MultiLoanItem.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/MultiLoanRepayItem.java b/src/main/java/io/gate/gateapi/models/MultiLoanRepayItem.java index 7ec8a7a..3490e27 100644 --- a/src/main/java/io/gate/gateapi/models/MultiLoanRepayItem.java +++ b/src/main/java/io/gate/gateapi/models/MultiLoanRepayItem.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -83,10 +83,9 @@ public MultiLoanRepayItem repaidAll(Boolean repaidAll) { } /** - * Repayment method, set to true for full repayment, false for partial repayment. + * Repayment method, set to true for full repayment, false for partial repayment * @return repaidAll **/ - @javax.annotation.Nullable public Boolean getRepaidAll() { return repaidAll; } diff --git a/src/main/java/io/gate/gateapi/models/MultiRepayRecord.java b/src/main/java/io/gate/gateapi/models/MultiRepayRecord.java index 5fc4cce..51b8d2a 100644 --- a/src/main/java/io/gate/gateapi/models/MultiRepayRecord.java +++ b/src/main/java/io/gate/gateapi/models/MultiRepayRecord.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -26,7 +26,7 @@ import java.util.List; /** - * Mult Repay Record + * Multi-Collateral Repayment Record */ public class MultiRepayRecord { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; @@ -125,7 +125,7 @@ public MultiRepayRecord initLtv(String initLtv) { } /** - * The initial collateralization rate + * Initial collateralization rate * @return initLtv **/ @javax.annotation.Nullable @@ -185,7 +185,7 @@ public MultiRepayRecord borrowTime(Long borrowTime) { } /** - * Borrowing time, timestamp in seconds. + * Borrowing time, timestamp in seconds * @return borrowTime **/ @javax.annotation.Nullable @@ -205,7 +205,7 @@ public MultiRepayRecord repayTime(Long repayTime) { } /** - * Repayment time, timestamp in seconds. + * Repayment time, timestamp in seconds * @return repayTime **/ @javax.annotation.Nullable @@ -345,7 +345,7 @@ public MultiRepayRecord addLeftRepayInterestListItem(RepayRecordLeftInterest lef } /** - * List of left repay interest + * List of remaining interest to be repaid * @return leftRepayInterestList **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MultiRepayResp.java b/src/main/java/io/gate/gateapi/models/MultiRepayResp.java index 816cc0b..6b76091 100644 --- a/src/main/java/io/gate/gateapi/models/MultiRepayResp.java +++ b/src/main/java/io/gate/gateapi/models/MultiRepayResp.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -23,7 +23,7 @@ import java.util.List; /** - * Repay Multi-Collateral Loan + * Multi-currency collateral repayment */ public class MultiRepayResp { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; diff --git a/src/main/java/io/gate/gateapi/models/MyFuturesTrade.java b/src/main/java/io/gate/gateapi/models/MyFuturesTrade.java index 2177c2b..9d97fad 100644 --- a/src/main/java/io/gate/gateapi/models/MyFuturesTrade.java +++ b/src/main/java/io/gate/gateapi/models/MyFuturesTrade.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -52,7 +52,7 @@ public class MyFuturesTrade { private String price; /** - * Trade role. Available values are `taker` and `maker` + * Trade role. taker - taker, maker - maker */ @JsonAdapter(RoleEnum.Adapter.class) public enum RoleEnum { @@ -122,7 +122,7 @@ public MyFuturesTrade id(Long id) { } /** - * Trade ID + * Fill ID * @return id **/ @javax.annotation.Nullable @@ -142,7 +142,7 @@ public MyFuturesTrade createTime(Double createTime) { } /** - * Trading time + * Fill Time * @return createTime **/ @javax.annotation.Nullable @@ -182,7 +182,7 @@ public MyFuturesTrade orderId(String orderId) { } /** - * Order ID related + * Related order ID * @return orderId **/ @javax.annotation.Nullable @@ -222,7 +222,7 @@ public MyFuturesTrade closeSize(Long closeSize) { } /** - * Number of closed positions: close_size=0 && size＞0 Open long position close_size=0 && size＜0 Open short position close_size>0 && size>0 && size <= close_size Close short postion close_size>0 && size>0 && size > close_size Close short position and open long position close_size<0 && size<0 && size >= close_size Close long postion close_size<0 && size<0 && size < close_size Close long position and open short position + * 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 * @return closeSize **/ @javax.annotation.Nullable @@ -242,7 +242,7 @@ public MyFuturesTrade price(String price) { } /** - * Trading price + * Fill Price * @return price **/ @javax.annotation.Nullable @@ -262,7 +262,7 @@ public MyFuturesTrade role(RoleEnum role) { } /** - * Trade role. Available values are `taker` and `maker` + * Trade role. taker - taker, maker - maker * @return role **/ @javax.annotation.Nullable @@ -282,7 +282,7 @@ public MyFuturesTrade text(String text) { } /** - * User defined information + * Order custom information * @return text **/ @javax.annotation.Nullable @@ -302,7 +302,7 @@ public MyFuturesTrade fee(String fee) { } /** - * Fee deducted + * Trade fee * @return fee **/ @javax.annotation.Nullable @@ -322,7 +322,7 @@ public MyFuturesTrade pointFee(String pointFee) { } /** - * Points used to deduct fee + * Points used to deduct trade fee * @return pointFee **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MyFuturesTradeTimeRange.java b/src/main/java/io/gate/gateapi/models/MyFuturesTradeTimeRange.java index e771976..9364731 100644 --- a/src/main/java/io/gate/gateapi/models/MyFuturesTradeTimeRange.java +++ b/src/main/java/io/gate/gateapi/models/MyFuturesTradeTimeRange.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -52,7 +52,7 @@ public class MyFuturesTradeTimeRange { private String price; /** - * Trade role. Available values are `taker` and `maker` + * Trade role. taker - taker, maker - maker */ @JsonAdapter(RoleEnum.Adapter.class) public enum RoleEnum { @@ -122,7 +122,7 @@ public MyFuturesTradeTimeRange tradeId(String tradeId) { } /** - * Trade ID + * Fill ID * @return tradeId **/ @javax.annotation.Nullable @@ -142,7 +142,7 @@ public MyFuturesTradeTimeRange createTime(Double createTime) { } /** - * Trading time + * Fill Time * @return createTime **/ @javax.annotation.Nullable @@ -182,7 +182,7 @@ public MyFuturesTradeTimeRange orderId(String orderId) { } /** - * Order ID related + * Related order ID * @return orderId **/ @javax.annotation.Nullable @@ -222,7 +222,7 @@ public MyFuturesTradeTimeRange closeSize(Long closeSize) { } /** - * Number of closed positions: close_size=0 && size＞0 Open long position close_size=0 && size＜0 Open short position close_size>0 && size>0 && size <= close_size Close short postion close_size>0 && size>0 && size > close_size Close short position and open long position close_size<0 && size<0 && size >= close_size Close long postion close_size<0 && size<0 && size < close_size Close long position and open short position + * 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 * @return closeSize **/ @javax.annotation.Nullable @@ -242,7 +242,7 @@ public MyFuturesTradeTimeRange price(String price) { } /** - * Trading price + * Fill Price * @return price **/ @javax.annotation.Nullable @@ -262,7 +262,7 @@ public MyFuturesTradeTimeRange role(RoleEnum role) { } /** - * Trade role. Available values are `taker` and `maker` + * Trade role. taker - taker, maker - maker * @return role **/ @javax.annotation.Nullable @@ -282,7 +282,7 @@ public MyFuturesTradeTimeRange text(String text) { } /** - * User defined information + * Order custom information * @return text **/ @javax.annotation.Nullable @@ -302,7 +302,7 @@ public MyFuturesTradeTimeRange fee(String fee) { } /** - * Fee deducted + * Trade fee * @return fee **/ @javax.annotation.Nullable @@ -322,7 +322,7 @@ public MyFuturesTradeTimeRange pointFee(String pointFee) { } /** - * Points used to deduct fee + * Points used to deduct trade fee * @return pointFee **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/OpenOrders.java b/src/main/java/io/gate/gateapi/models/OpenOrders.java index 6040213..39708aa 100644 --- a/src/main/java/io/gate/gateapi/models/OpenOrders.java +++ b/src/main/java/io/gate/gateapi/models/OpenOrders.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -66,7 +66,7 @@ public OpenOrders total(Integer total) { } /** - * The total number of pending orders for this trading pair on the current page + * Total number of open orders for this trading pair on the current page * @return total **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/OptionsAccount.java b/src/main/java/io/gate/gateapi/models/OptionsAccount.java index cbadfa6..535c794 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsAccount.java +++ b/src/main/java/io/gate/gateapi/models/OptionsAccount.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -176,7 +176,7 @@ public OptionsAccount total(String total) { } /** - * Account balance + * Account Balance * @return total **/ @javax.annotation.Nullable @@ -456,7 +456,7 @@ public OptionsAccount point(String point) { } /** - * POINT amount + * Point card amount * @return point **/ @javax.annotation.Nullable @@ -476,7 +476,7 @@ public OptionsAccount currency(String currency) { } /** - * Settle currency + * Settlement currency * @return currency **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/OptionsAccountBook.java b/src/main/java/io/gate/gateapi/models/OptionsAccountBook.java index a71fbd2..0e71a07 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsAccountBook.java +++ b/src/main/java/io/gate/gateapi/models/OptionsAccountBook.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -111,7 +111,7 @@ public OptionsAccountBook type(String type) { } /** - * Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - point_dnw: POINT Deposit & Withdraw - point_fee: POINT Trading fee - point_refr: POINT Referrer rebate + * 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 * @return type **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public OptionsAccountBook text(String text) { } /** - * custom text + * Remark * @return text **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/OptionsCandlestick.java b/src/main/java/io/gate/gateapi/models/OptionsCandlestick.java index 2b4d7c4..247eee0 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsCandlestick.java +++ b/src/main/java/io/gate/gateapi/models/OptionsCandlestick.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/OptionsContract.java b/src/main/java/io/gate/gateapi/models/OptionsContract.java index 5ec6cbd..827a036 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsContract.java +++ b/src/main/java/io/gate/gateapi/models/OptionsContract.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Options contract detail + * Options contract details */ public class OptionsContract { public static final String SERIALIZED_NAME_NAME = "name"; @@ -151,7 +151,7 @@ public OptionsContract tag(String tag) { } /** - * tag + * Tag * @return tag **/ @javax.annotation.Nullable @@ -171,7 +171,7 @@ public OptionsContract createTime(Double createTime) { } /** - * Creation time + * Created time * @return createTime **/ @javax.annotation.Nullable @@ -211,7 +211,7 @@ public OptionsContract isCall(Boolean isCall) { } /** - * `true` means call options, while `false` is put options + * `true` means call options, `false` means put options * @return isCall **/ @javax.annotation.Nullable @@ -351,7 +351,7 @@ public OptionsContract makerFeeRate(String makerFeeRate) { } /** - * Maker fee rate, where negative means rebate + * Maker fee rate, negative values indicate rebates * @return makerFeeRate **/ @javax.annotation.Nullable @@ -431,7 +431,7 @@ public OptionsContract orderSizeMin(Long orderSizeMin) { } /** - * Minimum order size the contract allowed + * Minimum order size allowed by the contract * @return orderSizeMin **/ @javax.annotation.Nullable @@ -451,7 +451,7 @@ public OptionsContract orderSizeMax(Long orderSizeMax) { } /** - * Maximum order size the contract allowed + * Maximum order size allowed by the contract * @return orderSizeMax **/ @javax.annotation.Nullable @@ -471,7 +471,7 @@ public OptionsContract orderPriceDeviate(String orderPriceDeviate) { } /** - * The positive and negative offset allowed between the order price and the current mark price, that is, the order price `order_price` must meet the following conditions: order_price is within the range of mark_price +/- order_price_deviate * underlying_price and does not distinguish between buy and sell orders + * 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 * @return orderPriceDeviate **/ @javax.annotation.Nullable @@ -491,7 +491,7 @@ public OptionsContract refDiscountRate(String refDiscountRate) { } /** - * Referral fee rate discount + * Trading fee discount for referred users * @return refDiscountRate **/ @javax.annotation.Nullable @@ -511,7 +511,7 @@ public OptionsContract refRebateRate(String refRebateRate) { } /** - * Referrer commission rate + * Commission rate for referrers * @return refRebateRate **/ @javax.annotation.Nullable @@ -531,7 +531,7 @@ public OptionsContract orderbookId(Long orderbookId) { } /** - * Current orderbook ID + * Orderbook update ID * @return orderbookId **/ @javax.annotation.Nullable @@ -571,7 +571,7 @@ public OptionsContract tradeSize(Long tradeSize) { } /** - * Historical accumulated trade size + * Historical cumulative trading volume * @return tradeSize **/ @javax.annotation.Nullable @@ -611,7 +611,7 @@ public OptionsContract ordersLimit(Integer ordersLimit) { } /** - * Maximum number of open orders + * Maximum number of pending orders * @return ordersLimit **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/OptionsMMP.java b/src/main/java/io/gate/gateapi/models/OptionsMMP.java index f30bff8..7bae71b 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsMMP.java +++ b/src/main/java/io/gate/gateapi/models/OptionsMMP.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -78,7 +78,7 @@ public OptionsMMP window(Integer window) { } /** - * Time window (milliseconds), between 1-5000, 0 means disabling MMP + * Time window (milliseconds), between 1-5000, 0 means disable MMP * @return window **/ public Integer getWindow() { @@ -158,7 +158,7 @@ public Long getTriggerTimeMs() { /** - * Unfreeze time (milliseconds). If the freeze duration is not configured, there will be no unfreeze time after the freeze is triggered. + * Unfreeze time (milliseconds). If the freeze duration is not configured, there will be no unfreeze time after the freeze is triggered * @return frozenUntilMs **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/OptionsMMPReset.java b/src/main/java/io/gate/gateapi/models/OptionsMMPReset.java index 6388b30..73a9157 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsMMPReset.java +++ b/src/main/java/io/gate/gateapi/models/OptionsMMPReset.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -72,7 +72,7 @@ public void setUnderlying(String underlying) { } /** - * Time window (milliseconds), between 1-5000, 0 means disabling MMP + * Time window (milliseconds), between 1-5000, 0 means disable MMP * @return window **/ @javax.annotation.Nullable @@ -122,7 +122,7 @@ public Long getTriggerTimeMs() { /** - * Unfreeze time (milliseconds). If the freeze duration is not configured, there will be no unfreeze time after the freeze is triggered. + * Unfreeze time (milliseconds). If the freeze duration is not configured, there will be no unfreeze time after the freeze is triggered * @return frozenUntilMs **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/OptionsMySettlements.java b/src/main/java/io/gate/gateapi/models/OptionsMySettlements.java index d33a6fd..4f46613 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsMySettlements.java +++ b/src/main/java/io/gate/gateapi/models/OptionsMySettlements.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -167,7 +167,7 @@ public OptionsMySettlements size(Long size) { } /** - * Size + * Settlement size * @return size **/ @javax.annotation.Nullable @@ -207,7 +207,7 @@ public OptionsMySettlements fee(String fee) { } /** - * Fee (quote currency) + * Settlement fee (quote currency) * @return fee **/ @javax.annotation.Nullable @@ -227,7 +227,7 @@ public OptionsMySettlements realisedPnl(String realisedPnl) { } /** - * The accumulated profit and loss of opening a position, including premium, fee, settlement profit, etc. (quote currency) + * Accumulated profit and loss from opening positions, including premium, fees, settlement profit, etc. (quote currency) * @return realisedPnl **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/OptionsMyTrade.java b/src/main/java/io/gate/gateapi/models/OptionsMyTrade.java index c8e468f..dd22f1f 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsMyTrade.java +++ b/src/main/java/io/gate/gateapi/models/OptionsMyTrade.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -52,7 +52,7 @@ public class OptionsMyTrade { private String underlyingPrice; /** - * Trade role. Available values are `taker` and `maker` + * Trade role. taker - taker, maker - maker */ @JsonAdapter(RoleEnum.Adapter.class) public enum RoleEnum { @@ -110,7 +110,7 @@ public OptionsMyTrade id(Long id) { } /** - * Trade ID + * Fill ID * @return id **/ @javax.annotation.Nullable @@ -130,7 +130,7 @@ public OptionsMyTrade createTime(Double createTime) { } /** - * Trading time + * Fill Time * @return createTime **/ @javax.annotation.Nullable @@ -170,7 +170,7 @@ public OptionsMyTrade orderId(Integer orderId) { } /** - * Order ID related + * Related order ID * @return orderId **/ @javax.annotation.Nullable @@ -210,7 +210,7 @@ public OptionsMyTrade price(String price) { } /** - * Trading price (quote currency) + * Trade price (quote currency) * @return price **/ @javax.annotation.Nullable @@ -250,7 +250,7 @@ public OptionsMyTrade role(RoleEnum role) { } /** - * Trade role. Available values are `taker` and `maker` + * Trade role. taker - taker, maker - maker * @return role **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/OptionsOrder.java b/src/main/java/io/gate/gateapi/models/OptionsOrder.java index 32889d8..e6616ac 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsOrder.java +++ b/src/main/java/io/gate/gateapi/models/OptionsOrder.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Options order detail + * Options order details */ public class OptionsOrder { public static final String SERIALIZED_NAME_ID = "id"; @@ -40,7 +40,7 @@ public class OptionsOrder { private Double finishTime; /** - * 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, because reduce_only is set 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 + * 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 */ @JsonAdapter(FinishAsEnum.Adapter.class) public enum FinishAsEnum { @@ -105,7 +105,7 @@ public FinishAsEnum read(final JsonReader jsonReader) throws IOException { private FinishAsEnum finishAs; /** - * Order status - `open`: waiting to be traded - `finished`: finished + * Order status - `open`: Pending - `finished`: Completed */ @JsonAdapter(StatusEnum.Adapter.class) public enum StatusEnum { @@ -200,7 +200,7 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { private Boolean isMmp; /** - * Time in force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only - poc: PendingOrCancelled, makes a post-only order that always enjoys a maker fee + * 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 */ @JsonAdapter(TifEnum.Adapter.class) public enum TifEnum { @@ -322,7 +322,7 @@ public Double getFinishTime() { /** - * 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, because reduce_only is set 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 + * 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 * @return finishAs **/ @javax.annotation.Nullable @@ -332,7 +332,7 @@ public FinishAsEnum getFinishAs() { /** - * Order status - `open`: waiting to be traded - `finished`: finished + * Order status - `open`: Pending - `finished`: Completed * @return status **/ @javax.annotation.Nullable @@ -348,7 +348,7 @@ public OptionsOrder contract(String contract) { } /** - * Contract name + * Options identifier * @return contract **/ public String getContract() { @@ -367,7 +367,7 @@ public OptionsOrder size(Long size) { } /** - * Order size. Specify positive number to make a bid, and negative number to ask + * Required. Trading quantity. Positive for buy, negative for sell. Set to 0 for close position orders. * @return size **/ public Long getSize() { @@ -386,7 +386,7 @@ public OptionsOrder iceberg(Long iceberg) { } /** - * Display size for iceberg order. 0 for non-iceberg. Note that you will have to pay the taker fee for the hidden size + * Display size for iceberg orders. 0 for non-iceberg orders. Note that hidden portions are charged taker fees. * @return iceberg **/ @javax.annotation.Nullable @@ -406,7 +406,7 @@ public OptionsOrder price(String price) { } /** - * Order price. 0 for market order with `tif` set as `ioc` (USDT) + * Order price. Price of 0 with `tif` set as `ioc` represents market order (quote currency) * @return price **/ @javax.annotation.Nullable @@ -496,7 +496,7 @@ public OptionsOrder mmp(Boolean mmp) { } /** - * When set to true, delegate to MMP + * When set to true, it is an MMP order * @return mmp **/ @javax.annotation.Nullable @@ -510,7 +510,7 @@ public void setMmp(Boolean mmp) { } /** - * Whether it is MMP delegation. Corresponds to `mmp` in the request. + * Whether it is an MMP order. Corresponds to `mmp` in the request * @return isMmp **/ @javax.annotation.Nullable @@ -526,7 +526,7 @@ public OptionsOrder tif(TifEnum tif) { } /** - * Time in force - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled, taker only - poc: PendingOrCancelled, makes a post-only order that always enjoys a maker fee + * 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 * @return tif **/ @javax.annotation.Nullable @@ -540,7 +540,7 @@ public void setTif(TifEnum tif) { } /** - * Size left to be traded + * Unfilled quantity * @return left **/ @javax.annotation.Nullable @@ -550,7 +550,7 @@ public Long getLeft() { /** - * Fill price of the order + * Fill price * @return fillPrice **/ @javax.annotation.Nullable @@ -600,7 +600,7 @@ public String getMkfr() { /** - * Reference user ID + * Referrer user ID * @return refu **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/OptionsPosition.java b/src/main/java/io/gate/gateapi/models/OptionsPosition.java index 5fb1ede..edf15aa 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsPosition.java +++ b/src/main/java/io/gate/gateapi/models/OptionsPosition.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -21,7 +21,7 @@ import java.io.IOException; /** - * Options position information + * Options contract position details */ public class OptionsPosition { public static final String SERIALIZED_NAME_USER = "user"; @@ -130,7 +130,7 @@ public String getContract() { /** - * Position size (contract size) + * Position size (contract quantity) * @return size **/ @javax.annotation.Nullable @@ -170,7 +170,7 @@ public String getMarkIv() { /** - * Realized PNL + * Realized PnL * @return realisedPnl **/ @javax.annotation.Nullable @@ -190,7 +190,7 @@ public String getUnrealisedPnl() { /** - * Current open orders + * Current pending order quantity * @return pendingOrders **/ @javax.annotation.Nullable @@ -220,7 +220,7 @@ public void setCloseOrder(OptionsPositionCloseOrder closeOrder) { } /** - * Delta + * Greek letter delta * @return delta **/ @javax.annotation.Nullable @@ -230,7 +230,7 @@ public String getDelta() { /** - * Gamma + * Greek letter gamma * @return gamma **/ @javax.annotation.Nullable @@ -240,7 +240,7 @@ public String getGamma() { /** - * Vega + * Greek letter vega * @return vega **/ @javax.annotation.Nullable @@ -250,7 +250,7 @@ public String getVega() { /** - * Theta + * Greek letter theta * @return theta **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/OptionsPositionClose.java b/src/main/java/io/gate/gateapi/models/OptionsPositionClose.java index 2c88e19..b381613 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsPositionClose.java +++ b/src/main/java/io/gate/gateapi/models/OptionsPositionClose.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -32,7 +32,7 @@ public class OptionsPositionClose { private String contract; /** - * Position side, long or short + * Position side - `long`: Long position - `short`: Short position */ @JsonAdapter(SideEnum.Adapter.class) public enum SideEnum { @@ -116,7 +116,7 @@ public String getContract() { /** - * Position side, long or short + * Position side - `long`: Long position - `short`: Short position * @return side **/ @javax.annotation.Nullable @@ -126,7 +126,7 @@ public SideEnum getSide() { /** - * PNL + * PnL * @return pnl **/ @javax.annotation.Nullable @@ -136,7 +136,7 @@ public String getPnl() { /** - * Text of close order + * Source of close order. See `order.text` field for specific values * @return text **/ @javax.annotation.Nullable @@ -146,7 +146,7 @@ public String getText() { /** - * settlement size + * Settlement size * @return settleSize **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/OptionsPositionCloseOrder.java b/src/main/java/io/gate/gateapi/models/OptionsPositionCloseOrder.java index ab879d2..0661e85 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsPositionCloseOrder.java +++ b/src/main/java/io/gate/gateapi/models/OptionsPositionCloseOrder.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Current close order if any, or `null` + * Current close order information, or `null` if no close order */ public class OptionsPositionCloseOrder { public static final String SERIALIZED_NAME_ID = "id"; @@ -43,7 +43,7 @@ public OptionsPositionCloseOrder id(Long id) { } /** - * Close order ID + * Order ID * @return id **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public OptionsPositionCloseOrder price(String price) { } /** - * Close order price （quote currency) + * Order price (quote currency) * @return price **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public OptionsPositionCloseOrder isLiq(Boolean isLiq) { } /** - * Is the close order from liquidation + * Whether the close order is from liquidation * @return isLiq **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/OptionsSettlement.java b/src/main/java/io/gate/gateapi/models/OptionsSettlement.java index ead66e6..dc34021 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsSettlement.java +++ b/src/main/java/io/gate/gateapi/models/OptionsSettlement.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -55,7 +55,7 @@ public OptionsSettlement time(Double time) { } /** - * Last changed time of configuration + * Last configuration update time * @return time **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public OptionsSettlement profit(String profit) { } /** - * Settlement profit per size (quote currency) + * Settlement profit per contract (quote currency) * @return profit **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public OptionsSettlement fee(String fee) { } /** - * Settlement fee per size (quote currency) + * Settlement fee per contract (quote currency) * @return fee **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/OptionsTicker.java b/src/main/java/io/gate/gateapi/models/OptionsTicker.java index b0a3d06..e04290f 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsTicker.java +++ b/src/main/java/io/gate/gateapi/models/OptionsTicker.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Options contract detail + * Options contract details */ public class OptionsTicker { public static final String SERIALIZED_NAME_NAME = "name"; @@ -123,7 +123,7 @@ public OptionsTicker lastPrice(String lastPrice) { } /** - * Last trading price (quote currency) + * Last trade price (quote currency) * @return lastPrice **/ @javax.annotation.Nullable @@ -363,7 +363,7 @@ public OptionsTicker delta(String delta) { } /** - * Delta + * Greek letter delta * @return delta **/ @javax.annotation.Nullable @@ -383,7 +383,7 @@ public OptionsTicker gamma(String gamma) { } /** - * Gamma + * Greek letter gamma * @return gamma **/ @javax.annotation.Nullable @@ -403,7 +403,7 @@ public OptionsTicker vega(String vega) { } /** - * Vega + * Greek letter vega * @return vega **/ @javax.annotation.Nullable @@ -423,7 +423,7 @@ public OptionsTicker theta(String theta) { } /** - * Theta + * Greek letter theta * @return theta **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/OptionsUnderlying.java b/src/main/java/io/gate/gateapi/models/OptionsUnderlying.java index 074c737..883ff74 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsUnderlying.java +++ b/src/main/java/io/gate/gateapi/models/OptionsUnderlying.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/OptionsUnderlyingTicker.java b/src/main/java/io/gate/gateapi/models/OptionsUnderlyingTicker.java index 363e1f3..d77ea4b 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsUnderlyingTicker.java +++ b/src/main/java/io/gate/gateapi/models/OptionsUnderlyingTicker.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/Order.java b/src/main/java/io/gate/gateapi/models/Order.java index fd70125..267009e 100644 --- a/src/main/java/io/gate/gateapi/models/Order.java +++ b/src/main/java/io/gate/gateapi/models/Order.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -109,7 +109,7 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { private String currencyPair; /** - * Order Type - limit : Limit Order - market : Market Order + * Order Type - limit : Limit Order - market : Market Order */ @JsonAdapter(TypeEnum.Adapter.class) public enum TypeEnum { @@ -164,7 +164,7 @@ public TypeEnum read(final JsonReader jsonReader) throws IOException { private String account = "spot"; /** - * Order side + * Buy or sell order */ @JsonAdapter(SideEnum.Adapter.class) public enum SideEnum { @@ -350,7 +350,7 @@ public TimeInForceEnum read(final JsonReader jsonReader) throws IOException { private Integer stpId; /** - * Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled + * 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 */ @JsonAdapter(StpActEnum.Adapter.class) public enum StpActEnum { @@ -405,7 +405,7 @@ public StpActEnum read(final JsonReader jsonReader) throws IOException { private StpActEnum stpAct; /** - * Order completion statuses include: - open: Awaiting processing - filled: Fully filled - cancelled: Cancelled by user - liquidate_cancelled: Cancelled due to liquidation - small: Order quantity too small - depth_not_enough: Cancelled due to insufficient market depth - trader_not_enough: Cancelled due to insufficient counterparty - ioc: Not immediately filled because tif is set to ioc - poc: Not met the order strategy because tif is set to poc - fok: Not fully filled immediately because tif is set to fok - stp: Cancelled due to self-trade prevention - unknown: Unknown + * 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 */ @JsonAdapter(FinishAsEnum.Adapter.class) public enum FinishAsEnum { @@ -596,7 +596,7 @@ public Order type(TypeEnum type) { } /** - * Order Type - limit : Limit Order - market : Market Order + * Order Type - limit : Limit Order - market : Market Order * @return type **/ @javax.annotation.Nullable @@ -636,7 +636,7 @@ public Order side(SideEnum side) { } /** - * Order side + * Buy or sell order * @return side **/ public SideEnum getSide() { @@ -655,7 +655,7 @@ public Order amount(String amount) { } /** - * When `type` is limit, it refers to base currency. For instance, `BTC_USDT` means `BTC` When `type` is `market`, it refers to different currency according to `side` - `side` : `buy` means quote currency, `BTC_USDT` means `USDT` - `side` : `sell` means base currency，`BTC_USDT` means `BTC` + * 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` * @return amount **/ public String getAmount() { @@ -674,7 +674,7 @@ public Order price(String price) { } /** - * Price can't be empty when `type`= `limit` + * Trading price, required when `type`=`limit` * @return price **/ @javax.annotation.Nullable @@ -714,7 +714,7 @@ public Order iceberg(String iceberg) { } /** - * Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported. + * Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported * @return iceberg **/ @javax.annotation.Nullable @@ -734,7 +734,7 @@ public Order autoBorrow(Boolean autoBorrow) { } /** - * Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough. + * Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough * @return autoBorrow **/ @javax.annotation.Nullable @@ -754,7 +754,7 @@ public Order autoRepay(Boolean autoRepay) { } /** - * 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. + * 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 * @return autoRepay **/ @javax.annotation.Nullable @@ -778,7 +778,7 @@ public String getLeft() { /** - * Amount traded to fill + * Amount filled * @return filledAmount **/ @javax.annotation.Nullable @@ -858,7 +858,7 @@ public String getGtFee() { /** - * GT used to deduct maker fee + * GT amount used to deduct maker fee * @return gtMakerFee **/ @javax.annotation.Nullable @@ -868,7 +868,7 @@ public String getGtMakerFee() { /** - * GT used to deduct taker fee + * GT amount used to deduct taker fee * @return gtTakerFee **/ @javax.annotation.Nullable @@ -878,7 +878,7 @@ public String getGtTakerFee() { /** - * Whether GT fee discount is used + * Whether GT fee deduction is enabled * @return gtDiscount **/ @javax.annotation.Nullable @@ -924,7 +924,7 @@ public Order stpAct(StpActEnum stpAct) { } /** - * Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled + * 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 * @return stpAct **/ @javax.annotation.Nullable @@ -938,7 +938,7 @@ public void setStpAct(StpActEnum stpAct) { } /** - * Order completion statuses include: - open: Awaiting processing - filled: Fully filled - cancelled: Cancelled by user - liquidate_cancelled: Cancelled due to liquidation - small: Order quantity too small - depth_not_enough: Cancelled due to insufficient market depth - trader_not_enough: Cancelled due to insufficient counterparty - ioc: Not immediately filled because tif is set to ioc - poc: Not met the order strategy because tif is set to poc - fok: Not fully filled immediately because tif is set to fok - stp: Cancelled due to self-trade prevention - unknown: Unknown + * 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 * @return finishAs **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/OrderBook.java b/src/main/java/io/gate/gateapi/models/OrderBook.java index 72e5482..7eb383a 100644 --- a/src/main/java/io/gate/gateapi/models/OrderBook.java +++ b/src/main/java/io/gate/gateapi/models/OrderBook.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -118,7 +118,7 @@ public OrderBook addAsksItem(List asksItem) { } /** - * Asks order depth + * Ask Depth * @return asks **/ public List> getAsks() { @@ -142,7 +142,7 @@ public OrderBook addBidsItem(List bidsItem) { } /** - * Bids order depth + * Bid Depth * @return bids **/ public List> getBids() { diff --git a/src/main/java/io/gate/gateapi/models/OrderCancel.java b/src/main/java/io/gate/gateapi/models/OrderCancel.java index 7524b4e..63a6ada 100644 --- a/src/main/java/io/gate/gateapi/models/OrderCancel.java +++ b/src/main/java/io/gate/gateapi/models/OrderCancel.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -121,7 +121,7 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { private String currencyPair; /** - * Order Type - limit : Limit Order - market : Market Order + * Order Type - limit : Limit Order - market : Market Order */ @JsonAdapter(TypeEnum.Adapter.class) public enum TypeEnum { @@ -176,7 +176,7 @@ public TypeEnum read(final JsonReader jsonReader) throws IOException { private String account = "spot"; /** - * Order side + * Buy or sell order */ @JsonAdapter(SideEnum.Adapter.class) public enum SideEnum { @@ -362,7 +362,7 @@ public TimeInForceEnum read(final JsonReader jsonReader) throws IOException { private Integer stpId; /** - * Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled + * 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 */ @JsonAdapter(StpActEnum.Adapter.class) public enum StpActEnum { @@ -525,7 +525,7 @@ public OrderCancel succeeded(Boolean succeeded) { } /** - * Whether the batch of orders succeeded + * Request execution result * @return succeeded **/ @javax.annotation.Nullable @@ -654,7 +654,7 @@ public OrderCancel type(TypeEnum type) { } /** - * Order Type - limit : Limit Order - market : Market Order + * Order Type - limit : Limit Order - market : Market Order * @return type **/ @javax.annotation.Nullable @@ -694,7 +694,7 @@ public OrderCancel side(SideEnum side) { } /** - * Order side + * Buy or sell order * @return side **/ public SideEnum getSide() { @@ -713,7 +713,7 @@ public OrderCancel amount(String amount) { } /** - * When `type` is limit, it refers to base currency. For instance, `BTC_USDT` means `BTC` When `type` is `market`, it refers to different currency according to `side` - `side` : `buy` means quote currency, `BTC_USDT` means `USDT` - `side` : `sell` means base currency，`BTC_USDT` means `BTC` + * 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` * @return amount **/ public String getAmount() { @@ -732,7 +732,7 @@ public OrderCancel price(String price) { } /** - * Price can't be empty when `type`= `limit` + * Trading price, required when `type`=`limit` * @return price **/ @javax.annotation.Nullable @@ -772,7 +772,7 @@ public OrderCancel iceberg(String iceberg) { } /** - * Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported. + * Amount to display for the iceberg order. Null or 0 for normal orders. Hiding all amount is not supported * @return iceberg **/ @javax.annotation.Nullable @@ -792,7 +792,7 @@ public OrderCancel autoBorrow(Boolean autoBorrow) { } /** - * Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough. + * Used in margin or cross margin trading to allow automatic loan of insufficient amount if balance is not enough * @return autoBorrow **/ @javax.annotation.Nullable @@ -812,7 +812,7 @@ public OrderCancel autoRepay(Boolean autoRepay) { } /** - * 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. + * 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 * @return autoRepay **/ @javax.annotation.Nullable @@ -836,7 +836,7 @@ public String getLeft() { /** - * Amount traded to fill + * Amount filled * @return filledAmount **/ @javax.annotation.Nullable @@ -916,7 +916,7 @@ public String getGtFee() { /** - * GT used to deduct maker fee + * GT amount used to deduct maker fee * @return gtMakerFee **/ @javax.annotation.Nullable @@ -926,7 +926,7 @@ public String getGtMakerFee() { /** - * GT used to deduct taker fee + * GT amount used to deduct taker fee * @return gtTakerFee **/ @javax.annotation.Nullable @@ -936,7 +936,7 @@ public String getGtTakerFee() { /** - * Whether GT fee discount is used + * Whether GT fee deduction is enabled * @return gtDiscount **/ @javax.annotation.Nullable @@ -982,7 +982,7 @@ public OrderCancel stpAct(StpActEnum stpAct) { } /** - * Self-Trading Prevention Action. Users can use this field to set self-trade prevetion strategies 1. After users join the `STP Group`, he can pass `stp_act` to limit the user's self-trade prevetion strategy. If `stp_act` is not passed, the default is `cn` strategy。 2. When the user does not join the `STP group`, an error will be returned when passing the `stp_act` parameter。 3. If the user did not use 'stp_act' when placing the order, 'stp_act' will return '-' - cn: Cancel newest, Cancel new orders and keep old ones - co: Cancel oldest, Cancel old orders and keep new ones - cb: Cancel both, Both old and new orders will be cancelled + * 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 * @return stpAct **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/OrderPatch.java b/src/main/java/io/gate/gateapi/models/OrderPatch.java index fcd63df..da8eeb3 100644 --- a/src/main/java/io/gate/gateapi/models/OrderPatch.java +++ b/src/main/java/io/gate/gateapi/models/OrderPatch.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -75,7 +75,7 @@ public OrderPatch account(String account) { } /** - * Specify query account. + * Specify query account * @return account **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public OrderPatch amount(String amount) { } /** - * New order amount. `amount` and `price` must specify one of them + * Trading quantity. Either `amount` or `price` must be specified * @return amount **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public OrderPatch price(String price) { } /** - * New order price. `amount` and `Price` must specify one of them\" + * Trading price. Either `amount` or `price` must be specified * @return price **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public OrderPatch amendText(String amendText) { } /** - * Custom info during amending order + * Custom info during order amendment * @return amendText **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/OrderResp.java b/src/main/java/io/gate/gateapi/models/OrderResp.java index f15981c..024ca14 100644 --- a/src/main/java/io/gate/gateapi/models/OrderResp.java +++ b/src/main/java/io/gate/gateapi/models/OrderResp.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/PartnerCommissionHistory.java b/src/main/java/io/gate/gateapi/models/PartnerCommissionHistory.java index a3f0cca..ee4d1d9 100644 --- a/src/main/java/io/gate/gateapi/models/PartnerCommissionHistory.java +++ b/src/main/java/io/gate/gateapi/models/PartnerCommissionHistory.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -70,7 +70,7 @@ public PartnerCommissionHistory addListItem(AgencyCommission listItem) { } /** - * List of comission history + * List of commission history * @return list **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/PartnerSub.java b/src/main/java/io/gate/gateapi/models/PartnerSub.java index 05c49a6..0a823f9 100644 --- a/src/main/java/io/gate/gateapi/models/PartnerSub.java +++ b/src/main/java/io/gate/gateapi/models/PartnerSub.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -63,7 +63,7 @@ public PartnerSub userJoinTime(Long userJoinTime) { } /** - * The time when the user joined the system, in seconds Unix timestamp + * Time when user joined the system, Unix timestamp in seconds * @return userJoinTime **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public PartnerSub type(Long type) { } /** - * Type (1-Sub-agent 2-Indirect Customer 3-Direct Customer) + * Type (1-Sub-agent 2-Indirect direct customer 3-Direct direct customer) * @return type **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/PartnerSubList.java b/src/main/java/io/gate/gateapi/models/PartnerSubList.java index bb20615..d316678 100644 --- a/src/main/java/io/gate/gateapi/models/PartnerSubList.java +++ b/src/main/java/io/gate/gateapi/models/PartnerSubList.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/PartnerTransactionHistory.java b/src/main/java/io/gate/gateapi/models/PartnerTransactionHistory.java index 3f4a366..0562ee3 100644 --- a/src/main/java/io/gate/gateapi/models/PartnerTransactionHistory.java +++ b/src/main/java/io/gate/gateapi/models/PartnerTransactionHistory.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/PatchUniLend.java b/src/main/java/io/gate/gateapi/models/PatchUniLend.java index 8cd0667..5015c6b 100644 --- a/src/main/java/io/gate/gateapi/models/PatchUniLend.java +++ b/src/main/java/io/gate/gateapi/models/PatchUniLend.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/PlaceDualInvestmentOrder.java b/src/main/java/io/gate/gateapi/models/PlaceDualInvestmentOrder.java index 62fbc1f..5fdd9da 100644 --- a/src/main/java/io/gate/gateapi/models/PlaceDualInvestmentOrder.java +++ b/src/main/java/io/gate/gateapi/models/PlaceDualInvestmentOrder.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Dual Investment order + * Dual Investment Order */ public class PlaceDualInvestmentOrder { public static final String SERIALIZED_NAME_PLAN_ID = "plan_id"; @@ -43,7 +43,7 @@ public PlaceDualInvestmentOrder planId(String planId) { } /** - * Plan ID + * Product ID * @return planId **/ public String getPlanId() { @@ -62,7 +62,7 @@ public PlaceDualInvestmentOrder amount(String amount) { } /** - * Subscription amount, mutually exclusive with the copies field + * Subscription amount, mutually exclusive with copies field * @return amount **/ public String getAmount() { @@ -81,7 +81,7 @@ public PlaceDualInvestmentOrder text(String text) { } /** - * 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(.) + * 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(.) * @return text **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/Position.java b/src/main/java/io/gate/gateapi/models/Position.java index a7a4bd8..ea48a8b 100644 --- a/src/main/java/io/gate/gateapi/models/Position.java +++ b/src/main/java/io/gate/gateapi/models/Position.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -129,7 +129,7 @@ public class Position { private PositionCloseOrder closeOrder; /** - * Position mode, including: - `single`: dual mode is not enabled- `dual_long`: long position in dual mode- `dual_short`: short position in dual mode + * Position mode, including: - `single`: Single position mode - `dual_long`: Long position in dual position mode - `dual_short`: Short position in dual position mode */ @JsonAdapter(ModeEnum.Adapter.class) public enum ModeEnum { @@ -197,6 +197,18 @@ public ModeEnum read(final JsonReader jsonReader) throws IOException { @SerializedName(SERIALIZED_NAME_OPEN_TIME) private Long openTime; + public static final String SERIALIZED_NAME_RISK_LIMIT_TABLE = "risk_limit_table"; + @SerializedName(SERIALIZED_NAME_RISK_LIMIT_TABLE) + private String riskLimitTable; + + public static final String SERIALIZED_NAME_AVERAGE_MAINTENANCE_RATE = "average_maintenance_rate"; + @SerializedName(SERIALIZED_NAME_AVERAGE_MAINTENANCE_RATE) + private String averageMaintenanceRate; + + public static final String SERIALIZED_NAME_PID = "pid"; + @SerializedName(SERIALIZED_NAME_PID) + private Long pid; + /** * User ID @@ -379,7 +391,7 @@ public String getUnrealisedPnl() { /** - * Realized PNL + * Realized PnL * @return realisedPnl **/ @javax.annotation.Nullable @@ -399,7 +411,7 @@ public String getPnlPnl() { /** - * Realized PNL - Funding Fees + * Realized PNL - Funding Fees * @return pnlFund **/ @javax.annotation.Nullable @@ -419,7 +431,7 @@ public String getPnlFee() { /** - * History realized PNL + * Total realized PnL from closed positions * @return historyPnl **/ @javax.annotation.Nullable @@ -469,7 +481,7 @@ public Integer getAdlRanking() { /** - * Current open orders + * Current pending order quantity * @return pendingOrders **/ @javax.annotation.Nullable @@ -505,7 +517,7 @@ public Position mode(ModeEnum mode) { } /** - * Position mode, including: - `single`: dual mode is not enabled- `dual_long`: long position in dual mode- `dual_short`: short position in dual mode + * Position mode, including: - `single`: Single position mode - `dual_long`: Long position in dual position mode - `dual_short`: Short position in dual position mode * @return mode **/ @javax.annotation.Nullable @@ -525,7 +537,7 @@ public Position crossLeverageLimit(String crossLeverageLimit) { } /** - * Cross margin leverage(valid only when `leverage` is 0) + * Cross margin leverage (valid only when `leverage` is 0) * @return crossLeverageLimit **/ @javax.annotation.Nullable @@ -549,7 +561,7 @@ public Long getUpdateTime() { /** - * Update id. Each time the position is updated, the value will be +1. + * Update ID. The value increments by 1 each time the position is updated * @return updateId **/ @javax.annotation.Nullable @@ -577,6 +589,36 @@ public Long getOpenTime() { public void setOpenTime(Long openTime) { this.openTime = openTime; } + + /** + * Risk limit table ID + * @return riskLimitTable + **/ + @javax.annotation.Nullable + public String getRiskLimitTable() { + return riskLimitTable; + } + + + /** + * Average maintenance margin rate + * @return averageMaintenanceRate + **/ + @javax.annotation.Nullable + public String getAverageMaintenanceRate() { + return averageMaintenanceRate; + } + + + /** + * Sub-account position ID + * @return pid + **/ + @javax.annotation.Nullable + public Long getPid() { + return pid; + } + @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -616,12 +658,15 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.crossLeverageLimit, position.crossLeverageLimit) && Objects.equals(this.updateTime, position.updateTime) && Objects.equals(this.updateId, position.updateId) && - Objects.equals(this.openTime, position.openTime); + Objects.equals(this.openTime, position.openTime) && + Objects.equals(this.riskLimitTable, position.riskLimitTable) && + Objects.equals(this.averageMaintenanceRate, position.averageMaintenanceRate) && + Objects.equals(this.pid, position.pid); } @Override public int hashCode() { - return Objects.hash(user, contract, size, leverage, riskLimit, leverageMax, maintenanceRate, value, margin, entryPrice, liqPrice, markPrice, initialMargin, maintenanceMargin, unrealisedPnl, realisedPnl, pnlPnl, pnlFund, pnlFee, historyPnl, lastClosePnl, realisedPoint, historyPoint, adlRanking, pendingOrders, closeOrder, mode, crossLeverageLimit, updateTime, updateId, openTime); + return Objects.hash(user, contract, size, leverage, riskLimit, leverageMax, maintenanceRate, value, margin, entryPrice, liqPrice, markPrice, initialMargin, maintenanceMargin, unrealisedPnl, realisedPnl, pnlPnl, pnlFund, pnlFee, historyPnl, lastClosePnl, realisedPoint, historyPoint, adlRanking, pendingOrders, closeOrder, mode, crossLeverageLimit, updateTime, updateId, openTime, riskLimitTable, averageMaintenanceRate, pid); } @@ -660,6 +705,9 @@ public String toString() { sb.append(" updateTime: ").append(toIndentedString(updateTime)).append("\n"); sb.append(" updateId: ").append(toIndentedString(updateId)).append("\n"); sb.append(" openTime: ").append(toIndentedString(openTime)).append("\n"); + sb.append(" riskLimitTable: ").append(toIndentedString(riskLimitTable)).append("\n"); + sb.append(" averageMaintenanceRate: ").append(toIndentedString(averageMaintenanceRate)).append("\n"); + sb.append(" pid: ").append(toIndentedString(pid)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/gate/gateapi/models/PositionClose.java b/src/main/java/io/gate/gateapi/models/PositionClose.java index 49cbf69..aacd6a0 100644 --- a/src/main/java/io/gate/gateapi/models/PositionClose.java +++ b/src/main/java/io/gate/gateapi/models/PositionClose.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -32,7 +32,7 @@ public class PositionClose { private String contract; /** - * Position side, long or short + * Position side - `long`: Long position - `short`: Short position */ @JsonAdapter(SideEnum.Adapter.class) public enum SideEnum { @@ -144,7 +144,7 @@ public String getContract() { /** - * Position side, long or short + * Position side - `long`: Long position - `short`: Short position * @return side **/ @javax.annotation.Nullable @@ -154,7 +154,7 @@ public SideEnum getSide() { /** - * PNL + * PnL * @return pnl **/ @javax.annotation.Nullable @@ -194,7 +194,7 @@ public String getPnlFee() { /** - * Text of close order + * Source of close order. See `order.text` field for specific values * @return text **/ @javax.annotation.Nullable @@ -234,7 +234,7 @@ public Long getFirstOpenTime() { /** - * When 'side' is 'long,' it indicates the opening average price; when 'side' is 'short,' it indicates the closing average price. + * When side is 'long', it indicates the opening average price; when side is 'short', it indicates the closing average price * @return longPrice **/ @javax.annotation.Nullable @@ -244,7 +244,7 @@ public String getLongPrice() { /** - * When 'side' is 'long,' it indicates the opening average price; when 'side' is 'short,' it indicates the closing average price + * When side is 'long', it indicates the closing average price; when side is 'short', it indicates the opening average price * @return shortPrice **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/PositionCloseOrder.java b/src/main/java/io/gate/gateapi/models/PositionCloseOrder.java index 7f1dd25..b771436 100644 --- a/src/main/java/io/gate/gateapi/models/PositionCloseOrder.java +++ b/src/main/java/io/gate/gateapi/models/PositionCloseOrder.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Current close order if any, or `null` + * Current close order information, or `null` if no close order */ public class PositionCloseOrder { public static final String SERIALIZED_NAME_ID = "id"; @@ -43,7 +43,7 @@ public PositionCloseOrder id(Long id) { } /** - * Close order ID + * Order ID * @return id **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public PositionCloseOrder price(String price) { } /** - * Close order price + * Order price * @return price **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public PositionCloseOrder isLiq(Boolean isLiq) { } /** - * Is the close order from liquidation + * Whether the close order is from liquidation * @return isLiq **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/ProfitLossRange.java b/src/main/java/io/gate/gateapi/models/ProfitLossRange.java index e1c55c6..55b7200 100644 --- a/src/main/java/io/gate/gateapi/models/ProfitLossRange.java +++ b/src/main/java/io/gate/gateapi/models/ProfitLossRange.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -83,7 +83,7 @@ public ProfitLossRange profitLoss(String profitLoss) { } /** - * PNL + * PnL * @return profitLoss **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/RebateUserInfo.java b/src/main/java/io/gate/gateapi/models/RebateUserInfo.java index 9da84bb..f30b2ed 100644 --- a/src/main/java/io/gate/gateapi/models/RebateUserInfo.java +++ b/src/main/java/io/gate/gateapi/models/RebateUserInfo.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/RepayCurrencyRes.java b/src/main/java/io/gate/gateapi/models/RepayCurrencyRes.java index 0d9576b..a0a4f3b 100644 --- a/src/main/java/io/gate/gateapi/models/RepayCurrencyRes.java +++ b/src/main/java/io/gate/gateapi/models/RepayCurrencyRes.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -55,7 +55,7 @@ public RepayCurrencyRes succeeded(Boolean succeeded) { } /** - * Has the repayment been successful + * Whether the repayment was successful * @return succeeded **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public RepayCurrencyRes label(String label) { } /** - * Error identifier for unsuccessful operations; empty for successful. + * Error identifier for failed operations; empty when successful * @return label **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public RepayCurrencyRes message(String message) { } /** - * Error description in case of operation failure; empty when successful. + * Error description for failed operations; empty when successful * @return message **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/RepayLoan.java b/src/main/java/io/gate/gateapi/models/RepayLoan.java index 5b78c48..a1ab151 100644 --- a/src/main/java/io/gate/gateapi/models/RepayLoan.java +++ b/src/main/java/io/gate/gateapi/models/RepayLoan.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -81,7 +81,7 @@ public RepayLoan repaidAll(Boolean repaidAll) { } /** - * Repayment method, set to `true` for full repayment, and `false` for partial repayment; When set to false for partial repayment, the repay_amount parameter cannot be greater than the remaining amount to be repaid by the user. + * 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. * @return repaidAll **/ public Boolean getRepaidAll() { diff --git a/src/main/java/io/gate/gateapi/models/RepayMultiLoan.java b/src/main/java/io/gate/gateapi/models/RepayMultiLoan.java index 362e2a6..7cb7157 100644 --- a/src/main/java/io/gate/gateapi/models/RepayMultiLoan.java +++ b/src/main/java/io/gate/gateapi/models/RepayMultiLoan.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -23,7 +23,7 @@ import java.util.List; /** - * Repay Multi-Collateral Loan + * Multi-currency collateral repayment */ public class RepayMultiLoan { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; diff --git a/src/main/java/io/gate/gateapi/models/RepayRecord.java b/src/main/java/io/gate/gateapi/models/RepayRecord.java index 6b7fa64..ca9dee6 100644 --- a/src/main/java/io/gate/gateapi/models/RepayRecord.java +++ b/src/main/java/io/gate/gateapi/models/RepayRecord.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -163,7 +163,7 @@ public RepayRecord collateralCurrency(String collateralCurrency) { } /** - * Collateral + * Collateral currency * @return collateralCurrency **/ @javax.annotation.Nullable @@ -183,7 +183,7 @@ public RepayRecord initLtv(String initLtv) { } /** - * The initial collateralization rate + * Initial collateralization rate * @return initLtv **/ @javax.annotation.Nullable @@ -303,7 +303,7 @@ public RepayRecord beforeLeftCollateral(String beforeLeftCollateral) { } /** - * Collateral quantity before repayment + * Collateral amount before repayment * @return beforeLeftCollateral **/ @javax.annotation.Nullable @@ -323,7 +323,7 @@ public RepayRecord afterLeftCollateral(String afterLeftCollateral) { } /** - * Collateral quantity after repayment + * Collateral amount after repayment * @return afterLeftCollateral **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/RepayRecordCurrency.java b/src/main/java/io/gate/gateapi/models/RepayRecordCurrency.java index dc3e902..e579cce 100644 --- a/src/main/java/io/gate/gateapi/models/RepayRecordCurrency.java +++ b/src/main/java/io/gate/gateapi/models/RepayRecordCurrency.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -115,7 +115,7 @@ public RepayRecordCurrency beforeAmountUsdt(String beforeAmountUsdt) { } /** - * USDT Amount before the operation. + * USDT Amount before the operation * @return beforeAmountUsdt **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public RepayRecordCurrency afterAmount(String afterAmount) { } /** - * Amount after the operation. + * Amount after the operation * @return afterAmount **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public RepayRecordCurrency afterAmountUsdt(String afterAmountUsdt) { } /** - * USDT Amount after the operation. + * USDT Amount after the operation * @return afterAmountUsdt **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/RepayRecordLeftInterest.java b/src/main/java/io/gate/gateapi/models/RepayRecordLeftInterest.java index 248b868..3c2660e 100644 --- a/src/main/java/io/gate/gateapi/models/RepayRecordLeftInterest.java +++ b/src/main/java/io/gate/gateapi/models/RepayRecordLeftInterest.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/RepayRecordRepaidCurrency.java b/src/main/java/io/gate/gateapi/models/RepayRecordRepaidCurrency.java index 882f006..7c38ec2 100644 --- a/src/main/java/io/gate/gateapi/models/RepayRecordRepaidCurrency.java +++ b/src/main/java/io/gate/gateapi/models/RepayRecordRepaidCurrency.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -155,7 +155,7 @@ public RepayRecordRepaidCurrency repaidAmountUsdt(String repaidAmountUsdt) { } /** - * Value of the repayment amount in USDT + * Repayment amount converted to USDT * @return repaidAmountUsdt **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/RepayRecordTotalInterest.java b/src/main/java/io/gate/gateapi/models/RepayRecordTotalInterest.java index 24f8c6e..1d03f57 100644 --- a/src/main/java/io/gate/gateapi/models/RepayRecordTotalInterest.java +++ b/src/main/java/io/gate/gateapi/models/RepayRecordTotalInterest.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/RepayResp.java b/src/main/java/io/gate/gateapi/models/RepayResp.java index 72cb7d7..708657a 100644 --- a/src/main/java/io/gate/gateapi/models/RepayResp.java +++ b/src/main/java/io/gate/gateapi/models/RepayResp.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/RiskUnits.java b/src/main/java/io/gate/gateapi/models/RiskUnits.java index 4689568..852809f 100644 --- a/src/main/java/io/gate/gateapi/models/RiskUnits.java +++ b/src/main/java/io/gate/gateapi/models/RiskUnits.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -83,7 +83,7 @@ public RiskUnits spotInUse(String spotInUse) { } /** - * Spot hedging utilization + * Spot hedging occupied amount * @return spotInUse **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SavedAddress.java b/src/main/java/io/gate/gateapi/models/SavedAddress.java index 76b0d9d..5194f10 100644 --- a/src/main/java/io/gate/gateapi/models/SavedAddress.java +++ b/src/main/java/io/gate/gateapi/models/SavedAddress.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/SmallBalance.java b/src/main/java/io/gate/gateapi/models/SmallBalance.java index bd7f842..64c9113 100644 --- a/src/main/java/io/gate/gateapi/models/SmallBalance.java +++ b/src/main/java/io/gate/gateapi/models/SmallBalance.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Convert Small Balance + * Small Balance Conversion */ public class SmallBalance { public static final String SERIALIZED_NAME_CURRENCY = "currency"; diff --git a/src/main/java/io/gate/gateapi/models/SmallBalanceHistory.java b/src/main/java/io/gate/gateapi/models/SmallBalanceHistory.java index 42b4e86..e1de3e3 100644 --- a/src/main/java/io/gate/gateapi/models/SmallBalanceHistory.java +++ b/src/main/java/io/gate/gateapi/models/SmallBalanceHistory.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Convert Small Balance + * Small Balance Conversion */ public class SmallBalanceHistory { public static final String SERIALIZED_NAME_ID = "id"; @@ -65,7 +65,7 @@ public String getCurrency() { /** - * amount + * Swap Amount * @return amount **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SpotAccount.java b/src/main/java/io/gate/gateapi/models/SpotAccount.java index 929402d..6bff1ce 100644 --- a/src/main/java/io/gate/gateapi/models/SpotAccount.java +++ b/src/main/java/io/gate/gateapi/models/SpotAccount.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/SpotAccountBook.java b/src/main/java/io/gate/gateapi/models/SpotAccountBook.java index 82b375e..f4f618d 100644 --- a/src/main/java/io/gate/gateapi/models/SpotAccountBook.java +++ b/src/main/java/io/gate/gateapi/models/SpotAccountBook.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -163,7 +163,7 @@ public SpotAccountBook type(String type) { } /** - * Account book type. Please refer to [account book type](#accountbook-type) for more detail + * Account book type. Please refer to [account book type](#accountbook-type) for more detail * @return type **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SpotCurrencyChain.java b/src/main/java/io/gate/gateapi/models/SpotCurrencyChain.java index 399e6ff..057a732 100644 --- a/src/main/java/io/gate/gateapi/models/SpotCurrencyChain.java +++ b/src/main/java/io/gate/gateapi/models/SpotCurrencyChain.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -51,7 +51,7 @@ public SpotCurrencyChain name(String name) { } /** - * Chain name + * Blockchain name * @return name **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SpotFee.java b/src/main/java/io/gate/gateapi/models/SpotFee.java index dcefeb9..d81a14e 100644 --- a/src/main/java/io/gate/gateapi/models/SpotFee.java +++ b/src/main/java/io/gate/gateapi/models/SpotFee.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -131,7 +131,7 @@ public SpotFee gtDiscount(Boolean gtDiscount) { } /** - * If GT deduction is enabled + * Whether GT deduction discount is enabled * @return gtDiscount **/ @javax.annotation.Nullable @@ -171,7 +171,7 @@ public SpotFee gtMakerFee(String gtMakerFee) { } /** - * Maker fee rate if using GT deduction. It will be 0 if GT deduction is disabled + * Maker fee rate with GT deduction. Returns 0 if GT deduction is disabled * @return gtMakerFee **/ @javax.annotation.Nullable @@ -211,7 +211,7 @@ public SpotFee pointType(String pointType) { } /** - * Point type. 0 - Initial version. 1 - new version since 202009 + * Point card type: 0 - Original version, 1 - New version since 202009 * @return pointType **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SpotInsuranceHistory.java b/src/main/java/io/gate/gateapi/models/SpotInsuranceHistory.java index 8fb839d..36464d2 100644 --- a/src/main/java/io/gate/gateapi/models/SpotInsuranceHistory.java +++ b/src/main/java/io/gate/gateapi/models/SpotInsuranceHistory.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -63,7 +63,7 @@ public SpotInsuranceHistory balance(String balance) { } /** - * balance + * Balance * @return balance **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SpotPricePutOrder.java b/src/main/java/io/gate/gateapi/models/SpotPricePutOrder.java index 23be167..ee0739b 100644 --- a/src/main/java/io/gate/gateapi/models/SpotPricePutOrder.java +++ b/src/main/java/io/gate/gateapi/models/SpotPricePutOrder.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -134,7 +134,7 @@ public SideEnum read(final JsonReader jsonReader) throws IOException { private String amount; /** - * Trading account type. Portfolio margin account must set to `unified` - normal: spot trading - margin: margin trading - unified: unified trading + * Trading account type. Unified account must be set to `unified` - normal: spot trading - margin: margin trading - unified: unified account */ @JsonAdapter(AccountEnum.Adapter.class) public enum AccountEnum { @@ -315,7 +315,7 @@ public SpotPricePutOrder amount(String amount) { } /** - * When `type` is limit, it refers to base currency. For instance, `BTC_USDT` means `BTC` When `type` is `market`, it refers to different currency according to `side` - `side` : `buy` means quote currency, `BTC_USDT` means `USDT` - `side` : `sell` means base currency，`BTC_USDT` means `BTC` + * 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` * @return amount **/ public String getAmount() { @@ -334,7 +334,7 @@ public SpotPricePutOrder account(AccountEnum account) { } /** - * Trading account type. Portfolio margin account must set to `unified` - normal: spot trading - margin: margin trading - unified: unified trading + * Trading account type. Unified account must be set to `unified` - normal: spot trading - margin: margin trading - unified: unified account * @return account **/ public AccountEnum getAccount() { @@ -413,7 +413,7 @@ public SpotPricePutOrder text(String text) { } /** - * The source of the order, including: - web: web - api: api - app: app + * The source of the order, including: - web: Web - api: API call - app: Mobile app * @return text **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SpotPriceTrigger.java b/src/main/java/io/gate/gateapi/models/SpotPriceTrigger.java index 2ba9356..843ec5f 100644 --- a/src/main/java/io/gate/gateapi/models/SpotPriceTrigger.java +++ b/src/main/java/io/gate/gateapi/models/SpotPriceTrigger.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -28,7 +28,7 @@ public class SpotPriceTrigger { private String price; /** - * Price trigger condition - >=: triggered when market price larger than or equal to `price` field - <=: triggered when market price less than or equal to `price` field + * 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` */ @JsonAdapter(RuleEnum.Adapter.class) public enum RuleEnum { @@ -109,7 +109,7 @@ public SpotPriceTrigger rule(RuleEnum rule) { } /** - * Price trigger condition - >=: triggered when market price larger than or equal to `price` field - <=: triggered when market price less than or equal to `price` field + * 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` * @return rule **/ public RuleEnum getRule() { @@ -128,7 +128,7 @@ public SpotPriceTrigger expiration(Integer expiration) { } /** - * How long (in seconds) to wait for the condition to be triggered before cancelling the order. + * Maximum wait time for trigger condition (in seconds). Order will be cancelled if timeout * @return expiration **/ public Integer getExpiration() { diff --git a/src/main/java/io/gate/gateapi/models/SpotPriceTriggeredOrder.java b/src/main/java/io/gate/gateapi/models/SpotPriceTriggeredOrder.java index b38d095..c4dd8e0 100644 --- a/src/main/java/io/gate/gateapi/models/SpotPriceTriggeredOrder.java +++ b/src/main/java/io/gate/gateapi/models/SpotPriceTriggeredOrder.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -22,7 +22,7 @@ import java.io.IOException; /** - * Spot order detail + * Spot price order details */ public class SpotPriceTriggeredOrder { public static final String SERIALIZED_NAME_TRIGGER = "trigger"; @@ -131,7 +131,7 @@ public SpotPriceTriggeredOrder market(String market) { } /** - * Currency pair + * Market * @return market **/ public String getMarket() { @@ -144,7 +144,7 @@ public void setMarket(String market) { } /** - * Creation time + * Created time * @return ctime **/ @javax.annotation.Nullable @@ -154,7 +154,7 @@ public Long getCtime() { /** - * Finished time + * End time * @return ftime **/ @javax.annotation.Nullable @@ -164,7 +164,7 @@ public Long getFtime() { /** - * ID of the newly created order on condition triggered + * ID of the order created after trigger * @return firedOrderId **/ @javax.annotation.Nullable @@ -174,7 +174,7 @@ public Long getFiredOrderId() { /** - * Status - open: open - cancelled: being manually cancelled - finish: successfully executed - failed: failed to execute - expired - expired + * Status - open: Running - cancelled: Manually cancelled - finish: Successfully completed - failed: Failed to execute - expired: Expired * @return status **/ @javax.annotation.Nullable @@ -184,7 +184,7 @@ public String getStatus() { /** - * Additional remarks on how the order was finished + * Additional description of how the order was completed * @return reason **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/StpGroup.java b/src/main/java/io/gate/gateapi/models/StpGroup.java index e50faf2..bc53e57 100644 --- a/src/main/java/io/gate/gateapi/models/StpGroup.java +++ b/src/main/java/io/gate/gateapi/models/StpGroup.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -106,7 +106,7 @@ public StpGroup createTime(Long createTime) { } /** - * Creation time + * Created time * @return createTime **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/StpGroupUser.java b/src/main/java/io/gate/gateapi/models/StpGroupUser.java index 864e5fc..f69d405 100644 --- a/src/main/java/io/gate/gateapi/models/StpGroupUser.java +++ b/src/main/java/io/gate/gateapi/models/StpGroupUser.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -83,7 +83,7 @@ public StpGroupUser createTime(Long createTime) { } /** - * Creation time + * Created time * @return createTime **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/StructuredBuy.java b/src/main/java/io/gate/gateapi/models/StructuredBuy.java index d262e96..999fc46 100644 --- a/src/main/java/io/gate/gateapi/models/StructuredBuy.java +++ b/src/main/java/io/gate/gateapi/models/StructuredBuy.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Dual Investment Purchase + * Dual Investment Buy */ public class StructuredBuy { public static final String SERIALIZED_NAME_PID = "pid"; @@ -39,7 +39,7 @@ public StructuredBuy pid(String pid) { } /** - * Plan ID + * Product ID * @return pid **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public StructuredBuy amount(String amount) { } /** - * Purchase Amount + * Buy Quantity * @return amount **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/StructuredGetProjectList.java b/src/main/java/io/gate/gateapi/models/StructuredGetProjectList.java index f0dddf8..11bcdd9 100644 --- a/src/main/java/io/gate/gateapi/models/StructuredGetProjectList.java +++ b/src/main/java/io/gate/gateapi/models/StructuredGetProjectList.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Structured Products + * Structured Investment */ public class StructuredGetProjectList { public static final String SERIALIZED_NAME_ID = "id"; @@ -79,7 +79,7 @@ public StructuredGetProjectList id(Integer id) { } /** - * Plan ID + * Product ID * @return id **/ @javax.annotation.Nullable @@ -99,7 +99,7 @@ public StructuredGetProjectList type(String type) { } /** - * 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 + * 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 * @return type **/ @javax.annotation.Nullable @@ -119,7 +119,7 @@ public StructuredGetProjectList nameEn(String nameEn) { } /** - * name + * Product Name * @return nameEn **/ @javax.annotation.Nullable @@ -139,7 +139,7 @@ public StructuredGetProjectList investmentCoin(String investmentCoin) { } /** - * Investment Currency + * Investment Token * @return investmentCoin **/ @javax.annotation.Nullable @@ -159,7 +159,7 @@ public StructuredGetProjectList investmentPeriod(String investmentPeriod) { } /** - * Investment term + * Investment Period * @return investmentPeriod **/ @javax.annotation.Nullable @@ -179,7 +179,7 @@ public StructuredGetProjectList minAnnualRate(String minAnnualRate) { } /** - * Minimum annual rate + * Minimum Annual Rate * @return minAnnualRate **/ @javax.annotation.Nullable @@ -199,7 +199,7 @@ public StructuredGetProjectList midAnnualRate(String midAnnualRate) { } /** - * Intermediate annual rate + * Intermediate Annual Rate * @return midAnnualRate **/ @javax.annotation.Nullable @@ -219,7 +219,7 @@ public StructuredGetProjectList maxAnnualRate(String maxAnnualRate) { } /** - * Maximum annual rate + * Maximum Annual Rate * @return maxAnnualRate **/ @javax.annotation.Nullable @@ -239,7 +239,7 @@ public StructuredGetProjectList watchMarket(String watchMarket) { } /** - * Watch market + * Underlying Market * @return watchMarket **/ @javax.annotation.Nullable @@ -259,7 +259,7 @@ public StructuredGetProjectList startTime(Integer startTime) { } /** - * start time + * Start Time * @return startTime **/ @javax.annotation.Nullable @@ -279,7 +279,7 @@ public StructuredGetProjectList endTime(Integer endTime) { } /** - * Finished time + * End time * @return endTime **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/StructuredOrderList.java b/src/main/java/io/gate/gateapi/models/StructuredOrderList.java index 9a266de..dd1e269 100644 --- a/src/main/java/io/gate/gateapi/models/StructuredOrderList.java +++ b/src/main/java/io/gate/gateapi/models/StructuredOrderList.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -79,7 +79,7 @@ public StructuredOrderList pid(String pid) { } /** - * Plan ID + * Product ID * @return pid **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SubAccount.java b/src/main/java/io/gate/gateapi/models/SubAccount.java index ede3d21..29635d8 100644 --- a/src/main/java/io/gate/gateapi/models/SubAccount.java +++ b/src/main/java/io/gate/gateapi/models/SubAccount.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -63,7 +63,7 @@ public SubAccount remark(String remark) { } /** - * custom text + * Remark * @return remark **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public SubAccount loginName(String loginName) { } /** - * Sub-account login name: Only letters, numbers and underscores are supported, and cannot contain other illegal characters + * Sub-account login name: Only letters, numbers and underscores are supported, cannot contain other invalid characters * @return loginName **/ public String getLoginName() { @@ -136,7 +136,7 @@ public void setEmail(String email) { } /** - * State: 1-normal, 2-locked\" + * Sub-account status: 1-normal, 2-locked * @return state **/ @javax.annotation.Nullable @@ -146,7 +146,7 @@ public Integer getState() { /** - * \"Sub-account type: 1 - sub-account, 3 - cross margin account + * Sub-account type: 1-Regular sub-account, 3-Cross margin sub-account * @return type **/ @javax.annotation.Nullable @@ -156,7 +156,7 @@ public Integer getType() { /** - * The user id of the sub-account + * Sub-account user ID * @return userId **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SubAccountBalance.java b/src/main/java/io/gate/gateapi/models/SubAccountBalance.java index 836efb6..802a901 100644 --- a/src/main/java/io/gate/gateapi/models/SubAccountBalance.java +++ b/src/main/java/io/gate/gateapi/models/SubAccountBalance.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/SubAccountCrossMarginBalance.java b/src/main/java/io/gate/gateapi/models/SubAccountCrossMarginBalance.java index b8045f2..b1b2c3f 100644 --- a/src/main/java/io/gate/gateapi/models/SubAccountCrossMarginBalance.java +++ b/src/main/java/io/gate/gateapi/models/SubAccountCrossMarginBalance.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/SubAccountFuturesBalance.java b/src/main/java/io/gate/gateapi/models/SubAccountFuturesBalance.java index da7fe1c..8b01461 100644 --- a/src/main/java/io/gate/gateapi/models/SubAccountFuturesBalance.java +++ b/src/main/java/io/gate/gateapi/models/SubAccountFuturesBalance.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/SubAccountKey.java b/src/main/java/io/gate/gateapi/models/SubAccountKey.java index 3ffbd44..3725e4b 100644 --- a/src/main/java/io/gate/gateapi/models/SubAccountKey.java +++ b/src/main/java/io/gate/gateapi/models/SubAccountKey.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -28,7 +28,7 @@ public class SubAccountKey { public static final String SERIALIZED_NAME_USER_ID = "user_id"; @SerializedName(SERIALIZED_NAME_USER_ID) - private String userId; + private Long userId; public static final String SERIALIZED_NAME_MODE = "mode"; @SerializedName(SERIALIZED_NAME_MODE) @@ -72,7 +72,7 @@ public class SubAccountKey { * @return userId **/ @javax.annotation.Nullable - public String getUserId() { + public Long getUserId() { return userId; } @@ -104,7 +104,7 @@ public SubAccountKey name(String name) { } /** - * API key name + * API Key Name * @return name **/ @javax.annotation.Nullable @@ -160,7 +160,7 @@ public SubAccountKey addIpWhitelistItem(String ipWhitelistItem) { } /** - * ip white list (list will be removed if no value is passed) + * IP whitelist (list will be cleared if no value is passed) * @return ipWhitelist **/ @javax.annotation.Nullable @@ -184,7 +184,7 @@ public String getKey() { /** - * State 1 - normal 2 - locked 3 - frozen + * Status: 1-Normal 2-Frozen 3-Locked * @return state **/ @javax.annotation.Nullable @@ -194,7 +194,7 @@ public Integer getState() { /** - * Creation time + * Created time * @return createdAt **/ @javax.annotation.Nullable @@ -204,7 +204,7 @@ public Long getCreatedAt() { /** - * Last update time + * Last Update Time * @return updatedAt **/ @javax.annotation.Nullable @@ -214,7 +214,7 @@ public Long getUpdatedAt() { /** - * Last access time + * Last Access Time * @return lastAccess **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SubAccountKeyPerms.java b/src/main/java/io/gate/gateapi/models/SubAccountKeyPerms.java index bdcd639..6133f8a 100644 --- a/src/main/java/io/gate/gateapi/models/SubAccountKeyPerms.java +++ b/src/main/java/io/gate/gateapi/models/SubAccountKeyPerms.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -39,7 +39,7 @@ public SubAccountKeyPerms name(String name) { } /** - * 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 + * 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 * @return name **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public SubAccountKeyPerms readOnly(Boolean readOnly) { } /** - * read only + * Read Only * @return readOnly **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SubAccountMarginBalance.java b/src/main/java/io/gate/gateapi/models/SubAccountMarginBalance.java index 7540dec..6f1dae5 100644 --- a/src/main/java/io/gate/gateapi/models/SubAccountMarginBalance.java +++ b/src/main/java/io/gate/gateapi/models/SubAccountMarginBalance.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/SubAccountToSubAccount.java b/src/main/java/io/gate/gateapi/models/SubAccountToSubAccount.java index 89f839c..9d99d91 100644 --- a/src/main/java/io/gate/gateapi/models/SubAccountToSubAccount.java +++ b/src/main/java/io/gate/gateapi/models/SubAccountToSubAccount.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -78,7 +78,7 @@ public SubAccountToSubAccount subAccountType(String subAccountType) { } /** - * Transfer from the account. (deprecate, use `sub_account_from_type` and `sub_account_to_type` instead) + * Transfer from account (deprecated, use `sub_account_from_type` and `sub_account_to_type` instead) * @return subAccountType **/ @javax.annotation.Nullable @@ -117,7 +117,7 @@ public SubAccountToSubAccount subAccountFromType(String subAccountFromType) { } /** - * The sub-account's outgoing trading account, spot - spot account, futures - perpetual contract account, delivery - delivery contract account. + * Source sub-account trading account: spot - spot account, futures - perpetual contract account, delivery - delivery contract account * @return subAccountFromType **/ public String getSubAccountFromType() { @@ -155,7 +155,7 @@ public SubAccountToSubAccount subAccountToType(String subAccountToType) { } /** - * The sub-account's incoming trading account, spot - spot account, futures - perpetual contract account, delivery - delivery contract account + * Target sub-account trading account: spot - spot account, futures - perpetual contract account, delivery - delivery contract account * @return subAccountToType **/ public String getSubAccountToType() { diff --git a/src/main/java/io/gate/gateapi/models/SubAccountTransfer.java b/src/main/java/io/gate/gateapi/models/SubAccountTransfer.java index 26aa343..e8273e7 100644 --- a/src/main/java/io/gate/gateapi/models/SubAccountTransfer.java +++ b/src/main/java/io/gate/gateapi/models/SubAccountTransfer.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -23,14 +23,6 @@ * SubAccountTransfer */ public class SubAccountTransfer { - public static final String SERIALIZED_NAME_TIMEST = "timest"; - @SerializedName(SERIALIZED_NAME_TIMEST) - private String timest; - - public static final String SERIALIZED_NAME_UID = "uid"; - @SerializedName(SERIALIZED_NAME_UID) - private String uid; - public static final String SERIALIZED_NAME_SUB_ACCOUNT = "sub_account"; @SerializedName(SERIALIZED_NAME_SUB_ACCOUNT) private String subAccount; @@ -51,38 +43,10 @@ public class SubAccountTransfer { @SerializedName(SERIALIZED_NAME_DIRECTION) private String direction; - public static final String SERIALIZED_NAME_SOURCE = "source"; - @SerializedName(SERIALIZED_NAME_SOURCE) - private String source; - public static final String SERIALIZED_NAME_CLIENT_ORDER_ID = "client_order_id"; @SerializedName(SERIALIZED_NAME_CLIENT_ORDER_ID) private String clientOrderId; - public static final String SERIALIZED_NAME_STATUS = "status"; - @SerializedName(SERIALIZED_NAME_STATUS) - private String status; - - - /** - * Transfer timestamp - * @return timest - **/ - @javax.annotation.Nullable - public String getTimest() { - return timest; - } - - - /** - * Main account user ID - * @return uid - **/ - @javax.annotation.Nullable - public String getUid() { - return uid; - } - public SubAccountTransfer subAccount(String subAccount) { @@ -110,7 +74,7 @@ public SubAccountTransfer subAccountType(String subAccountType) { } /** - * Target sub user's account. `spot` - spot account, `futures` - perpetual contract account, `delivery` - delivery account + * Target sub-account trading account: spot - spot account, futures - perpetual contract account, delivery - delivery contract account, options - options account * @return subAccountType **/ @javax.annotation.Nullable @@ -168,7 +132,7 @@ public SubAccountTransfer direction(String direction) { } /** - * Transfer direction. to - transfer into sub account; from - transfer out from sub account + * Transfer direction: to - transfer into sub-account, from - transfer out from sub-account * @return direction **/ public String getDirection() { @@ -180,16 +144,6 @@ public void setDirection(String direction) { this.direction = direction; } - /** - * Where the operation is initiated from - * @return source - **/ - @javax.annotation.Nullable - public String getSource() { - return source; - } - - public SubAccountTransfer clientOrderId(String clientOrderId) { this.clientOrderId = clientOrderId; @@ -197,7 +151,7 @@ public SubAccountTransfer clientOrderId(String clientOrderId) { } /** - * 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. + * 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 * @return clientOrderId **/ @javax.annotation.Nullable @@ -209,26 +163,6 @@ public String getClientOrderId() { public void setClientOrderId(String clientOrderId) { this.clientOrderId = clientOrderId; } - - public SubAccountTransfer status(String status) { - - this.status = status; - return this; - } - - /** - * Sub-account transfer record status, currently only success - * @return status - **/ - @javax.annotation.Nullable - public String getStatus() { - return status; - } - - - public void setStatus(String status) { - this.status = status; - } @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -238,21 +172,17 @@ public boolean equals(java.lang.Object o) { return false; } SubAccountTransfer subAccountTransfer = (SubAccountTransfer) o; - return Objects.equals(this.timest, subAccountTransfer.timest) && - Objects.equals(this.uid, subAccountTransfer.uid) && - Objects.equals(this.subAccount, subAccountTransfer.subAccount) && + return Objects.equals(this.subAccount, subAccountTransfer.subAccount) && Objects.equals(this.subAccountType, subAccountTransfer.subAccountType) && Objects.equals(this.currency, subAccountTransfer.currency) && Objects.equals(this.amount, subAccountTransfer.amount) && Objects.equals(this.direction, subAccountTransfer.direction) && - Objects.equals(this.source, subAccountTransfer.source) && - Objects.equals(this.clientOrderId, subAccountTransfer.clientOrderId) && - Objects.equals(this.status, subAccountTransfer.status); + Objects.equals(this.clientOrderId, subAccountTransfer.clientOrderId); } @Override public int hashCode() { - return Objects.hash(timest, uid, subAccount, subAccountType, currency, amount, direction, source, clientOrderId, status); + return Objects.hash(subAccount, subAccountType, currency, amount, direction, clientOrderId); } @@ -260,16 +190,12 @@ public int hashCode() { public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class SubAccountTransfer {\n"); - sb.append(" timest: ").append(toIndentedString(timest)).append("\n"); - sb.append(" uid: ").append(toIndentedString(uid)).append("\n"); sb.append(" subAccount: ").append(toIndentedString(subAccount)).append("\n"); sb.append(" subAccountType: ").append(toIndentedString(subAccountType)).append("\n"); sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); sb.append(" amount: ").append(toIndentedString(amount)).append("\n"); sb.append(" direction: ").append(toIndentedString(direction)).append("\n"); - sb.append(" source: ").append(toIndentedString(source)).append("\n"); sb.append(" clientOrderId: ").append(toIndentedString(clientOrderId)).append("\n"); - sb.append(" status: ").append(toIndentedString(status)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/gate/gateapi/models/SubAccountTransferRecordItem.java b/src/main/java/io/gate/gateapi/models/SubAccountTransferRecordItem.java new file mode 100644 index 0000000..4bdc741 --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/SubAccountTransferRecordItem.java @@ -0,0 +1,289 @@ +/* + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package io.gate.gateapi.models; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; + +/** + * SubAccountTransferRecordItem + */ +public class SubAccountTransferRecordItem { + public static final String SERIALIZED_NAME_TIMEST = "timest"; + @SerializedName(SERIALIZED_NAME_TIMEST) + private String timest; + + public static final String SERIALIZED_NAME_UID = "uid"; + @SerializedName(SERIALIZED_NAME_UID) + private String uid; + + public static final String SERIALIZED_NAME_SUB_ACCOUNT = "sub_account"; + @SerializedName(SERIALIZED_NAME_SUB_ACCOUNT) + private String subAccount; + + public static final String SERIALIZED_NAME_SUB_ACCOUNT_TYPE = "sub_account_type"; + @SerializedName(SERIALIZED_NAME_SUB_ACCOUNT_TYPE) + private String subAccountType = "spot"; + + public static final String SERIALIZED_NAME_CURRENCY = "currency"; + @SerializedName(SERIALIZED_NAME_CURRENCY) + private String currency; + + public static final String SERIALIZED_NAME_AMOUNT = "amount"; + @SerializedName(SERIALIZED_NAME_AMOUNT) + private String amount; + + public static final String SERIALIZED_NAME_DIRECTION = "direction"; + @SerializedName(SERIALIZED_NAME_DIRECTION) + private String direction; + + public static final String SERIALIZED_NAME_SOURCE = "source"; + @SerializedName(SERIALIZED_NAME_SOURCE) + private String source; + + public static final String SERIALIZED_NAME_CLIENT_ORDER_ID = "client_order_id"; + @SerializedName(SERIALIZED_NAME_CLIENT_ORDER_ID) + private String clientOrderId; + + public static final String SERIALIZED_NAME_STATUS = "status"; + @SerializedName(SERIALIZED_NAME_STATUS) + private String status; + + + /** + * Transfer timestamp + * @return timest + **/ + @javax.annotation.Nullable + public String getTimest() { + return timest; + } + + + /** + * Main account user ID + * @return uid + **/ + @javax.annotation.Nullable + public String getUid() { + return uid; + } + + + public SubAccountTransferRecordItem subAccount(String subAccount) { + + this.subAccount = subAccount; + return this; + } + + /** + * Sub account user ID + * @return subAccount + **/ + public String getSubAccount() { + return subAccount; + } + + + public void setSubAccount(String subAccount) { + this.subAccount = subAccount; + } + + public SubAccountTransferRecordItem subAccountType(String subAccountType) { + + this.subAccountType = subAccountType; + return this; + } + + /** + * Target sub-account trading account: spot - spot account, futures - perpetual contract account, delivery - delivery contract account, options - options account + * @return subAccountType + **/ + @javax.annotation.Nullable + public String getSubAccountType() { + return subAccountType; + } + + + public void setSubAccountType(String subAccountType) { + this.subAccountType = subAccountType; + } + + public SubAccountTransferRecordItem currency(String currency) { + + this.currency = currency; + return this; + } + + /** + * Transfer currency name + * @return currency + **/ + public String getCurrency() { + return currency; + } + + + public void setCurrency(String currency) { + this.currency = currency; + } + + public SubAccountTransferRecordItem amount(String amount) { + + this.amount = amount; + return this; + } + + /** + * Transfer amount + * @return amount + **/ + public String getAmount() { + return amount; + } + + + public void setAmount(String amount) { + this.amount = amount; + } + + public SubAccountTransferRecordItem direction(String direction) { + + this.direction = direction; + return this; + } + + /** + * Transfer direction: to - transfer into sub-account, from - transfer out from sub-account + * @return direction + **/ + public String getDirection() { + return direction; + } + + + public void setDirection(String direction) { + this.direction = direction; + } + + /** + * Source of the transfer operation + * @return source + **/ + @javax.annotation.Nullable + public String getSource() { + return source; + } + + + public SubAccountTransferRecordItem clientOrderId(String clientOrderId) { + + this.clientOrderId = clientOrderId; + return this; + } + + /** + * 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 + * @return clientOrderId + **/ + @javax.annotation.Nullable + public String getClientOrderId() { + return clientOrderId; + } + + + public void setClientOrderId(String clientOrderId) { + this.clientOrderId = clientOrderId; + } + + public SubAccountTransferRecordItem status(String status) { + + this.status = status; + return this; + } + + /** + * Sub-account transfer record status, currently only 'success' + * @return status + **/ + @javax.annotation.Nullable + public String getStatus() { + return status; + } + + + public void setStatus(String status) { + this.status = status; + } + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SubAccountTransferRecordItem subAccountTransferRecordItem = (SubAccountTransferRecordItem) o; + return Objects.equals(this.timest, subAccountTransferRecordItem.timest) && + Objects.equals(this.uid, subAccountTransferRecordItem.uid) && + Objects.equals(this.subAccount, subAccountTransferRecordItem.subAccount) && + Objects.equals(this.subAccountType, subAccountTransferRecordItem.subAccountType) && + Objects.equals(this.currency, subAccountTransferRecordItem.currency) && + Objects.equals(this.amount, subAccountTransferRecordItem.amount) && + Objects.equals(this.direction, subAccountTransferRecordItem.direction) && + Objects.equals(this.source, subAccountTransferRecordItem.source) && + Objects.equals(this.clientOrderId, subAccountTransferRecordItem.clientOrderId) && + Objects.equals(this.status, subAccountTransferRecordItem.status); + } + + @Override + public int hashCode() { + return Objects.hash(timest, uid, subAccount, subAccountType, currency, amount, direction, source, clientOrderId, status); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SubAccountTransferRecordItem {\n"); + sb.append(" timest: ").append(toIndentedString(timest)).append("\n"); + sb.append(" uid: ").append(toIndentedString(uid)).append("\n"); + sb.append(" subAccount: ").append(toIndentedString(subAccount)).append("\n"); + sb.append(" subAccountType: ").append(toIndentedString(subAccountType)).append("\n"); + sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); + sb.append(" amount: ").append(toIndentedString(amount)).append("\n"); + sb.append(" direction: ").append(toIndentedString(direction)).append("\n"); + sb.append(" source: ").append(toIndentedString(source)).append("\n"); + sb.append(" clientOrderId: ").append(toIndentedString(clientOrderId)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/gate/gateapi/models/SubCrossMarginAccount.java b/src/main/java/io/gate/gateapi/models/SubCrossMarginAccount.java index cce97a1..7111ea2 100644 --- a/src/main/java/io/gate/gateapi/models/SubCrossMarginAccount.java +++ b/src/main/java/io/gate/gateapi/models/SubCrossMarginAccount.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -17,7 +17,7 @@ import com.google.gson.annotations.SerializedName; import com.google.gson.stream.JsonReader; import com.google.gson.stream.JsonWriter; -import io.gate.gateapi.models.CrossMarginBalance1; +import io.gate.gateapi.models.CrossMarginBalance; import java.io.IOException; import java.util.HashMap; import java.util.List; @@ -37,7 +37,7 @@ public class SubCrossMarginAccount { public static final String SERIALIZED_NAME_BALANCES = "balances"; @SerializedName(SERIALIZED_NAME_BALANCES) - private Map balances = null; + private Map balances = null; public static final String SERIALIZED_NAME_TOTAL = "total"; @SerializedName(SERIALIZED_NAME_TOTAL) @@ -99,7 +99,7 @@ public SubCrossMarginAccount userId(Long userId) { } /** - * User ID of the cross margin account. 0 means that the subaccount has not yet opened a cross margin account + * Cross margin account user ID. 0 means this sub-account has not yet opened a cross margin account * @return userId **/ @javax.annotation.Nullable @@ -119,7 +119,7 @@ public SubCrossMarginAccount locked(Boolean locked) { } /** - * Whether account is locked + * Whether the account is locked * @return locked **/ @javax.annotation.Nullable @@ -132,13 +132,13 @@ public void setLocked(Boolean locked) { this.locked = locked; } - public SubCrossMarginAccount balances(Map balances) { + public SubCrossMarginAccount balances(Map balances) { this.balances = balances; return this; } - public SubCrossMarginAccount putBalancesItem(String key, CrossMarginBalance1 balancesItem) { + public SubCrossMarginAccount putBalancesItem(String key, CrossMarginBalance balancesItem) { if (this.balances == null) { this.balances = new HashMap<>(); } @@ -151,12 +151,12 @@ public SubCrossMarginAccount putBalancesItem(String key, CrossMarginBalance1 bal * @return balances **/ @javax.annotation.Nullable - public Map getBalances() { + public Map getBalances() { return balances; } - public void setBalances(Map balances) { + public void setBalances(Map balances) { this.balances = balances; } @@ -207,7 +207,7 @@ public SubCrossMarginAccount borrowedNet(String borrowedNet) { } /** - * Total borrowed value in USDT * borrowed factor + * Total borrowed value in USDT * leverage factor * @return borrowedNet **/ @javax.annotation.Nullable @@ -267,7 +267,7 @@ public SubCrossMarginAccount interest(String interest) { } /** - * Total unpaid interests in USDT, i.e., the sum of all currencies' `interest*price*discount` + * Total unpaid interest in USDT, i.e., the sum of all currencies' `interest*price*discount` * @return interest **/ @javax.annotation.Nullable @@ -287,7 +287,7 @@ public SubCrossMarginAccount risk(String risk) { } /** - * Risk rate. When it belows 110%, liquidation will be triggered. Calculation formula: `total / (borrowed+interest)` + * Risk rate. When it falls below 110%, liquidation will be triggered. Calculation formula: `total / (borrowed+interest)` * @return risk **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SubUserMode.java b/src/main/java/io/gate/gateapi/models/SubUserMode.java index 93b2948..5ea3a83 100644 --- a/src/main/java/io/gate/gateapi/models/SubUserMode.java +++ b/src/main/java/io/gate/gateapi/models/SubUserMode.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -63,7 +63,7 @@ public SubUserMode isUnified(Boolean isUnified) { } /** - * Is it a unified account? + * Whether it is a unified account * @return isUnified **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public SubUserMode mode(String 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 * @return mode **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SwapCoin.java b/src/main/java/io/gate/gateapi/models/SwapCoin.java new file mode 100644 index 0000000..0f7fe0a --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/SwapCoin.java @@ -0,0 +1,164 @@ +/* + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package io.gate.gateapi.models; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; + +/** + * Blockchain Mining + */ +public class SwapCoin { + public static final String SERIALIZED_NAME_COIN = "coin"; + @SerializedName(SERIALIZED_NAME_COIN) + private String coin; + + public static final String SERIALIZED_NAME_SIDE = "side"; + @SerializedName(SERIALIZED_NAME_SIDE) + private String side; + + public static final String SERIALIZED_NAME_AMOUNT = "amount"; + @SerializedName(SERIALIZED_NAME_AMOUNT) + private String amount; + + public static final String SERIALIZED_NAME_PID = "pid"; + @SerializedName(SERIALIZED_NAME_PID) + private Integer pid; + + + public SwapCoin coin(String coin) { + + this.coin = coin; + return this; + } + + /** + * Currency + * @return coin + **/ + public String getCoin() { + return coin; + } + + + public void setCoin(String coin) { + this.coin = coin; + } + + public SwapCoin side(String side) { + + this.side = side; + return this; + } + + /** + * 0 - Stake 1 - Redeem + * @return side + **/ + public String getSide() { + return side; + } + + + public void setSide(String side) { + this.side = side; + } + + public SwapCoin amount(String amount) { + + this.amount = amount; + return this; + } + + /** + * Size + * @return amount + **/ + public String getAmount() { + return amount; + } + + + public void setAmount(String amount) { + this.amount = amount; + } + + public SwapCoin pid(Integer pid) { + + this.pid = pid; + return this; + } + + /** + * DeFi-type Mining Protocol Identifier + * @return pid + **/ + @javax.annotation.Nullable + public Integer getPid() { + return pid; + } + + + public void setPid(Integer pid) { + this.pid = pid; + } + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SwapCoin swapCoin = (SwapCoin) o; + return Objects.equals(this.coin, swapCoin.coin) && + Objects.equals(this.side, swapCoin.side) && + Objects.equals(this.amount, swapCoin.amount) && + Objects.equals(this.pid, swapCoin.pid); + } + + @Override + public int hashCode() { + return Objects.hash(coin, side, amount, pid); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SwapCoin {\n"); + sb.append(" coin: ").append(toIndentedString(coin)).append("\n"); + sb.append(" side: ").append(toIndentedString(side)).append("\n"); + sb.append(" amount: ").append(toIndentedString(amount)).append("\n"); + sb.append(" pid: ").append(toIndentedString(pid)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/gate/gateapi/models/SwapCoinStruct.java b/src/main/java/io/gate/gateapi/models/SwapCoinStruct.java new file mode 100644 index 0000000..f15a430 --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/SwapCoinStruct.java @@ -0,0 +1,453 @@ +/* + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package io.gate.gateapi.models; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; + +/** + * SwapCoinStruct + */ +public class SwapCoinStruct { + public static final String SERIALIZED_NAME_ID = "id"; + @SerializedName(SERIALIZED_NAME_ID) + private Integer id; + + public static final String SERIALIZED_NAME_PID = "pid"; + @SerializedName(SERIALIZED_NAME_PID) + private Integer pid; + + public static final String SERIALIZED_NAME_UID = "uid"; + @SerializedName(SERIALIZED_NAME_UID) + private Integer uid; + + public static final String SERIALIZED_NAME_COIN = "coin"; + @SerializedName(SERIALIZED_NAME_COIN) + private String coin; + + public static final String SERIALIZED_NAME_TYPE = "type"; + @SerializedName(SERIALIZED_NAME_TYPE) + private Integer type; + + public static final String SERIALIZED_NAME_SUBTYPE = "subtype"; + @SerializedName(SERIALIZED_NAME_SUBTYPE) + private String subtype; + + public static final String SERIALIZED_NAME_AMOUNT = "amount"; + @SerializedName(SERIALIZED_NAME_AMOUNT) + private String amount; + + public static final String SERIALIZED_NAME_EXCHANGE_RATE = "exchange_rate"; + @SerializedName(SERIALIZED_NAME_EXCHANGE_RATE) + private String exchangeRate; + + public static final String SERIALIZED_NAME_EXCHANGE_AMOUNT = "exchange_amount"; + @SerializedName(SERIALIZED_NAME_EXCHANGE_AMOUNT) + private String exchangeAmount; + + public static final String SERIALIZED_NAME_UPDATE_STAMP = "updateStamp"; + @SerializedName(SERIALIZED_NAME_UPDATE_STAMP) + private Integer updateStamp; + + public static final String SERIALIZED_NAME_CREATE_STAMP = "createStamp"; + @SerializedName(SERIALIZED_NAME_CREATE_STAMP) + private Integer createStamp; + + public static final String SERIALIZED_NAME_STATUS = "status"; + @SerializedName(SERIALIZED_NAME_STATUS) + private Integer status; + + public static final String SERIALIZED_NAME_PROTOCOL_TYPE = "protocol_type"; + @SerializedName(SERIALIZED_NAME_PROTOCOL_TYPE) + private Integer protocolType; + + public static final String SERIALIZED_NAME_CLIENT_ORDER_ID = "client_order_id"; + @SerializedName(SERIALIZED_NAME_CLIENT_ORDER_ID) + private String clientOrderId; + + public static final String SERIALIZED_NAME_SOURCE = "source"; + @SerializedName(SERIALIZED_NAME_SOURCE) + private String source; + + + public SwapCoinStruct id(Integer id) { + + this.id = id; + return this; + } + + /** + * Order ID + * @return id + **/ + @javax.annotation.Nullable + public Integer getId() { + return id; + } + + + public void setId(Integer id) { + this.id = id; + } + + public SwapCoinStruct pid(Integer pid) { + + this.pid = pid; + return this; + } + + /** + * Product ID + * @return pid + **/ + @javax.annotation.Nullable + public Integer getPid() { + return pid; + } + + + public void setPid(Integer pid) { + this.pid = pid; + } + + public SwapCoinStruct uid(Integer uid) { + + this.uid = uid; + return this; + } + + /** + * User ID + * @return uid + **/ + @javax.annotation.Nullable + public Integer getUid() { + return uid; + } + + + public void setUid(Integer uid) { + this.uid = uid; + } + + public SwapCoinStruct coin(String coin) { + + this.coin = coin; + return this; + } + + /** + * Currency + * @return coin + **/ + @javax.annotation.Nullable + public String getCoin() { + return coin; + } + + + public void setCoin(String coin) { + this.coin = coin; + } + + public SwapCoinStruct type(Integer type) { + + this.type = type; + return this; + } + + /** + * Type 0-Staking 1-Redemption + * @return type + **/ + @javax.annotation.Nullable + public Integer getType() { + return type; + } + + + public void setType(Integer type) { + this.type = type; + } + + public SwapCoinStruct subtype(String subtype) { + + this.subtype = subtype; + return this; + } + + /** + * SubType + * @return subtype + **/ + @javax.annotation.Nullable + public String getSubtype() { + return subtype; + } + + + public void setSubtype(String subtype) { + this.subtype = subtype; + } + + public SwapCoinStruct amount(String amount) { + + this.amount = amount; + return this; + } + + /** + * Amount + * @return amount + **/ + @javax.annotation.Nullable + public String getAmount() { + return amount; + } + + + public void setAmount(String amount) { + this.amount = amount; + } + + public SwapCoinStruct exchangeRate(String exchangeRate) { + + this.exchangeRate = exchangeRate; + return this; + } + + /** + * Exchange ratio + * @return exchangeRate + **/ + @javax.annotation.Nullable + public String getExchangeRate() { + return exchangeRate; + } + + + public void setExchangeRate(String exchangeRate) { + this.exchangeRate = exchangeRate; + } + + public SwapCoinStruct exchangeAmount(String exchangeAmount) { + + this.exchangeAmount = exchangeAmount; + return this; + } + + /** + * Redemption Amount + * @return exchangeAmount + **/ + @javax.annotation.Nullable + public String getExchangeAmount() { + return exchangeAmount; + } + + + public void setExchangeAmount(String exchangeAmount) { + this.exchangeAmount = exchangeAmount; + } + + public SwapCoinStruct updateStamp(Integer updateStamp) { + + this.updateStamp = updateStamp; + return this; + } + + /** + * UpdateTimestamp + * @return updateStamp + **/ + @javax.annotation.Nullable + public Integer getUpdateStamp() { + return updateStamp; + } + + + public void setUpdateStamp(Integer updateStamp) { + this.updateStamp = updateStamp; + } + + public SwapCoinStruct createStamp(Integer createStamp) { + + this.createStamp = createStamp; + return this; + } + + /** + * Transaction timestamp + * @return createStamp + **/ + @javax.annotation.Nullable + public Integer getCreateStamp() { + return createStamp; + } + + + public void setCreateStamp(Integer createStamp) { + this.createStamp = createStamp; + } + + public SwapCoinStruct status(Integer status) { + + this.status = status; + return this; + } + + /** + * status 1-success + * @return status + **/ + @javax.annotation.Nullable + public Integer getStatus() { + return status; + } + + + public void setStatus(Integer status) { + this.status = status; + } + + public SwapCoinStruct protocolType(Integer protocolType) { + + this.protocolType = protocolType; + return this; + } + + /** + * DEFI Protocol Type + * @return protocolType + **/ + @javax.annotation.Nullable + public Integer getProtocolType() { + return protocolType; + } + + + public void setProtocolType(Integer protocolType) { + this.protocolType = protocolType; + } + + public SwapCoinStruct clientOrderId(String clientOrderId) { + + this.clientOrderId = clientOrderId; + return this; + } + + /** + * Reference ID + * @return clientOrderId + **/ + @javax.annotation.Nullable + public String getClientOrderId() { + return clientOrderId; + } + + + public void setClientOrderId(String clientOrderId) { + this.clientOrderId = clientOrderId; + } + + public SwapCoinStruct source(String source) { + + this.source = source; + return this; + } + + /** + * Order Origin + * @return source + **/ + @javax.annotation.Nullable + public String getSource() { + return source; + } + + + public void setSource(String source) { + this.source = source; + } + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SwapCoinStruct swapCoinStruct = (SwapCoinStruct) o; + return Objects.equals(this.id, swapCoinStruct.id) && + Objects.equals(this.pid, swapCoinStruct.pid) && + Objects.equals(this.uid, swapCoinStruct.uid) && + Objects.equals(this.coin, swapCoinStruct.coin) && + Objects.equals(this.type, swapCoinStruct.type) && + Objects.equals(this.subtype, swapCoinStruct.subtype) && + Objects.equals(this.amount, swapCoinStruct.amount) && + Objects.equals(this.exchangeRate, swapCoinStruct.exchangeRate) && + Objects.equals(this.exchangeAmount, swapCoinStruct.exchangeAmount) && + Objects.equals(this.updateStamp, swapCoinStruct.updateStamp) && + Objects.equals(this.createStamp, swapCoinStruct.createStamp) && + Objects.equals(this.status, swapCoinStruct.status) && + Objects.equals(this.protocolType, swapCoinStruct.protocolType) && + Objects.equals(this.clientOrderId, swapCoinStruct.clientOrderId) && + Objects.equals(this.source, swapCoinStruct.source); + } + + @Override + public int hashCode() { + return Objects.hash(id, pid, uid, coin, type, subtype, amount, exchangeRate, exchangeAmount, updateStamp, createStamp, status, protocolType, clientOrderId, source); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SwapCoinStruct {\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" pid: ").append(toIndentedString(pid)).append("\n"); + sb.append(" uid: ").append(toIndentedString(uid)).append("\n"); + sb.append(" coin: ").append(toIndentedString(coin)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" subtype: ").append(toIndentedString(subtype)).append("\n"); + sb.append(" amount: ").append(toIndentedString(amount)).append("\n"); + sb.append(" exchangeRate: ").append(toIndentedString(exchangeRate)).append("\n"); + sb.append(" exchangeAmount: ").append(toIndentedString(exchangeAmount)).append("\n"); + sb.append(" updateStamp: ").append(toIndentedString(updateStamp)).append("\n"); + sb.append(" createStamp: ").append(toIndentedString(createStamp)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).append("\n"); + sb.append(" protocolType: ").append(toIndentedString(protocolType)).append("\n"); + sb.append(" clientOrderId: ").append(toIndentedString(clientOrderId)).append("\n"); + sb.append(" source: ").append(toIndentedString(source)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/gate/gateapi/models/SystemTime.java b/src/main/java/io/gate/gateapi/models/SystemTime.java index 6308689..dae8438 100644 --- a/src/main/java/io/gate/gateapi/models/SystemTime.java +++ b/src/main/java/io/gate/gateapi/models/SystemTime.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/Ticker.java b/src/main/java/io/gate/gateapi/models/Ticker.java index 0fcb1f7..908546a 100644 --- a/src/main/java/io/gate/gateapi/models/Ticker.java +++ b/src/main/java/io/gate/gateapi/models/Ticker.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -159,7 +159,7 @@ public Ticker lowestSize(String lowestSize) { } /** - * 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 + * Latest seller's lowest price quantity; not available for batch queries; available for single queries, empty if no data * @return lowestSize **/ @javax.annotation.Nullable @@ -199,7 +199,7 @@ public Ticker highestSize(String highestSize) { } /** - * 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 + * Latest buyer's highest price quantity; not available for batch queries; available for single queries, empty if no data * @return highestSize **/ @javax.annotation.Nullable @@ -219,7 +219,7 @@ public Ticker changePercentage(String changePercentage) { } /** - * Change percentage in the last 24h + * 24h price change percentage (negative for decrease, e.g., -7.45) * @return changePercentage **/ @javax.annotation.Nullable @@ -239,7 +239,7 @@ public Ticker changeUtc0(String changeUtc0) { } /** - * utc0 timezone, the percentage change in the last 24 hours + * UTC+0 timezone, 24h price change percentage, negative for decline (e.g., -7.45) * @return changeUtc0 **/ @javax.annotation.Nullable @@ -259,7 +259,7 @@ public Ticker changeUtc8(String changeUtc8) { } /** - * utc8 timezone, the percentage change in the last 24 hours + * UTC+8 timezone, 24h price change percentage, negative for decline (e.g., -7.45) * @return changeUtc8 **/ @javax.annotation.Nullable @@ -279,7 +279,7 @@ public Ticker baseVolume(String baseVolume) { } /** - * Base currency trade volume in the last 24h + * Base currency trading volume in the last 24h * @return baseVolume **/ @javax.annotation.Nullable @@ -299,7 +299,7 @@ public Ticker quoteVolume(String quoteVolume) { } /** - * Quote currency trade volume in the last 24h + * Quote currency trading volume in the last 24h * @return quoteVolume **/ @javax.annotation.Nullable @@ -319,7 +319,7 @@ public Ticker high24h(String high24h) { } /** - * Highest price in 24h + * 24h High * @return high24h **/ @javax.annotation.Nullable @@ -339,7 +339,7 @@ public Ticker low24h(String low24h) { } /** - * Lowest price in 24h + * 24h Low * @return low24h **/ @javax.annotation.Nullable @@ -379,7 +379,7 @@ public Ticker etfPreNetValue(String etfPreNetValue) { } /** - * ETF previous net value at re-balancing time + * ETF net value at previous rebalancing point * @return etfPreNetValue **/ @javax.annotation.Nullable @@ -399,7 +399,7 @@ public Ticker etfPreTimestamp(Long etfPreTimestamp) { } /** - * ETF previous re-balancing time + * ETF previous rebalancing time * @return etfPreTimestamp **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/TotalBalance.java b/src/main/java/io/gate/gateapi/models/TotalBalance.java index bd6dd04..dbd650c 100644 --- a/src/main/java/io/gate/gateapi/models/TotalBalance.java +++ b/src/main/java/io/gate/gateapi/models/TotalBalance.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -24,7 +24,7 @@ import java.util.Map; /** - * User's balance in all accounts + * User's total balance information */ public class TotalBalance { public static final String SERIALIZED_NAME_TOTAL = "total"; @@ -71,7 +71,7 @@ public TotalBalance putDetailsItem(String key, AccountBalance detailsItem) { } /** - * 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 + * 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 * @return details **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/Trade.java b/src/main/java/io/gate/gateapi/models/Trade.java index e53cebc..41d8c14 100644 --- a/src/main/java/io/gate/gateapi/models/Trade.java +++ b/src/main/java/io/gate/gateapi/models/Trade.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -40,7 +40,7 @@ public class Trade { private String currencyPair; /** - * Order side + * Buy or sell order */ @JsonAdapter(SideEnum.Adapter.class) public enum SideEnum { @@ -91,7 +91,7 @@ public SideEnum read(final JsonReader jsonReader) throws IOException { private SideEnum side; /** - * Trade role. No value in public endpoints + * Trade role, not returned in public endpoints */ @JsonAdapter(RoleEnum.Adapter.class) public enum RoleEnum { @@ -189,7 +189,7 @@ public Trade id(String id) { } /** - * Trade ID + * Fill ID * @return id **/ @javax.annotation.Nullable @@ -209,7 +209,7 @@ public Trade createTime(String createTime) { } /** - * Trading time + * Fill Time * @return createTime **/ @javax.annotation.Nullable @@ -269,7 +269,7 @@ public Trade side(SideEnum side) { } /** - * Order side + * Buy or sell order * @return side **/ @javax.annotation.Nullable @@ -289,7 +289,7 @@ public Trade role(RoleEnum role) { } /** - * Trade role. No value in public endpoints + * Trade role, not returned in public endpoints * @return role **/ @javax.annotation.Nullable @@ -349,7 +349,7 @@ public Trade orderId(String orderId) { } /** - * Related order ID. No value in public endpoints + * Related order ID, not returned in public endpoints * @return orderId **/ @javax.annotation.Nullable @@ -369,7 +369,7 @@ public Trade fee(String fee) { } /** - * Fee deducted. No value in public endpoints + * Fee deducted, not returned in public endpoints * @return fee **/ @javax.annotation.Nullable @@ -389,7 +389,7 @@ public Trade feeCurrency(String feeCurrency) { } /** - * Fee currency unit. No value in public endpoints + * Fee currency unit, not returned in public endpoints * @return feeCurrency **/ @javax.annotation.Nullable @@ -409,7 +409,7 @@ public Trade pointFee(String pointFee) { } /** - * Points used to deduct fee. No value in public endpoints + * Points used to deduct fee, not returned in public endpoints * @return pointFee **/ @javax.annotation.Nullable @@ -429,7 +429,7 @@ public Trade gtFee(String gtFee) { } /** - * GT used to deduct fee. No value in public endpoints + * GT used to deduct fee, not returned in public endpoints * @return gtFee **/ @javax.annotation.Nullable @@ -469,7 +469,7 @@ public Trade sequenceId(String sequenceId) { } /** - * Represents a unique and consecutive trade ID within a single market. It is used to track and identify trades in the specific market + * Consecutive trade ID within a single market. Used to track and identify trades in the specific market * @return sequenceId **/ @javax.annotation.Nullable @@ -489,7 +489,7 @@ public Trade text(String text) { } /** - * User defined information. No value in public endpoints + * User-defined information, not returned in public endpoints * @return text **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/TradeFee.java b/src/main/java/io/gate/gateapi/models/TradeFee.java index 7ab4987..540c779 100644 --- a/src/main/java/io/gate/gateapi/models/TradeFee.java +++ b/src/main/java/io/gate/gateapi/models/TradeFee.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -143,7 +143,7 @@ public TradeFee gtDiscount(Boolean gtDiscount) { } /** - * If GT deduction is enabled + * Whether GT deduction discount is enabled * @return gtDiscount **/ @javax.annotation.Nullable @@ -183,7 +183,7 @@ public TradeFee gtMakerFee(String gtMakerFee) { } /** - * Maker fee rate if using GT deduction. It will be 0 if GT deduction is disabled + * Maker fee rate with GT deduction. Returns 0 if GT deduction is disabled * @return gtMakerFee **/ @javax.annotation.Nullable @@ -223,7 +223,7 @@ public TradeFee pointType(String pointType) { } /** - * Point type. 0 - Initial version. 1 - new version since 202009 + * Point card type: 0 - Original version, 1 - New version since 202009 * @return pointType **/ @javax.annotation.Nullable @@ -243,7 +243,7 @@ public TradeFee futuresTakerFee(String futuresTakerFee) { } /** - * Futures trading taker fee + * Perpetual contract taker fee rate * @return futuresTakerFee **/ @javax.annotation.Nullable @@ -263,7 +263,7 @@ public TradeFee futuresMakerFee(String futuresMakerFee) { } /** - * Future trading maker fee + * Perpetual contract maker fee rate * @return futuresMakerFee **/ @javax.annotation.Nullable @@ -283,7 +283,7 @@ public TradeFee deliveryTakerFee(String deliveryTakerFee) { } /** - * Delivery trading taker fee + * Delivery contract taker fee rate * @return deliveryTakerFee **/ @javax.annotation.Nullable @@ -303,7 +303,7 @@ public TradeFee deliveryMakerFee(String deliveryMakerFee) { } /** - * Delivery trading maker fee + * Delivery contract maker fee rate * @return deliveryMakerFee **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/TransactionID.java b/src/main/java/io/gate/gateapi/models/TransactionID.java index 8556e32..a0ae56a 100644 --- a/src/main/java/io/gate/gateapi/models/TransactionID.java +++ b/src/main/java/io/gate/gateapi/models/TransactionID.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -35,7 +35,7 @@ public TransactionID txId(Long txId) { } /** - * Order id + * Order ID * @return txId **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/Transfer.java b/src/main/java/io/gate/gateapi/models/Transfer.java index ee3067c..73c4e4d 100644 --- a/src/main/java/io/gate/gateapi/models/Transfer.java +++ b/src/main/java/io/gate/gateapi/models/Transfer.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -161,7 +161,7 @@ public Transfer currency(String currency) { } /** - * Transfer currency. For futures account, `currency` can be set to `POINT` or settle currency + * Transfer currency name. For contract accounts, `currency` can be set to `POINT` (points) or supported settlement currencies (e.g., `BTC`, `USDT`) * @return currency **/ public String getCurrency() { @@ -237,7 +237,7 @@ public Transfer currencyPair(String currencyPair) { } /** - * Margin currency pair. Required if transfer from or to margin account + * Margin trading pair. Required when transferring to or from margin account * @return currencyPair **/ @javax.annotation.Nullable @@ -257,7 +257,7 @@ public Transfer settle(String settle) { } /** - * Futures settle currency. Required if transferring from or to futures account + * Contract settlement currency. Required when transferring to or from contract account * @return settle **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/TransferOrderStatus.java b/src/main/java/io/gate/gateapi/models/TransferOrderStatus.java index 0d39c9a..a888ea0 100644 --- a/src/main/java/io/gate/gateapi/models/TransferOrderStatus.java +++ b/src/main/java/io/gate/gateapi/models/TransferOrderStatus.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -39,7 +39,7 @@ public TransferOrderStatus txId(String txId) { } /** - * Order id + * Order ID * @return txId **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public TransferOrderStatus status(String status) { } /** - * Transfer status, PENDING - in process, SUCCESS - successful transfer, FAIL - failed transfer, PARTIAL_SUCCESS - Partially successful (this status will appear when transferring between sub-subs) + * Transfer status: PENDING - Processing, SUCCESS - Transfer successful, FAIL - Transfer failed, PARTIAL_SUCCESS - Partially successful (this status appears when transferring between sub-accounts) * @return status **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/TransferablesResult.java b/src/main/java/io/gate/gateapi/models/TransferablesResult.java index b66b414..f4147d9 100644 --- a/src/main/java/io/gate/gateapi/models/TransferablesResult.java +++ b/src/main/java/io/gate/gateapi/models/TransferablesResult.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Batch query unified account can be transferred up to a maximum of results + * Batch query unified account maximum transferable results */ public class TransferablesResult { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -59,7 +59,7 @@ public TransferablesResult amount(String amount) { } /** - * The maximum amount that can be transferred out + * Maximum transferable amount * @return amount **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/TriggerOrderResponse.java b/src/main/java/io/gate/gateapi/models/TriggerOrderResponse.java index 8d8f072..6b78f96 100644 --- a/src/main/java/io/gate/gateapi/models/TriggerOrderResponse.java +++ b/src/main/java/io/gate/gateapi/models/TriggerOrderResponse.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/TriggerTime.java b/src/main/java/io/gate/gateapi/models/TriggerTime.java index 2981afb..37c370d 100644 --- a/src/main/java/io/gate/gateapi/models/TriggerTime.java +++ b/src/main/java/io/gate/gateapi/models/TriggerTime.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -35,7 +35,7 @@ public TriggerTime triggerTime(Long triggerTime) { } /** - * Timestamp of the end of the countdown, in milliseconds + * Timestamp when countdown ends, in milliseconds * @return triggerTime **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UidPushOrder.java b/src/main/java/io/gate/gateapi/models/UidPushOrder.java index f6fdeef..65c1687 100644 --- a/src/main/java/io/gate/gateapi/models/UidPushOrder.java +++ b/src/main/java/io/gate/gateapi/models/UidPushOrder.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -167,7 +167,7 @@ public UidPushOrder createTime(Long createTime) { } /** - * Creation time + * Created time * @return createTime **/ @javax.annotation.Nullable @@ -187,7 +187,7 @@ public UidPushOrder status(String status) { } /** - * 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 + * 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 * @return status **/ @javax.annotation.Nullable @@ -207,7 +207,7 @@ public UidPushOrder message(String message) { } /** - * PENDING Reason Tips + * PENDING reason tips * @return message **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UidPushWithdrawal.java b/src/main/java/io/gate/gateapi/models/UidPushWithdrawal.java index 1b68439..32ee3a2 100644 --- a/src/main/java/io/gate/gateapi/models/UidPushWithdrawal.java +++ b/src/main/java/io/gate/gateapi/models/UidPushWithdrawal.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/UidPushWithdrawalResp.java b/src/main/java/io/gate/gateapi/models/UidPushWithdrawalResp.java index 46929bf..5d1d399 100644 --- a/src/main/java/io/gate/gateapi/models/UidPushWithdrawalResp.java +++ b/src/main/java/io/gate/gateapi/models/UidPushWithdrawalResp.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/UniCurrency.java b/src/main/java/io/gate/gateapi/models/UniCurrency.java index b002cf5..21eef24 100644 --- a/src/main/java/io/gate/gateapi/models/UniCurrency.java +++ b/src/main/java/io/gate/gateapi/models/UniCurrency.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -55,7 +55,7 @@ public String getCurrency() { /** - * The minimum lending amount, in the unit of the currency. + * The minimum lending amount, in the unit of the currency * @return minLendAmount **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UniCurrencyInterest.java b/src/main/java/io/gate/gateapi/models/UniCurrencyInterest.java index 58573df..609c2b1 100644 --- a/src/main/java/io/gate/gateapi/models/UniCurrencyInterest.java +++ b/src/main/java/io/gate/gateapi/models/UniCurrencyInterest.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -43,7 +43,7 @@ public String getCurrency() { /** - * Interest status: interest_dividend - regular dividend, interest_reinvest - interest reinvestment + * Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment * @return interestStatus **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UniCurrencyPair.java b/src/main/java/io/gate/gateapi/models/UniCurrencyPair.java index c83a614..16c27d7 100644 --- a/src/main/java/io/gate/gateapi/models/UniCurrencyPair.java +++ b/src/main/java/io/gate/gateapi/models/UniCurrencyPair.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/UniInterestMode.java b/src/main/java/io/gate/gateapi/models/UniInterestMode.java deleted file mode 100644 index 1fcb77c..0000000 --- a/src/main/java/io/gate/gateapi/models/UniInterestMode.java +++ /dev/null @@ -1,113 +0,0 @@ -/* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package io.gate.gateapi.models; - -import java.util.Objects; -import java.util.Arrays; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import java.io.IOException; - -/** - * Lend & Earn interest reinvestment toggle - */ -public class UniInterestMode { - public static final String SERIALIZED_NAME_CURRENCY = "currency"; - @SerializedName(SERIALIZED_NAME_CURRENCY) - private String currency; - - public static final String SERIALIZED_NAME_STATUS = "status"; - @SerializedName(SERIALIZED_NAME_STATUS) - private Boolean status; - - - public UniInterestMode currency(String currency) { - - this.currency = currency; - return this; - } - - /** - * Currency - * @return currency - **/ - public String getCurrency() { - return currency; - } - - - public void setCurrency(String currency) { - this.currency = currency; - } - - public UniInterestMode status(Boolean status) { - - this.status = status; - return this; - } - - /** - * Interest toggle settings, true - interest reinvestment, false - regular dividend - * @return status - **/ - public Boolean getStatus() { - return status; - } - - - public void setStatus(Boolean status) { - this.status = status; - } - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - UniInterestMode uniInterestMode = (UniInterestMode) o; - return Objects.equals(this.currency, uniInterestMode.currency) && - Objects.equals(this.status, uniInterestMode.status); - } - - @Override - public int hashCode() { - return Objects.hash(currency, status); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class UniInterestMode {\n"); - sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); - sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/io/gate/gateapi/models/UniInterestRecord.java b/src/main/java/io/gate/gateapi/models/UniInterestRecord.java index 1c6809b..19c3fbb 100644 --- a/src/main/java/io/gate/gateapi/models/UniInterestRecord.java +++ b/src/main/java/io/gate/gateapi/models/UniInterestRecord.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -89,7 +89,7 @@ public String getInterest() { /** - * Interest status: interest_dividend - regular dividend, interest_reinvest - interest reinvestment + * Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment * @return interestStatus **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UniLend.java b/src/main/java/io/gate/gateapi/models/UniLend.java index 64305b1..6008e2c 100644 --- a/src/main/java/io/gate/gateapi/models/UniLend.java +++ b/src/main/java/io/gate/gateapi/models/UniLend.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -85,7 +85,7 @@ public String getCurrentAmount() { /** - * Total amount + * Total Lending Amount * @return amount **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public String getAmount() { /** - * Lent amount + * Lent Amount * @return lentAmount **/ @javax.annotation.Nullable @@ -105,7 +105,7 @@ public String getLentAmount() { /** - * Frozen amount + * Pending Redemption Amount * @return frozenAmount **/ @javax.annotation.Nullable @@ -125,7 +125,7 @@ public String getMinRate() { /** - * Interest status: interest_dividend - regular dividend, interest_reinvest - interest reinvestment + * Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment * @return interestStatus **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public String getInterestStatus() { /** - * Amount not reinvested + * Non-reinvested Amount * @return reinvestLeftAmount **/ @javax.annotation.Nullable @@ -145,7 +145,7 @@ public String getReinvestLeftAmount() { /** - * Created time of the lending order + * Lending Order Creation Time * @return createTime **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public Long getCreateTime() { /** - * Upated time of the lending order + * Lending Order Last Update Time * @return updateTime **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UniLendInterest.java b/src/main/java/io/gate/gateapi/models/UniLendInterest.java index cc77201..e7ec36c 100644 --- a/src/main/java/io/gate/gateapi/models/UniLendInterest.java +++ b/src/main/java/io/gate/gateapi/models/UniLendInterest.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -43,7 +43,7 @@ public String getCurrency() { /** - * Interest + * Interest income * @return interest **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UniLendRecord.java b/src/main/java/io/gate/gateapi/models/UniLendRecord.java index 22da10b..605c3fa 100644 --- a/src/main/java/io/gate/gateapi/models/UniLendRecord.java +++ b/src/main/java/io/gate/gateapi/models/UniLendRecord.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Interest Record + * Lending Record */ public class UniLendRecord { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -63,7 +63,7 @@ public String getCurrency() { /** - * current amount + * Current Amount * @return amount **/ @javax.annotation.Nullable @@ -73,7 +73,7 @@ public String getAmount() { /** - * Last wallet amount + * Previous Available Amount * @return lastWalletAmount **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public String getLastWalletAmount() { /** - * Last lent amount + * Previous Lent Amount * @return lastLentAmount **/ @javax.annotation.Nullable @@ -93,7 +93,7 @@ public String getLastLentAmount() { /** - * Last frozen amount + * Previous Frozen Amount * @return lastFrozenAmount **/ @javax.annotation.Nullable @@ -103,7 +103,7 @@ public String getLastFrozenAmount() { /** - * Record type: lend - lend, redeem - redeem + * Record Type: lend - Lend, redeem - Redeem * @return type **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UniLoan.java b/src/main/java/io/gate/gateapi/models/UniLoan.java index dd1f922..80a9411 100644 --- a/src/main/java/io/gate/gateapi/models/UniLoan.java +++ b/src/main/java/io/gate/gateapi/models/UniLoan.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Loan + * Borrowing */ public class UniLoan { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -69,7 +69,7 @@ public String getCurrencyPair() { /** - * amount + * Amount to Repay * @return amount **/ @javax.annotation.Nullable @@ -79,7 +79,7 @@ public String getAmount() { /** - * Loan type, platform - platform, margin - margin + * Loan type: platform borrowing - platform, margin borrowing - margin * @return type **/ @javax.annotation.Nullable @@ -99,7 +99,7 @@ public Long getCreateTime() { /** - * Updated time + * Last Update Time * @return updateTime **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UniLoanInterestRecord.java b/src/main/java/io/gate/gateapi/models/UniLoanInterestRecord.java index 15edbe2..1a9027c 100644 --- a/src/main/java/io/gate/gateapi/models/UniLoanInterestRecord.java +++ b/src/main/java/io/gate/gateapi/models/UniLoanInterestRecord.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Interest record + * Interest Deduction Record */ public class UniLoanInterestRecord { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -73,7 +73,7 @@ public String getCurrencyPair() { /** - * Actual rate + * Actual Rate * @return actualRate **/ @javax.annotation.Nullable @@ -103,7 +103,7 @@ public Integer getStatus() { /** - * Type, platform - platform，margin - margin + * Type: platform - Platform borrowing, margin - Margin borrowing * @return type **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UniLoanRecord.java b/src/main/java/io/gate/gateapi/models/UniLoanRecord.java index 0a40aec..d2879be 100644 --- a/src/main/java/io/gate/gateapi/models/UniLoanRecord.java +++ b/src/main/java/io/gate/gateapi/models/UniLoanRecord.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Loan records + * Borrowing Records */ public class UniLoanRecord { public static final String SERIALIZED_NAME_TYPE = "type"; @@ -45,7 +45,7 @@ public class UniLoanRecord { /** - * type: borrow - borrow, repay - repay + * Type: `borrow` - borrow, `repay` - repay * @return type **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public String getCurrency() { /** - * The amount of lending or repaying + * Borrow or repayment amount * @return amount **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedAccount.java b/src/main/java/io/gate/gateapi/models/UnifiedAccount.java index b1119a7..da41ee1 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedAccount.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedAccount.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -103,6 +103,10 @@ public class UnifiedAccount { @SerializedName(SERIALIZED_NAME_USE_FUNDING) private Boolean useFunding; + public static final String SERIALIZED_NAME_IS_ALL_COLLATERAL = "is_all_collateral"; + @SerializedName(SERIALIZED_NAME_IS_ALL_COLLATERAL) + private Boolean isAllCollateral; + public UnifiedAccount userId(Long userId) { @@ -131,7 +135,7 @@ public UnifiedAccount refreshTime(Long refreshTime) { } /** - * Time of the most recent refresh + * Last refresh time * @return refreshTime **/ @javax.annotation.Nullable @@ -199,7 +203,7 @@ public UnifiedAccount total(String total) { } /** - * 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) + * 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) * @return total **/ @javax.annotation.Nullable @@ -219,7 +223,7 @@ public UnifiedAccount borrowed(String borrowed) { } /** - * 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. + * 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 * @return borrowed **/ @javax.annotation.Nullable @@ -359,7 +363,7 @@ public UnifiedAccount unifiedAccountTotal(String unifiedAccountTotal) { } /** - * Unify the total account assets, valid in single currency margin/cross-currency margin/combined margin mode + * Total unified account assets, valid in single currency margin/cross-currency margin/combined margin mode * @return unifiedAccountTotal **/ @javax.annotation.Nullable @@ -379,7 +383,7 @@ public UnifiedAccount unifiedAccountTotalLiab(String unifiedAccountTotalLiab) { } /** - * 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 + * Total unified account borrowed amount, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode * @return unifiedAccountTotalLiab **/ @javax.annotation.Nullable @@ -399,7 +403,7 @@ public UnifiedAccount unifiedAccountTotalEquity(String unifiedAccountTotalEquity } /** - * Unify the total account equity, valid in single currency margin/cross-currency margin/combined margin mode + * Total unified account equity, valid in single currency margin/cross-currency margin/combined margin mode * @return unifiedAccountTotalEquity **/ @javax.annotation.Nullable @@ -413,7 +417,7 @@ public void setUnifiedAccountTotalEquity(String unifiedAccountTotalEquity) { } /** - * Actual leverage, valid in cross-currency margin/combined margin mode + * Actual leverage ratio, valid in cross-currency margin/combined margin mode * @return leverage **/ @javax.annotation.Nullable @@ -449,7 +453,7 @@ public UnifiedAccount spotHedge(Boolean spotHedge) { } /** - * Spot hedging status, true - enabled, false - not enabled. + * Spot hedging status: true - enabled, false - disabled * @return spotHedge **/ @javax.annotation.Nullable @@ -469,7 +473,7 @@ public UnifiedAccount useFunding(Boolean useFunding) { } /** - * Whether to use funds as margin + * Whether to use Earn funds as margin * @return useFunding **/ @javax.annotation.Nullable @@ -481,6 +485,26 @@ public Boolean getUseFunding() { public void setUseFunding(Boolean useFunding) { this.useFunding = useFunding; } + + public UnifiedAccount isAllCollateral(Boolean isAllCollateral) { + + this.isAllCollateral = isAllCollateral; + return this; + } + + /** + * Whether all currencies are used as margin: true - all currencies as margin, false - no + * @return isAllCollateral + **/ + @javax.annotation.Nullable + public Boolean getIsAllCollateral() { + return isAllCollateral; + } + + + public void setIsAllCollateral(Boolean isAllCollateral) { + this.isAllCollateral = isAllCollateral; + } @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -508,12 +532,13 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.leverage, unifiedAccount.leverage) && Objects.equals(this.spotOrderLoss, unifiedAccount.spotOrderLoss) && Objects.equals(this.spotHedge, unifiedAccount.spotHedge) && - Objects.equals(this.useFunding, unifiedAccount.useFunding); + Objects.equals(this.useFunding, unifiedAccount.useFunding) && + Objects.equals(this.isAllCollateral, unifiedAccount.isAllCollateral); } @Override public int hashCode() { - return Objects.hash(userId, refreshTime, locked, balances, total, borrowed, totalInitialMargin, totalMarginBalance, totalMaintenanceMargin, totalInitialMarginRate, totalMaintenanceMarginRate, totalAvailableMargin, unifiedAccountTotal, unifiedAccountTotalLiab, unifiedAccountTotalEquity, leverage, spotOrderLoss, spotHedge, useFunding); + return Objects.hash(userId, refreshTime, locked, balances, total, borrowed, totalInitialMargin, totalMarginBalance, totalMaintenanceMargin, totalInitialMarginRate, totalMaintenanceMarginRate, totalAvailableMargin, unifiedAccountTotal, unifiedAccountTotalLiab, unifiedAccountTotalEquity, leverage, spotOrderLoss, spotHedge, useFunding, isAllCollateral); } @@ -540,6 +565,7 @@ public String toString() { sb.append(" spotOrderLoss: ").append(toIndentedString(spotOrderLoss)).append("\n"); sb.append(" spotHedge: ").append(toIndentedString(spotHedge)).append("\n"); sb.append(" useFunding: ").append(toIndentedString(useFunding)).append("\n"); + sb.append(" isAllCollateral: ").append(toIndentedString(isAllCollateral)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/gate/gateapi/models/UnifiedBalance.java b/src/main/java/io/gate/gateapi/models/UnifiedBalance.java index 9c5615a..6e76fe5 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedBalance.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedBalance.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -99,6 +99,10 @@ public class UnifiedBalance { @SerializedName(SERIALIZED_NAME_AVAILABLE_MARGIN) private String availableMargin; + public static final String SERIALIZED_NAME_ENABLED_COLLATERAL = "enabled_collateral"; + @SerializedName(SERIALIZED_NAME_ENABLED_COLLATERAL) + private Boolean enabledCollateral; + public UnifiedBalance available(String available) { @@ -107,7 +111,7 @@ public UnifiedBalance available(String available) { } /** - * Available amount is valid in single currency margin/cross-currency margin/combined margin mode, and the calculation is different in different modes + * Available balance, valid in single currency margin/cross-currency margin/combined margin mode, calculation varies by mode * @return available **/ @javax.annotation.Nullable @@ -127,7 +131,7 @@ public UnifiedBalance freeze(String freeze) { } /** - * The locked amount is valid in single currency margin/cross-currency margin/combined margin mode + * Locked balance, valid in single currency margin/cross-currency margin/combined margin mode * @return freeze **/ @javax.annotation.Nullable @@ -147,7 +151,7 @@ public UnifiedBalance borrowed(String borrowed) { } /** - * Borrow limit, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode + * Borrowed amount, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode * @return borrowed **/ @javax.annotation.Nullable @@ -167,7 +171,7 @@ public UnifiedBalance negativeLiab(String negativeLiab) { } /** - * Negative balance loan is valid in cross-currency margin/combined margin mode, and is 0 in other modes such as single-currency margin mode + * Negative balance borrowing, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode * @return negativeLiab **/ @javax.annotation.Nullable @@ -227,7 +231,7 @@ public UnifiedBalance totalFreeze(String totalFreeze) { } /** - * Total occupancy (discarded, to be offline field) + * Total frozen (deprecated, to be removed) * @return totalFreeze **/ @javax.annotation.Nullable @@ -247,7 +251,7 @@ public UnifiedBalance totalLiab(String totalLiab) { } /** - * Total borrowing, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode + * Total borrowed amount, valid in cross-currency margin/combined margin mode, 0 in other modes such as single-currency margin mode * @return totalLiab **/ @javax.annotation.Nullable @@ -287,7 +291,7 @@ public UnifiedBalance funding(String funding) { } /** - * Uniloan financial management amount, effective when Uniloan financial management is turned on as a unified account margin switch + * Uniloan financial management amount, effective when turned on as a unified account margin switch * @return funding **/ @javax.annotation.Nullable @@ -387,7 +391,7 @@ public UnifiedBalance mm(String mm) { } /** - * The full position maintains margin, which is valid in the single currency margin mode, and other cross-currency margin combination margin mode is 0. + * Cross margin maintenance margin, valid in single-currency margin mode, 0 in other modes such as cross-currency margin/combined margin mode * @return mm **/ @javax.annotation.Nullable @@ -467,7 +471,7 @@ public UnifiedBalance availableMargin(String availableMargin) { } /** - * 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 + * Cross margin available balance, valid in single currency margin mode, 0 in other modes such as cross-currency margin/combined margin mode * @return availableMargin **/ @javax.annotation.Nullable @@ -479,6 +483,26 @@ public String getAvailableMargin() { public void setAvailableMargin(String availableMargin) { this.availableMargin = availableMargin; } + + public UnifiedBalance enabledCollateral(Boolean enabledCollateral) { + + this.enabledCollateral = enabledCollateral; + return this; + } + + /** + * Currency enabled as margin: true - Enabled, false - Disabled + * @return enabledCollateral + **/ + @javax.annotation.Nullable + public Boolean getEnabledCollateral() { + return enabledCollateral; + } + + + public void setEnabledCollateral(Boolean enabledCollateral) { + this.enabledCollateral = enabledCollateral; + } @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -506,12 +530,13 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.imr, unifiedBalance.imr) && Objects.equals(this.mmr, unifiedBalance.mmr) && Objects.equals(this.marginBalance, unifiedBalance.marginBalance) && - Objects.equals(this.availableMargin, unifiedBalance.availableMargin); + Objects.equals(this.availableMargin, unifiedBalance.availableMargin) && + Objects.equals(this.enabledCollateral, unifiedBalance.enabledCollateral); } @Override public int hashCode() { - return Objects.hash(available, freeze, borrowed, negativeLiab, futuresPosLiab, equity, totalFreeze, totalLiab, spotInUse, funding, fundingVersion, crossBalance, isoBalance, im, mm, imr, mmr, marginBalance, availableMargin); + return Objects.hash(available, freeze, borrowed, negativeLiab, futuresPosLiab, equity, totalFreeze, totalLiab, spotInUse, funding, fundingVersion, crossBalance, isoBalance, im, mm, imr, mmr, marginBalance, availableMargin, enabledCollateral); } @@ -538,6 +563,7 @@ public String toString() { sb.append(" mmr: ").append(toIndentedString(mmr)).append("\n"); sb.append(" marginBalance: ").append(toIndentedString(marginBalance)).append("\n"); sb.append(" availableMargin: ").append(toIndentedString(availableMargin)).append("\n"); + sb.append(" enabledCollateral: ").append(toIndentedString(enabledCollateral)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/gate/gateapi/models/UnifiedBorrowable.java b/src/main/java/io/gate/gateapi/models/UnifiedBorrowable.java index 436159b..e553e3f 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedBorrowable.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedBorrowable.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/UnifiedBorrowable1.java b/src/main/java/io/gate/gateapi/models/UnifiedBorrowable1.java index 9f3e292..165b1c1 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedBorrowable1.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedBorrowable1.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Batch query unified account can be borrowed up to a maximum of results + * Batch query unified account maximum borrowable results */ public class UnifiedBorrowable1 { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -59,7 +59,7 @@ public UnifiedBorrowable1 amount(String amount) { } /** - * The maximum amount to borrow + * Maximum borrowable amount * @return amount **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedCollateralReq.java b/src/main/java/io/gate/gateapi/models/UnifiedCollateralReq.java new file mode 100644 index 0000000..7ed61e3 --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/UnifiedCollateralReq.java @@ -0,0 +1,206 @@ +/* + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package io.gate.gateapi.models; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * UnifiedCollateralReq + */ +public class UnifiedCollateralReq { + /** + * User-set collateral mode: 0(all)-All currencies as collateral, 1(custom)-Custom currencies as collateral. When collateral_type is 0(all), enable_list and disable_list parameters are invalid + */ + @JsonAdapter(CollateralTypeEnum.Adapter.class) + public enum CollateralTypeEnum { + NUMBER_0(0), + + NUMBER_1(1); + + private Integer value; + + CollateralTypeEnum(Integer value) { + this.value = value; + } + + public Integer getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static CollateralTypeEnum fromValue(Integer value) { + for (CollateralTypeEnum b : CollateralTypeEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final CollateralTypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public CollateralTypeEnum read(final JsonReader jsonReader) throws IOException { + Integer value = jsonReader.nextInt(); + return CollateralTypeEnum.fromValue(value); + } + } + } + + public static final String SERIALIZED_NAME_COLLATERAL_TYPE = "collateral_type"; + @SerializedName(SERIALIZED_NAME_COLLATERAL_TYPE) + private CollateralTypeEnum collateralType; + + public static final String SERIALIZED_NAME_ENABLE_LIST = "enable_list"; + @SerializedName(SERIALIZED_NAME_ENABLE_LIST) + private List enableList = null; + + public static final String SERIALIZED_NAME_DISABLE_LIST = "disable_list"; + @SerializedName(SERIALIZED_NAME_DISABLE_LIST) + private List disableList = null; + + + public UnifiedCollateralReq collateralType(CollateralTypeEnum collateralType) { + + this.collateralType = collateralType; + return this; + } + + /** + * 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 + * @return collateralType + **/ + @javax.annotation.Nullable + public CollateralTypeEnum getCollateralType() { + return collateralType; + } + + + public void setCollateralType(CollateralTypeEnum collateralType) { + this.collateralType = collateralType; + } + + public UnifiedCollateralReq enableList(List enableList) { + + this.enableList = enableList; + return this; + } + + public UnifiedCollateralReq addEnableListItem(String enableListItem) { + if (this.enableList == null) { + this.enableList = new ArrayList<>(); + } + this.enableList.add(enableListItem); + return this; + } + + /** + * Currency list, where collateral_type=1(custom) indicates the addition logic + * @return enableList + **/ + @javax.annotation.Nullable + public List getEnableList() { + return enableList; + } + + + public void setEnableList(List enableList) { + this.enableList = enableList; + } + + public UnifiedCollateralReq disableList(List disableList) { + + this.disableList = disableList; + return this; + } + + public UnifiedCollateralReq addDisableListItem(String disableListItem) { + if (this.disableList == null) { + this.disableList = new ArrayList<>(); + } + this.disableList.add(disableListItem); + return this; + } + + /** + * Disable list, indicating the disable logic + * @return disableList + **/ + @javax.annotation.Nullable + public List getDisableList() { + return disableList; + } + + + public void setDisableList(List disableList) { + this.disableList = disableList; + } + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnifiedCollateralReq unifiedCollateralReq = (UnifiedCollateralReq) o; + return Objects.equals(this.collateralType, unifiedCollateralReq.collateralType) && + Objects.equals(this.enableList, unifiedCollateralReq.enableList) && + Objects.equals(this.disableList, unifiedCollateralReq.disableList); + } + + @Override + public int hashCode() { + return Objects.hash(collateralType, enableList, disableList); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnifiedCollateralReq {\n"); + sb.append(" collateralType: ").append(toIndentedString(collateralType)).append("\n"); + sb.append(" enableList: ").append(toIndentedString(enableList)).append("\n"); + sb.append(" disableList: ").append(toIndentedString(disableList)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/gate/gateapi/models/UnifiedCollateralRes.java b/src/main/java/io/gate/gateapi/models/UnifiedCollateralRes.java new file mode 100644 index 0000000..a1aa90d --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/UnifiedCollateralRes.java @@ -0,0 +1,89 @@ +/* + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package io.gate.gateapi.models; + +import java.util.Objects; +import java.util.Arrays; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import java.io.IOException; + +/** + * Unified account collateral mode settings response + */ +public class UnifiedCollateralRes { + public static final String SERIALIZED_NAME_IS_SUCCESS = "is_success"; + @SerializedName(SERIALIZED_NAME_IS_SUCCESS) + private Boolean isSuccess; + + + public UnifiedCollateralRes isSuccess(Boolean isSuccess) { + + this.isSuccess = isSuccess; + return this; + } + + /** + * Whether the setting was successful + * @return isSuccess + **/ + @javax.annotation.Nullable + public Boolean getIsSuccess() { + return isSuccess; + } + + + public void setIsSuccess(Boolean isSuccess) { + this.isSuccess = isSuccess; + } + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + UnifiedCollateralRes unifiedCollateralRes = (UnifiedCollateralRes) o; + return Objects.equals(this.isSuccess, unifiedCollateralRes.isSuccess); + } + + @Override + public int hashCode() { + return Objects.hash(isSuccess); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class UnifiedCollateralRes {\n"); + sb.append(" isSuccess: ").append(toIndentedString(isSuccess)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/io/gate/gateapi/models/UnifiedCurrency.java b/src/main/java/io/gate/gateapi/models/UnifiedCurrency.java index 01c3cb7..24624f9 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedCurrency.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedCurrency.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -95,7 +95,7 @@ public UnifiedCurrency minBorrowAmount(String minBorrowAmount) { } /** - * The minimum debit limit is the unit of currency + * Minimum borrowable limit, in currency units * @return minBorrowAmount **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public UnifiedCurrency userMaxBorrowAmount(String userMaxBorrowAmount) { } /** - * The minimum debit limit is the unit of currency + * User's maximum borrowable limit, in USDT * @return userMaxBorrowAmount **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public UnifiedCurrency totalMaxBorrowAmount(String totalMaxBorrowAmount) { } /** - * The maximum debit limit for the platform is USDT + * Platform's maximum borrowable limit, in USDT * @return totalMaxBorrowAmount **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public UnifiedCurrency loanStatus(String loanStatus) { } /** - * Does the lending status - `disable` : Loans are prohibited - `enable`: Support lending + * Lending status - `disable` : Lending prohibited - `enable` : Lending supported * @return loanStatus **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedDiscount.java b/src/main/java/io/gate/gateapi/models/UnifiedDiscount.java index 1cb6bcc..ad5b0e0 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedDiscount.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedDiscount.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -23,7 +23,7 @@ import java.util.List; /** - * Currency discount tiers + * Unified account tiered discount */ public class UnifiedDiscount { public static final String SERIALIZED_NAME_CURRENCY = "currency"; diff --git a/src/main/java/io/gate/gateapi/models/UnifiedDiscountTiers.java b/src/main/java/io/gate/gateapi/models/UnifiedDiscountTiers.java index de7625f..e1605ce 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedDiscountTiers.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedDiscountTiers.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -111,7 +111,7 @@ public UnifiedDiscountTiers upperLimit(String upperLimit) { } /** - * Upper limit,＋ indicates positive infinity + * Upper limit, + indicates positive infinity * @return upperLimit **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedHistoryLoanRate.java b/src/main/java/io/gate/gateapi/models/UnifiedHistoryLoanRate.java index 4c0fe2c..dbcc1e9 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedHistoryLoanRate.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedHistoryLoanRate.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -70,7 +70,7 @@ public UnifiedHistoryLoanRate tier(String tier) { } /** - * The VIP level of the floating rate required + * VIP level for the floating rate to be retrieved * @return tier **/ @javax.annotation.Nullable @@ -90,7 +90,7 @@ public UnifiedHistoryLoanRate tierUpRate(String tierUpRate) { } /** - * VIP level corresponding floating rate + * Floating rate corresponding to VIP level * @return tierUpRate **/ @javax.annotation.Nullable @@ -118,7 +118,7 @@ public UnifiedHistoryLoanRate addRatesItem(UnifiedHistoryLoanRateRates ratesItem } /** - * 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 + * 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 * @return rates **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedHistoryLoanRateRates.java b/src/main/java/io/gate/gateapi/models/UnifiedHistoryLoanRateRates.java index 82da3d4..fcbc9c4 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedHistoryLoanRateRates.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedHistoryLoanRateRates.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -39,7 +39,7 @@ public UnifiedHistoryLoanRateRates time(Long time) { } /** - * The hourly timestamp corresponding to the interest rate, in milliseconds + * Hourly timestamp corresponding to this interest rate, in milliseconds * @return time **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public UnifiedHistoryLoanRateRates rate(String rate) { } /** - * Historical interest rates for this hour + * Historical interest rate for this hour * @return rate **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedLeverageConfig.java b/src/main/java/io/gate/gateapi/models/UnifiedLeverageConfig.java index b9c3c20..6073415 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedLeverageConfig.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedLeverageConfig.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -159,7 +159,7 @@ public UnifiedLeverageConfig borrowable(String borrowable) { } /** - * The current leverage you can choose is + * Maximum borrowable amount at current leverage * @return borrowable **/ @javax.annotation.Nullable @@ -179,7 +179,7 @@ public UnifiedLeverageConfig exceptLeverageBorrowable(String exceptLeverageBorro } /** - * The maximum amount of margin that can be borrowed and the maximum amount of Uniloan that can be borrowed, whichever is smaller + * Maximum borrowable from margin and maximum borrowable from Earn, whichever is smaller * @return exceptLeverageBorrowable **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedLeverageSetting.java b/src/main/java/io/gate/gateapi/models/UnifiedLeverageSetting.java index 7ed4c19..5b869a9 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedLeverageSetting.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedLeverageSetting.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Loan currency leverage + * Leverage multiplier for borrowing currency */ public class UnifiedLeverageSetting { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -58,7 +58,7 @@ public UnifiedLeverageSetting leverage(String leverage) { } /** - * multiple + * Multiplier * @return leverage **/ public String getLeverage() { diff --git a/src/main/java/io/gate/gateapi/models/UnifiedLoan.java b/src/main/java/io/gate/gateapi/models/UnifiedLoan.java index ba5dae6..f69f3f0 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedLoan.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedLoan.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -28,7 +28,7 @@ public class UnifiedLoan { private String currency; /** - * type: borrow - borrow, repay - repay + * Type: `borrow` - borrow, `repay` - repay */ @JsonAdapter(TypeEnum.Adapter.class) public enum TypeEnum { @@ -117,7 +117,7 @@ public UnifiedLoan type(TypeEnum type) { } /** - * type: borrow - borrow, repay - repay + * Type: `borrow` - borrow, `repay` - repay * @return type **/ public TypeEnum getType() { @@ -136,7 +136,7 @@ public UnifiedLoan amount(String amount) { } /** - * The amount of lending or repaying + * Borrow or repayment amount * @return amount **/ public String getAmount() { @@ -155,7 +155,7 @@ public UnifiedLoan repaidAll(Boolean repaidAll) { } /** - * Full repayment is solely for repayment operations. When set to 'true,' it overrides the 'amount,' allowing for direct full repayment. + * Full repayment, only used for repayment operations. When set to `true`, overrides `amount` and directly repays the full amount * @return repaidAll **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedLoanRecord.java b/src/main/java/io/gate/gateapi/models/UnifiedLoanRecord.java index 0a9e362..b759379 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedLoanRecord.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedLoanRecord.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Loan records + * Borrowing Records */ public class UnifiedLoanRecord { public static final String SERIALIZED_NAME_ID = "id"; @@ -57,7 +57,7 @@ public class UnifiedLoanRecord { /** - * id + * ID * @return id **/ @javax.annotation.Nullable @@ -67,7 +67,7 @@ public Long getId() { /** - * type: borrow - borrow, repay - repay + * Type: `borrow` - borrow, `repay` - repay * @return type **/ @javax.annotation.Nullable @@ -77,7 +77,7 @@ public String getType() { /** - * Repayment type, none - No repayment type, manual_repay - Manual repayment, auto_repay - Automatic repayment, cancel_auto_repay - Automatic repayment after withdrawal, different_currencies_repayment - Different currency repayment + * 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 * @return repaymentType **/ @javax.annotation.Nullable @@ -93,7 +93,7 @@ public UnifiedLoanRecord borrowType(String borrowType) { } /** - * Loan type, returned when querying loan records. manual_borrow - Manual repayment , auto_borrow - Automatic repayment + * Borrowing type, returned when querying loan records: manual_borrow - Manual borrowing, auto_borrow - Automatic borrowing * @return borrowType **/ @javax.annotation.Nullable @@ -127,7 +127,7 @@ public String getCurrency() { /** - * The amount of lending or repaying + * Borrow or repayment amount * @return amount **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedLoanResult.java b/src/main/java/io/gate/gateapi/models/UnifiedLoanResult.java index f34c9ce..bd4269c 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedLoanResult.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedLoanResult.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Unified account loan and repayment response results + * Unified account borrowing and repayment response result */ public class UnifiedLoanResult { public static final String SERIALIZED_NAME_TRAN_ID = "tran_id"; @@ -35,7 +35,7 @@ public UnifiedLoanResult tranId(Long tranId) { } /** - * Transaction id + * Transaction ID * @return tranId **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedMarginTiers.java b/src/main/java/io/gate/gateapi/models/UnifiedMarginTiers.java index 963b2aa..1eac0ac 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedMarginTiers.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedMarginTiers.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -23,7 +23,7 @@ import java.util.List; /** - * Unified margin tiers + * Unified account borrowing margin tiers */ public class UnifiedMarginTiers { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -70,7 +70,7 @@ public UnifiedMarginTiers addMarginTiersItem(MarginTiers marginTiersItem) { } /** - * Margin tiers + * Tiered margin * @return marginTiers **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedModeSet.java b/src/main/java/io/gate/gateapi/models/UnifiedModeSet.java index 5e724ba..855fc5f 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedModeSet.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedModeSet.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -40,7 +40,7 @@ public UnifiedModeSet mode(String mode) { } /** - * Unified account mode: - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single Currency Margin Model + * Unified account mode: - `classic`: Classic account mode - `multi_currency`: Cross-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single-currency margin mode * @return mode **/ public String getMode() { diff --git a/src/main/java/io/gate/gateapi/models/UnifiedPortfolioInput.java b/src/main/java/io/gate/gateapi/models/UnifiedPortfolioInput.java index ab36e64..841e7bf 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedPortfolioInput.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedPortfolioInput.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -28,7 +28,7 @@ import java.util.List; /** - * Input for the portfolio margin calculator. + * Portfolio margin calculator input */ public class UnifiedPortfolioInput { public static final String SERIALIZED_NAME_SPOT_BALANCES = "spot_balances"; @@ -235,7 +235,7 @@ public UnifiedPortfolioInput spotHedge(Boolean spotHedge) { } /** - * Whether to enable spot hedging. + * Whether to enable spot hedging * @return spotHedge **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedPortfolioOutput.java b/src/main/java/io/gate/gateapi/models/UnifiedPortfolioOutput.java index c8adf73..7a9b9c1 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedPortfolioOutput.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedPortfolioOutput.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -23,7 +23,7 @@ import java.util.List; /** - * The output of the portfolio margin calculator. + * Portfolio margin calculator output */ public class UnifiedPortfolioOutput { public static final String SERIALIZED_NAME_MAINTAIN_MARGIN_TOTAL = "maintain_margin_total"; @@ -50,7 +50,7 @@ public UnifiedPortfolioOutput maintainMarginTotal(String maintainMarginTotal) { } /** - * 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. + * 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 * @return maintainMarginTotal **/ @javax.annotation.Nullable @@ -70,7 +70,7 @@ public UnifiedPortfolioOutput initialMarginTotal(String initialMarginTotal) { } /** - * Total initial margin, calculated as the maximum of the following three combinations: position, position + positive delta orders, position + negative delta orders. + * Total initial margin, calculated as the maximum of the following three combinations: position, position + positive delta orders, position + negative delta orders * @return initialMarginTotal **/ @javax.annotation.Nullable @@ -90,7 +90,7 @@ public UnifiedPortfolioOutput calculateTime(Long calculateTime) { } /** - * Calculate time + * Calculation time * @return calculateTime **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedRiskUnits.java b/src/main/java/io/gate/gateapi/models/UnifiedRiskUnits.java index 6c8effe..d47e0b4 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedRiskUnits.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedRiskUnits.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -66,7 +66,7 @@ public UnifiedRiskUnits spotHedge(Boolean spotHedge) { } /** - * Spot hedging status, true - enabled, false - not enabled. + * Spot hedging status: true - enabled, false - disabled * @return spotHedge **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedSettings.java b/src/main/java/io/gate/gateapi/models/UnifiedSettings.java index 718ad35..3ba73ea 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedSettings.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedSettings.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -47,7 +47,7 @@ public UnifiedSettings usdtFutures(Boolean usdtFutures) { } /** - * USDT contract switch. In cross-currency margin mode, it can only be turned on and not off + * USDT futures switch. In cross-currency margin mode, can only be enabled and cannot be disabled * @return usdtFutures **/ @javax.annotation.Nullable @@ -67,7 +67,7 @@ public UnifiedSettings spotHedge(Boolean spotHedge) { } /** - * Spot hedging switch. + * Spot hedging switch * @return spotHedge **/ @javax.annotation.Nullable @@ -87,7 +87,7 @@ public UnifiedSettings useFunding(Boolean useFunding) { } /** - * switch, when the mode is cross-currency margin mode, whether to use Uniloan financial funds as margin + * Earn switch, when mode is cross-currency margin mode, whether to use Earn funds as margin * @return useFunding **/ @javax.annotation.Nullable @@ -107,7 +107,7 @@ public UnifiedSettings options(Boolean options) { } /** - * Option switch. In cross-currency margin mode, it can only be turned on and not off + * Options switch. In cross-currency margin mode, can only be enabled and cannot be disabled * @return options **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedTransferable.java b/src/main/java/io/gate/gateapi/models/UnifiedTransferable.java index bf15f53..6fd5153 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedTransferable.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedTransferable.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -59,7 +59,7 @@ public UnifiedTransferable amount(String amount) { } /** - * The maximum amount that can be transferred out + * Maximum transferable amount * @return amount **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UserLtvInfo.java b/src/main/java/io/gate/gateapi/models/UserLtvInfo.java index 797c6c5..496d13f 100644 --- a/src/main/java/io/gate/gateapi/models/UserLtvInfo.java +++ b/src/main/java/io/gate/gateapi/models/UserLtvInfo.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -59,7 +59,7 @@ public UserLtvInfo collateralCurrency(String collateralCurrency) { } /** - * Collateral + * Collateral currency * @return collateralCurrency **/ @javax.annotation.Nullable @@ -99,7 +99,7 @@ public UserLtvInfo initLtv(String initLtv) { } /** - * The initial collateralization rate + * Initial collateralization rate * @return initLtv **/ @javax.annotation.Nullable @@ -119,7 +119,7 @@ public UserLtvInfo alertLtv(String alertLtv) { } /** - * Warning collateralization ratio + * Warning collateralization rate * @return alertLtv **/ @javax.annotation.Nullable @@ -139,7 +139,7 @@ public UserLtvInfo liquidateLtv(String liquidateLtv) { } /** - * The liquidation collateralization rate + * Liquidation collateralization rate * @return liquidateLtv **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UserSub.java b/src/main/java/io/gate/gateapi/models/UserSub.java index 536943b..a276564 100644 --- a/src/main/java/io/gate/gateapi/models/UserSub.java +++ b/src/main/java/io/gate/gateapi/models/UserSub.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -67,7 +67,7 @@ public UserSub belong(String belong) { } /** - * The system to which the user belongs (partner referral). If empty, it means not belonging to any system. + * User's system affiliation (partner/referral). Empty means not belonging to any system * @return belong **/ @javax.annotation.Nullable @@ -87,7 +87,7 @@ public UserSub type(Long type) { } /** - * Type (0-not in the system 1-direct subordinate agent 2-indirect subordinate agent 3-direct direct customer 4-indirect direct customer 5-ordinary user) + * Type (0-Not in system 1-Direct subordinate agent 2-Indirect subordinate agent 3-Direct direct customer 4-Indirect direct customer 5-Regular user) * @return type **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UserSubRelation.java b/src/main/java/io/gate/gateapi/models/UserSubRelation.java index 065ec11..c76a733 100644 --- a/src/main/java/io/gate/gateapi/models/UserSubRelation.java +++ b/src/main/java/io/gate/gateapi/models/UserSubRelation.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech diff --git a/src/main/java/io/gate/gateapi/models/UserTotalAmount.java b/src/main/java/io/gate/gateapi/models/UserTotalAmount.java index ea6ec78..b416530 100644 --- a/src/main/java/io/gate/gateapi/models/UserTotalAmount.java +++ b/src/main/java/io/gate/gateapi/models/UserTotalAmount.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Total borrowed amount and pledged collateral amount by the user + * User's total borrowing and collateral amount */ public class UserTotalAmount { public static final String SERIALIZED_NAME_BORROW_AMOUNT = "borrow_amount"; @@ -39,7 +39,7 @@ public UserTotalAmount borrowAmount(String borrowAmount) { } /** - * Total borrowing amount, calculated in USDT + * Total borrowing amount in USDT * @return borrowAmount **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public UserTotalAmount collateralAmount(String collateralAmount) { } /** - * Total collateral amount, calculated in USDT + * Total collateral amount in USDT * @return collateralAmount **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/WithdrawStatus.java b/src/main/java/io/gate/gateapi/models/WithdrawStatus.java index dc72aad..da92b8d 100644 --- a/src/main/java/io/gate/gateapi/models/WithdrawStatus.java +++ b/src/main/java/io/gate/gateapi/models/WithdrawStatus.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -142,7 +142,7 @@ public WithdrawStatus deposit(String deposit) { } /** - * Deposits fee + * Deposit fee * @return deposit **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/WithdrawalRecord.java b/src/main/java/io/gate/gateapi/models/WithdrawalRecord.java index c027354..207ac42 100644 --- a/src/main/java/io/gate/gateapi/models/WithdrawalRecord.java +++ b/src/main/java/io/gate/gateapi/models/WithdrawalRecord.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -101,7 +101,7 @@ public String getTxid() { /** - * 区块编号 + * Block Number * @return blockNumber **/ @javax.annotation.Nullable @@ -147,7 +147,7 @@ public WithdrawalRecord amount(String amount) { } /** - * Currency amount + * Token amount * @return amount **/ public String getAmount() { @@ -215,7 +215,7 @@ public WithdrawalRecord failReason(String failReason) { } /** - * The reason for withdrawal failure is that there is a value when status = CANCEL, and the rest of the state is empty + * Reason for withdrawal failure. Has a value when status = CANCEL, empty for all other statuses * @return failReason **/ @javax.annotation.Nullable @@ -235,7 +235,7 @@ public WithdrawalRecord timestamp2(String timestamp2) { } /** - * 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 time to withdrawal success + * 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 * @return timestamp2 **/ @javax.annotation.Nullable