From d24d4d36b00d8dc75f2bb6c72ae5d2ce25eb9783 Mon Sep 17 00:00:00 2001 From: gateio Date: Tue, 17 Jun 2025 09:54:08 +0000 Subject: [PATCH 01/14] update to v6.99.0 --- README.md | 45 +- build.gradle | 2 +- build.sbt | 2 +- docs/CrossMarginAccount.md | 25 - docs/CrossMarginAccountBook.md | 14 - docs/CrossMarginBalance.md | 5 - docs/CrossMarginBalance1.md | 12 - docs/CrossMarginCurrency.md | 18 - docs/CrossMarginRepayRequest.md | 10 - docs/CrossMarginTransferable.md | 10 - docs/EarnUniApi.md | 76 +- docs/MarginApi.md | 1068 +----- docs/MarginUniApi.md | 230 +- docs/SpotAccount.md | 1 + docs/SpotApi.md | 2 +- docs/SubCrossMarginAccount.md | 2 +- docs/UniInterestMode.md | 12 - pom.xml | 4 +- src/main/java/io/gate/gateapi/ApiClient.java | 2 +- .../java/io/gate/gateapi/api/EarnUniApi.java | 132 +- .../java/io/gate/gateapi/api/MarginApi.java | 3126 +++++------------ .../io/gate/gateapi/api/MarginUniApi.java | 750 ++-- .../java/io/gate/gateapi/api/SpotApi.java | 6 +- .../gateapi/models/CrossMarginAccount.java | 517 --- .../models/CrossMarginAccountBook.java | 219 -- .../gateapi/models/CrossMarginBalance.java | 134 +- .../gateapi/models/CrossMarginBalance1.java | 167 - .../gateapi/models/CrossMarginCurrency.java | 323 -- .../models/CrossMarginRepayRequest.java | 113 - .../models/CrossMarginTransferable.java | 115 - .../io/gate/gateapi/models/SpotAccount.java | 30 +- .../gateapi/models/SubCrossMarginAccount.java | 12 +- .../gate/gateapi/models/UniInterestMode.java | 113 - 33 files changed, 1529 insertions(+), 5768 deletions(-) delete mode 100644 docs/CrossMarginAccount.md delete mode 100644 docs/CrossMarginAccountBook.md delete mode 100644 docs/CrossMarginBalance1.md delete mode 100644 docs/CrossMarginCurrency.md delete mode 100644 docs/CrossMarginRepayRequest.md delete mode 100644 docs/CrossMarginTransferable.md delete mode 100644 docs/UniInterestMode.md delete mode 100644 src/main/java/io/gate/gateapi/models/CrossMarginAccount.java delete mode 100644 src/main/java/io/gate/gateapi/models/CrossMarginAccountBook.java delete mode 100644 src/main/java/io/gate/gateapi/models/CrossMarginBalance1.java delete mode 100644 src/main/java/io/gate/gateapi/models/CrossMarginCurrency.java delete mode 100644 src/main/java/io/gate/gateapi/models/CrossMarginRepayRequest.java delete mode 100644 src/main/java/io/gate/gateapi/models/CrossMarginTransferable.java delete mode 100644 src/main/java/io/gate/gateapi/models/UniInterestMode.java diff --git a/README.md b/README.md index 56d0ad0..26bdb3c 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ Gate API v4 -- API version: 4.98.0 -- SDK version: 6.98.0 +- API version: 4.99.0 +- SDK version: 6.99.0 Welcome to Gate API @@ -53,7 +53,7 @@ Add this dependency to your project's POM: io.gate gate-api - 6.98.0 + 6.99.0 compile ``` @@ -63,7 +63,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:6.99.0" ``` ### Others @@ -76,7 +76,7 @@ mvn clean package Then manually install the following JARs: -* `target/gate-api-6.98.0.jar` +* `target/gate-api-6.99.0.jar` * `target/lib/*.jar` To install the API client library to your local Maven repository, simply execute: @@ -205,7 +205,6 @@ Class | Method | HTTP request | Description *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 *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 @@ -263,36 +262,25 @@ Class | Method | HTTP request | Description *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 *MarginApi* | [**listMarginAccounts**](docs/MarginApi.md#listMarginAccounts) | **GET** /margin/accounts | Margin account list +*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 *MarginApi* | [**listMarginAccountBook**](docs/MarginApi.md#listMarginAccountBook) | **GET** /margin/account_book | List 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* | [**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* | [**createUniLoan**](docs/MarginUniApi.md#createUniLoan) | **POST** /margin/uni/loans | Borrow or repay +*MarginUniApi* | [**getUniBorrowable**](docs/MarginUniApi.md#getUniBorrowable) | **GET** /margin/uni/borrowable | Get maximum borrowable +*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* | [**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 @@ -476,15 +464,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) @@ -651,7 +633,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) @@ -702,5 +683,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..ea5ee91 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 = '6.99.0' buildscript { repositories { diff --git a/build.sbt b/build.sbt index 3fcf8ab..d02e701 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 := "6.99.0", scalaVersion := "2.11.4", scalacOptions ++= Seq("-feature"), javacOptions in compile ++= Seq("-Xlint:deprecation"), 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..806732e 100644 --- a/docs/CrossMarginBalance.md +++ b/docs/CrossMarginBalance.md @@ -9,9 +9,4 @@ Name | Type | Description | Notes **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] 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/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/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/EarnUniApi.md b/docs/EarnUniApi.md index e99b174..4d19c85 100644 --- a/docs/EarnUniApi.md +++ b/docs/EarnUniApi.md @@ -12,7 +12,6 @@ Method | HTTP request | Description [**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 [**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 @@ -591,73 +590,6 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **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 | - | - # **getUniInterestStatus** > UniCurrencyInterest getUniInterestStatus(currency) @@ -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-06-17 09:53+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 ### Example @@ -798,7 +730,7 @@ 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-06-17 09:53+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 | - | # **listUniRate** @@ -806,7 +738,7 @@ Name | Type | Description | Notes 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 +Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-06-17 09:53+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 ### 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-06-17 09:53+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 | - | diff --git a/docs/MarginApi.md b/docs/MarginApi.md index c2050bc..dede4b8 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 +[**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 [**listMarginAccountBook**](MarginApi.md#listMarginAccountBook) | **GET** /margin/account_book | List 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) [**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 @@ -99,13 +88,11 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | List retrieved | - | - -# **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 + +# **getUserMarginTier** +> List<MarginLeverageTier> getUserMarginTier(currencyPair) -Only transferals from and to margin account are provided for now. Time range allows 30 days at most +Check the user's own leverage lending gradient in the current market ### Example @@ -128,29 +115,15 @@ 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 - Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + String currencyPair = "BTC_USDT"; // String | Currency pair try { - List result = apiInstance.listMarginAccountBook() - .currency(currency) - .currencyPair(currencyPair) - .type(type) - .from(from) - .to(to) - .page(page) - .limit(limit) - .execute(); + 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#listMarginAccountBook"); + System.err.println("Exception when calling MarginApi#getUserMarginTier"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -163,17 +136,11 @@ 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] - **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] + **currencyPair** | **String**| Currency pair | ### Return type -[**List<MarginAccountBook>**](MarginAccountBook.md) +[**List<MarginLeverageTier>**](MarginLeverageTier.md) ### Authorization @@ -187,13 +154,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | Successfully retrieved | - | - -# **listFundingAccounts** -> List<FundingAccount> listFundingAccounts().currency(currency).execute(); + +# **getMarketMarginTier** +> List<MarginLeverageTier> getMarketMarginTier(currencyPair) -Funding account list +Query the current market leverage lending gradient ### Example @@ -203,7 +170,6 @@ 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; @@ -211,22 +177,17 @@ 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 + String currencyPair = "BTC_USDT"; // String | Currency pair try { - List result = apiInstance.listFundingAccounts() - .currency(currency) - .execute(); + 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#listFundingAccounts"); + System.err.println("Exception when calling MarginApi#getMarketMarginTier"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -239,15 +200,15 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | [optional] + **currencyPair** | **String**| Currency pair | ### Return type -[**List<FundingAccount>**](FundingAccount.md) +[**List<MarginLeverageTier>**](MarginLeverageTier.md) ### Authorization -[apiv4](../README.md#apiv4) +No authorization required ### HTTP request headers @@ -257,13 +218,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | Successfully retrieved | - | - -# **getAutoRepayStatus** -> AutoRepaySetting getAutoRepayStatus() + +# **setUserMarketLeverage** +> setUserMarketLeverage(marginMarketLeverage) -Retrieve user auto repayment setting +Set the user market leverage multiple ### Example @@ -286,14 +247,14 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginApi apiInstance = new MarginApi(defaultClient); + MarginMarketLeverage marginMarketLeverage = new MarginMarketLeverage(); // MarginMarketLeverage | try { - AutoRepaySetting result = apiInstance.getAutoRepayStatus(); - 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#getAutoRepayStatus"); + System.err.println("Exception when calling MarginApi#setUserMarketLeverage"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -303,11 +264,14 @@ public class Example { ``` ### Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **marginMarketLeverage** | [**MarginMarketLeverage**](MarginMarketLeverage.md)| | ### Return type -[**AutoRepaySetting**](AutoRepaySetting.md) +null (empty response body) ### Authorization @@ -315,19 +279,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** | Current auto repayment setting | - | +**204** | Success | - | - -# **setAutoRepay** -> AutoRepaySetting setAutoRepay(status) + +# **listMarginUserAccount** +> List<MarginAccount> listMarginUserAccount().currencyPair(currencyPair).execute(); -Update user's auto repayment setting +Query the user's leverage account list + +Support querying risk rate per position account and margin rate per position account ### Example @@ -350,15 +316,17 @@ 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 currencyPair = "BTC_USDT"; // String | Currency pair try { - AutoRepaySetting result = apiInstance.setAutoRepay(status); + 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#setAutoRepay"); + System.err.println("Exception when calling MarginApi#listMarginUserAccount"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -371,11 +339,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **status** | **String**| New auto repayment status. `on` - enabled, `off` - disabled | + **currencyPair** | **String**| Currency pair | [optional] ### Return type -[**AutoRepaySetting**](AutoRepaySetting.md) +[**List<MarginAccount>**](MarginAccount.md) ### Authorization @@ -389,13 +357,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Current auto repayment setting | - | +**200** | List retrieved | - | - -# **getMarginTransferable** -> MarginTransferable getMarginTransferable(currency).currencyPair(currencyPair).execute(); + +# **listMarginAccountBook** +> List<MarginAccountBook> listMarginAccountBook().currency(currency).currencyPair(currencyPair).type(type).from(from).to(to).page(page).limit(limit).execute(); -Get the max transferable amount for a specific margin currency +List margin account balance change history + +Only transferals from and to margin account are provided for now. Time range allows 30 days at most ### Example @@ -418,18 +388,29 @@ 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 currencyPair = "BTC_USDT"; // String | Currency pair + 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 + Integer page = 1; // Integer | Page number + Integer limit = 100; // Integer | Maximum number of records to be returned in a single list try { - MarginTransferable result = apiInstance.getMarginTransferable(currency) + List result = apiInstance.listMarginAccountBook() + .currency(currency) .currencyPair(currencyPair) + .type(type) + .from(from) + .to(to) + .page(page) + .limit(limit) .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#getMarginTransferable"); + System.err.println("Exception when calling MarginApi#listMarginAccountBook"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -442,12 +423,17 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | - **currencyPair** | **String**| Currency pair | [optional] + **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] + **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] ### Return type -[**MarginTransferable**](MarginTransferable.md) +[**List<MarginAccountBook>**](MarginAccountBook.md) ### Authorization @@ -461,13 +447,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | List retrieved | - | - -# **listCrossMarginCurrencies** -> List<CrossMarginCurrency> listCrossMarginCurrencies() + +# **listFundingAccounts** +> List<FundingAccount> listFundingAccounts().currency(currency).execute(); -Currencies supported by cross margin.(deprecated) +Funding account list ### Example @@ -477,6 +463,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 +471,22 @@ 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 { - List result = apiInstance.listCrossMarginCurrencies(); + List result = apiInstance.listFundingAccounts() + .currency(currency) + .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#listCrossMarginCurrencies"); + System.err.println("Exception when calling MarginApi#listFundingAccounts"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -503,15 +496,18 @@ public class Example { ``` ### Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **currency** | **String**| Retrieve data of the specified currency | [optional] ### Return type -[**List<CrossMarginCurrency>**](CrossMarginCurrency.md) +[**List<FundingAccount>**](FundingAccount.md) ### Authorization -No authorization required +[apiv4](../README.md#apiv4) ### HTTP request headers @@ -523,11 +519,11 @@ No authorization required |-------------|-------------|------------------| **200** | List retrieved | - | - -# **getCrossMarginCurrency** -> CrossMarginCurrency getCrossMarginCurrency(currency) + +# **getAutoRepayStatus** +> AutoRepaySetting getAutoRepayStatus() -Retrieve detail of one single currency supported by cross margin. (deprecated) +Retrieve user auto repayment setting ### Example @@ -537,6 +533,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; @@ -544,17 +541,19 @@ 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 | Currency name try { - CrossMarginCurrency result = apiInstance.getCrossMarginCurrency(currency); + AutoRepaySetting result = apiInstance.getAutoRepayStatus(); 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#getAutoRepayStatus"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -564,18 +563,15 @@ public class Example { ``` ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **currency** | **String**| Currency name | +This endpoint does not need any parameter. ### Return type -[**CrossMarginCurrency**](CrossMarginCurrency.md) +[**AutoRepaySetting**](AutoRepaySetting.md) ### Authorization -No authorization required +[apiv4](../README.md#apiv4) ### HTTP request headers @@ -585,13 +581,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Current auto repayment setting | - | - -# **getCrossMarginAccount** -> CrossMarginAccount getCrossMarginAccount() + +# **setAutoRepay** +> AutoRepaySetting setAutoRepay(status) -Retrieve cross margin account. (deprecated) +Update user's auto repayment setting ### Example @@ -614,14 +610,15 @@ 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 try { - CrossMarginAccount result = apiInstance.getCrossMarginAccount(); + AutoRepaySetting result = apiInstance.setAutoRepay(status); 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#getCrossMarginAccount"); + System.err.println("Exception when calling MarginApi#setAutoRepay"); 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 +------------- | ------------- | ------------- | ------------- + **status** | **String**| New auto repayment status. `on` - enabled, `off` - disabled | ### Return type -[**CrossMarginAccount**](CrossMarginAccount.md) +[**AutoRepaySetting**](AutoRepaySetting.md) ### Authorization @@ -649,15 +649,13 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | - - -# **listCrossMarginAccountBook** -> List<CrossMarginAccountBook> listCrossMarginAccountBook().currency(currency).from(from).to(to).page(page).limit(limit).type(type).execute(); +**200** | Current auto repayment setting | - | -Retrieve cross margin account change history. (deprecated) + +# **getMarginTransferable** +> MarginTransferable getMarginTransferable(currency).currencyPair(currencyPair).execute(); -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. +Get the max transferable amount for a specific margin currency ### Example @@ -680,27 +678,18 @@ 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 currency = "BTC"; // String | Retrieve data of the specified currency + String currencyPair = "BTC_USDT"; // String | Currency pair try { - List result = apiInstance.listCrossMarginAccountBook() - .currency(currency) - .from(from) - .to(to) - .page(page) - .limit(limit) - .type(type) + MarginTransferable result = apiInstance.getMarginTransferable(currency) + .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#getMarginTransferable"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -713,16 +702,12 @@ 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] + **currency** | **String**| Retrieve data of the specified currency | + **currencyPair** | **String**| Currency pair | [optional] ### Return type -[**List<CrossMarginAccountBook>**](CrossMarginAccountBook.md) +[**MarginTransferable**](MarginTransferable.md) ### Authorization @@ -736,7 +721,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | Successfully retrieved | - | # **listCrossMarginLoans** @@ -821,144 +806,6 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **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 | - | - # **listCrossMarginRepayments** > List<CrossMarginRepayment> listCrossMarginRepayments().currency(currency).loanId(loanId).limit(limit).offset(offset).reverse(reverse).execute(); @@ -1043,632 +890,3 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **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 | - | - diff --git a/docs/MarginUniApi.md b/docs/MarginUniApi.md index 2594a68..8aab8f4 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 [**createUniLoan**](MarginUniApi.md#createUniLoan) | **POST** /margin/uni/loans | Borrow or repay +[**getUniBorrowable**](MarginUniApi.md#getUniBorrowable) | **GET** /margin/uni/borrowable | Get maximum borrowable +[**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 [**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 @@ -74,11 +74,11 @@ No authorization required |-------------|-------------|------------------| **200** | Successfully retrieved | - | - -# **getUniCurrencyPair** -> UniCurrencyPair getUniCurrencyPair(currencyPair) + +# **listUniLoans** +> List<UniLoan> listUniLoans().currencyPair(currencyPair).currency(currency).page(page).limit(limit).execute(); -Get detail of lending market +List loans ### Example @@ -88,6 +88,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.MarginUniApi; @@ -95,17 +96,28 @@ 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"); MarginUniApi apiInstance = new MarginUniApi(defaultClient); - String currencyPair = "AE_USDT"; // String | Currency pair + String currencyPair = "BTC_USDT"; // String | Currency pair + 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 try { - UniCurrencyPair result = apiInstance.getUniCurrencyPair(currencyPair); + List result = apiInstance.listUniLoans() + .currencyPair(currencyPair) + .currency(currency) + .page(page) + .limit(limit) + .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 MarginUniApi#getUniCurrencyPair"); + System.err.println("Exception when calling MarginUniApi#listUniLoans"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -118,15 +130,18 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair | + **currencyPair** | **String**| Currency pair | [optional] + **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] ### Return type -[**UniCurrencyPair**](UniCurrencyPair.md) +[**List<UniLoan>**](UniLoan.md) ### Authorization -No authorization required +[apiv4](../README.md#apiv4) ### HTTP request headers @@ -138,13 +153,11 @@ No authorization required |-------------|-------------|------------------| **200** | Successfully retrieved | - | - -# **getMarginUniEstimateRate** -> Map<String, String> getMarginUniEstimateRate(currencies) - -Estimate interest Rate + +# **createUniLoan** +> createUniLoan(createUniLoan) -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. +Borrow or repay ### Example @@ -167,15 +180,14 @@ 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 + CreateUniLoan createUniLoan = new CreateUniLoan(); // CreateUniLoan | try { - Map result = apiInstance.getMarginUniEstimateRate(currencies); - System.out.println(result); + apiInstance.createUniLoan(createUniLoan); } 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 MarginUniApi#getMarginUniEstimateRate"); + System.err.println("Exception when calling MarginUniApi#createUniLoan"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -188,11 +200,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencies** | [**List<String>**](String.md)| An array of up to 10 specifying the currency name | + **createUniLoan** | [**CreateUniLoan**](CreateUniLoan.md)| | ### Return type -**Map<String, String>** +null (empty response body) ### Authorization @@ -200,19 +212,19 @@ Name | Type | Description | Notes ### 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** | Operated successfully | - | - -# **listUniLoans** -> List<UniLoan> listUniLoans().currencyPair(currencyPair).currency(currency).page(page).limit(limit).execute(); + +# **getUniBorrowable** +> MaxUniBorrowable getUniBorrowable(currency, currencyPair) -List loans +Get maximum borrowable ### Example @@ -235,23 +247,16 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginUniApi apiInstance = new MarginUniApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Currency pair 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 + String currencyPair = "BTC_USDT"; // String | Currency pair try { - List result = apiInstance.listUniLoans() - .currencyPair(currencyPair) - .currency(currency) - .page(page) - .limit(limit) - .execute(); + MaxUniBorrowable result = apiInstance.getUniBorrowable(currency, 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 MarginUniApi#listUniLoans"); + System.err.println("Exception when calling MarginUniApi#getUniBorrowable"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -264,14 +269,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair | [optional] - **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] + **currency** | **String**| Retrieve data of the specified currency | + **currencyPair** | **String**| Currency pair | ### Return type -[**List<UniLoan>**](UniLoan.md) +[**MaxUniBorrowable**](MaxUniBorrowable.md) ### Authorization @@ -287,11 +290,11 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | Successfully retrieved | - | - -# **createUniLoan** -> createUniLoan(createUniLoan) + +# **getUniCurrencyPair** +> UniCurrencyPair getUniCurrencyPair(currencyPair) -Borrow or repay +Get detail of lending market ### Example @@ -301,7 +304,6 @@ 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.MarginUniApi; @@ -309,19 +311,17 @@ 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"); MarginUniApi apiInstance = new MarginUniApi(defaultClient); - CreateUniLoan createUniLoan = new CreateUniLoan(); // CreateUniLoan | + String currencyPair = "AE_USDT"; // String | Currency pair try { - apiInstance.createUniLoan(createUniLoan); + UniCurrencyPair result = apiInstance.getUniCurrencyPair(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 MarginUniApi#createUniLoan"); + System.err.println("Exception when calling MarginUniApi#getUniCurrencyPair"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -334,31 +334,33 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **createUniLoan** | [**CreateUniLoan**](CreateUniLoan.md)| | + **currencyPair** | **String**| Currency pair | ### Return type -null (empty response body) +[**UniCurrencyPair**](UniCurrencyPair.md) ### Authorization -[apiv4](../README.md#apiv4) +No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined + - **Content-Type**: Not defined + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Operated successfully | - | +**200** | Successfully retrieved | - | - -# **listUniLoanRecords** -> List<UniLoanRecord> listUniLoanRecords().type(type).currency(currency).currencyPair(currencyPair).page(page).limit(limit).execute(); + +# **getMarginUniEstimateRate** +> Map<String, String> getMarginUniEstimateRate(currencies) -Get load records +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. ### Example @@ -381,25 +383,15 @@ 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 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 + List currencies = Arrays.asList(); // List | An array of up to 10 specifying the currency name try { - List result = apiInstance.listUniLoanRecords() - .type(type) - .currency(currency) - .currencyPair(currencyPair) - .page(page) - .limit(limit) - .execute(); + Map result = apiInstance.getMarginUniEstimateRate(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 MarginUniApi#listUniLoanRecords"); + System.err.println("Exception when calling MarginUniApi#getMarginUniEstimateRate"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -412,15 +404,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] - **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] + **currencies** | [**List<String>**](String.md)| An array of up to 10 specifying the currency name | ### Return type -[**List<UniLoanRecord>**](UniLoanRecord.md) +**Map<String, String>** ### Authorization @@ -436,11 +424,11 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | Successfully retrieved | - | - -# **listUniLoanInterestRecords** -> List<UniLoanInterestRecord> listUniLoanInterestRecords().currencyPair(currencyPair).currency(currency).page(page).limit(limit).from(from).to(to).execute(); + +# **listUniLoanRecords** +> List<UniLoanRecord> listUniLoanRecords().type(type).currency(currency).currencyPair(currencyPair).page(page).limit(limit).execute(); -List interest records +Get load records ### Example @@ -463,27 +451,25 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginUniApi apiInstance = new MarginUniApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Currency pair + String type = "type_example"; // String | type: borrow - borrow, repay - repay String currency = "BTC"; // String | Retrieve data of the specified currency + String currencyPair = "BTC_USDT"; // String | Currency pair 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 response items. Default: 100, minimum: 1, Maximum: 100 try { - List result = apiInstance.listUniLoanInterestRecords() - .currencyPair(currencyPair) + List result = apiInstance.listUniLoanRecords() + .type(type) .currency(currency) + .currencyPair(currencyPair) .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 MarginUniApi#listUniLoanInterestRecords"); + System.err.println("Exception when calling MarginUniApi#listUniLoanRecords"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -496,16 +482,15 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair | [optional] + **type** | **String**| type: borrow - borrow, repay - repay | [optional] [enum: borrow, repay] **currency** | **String**| Retrieve data of the specified currency | [optional] + **currencyPair** | **String**| Currency pair | [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 response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100] ### Return type -[**List<UniLoanInterestRecord>**](UniLoanInterestRecord.md) +[**List<UniLoanRecord>**](UniLoanRecord.md) ### Authorization @@ -521,11 +506,11 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | Successfully retrieved | - | - -# **getUniBorrowable** -> MaxUniBorrowable getUniBorrowable(currency, currencyPair) + +# **listUniLoanInterestRecords** +> List<UniLoanInterestRecord> listUniLoanInterestRecords().currencyPair(currencyPair).currency(currency).page(page).limit(limit).from(from).to(to).execute(); -Get maximum borrowable +List interest records ### Example @@ -548,16 +533,27 @@ 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 currencyPair = "BTC_USDT"; // String | Currency pair + String currency = "BTC"; // String | Retrieve data of the specified currency + 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 try { - MaxUniBorrowable result = apiInstance.getUniBorrowable(currency, currencyPair); + List result = apiInstance.listUniLoanInterestRecords() + .currencyPair(currencyPair) + .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 MarginUniApi#getUniBorrowable"); + System.err.println("Exception when calling MarginUniApi#listUniLoanInterestRecords"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -570,12 +566,16 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | - **currencyPair** | **String**| Currency pair | + **currencyPair** | **String**| Currency pair | [optional] + **currency** | **String**| Retrieve data of the specified 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 | [optional] + **to** | **Long**| End timestamp | [optional] ### Return type -[**MaxUniBorrowable**](MaxUniBorrowable.md) +[**List<UniLoanInterestRecord>**](UniLoanInterestRecord.md) ### Authorization diff --git a/docs/SpotAccount.md b/docs/SpotAccount.md index 167c46d..87cba1e 100644 --- a/docs/SpotAccount.md +++ b/docs/SpotAccount.md @@ -9,4 +9,5 @@ Name | Type | Description | Notes **available** | **String** | Available amount | [optional] **locked** | **String** | Locked amount, used in trading | [optional] **updateId** | **Long** | Version number | [optional] +**refreshTime** | **Long** | Asset Refresh Time (ms) | [optional] diff --git a/docs/SpotApi.md b/docs/SpotApi.md index 850b617..ffa4d8b 100644 --- a/docs/SpotApi.md +++ b/docs/SpotApi.md @@ -1590,7 +1590,7 @@ Name | Type | Description | Notes 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 +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, it supports modifying the price or quantity (choose one of two), and also supports modifying the price and quantity at the same time 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 ### Example diff --git a/docs/SubCrossMarginAccount.md b/docs/SubCrossMarginAccount.md index 5c63978..c86187d 100644 --- a/docs/SubCrossMarginAccount.md +++ b/docs/SubCrossMarginAccount.md @@ -7,7 +7,7 @@ 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] +**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] 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/pom.xml b/pom.xml index 4f310b5..e150c3a 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ gate-api jar gate-api - 6.98.0 + 6.99.0 https://github.com/gateio/gateapi-java.git Java client for gateapi @@ -25,7 +25,7 @@ Gate - support@mail.gate.io + support@mail.gate.com Gate https://www.gate.io diff --git a/src/main/java/io/gate/gateapi/ApiClient.java b/src/main/java/io/gate/gateapi/ApiClient.java index 297aa6f..382395a 100644 --- a/src/main/java/io/gate/gateapi/ApiClient.java +++ b/src/main/java/io/gate/gateapi/ApiClient.java @@ -113,7 +113,7 @@ private void init() { json = new JSON(); // Set default User-Agent. - setUserAgent("OpenAPI-Generator/6.98.0/java"); + setUserAgent("OpenAPI-Generator/6.99.0/java"); authentications = new HashMap(); } diff --git a/src/main/java/io/gate/gateapi/api/EarnUniApi.java b/src/main/java/io/gate/gateapi/api/EarnUniApi.java index 555dbe2..aa88a2e 100644 --- a/src/main/java/io/gate/gateapi/api/EarnUniApi.java +++ b/src/main/java/io/gate/gateapi/api/EarnUniApi.java @@ -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; @@ -1171,109 +1170,6 @@ 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) @@ -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-06-17 09:53+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 -
*/ public okhttp3.Call listUniChartCall(Long from, Long to, String asset, final ApiCallback _callback) throws ApiException { @@ -1460,7 +1356,7 @@ 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 + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-06-17 09:53+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) * @param asset Currency name (required) @@ -1469,7 +1365,7 @@ private okhttp3.Call listUniChartValidateBeforeCall(Long from, Long to, String a * @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-06-17 09:53+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 -
*/ public List listUniChart(Long from, Long to, String asset) throws ApiException { @@ -1479,7 +1375,7 @@ 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 + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-06-17 09:53+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) * @param asset Currency name (required) @@ -1488,7 +1384,7 @@ public List listUniChart(Long from, Long to, String asset) th * @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-06-17 09:53+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 -
*/ public ApiResponse> listUniChartWithHttpInfo(Long from, Long to, String asset) throws ApiException { @@ -1499,7 +1395,7 @@ 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 + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-06-17 09:53+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) * @param asset Currency name (required) @@ -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-06-17 09:53+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 -
*/ 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-06-17 09:53+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 -
*/ public okhttp3.Call listUniRateCall(final ApiCallback _callback) throws ApiException { @@ -1567,13 +1463,13 @@ 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 + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-06-17 09:53+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 * @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-06-17 09:53+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 -
*/ public List listUniRate() throws ApiException { @@ -1583,13 +1479,13 @@ 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 + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-06-17 09:53+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 * @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-06-17 09:53+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 -
*/ public ApiResponse> listUniRateWithHttpInfo() throws ApiException { @@ -1600,14 +1496,14 @@ 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 + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-06-17 09:53+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 _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-06-17 09:53+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 -
*/ public okhttp3.Call listUniRateAsync(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..b43a747 100644 --- a/src/main/java/io/gate/gateapi/api/MarginApi.java +++ b/src/main/java/io/gate/gateapi/api/MarginApi.java @@ -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; @@ -205,1539 +198,141 @@ public APIlistMarginAccountsRequest listMarginAccounts() { return new APIlistMarginAccountsRequest(); } - private okhttp3.Call listMarginAccountBookCall(String currency, String currencyPair, String type, Long from, Long to, Integer page, Integer limit, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/margin/account_book"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - if (currency != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); - } - - if (currencyPair != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency_pair", currencyPair)); - } - - if (type != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("type", type)); - } - - 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)); - } - - 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 listMarginAccountBookValidateBeforeCall(String currency, String currencyPair, String type, Long from, Long to, Integer page, Integer limit, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = listMarginAccountBookCall(currency, currencyPair, type, from, to, page, limit, _callback); - return localVarCall; - } - - - private ApiResponse> listMarginAccountBookWithHttpInfo(String currency, String currencyPair, String type, Long from, Long to, Integer page, Integer limit) throws ApiException { - okhttp3.Call localVarCall = listMarginAccountBookValidateBeforeCall(currency, currencyPair, type, from, to, page, limit, null); - Type localVarReturnType = new TypeToken>(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - private okhttp3.Call listMarginAccountBookAsync(String currency, String currencyPair, String type, Long from, Long to, Integer page, Integer limit, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = listMarginAccountBookValidateBeforeCall(currency, currencyPair, type, from, to, page, limit, _callback); - Type localVarReturnType = new TypeToken>(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - public class APIlistMarginAccountBookRequest { - private String currency; - private String currencyPair; - private String type; - private Long from; - private Long to; - private Integer page; - private Integer limit; - - private APIlistMarginAccountBookRequest() { - } - - /** - * Set currency - * @param currency List records related to specified currency only. If specified, `currency_pair` is also required. (optional) - * @return APIlistMarginAccountBookRequest - */ - public APIlistMarginAccountBookRequest currency(String currency) { - this.currency = currency; - return this; - } - - /** - * Set currencyPair - * @param currencyPair List records related to specified currency pair. Used in combination with `currency`. Ignored if `currency` is not provided (optional) - * @return APIlistMarginAccountBookRequest - */ - public APIlistMarginAccountBookRequest currencyPair(String currencyPair) { - this.currencyPair = currencyPair; - return this; - } - - /** - * Set type - * @param type Only retrieve changes of the specified type. All types will be returned if not specified. (optional) - * @return APIlistMarginAccountBookRequest - */ - public APIlistMarginAccountBookRequest type(String type) { - this.type = type; - return this; - } - - /** - * Set from - * @param from Start timestamp of the query (optional) - * @return APIlistMarginAccountBookRequest - */ - public APIlistMarginAccountBookRequest from(Long from) { - this.from = from; - return this; - } - - /** - * Set to - * @param to Time range ending, default to current time (optional) - * @return APIlistMarginAccountBookRequest - */ - public APIlistMarginAccountBookRequest to(Long to) { - this.to = to; - return this; - } - - /** - * Set page - * @param page Page number (optional, default to 1) - * @return APIlistMarginAccountBookRequest - */ - public APIlistMarginAccountBookRequest page(Integer page) { - this.page = page; - return this; - } - - /** - * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) - * @return APIlistMarginAccountBookRequest - */ - public APIlistMarginAccountBookRequest limit(Integer limit) { - this.limit = limit; - return this; - } - - /** - * Build call for listMarginAccountBook - * @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 listMarginAccountBookCall(currency, currencyPair, type, from, to, page, limit, _callback); - } - - /** - * Execute listMarginAccountBook request - * @return List<MarginAccountBook> - * @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 = listMarginAccountBookWithHttpInfo(currency, currencyPair, type, from, to, page, limit); - return localVarResp.getData(); - } - - /** - * Execute listMarginAccountBook request with HTTP info returned - * @return ApiResponse<List<MarginAccountBook>> - * @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 listMarginAccountBookWithHttpInfo(currency, currencyPair, type, from, to, page, limit); - } - - /** - * Execute listMarginAccountBook 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 listMarginAccountBookAsync(currency, currencyPair, type, from, to, page, limit, _callback); - } - } - - /** - * List margin account balance change history - * Only transferals from and to margin account are provided for now. Time range allows 30 days at most - * @return APIlistMarginAccountBookRequest - * @http.response.details - - - -
Status Code Description Response Headers
200 List retrieved -
- */ - public APIlistMarginAccountBookRequest listMarginAccountBook() { - return new APIlistMarginAccountBookRequest(); - } - - private okhttp3.Call listFundingAccountsCall(String currency, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/margin/funding_accounts"; - - 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); - } - - @SuppressWarnings("rawtypes") - private okhttp3.Call listFundingAccountsValidateBeforeCall(String currency, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = listFundingAccountsCall(currency, _callback); - return localVarCall; - } - - - private ApiResponse> listFundingAccountsWithHttpInfo(String currency) throws ApiException { - okhttp3.Call localVarCall = listFundingAccountsValidateBeforeCall(currency, null); - Type localVarReturnType = new TypeToken>(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - private okhttp3.Call listFundingAccountsAsync(String currency, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = listFundingAccountsValidateBeforeCall(currency, _callback); - Type localVarReturnType = new TypeToken>(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - public class APIlistFundingAccountsRequest { - private String currency; - - private APIlistFundingAccountsRequest() { - } - - /** - * Set currency - * @param currency Retrieve data of the specified currency (optional) - * @return APIlistFundingAccountsRequest - */ - public APIlistFundingAccountsRequest currency(String currency) { - this.currency = currency; - return this; - } - - /** - * Build call for listFundingAccounts - * @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 listFundingAccountsCall(currency, _callback); - } - - /** - * Execute listFundingAccounts request - * @return List<FundingAccount> - * @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 = listFundingAccountsWithHttpInfo(currency); - return localVarResp.getData(); - } - - /** - * Execute listFundingAccounts request with HTTP info returned - * @return ApiResponse<List<FundingAccount>> - * @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 listFundingAccountsWithHttpInfo(currency); - } - - /** - * Execute listFundingAccounts 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 listFundingAccountsAsync(currency, _callback); - } - } - - /** - * Funding account list - * - * @return APIlistFundingAccountsRequest - * @http.response.details - - - -
Status Code Description Response Headers
200 List retrieved -
- */ - public APIlistFundingAccountsRequest listFundingAccounts() { - return new APIlistFundingAccountsRequest(); - } - - /** - * Build call for getAutoRepayStatus - * @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 -
- */ - public okhttp3.Call getAutoRepayStatusCall(final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/margin/auto_repay"; - - 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); - } - - @SuppressWarnings("rawtypes") - private okhttp3.Call getAutoRepayStatusValidateBeforeCall(final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getAutoRepayStatusCall(_callback); - return localVarCall; - } - - /** - * Retrieve user auto repayment setting - * - * @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 -
- */ - public AutoRepaySetting getAutoRepayStatus() throws ApiException { - ApiResponse localVarResp = getAutoRepayStatusWithHttpInfo(); - return localVarResp.getData(); - } - - /** - * Retrieve user auto repayment setting - * - * @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 -
- */ - public ApiResponse getAutoRepayStatusWithHttpInfo() throws ApiException { - okhttp3.Call localVarCall = getAutoRepayStatusValidateBeforeCall(null); - Type localVarReturnType = new TypeToken(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - /** - * Retrieve user auto repayment setting (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 Current auto repayment setting -
- */ - public okhttp3.Call getAutoRepayStatusAsync(final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getAutoRepayStatusValidateBeforeCall(_callback); - Type localVarReturnType = new TypeToken(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - /** - * Build call for setAutoRepay - * @param status New auto repayment status. `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 -
- */ - public okhttp3.Call setAutoRepayCall(String status, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/margin/auto_repay"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - if (status != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("status", status)); - } - - 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, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @SuppressWarnings("rawtypes") - private okhttp3.Call setAutoRepayValidateBeforeCall(String status, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'status' is set - if (status == null) { - throw new ApiException("Missing the required parameter 'status' when calling setAutoRepay(Async)"); - } - - okhttp3.Call localVarCall = setAutoRepayCall(status, _callback); - return localVarCall; - } - - /** - * Update user's auto repayment setting - * - * @param status New auto repayment status. `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 -
- */ - public AutoRepaySetting setAutoRepay(String status) throws ApiException { - ApiResponse localVarResp = setAutoRepayWithHttpInfo(status); - return localVarResp.getData(); - } - - /** - * Update user's auto repayment setting - * - * @param status New auto repayment status. `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 -
- */ - public ApiResponse setAutoRepayWithHttpInfo(String status) throws ApiException { - okhttp3.Call localVarCall = setAutoRepayValidateBeforeCall(status, null); - Type localVarReturnType = new TypeToken(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - /** - * Update user's auto repayment setting (asynchronously) - * - * @param status New auto repayment status. `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 -
- */ - public okhttp3.Call setAutoRepayAsync(String status, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = setAutoRepayValidateBeforeCall(status, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - private okhttp3.Call getMarginTransferableCall(String currency, String currencyPair, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/margin/transferable"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - if (currency != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); - } - - 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 getMarginTransferableValidateBeforeCall(String currency, String currencyPair, 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 getMarginTransferable(Async)"); - } - - okhttp3.Call localVarCall = getMarginTransferableCall(currency, currencyPair, _callback); - return localVarCall; - } - - - private ApiResponse getMarginTransferableWithHttpInfo(String currency, String currencyPair) throws ApiException { - okhttp3.Call localVarCall = getMarginTransferableValidateBeforeCall(currency, currencyPair, null); - Type localVarReturnType = new TypeToken(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - private okhttp3.Call getMarginTransferableAsync(String currency, String currencyPair, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getMarginTransferableValidateBeforeCall(currency, currencyPair, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - public class APIgetMarginTransferableRequest { - private final String currency; - private String currencyPair; - - private APIgetMarginTransferableRequest(String currency) { - this.currency = currency; - } - - /** - * Set currencyPair - * @param currencyPair Currency pair (optional) - * @return APIgetMarginTransferableRequest - */ - public APIgetMarginTransferableRequest currencyPair(String currencyPair) { - this.currencyPair = currencyPair; - return this; - } - - /** - * Build call for getMarginTransferable - * @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 -
- */ - public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { - return getMarginTransferableCall(currency, currencyPair, _callback); - } - - /** - * Execute getMarginTransferable request - * @return MarginTransferable - * @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 MarginTransferable execute() throws ApiException { - ApiResponse localVarResp = getMarginTransferableWithHttpInfo(currency, currencyPair); - return localVarResp.getData(); - } - - /** - * Execute getMarginTransferable request with HTTP info returned - * @return ApiResponse<MarginTransferable> - * @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 executeWithHttpInfo() throws ApiException { - return getMarginTransferableWithHttpInfo(currency, currencyPair); - } - - /** - * Execute getMarginTransferable 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 -
- */ - public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { - return getMarginTransferableAsync(currency, currencyPair, _callback); - } - } - - /** - * Get the max transferable amount for a specific margin currency - * - * @param currency Retrieve data of the specified currency (required) - * @return APIgetMarginTransferableRequest - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- */ - public APIgetMarginTransferableRequest getMarginTransferable(String currency) { - return new APIgetMarginTransferableRequest(currency); - } - - /** - * Build call for listCrossMarginCurrencies - * @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 -
- * @deprecated - */ - @Deprecated - public okhttp3.Call listCrossMarginCurrenciesCall(final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/margin/cross/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 = { - - }; - 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); - } - - @Deprecated - @SuppressWarnings("rawtypes") - private okhttp3.Call listCrossMarginCurrenciesValidateBeforeCall(final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = listCrossMarginCurrenciesCall(_callback); - return localVarCall; - } - - /** - * Currencies supported by cross margin.(deprecated) - * - * @return List<CrossMarginCurrency> - * @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 -
- * @deprecated - */ - @Deprecated - public List listCrossMarginCurrencies() throws ApiException { - ApiResponse> localVarResp = listCrossMarginCurrenciesWithHttpInfo(); - return localVarResp.getData(); - } - - /** - * Currencies supported by cross margin.(deprecated) - * - * @return ApiResponse<List<CrossMarginCurrency>> - * @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 -
- * @deprecated - */ - @Deprecated - public ApiResponse> listCrossMarginCurrenciesWithHttpInfo() throws ApiException { - okhttp3.Call localVarCall = listCrossMarginCurrenciesValidateBeforeCall(null); - Type localVarReturnType = new TypeToken>(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - /** - * Currencies supported by cross margin.(deprecated) (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 -
- * @deprecated - */ - @Deprecated - public okhttp3.Call listCrossMarginCurrenciesAsync(final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = listCrossMarginCurrenciesValidateBeforeCall(_callback); - Type localVarReturnType = new TypeToken>(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - /** - * Build call for getCrossMarginCurrency - * @param currency 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 getCrossMarginCurrencyCall(String currency, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/margin/cross/currencies/{currency}" - .replaceAll("\\{" + "currency" + "\\}", localVarApiClient.escapeString(currency)); - - 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[] { }; - 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)"); - } - - okhttp3.Call localVarCall = getCrossMarginCurrencyCall(currency, _callback); - return localVarCall; - } - - /** - * Retrieve detail of one single currency supported by cross margin. (deprecated) - * - * @param currency Currency name (required) - * @return CrossMarginCurrency - * @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 CrossMarginCurrency getCrossMarginCurrency(String currency) throws ApiException { - ApiResponse localVarResp = getCrossMarginCurrencyWithHttpInfo(currency); - return localVarResp.getData(); - } - - /** - * Retrieve detail of one single currency supported by cross margin. (deprecated) - * - * @param currency Currency name (required) - * @return ApiResponse<CrossMarginCurrency> - * @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 getCrossMarginCurrencyWithHttpInfo(String currency) throws ApiException { - okhttp3.Call localVarCall = getCrossMarginCurrencyValidateBeforeCall(currency, null); - Type localVarReturnType = new TypeToken(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - /** - * Retrieve detail of one single currency supported by cross margin. (deprecated) (asynchronously) - * - * @param currency 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 getCrossMarginCurrencyAsync(String currency, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getCrossMarginCurrencyValidateBeforeCall(currency, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - /** - * Build call for getCrossMarginAccount - * @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 getCrossMarginAccountCall(final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/margin/cross/accounts"; - - 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 getCrossMarginAccountValidateBeforeCall(final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getCrossMarginAccountCall(_callback); - return localVarCall; - } - - /** - * Retrieve cross margin account. (deprecated) - * - * @return CrossMarginAccount - * @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 CrossMarginAccount getCrossMarginAccount() throws ApiException { - ApiResponse localVarResp = getCrossMarginAccountWithHttpInfo(); - return localVarResp.getData(); - } - - /** - * Retrieve cross margin account. (deprecated) - * - * @return ApiResponse<CrossMarginAccount> - * @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 getCrossMarginAccountWithHttpInfo() throws ApiException { - okhttp3.Call localVarCall = getCrossMarginAccountValidateBeforeCall(null); - Type localVarReturnType = new TypeToken(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - /** - * Retrieve cross margin account. (deprecated) (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 getCrossMarginAccountAsync(final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getCrossMarginAccountValidateBeforeCall(_callback); - Type localVarReturnType = new TypeToken(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - private okhttp3.Call listCrossMarginAccountBookCall(String currency, Long from, Long to, Integer page, Integer limit, String type, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/margin/cross/account_book"; - - 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)); - } - - 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 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); - 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(); - 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(); - 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; - } - - /** - * 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; - } - - /** - * Set type - * @param type Only retrieve changes of the specified type. All types will be returned if not specified. (optional) - * @return APIlistCrossMarginAccountBookRequest - */ - public APIlistCrossMarginAccountBookRequest type(String type) { - this.type = type; - return this; - } - - /** - * Build call for listCrossMarginAccountBook - * @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 -
- * @deprecated - */ - @Deprecated - public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { - return listCrossMarginAccountBookCall(currency, from, to, page, limit, type, _callback); - } - - /** - * Execute listCrossMarginAccountBook request - * @return List<CrossMarginAccountBook> - * @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 -
- * @deprecated - */ - @Deprecated - public List execute() throws ApiException { - ApiResponse> localVarResp = listCrossMarginAccountBookWithHttpInfo(currency, from, to, page, limit, type); - return localVarResp.getData(); - } - - /** - * Execute listCrossMarginAccountBook request with HTTP info returned - * @return ApiResponse<List<CrossMarginAccountBook>> - * @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 -
- * @deprecated - */ - @Deprecated - public ApiResponse> executeWithHttpInfo() throws ApiException { - return listCrossMarginAccountBookWithHttpInfo(currency, from, to, page, limit, type); - } - - /** - * Execute listCrossMarginAccountBook 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 -
- * @deprecated - */ - @Deprecated - public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { - return listCrossMarginAccountBookAsync(currency, from, to, page, limit, type, _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 - * @http.response.details - - - -
Status Code Description Response Headers
200 List retrieved -
- * @deprecated - */ - @Deprecated - public APIlistCrossMarginAccountBookRequest listCrossMarginAccountBook() { - return new APIlistCrossMarginAccountBookRequest(); - } - - private okhttp3.Call listCrossMarginLoansCall(Integer status, String currency, 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(); - if (status != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("status", status)); - } - - if (currency != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); - } - - if (limit != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("limit", limit)); - } - - if (offset != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("offset", offset)); - } - - if (reverse != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("reverse", reverse)); - } - - 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 listCrossMarginLoansValidateBeforeCall(Integer status, String currency, Integer limit, Integer offset, Boolean reverse, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'status' is set - if (status == null) { - throw new ApiException("Missing the required parameter 'status' when calling listCrossMarginLoans(Async)"); - } - - okhttp3.Call localVarCall = listCrossMarginLoansCall(status, currency, limit, offset, reverse, _callback); - return localVarCall; - } - - - private ApiResponse> listCrossMarginLoansWithHttpInfo(Integer status, String currency, Integer limit, Integer offset, Boolean reverse) throws ApiException { - okhttp3.Call localVarCall = listCrossMarginLoansValidateBeforeCall(status, currency, limit, offset, reverse, null); - Type localVarReturnType = new TypeToken>(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - private okhttp3.Call listCrossMarginLoansAsync(Integer status, String currency, Integer limit, Integer offset, Boolean reverse, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = listCrossMarginLoansValidateBeforeCall(status, currency, limit, offset, reverse, _callback); - Type localVarReturnType = new TypeToken>(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - public class APIlistCrossMarginLoansRequest { - private final Integer status; - private String currency; - private Integer limit; - private Integer offset; - private Boolean reverse; + * 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; - private APIlistCrossMarginLoansRequest(Integer status) { - this.status = status; - } + // create path and map variables + String localVarPath = "/margin/user/loan_margin_tiers"; - /** - * Set currency - * @param currency Filter by currency (optional) - * @return APIlistCrossMarginLoansRequest - */ - public APIlistCrossMarginLoansRequest currency(String currency) { - this.currency = currency; - return this; + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + if (currencyPair != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency_pair", currencyPair)); } - /** - * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) - * @return APIlistCrossMarginLoansRequest - */ - public APIlistCrossMarginLoansRequest limit(Integer limit) { - this.limit = limit; - return this; + 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); } - /** - * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) - * @return APIlistCrossMarginLoansRequest - */ - public APIlistCrossMarginLoansRequest offset(Integer offset) { - this.offset = offset; - return this; - } + final String[] localVarContentTypes = { + + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); - /** - * Set reverse - * @param reverse Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results (optional, default to true) - * @return APIlistCrossMarginLoansRequest - */ - public APIlistCrossMarginLoansRequest reverse(Boolean reverse) { - this.reverse = reverse; - return this; - } + String[] localVarAuthNames = new String[] { "apiv4" }; + return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } - /** - * Build call for listCrossMarginLoans - * @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 listCrossMarginLoansCall(status, currency, limit, offset, reverse, _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)"); } - /** - * Execute listCrossMarginLoans request - * @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 Successfully retrieved -
- * @deprecated - */ - @Deprecated - public List execute() throws ApiException { - ApiResponse> localVarResp = listCrossMarginLoansWithHttpInfo(status, currency, limit, offset, reverse); - return localVarResp.getData(); - } + okhttp3.Call localVarCall = getUserMarginTierCall(currencyPair, _callback); + return localVarCall; + } - /** - * Execute listCrossMarginLoans request with HTTP info returned - * @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 Successfully retrieved -
- * @deprecated - */ - @Deprecated - public ApiResponse> executeWithHttpInfo() throws ApiException { - return listCrossMarginLoansWithHttpInfo(status, currency, limit, offset, reverse); - } + /** + * 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(); + } - /** - * Execute listCrossMarginLoans 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 listCrossMarginLoansAsync(status, currency, limit, offset, reverse, _callback); - } + /** + * 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); } /** - * List cross margin borrow history. (deprecated) - * Sort by creation time in descending order by default. Set `reverse=false` to return ascending results. - * @param status Filter by status. Supported values are 2 and 3. (deprecated.) (required) - * @return APIlistCrossMarginLoansRequest + * 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 -
- * @deprecated */ - @Deprecated - public APIlistCrossMarginLoansRequest listCrossMarginLoans(Integer status) { - return new APIlistCrossMarginLoansRequest(status); + 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 createCrossMarginLoan - * @param crossMarginLoan (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 borrowed -
200 Successfully retrieved -
- * @deprecated */ - @Deprecated - public okhttp3.Call createCrossMarginLoanCall(CrossMarginLoan crossMarginLoan, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = crossMarginLoan; + public okhttp3.Call getMarketMarginTierCall(String currencyPair, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = null; // create path and map variables - String localVarPath = "/margin/cross/loans"; + 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(); @@ -1750,108 +345,98 @@ public okhttp3.Call createCrossMarginLoanCall(CrossMarginLoan crossMarginLoan, f } 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); + String[] localVarAuthNames = new String[] { }; + return localVarApiClient.buildCall(localVarPath, "GET", 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)"); + 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 = createCrossMarginLoanCall(crossMarginLoan, _callback); + okhttp3.Call localVarCall = getMarketMarginTierCall(currencyPair, _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 + * 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 borrowed -
200 Successfully retrieved -
- * @deprecated */ - @Deprecated - public CrossMarginLoan createCrossMarginLoan(CrossMarginLoan crossMarginLoan) throws ApiException { - ApiResponse localVarResp = createCrossMarginLoanWithHttpInfo(crossMarginLoan); + public List getMarketMarginTier(String currencyPair) throws ApiException { + ApiResponse> localVarResp = getMarketMarginTierWithHttpInfo(currencyPair); 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> + * 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 borrowed -
200 Successfully retrieved -
- * @deprecated */ - @Deprecated - public ApiResponse createCrossMarginLoanWithHttpInfo(CrossMarginLoan crossMarginLoan) throws ApiException { - okhttp3.Call localVarCall = createCrossMarginLoanValidateBeforeCall(crossMarginLoan, 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); } /** - * Create a cross margin borrow loan. (deprecated) (asynchronously) - * Borrow amount cannot be less than currency minimum borrow amount - * @param crossMarginLoan (required) + * 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 borrowed -
200 Successfully retrieved -
- * @deprecated */ - @Deprecated - public okhttp3.Call createCrossMarginLoanAsync(CrossMarginLoan crossMarginLoan, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = createCrossMarginLoanValidateBeforeCall(crossMarginLoan, _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 getCrossMarginLoan - * @param loanId Borrow loan ID (required) + * 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 Success -
- * @deprecated */ - @Deprecated - public okhttp3.Call getCrossMarginLoanCall(String loanId, 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/loans/{loan_id}" - .replaceAll("\\{" + "loan_id" + "\\}", localVarApiClient.escapeString(loanId)); + String localVarPath = "/margin/leverage/user_market_setting"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -1859,7 +444,7 @@ public okhttp3.Call getCrossMarginLoanCall(String loanId, final ApiCallback _cal Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "application/json" + }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -1867,114 +452,87 @@ public okhttp3.Call getCrossMarginLoanCall(String loanId, final ApiCallback _cal } 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 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)"); + 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 = getCrossMarginLoanCall(loanId, _callback); + okhttp3.Call localVarCall = setUserMarketLeverageCall(marginMarketLeverage, _callback); return localVarCall; } /** - * Retrieve single borrow loan detail. (deprecated) + * Set the user market leverage multiple * - * @param loanId Borrow loan ID (required) - * @return CrossMarginLoan + * @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 Success -
- * @deprecated */ - @Deprecated - public CrossMarginLoan getCrossMarginLoan(String loanId) throws ApiException { - ApiResponse localVarResp = getCrossMarginLoanWithHttpInfo(loanId); - return localVarResp.getData(); + public void setUserMarketLeverage(MarginMarketLeverage marginMarketLeverage) throws ApiException { + setUserMarketLeverageWithHttpInfo(marginMarketLeverage); } /** - * Retrieve single borrow loan detail. (deprecated) + * Set the user market leverage multiple * - * @param loanId Borrow loan ID (required) - * @return ApiResponse<CrossMarginLoan> + * @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 Success -
- * @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); + public ApiResponse setUserMarketLeverageWithHttpInfo(MarginMarketLeverage marginMarketLeverage) throws ApiException { + okhttp3.Call localVarCall = setUserMarketLeverageValidateBeforeCall(marginMarketLeverage, null); + return localVarApiClient.execute(localVarCall); } /** - * Retrieve single borrow loan detail. (deprecated) (asynchronously) + * Set the user market leverage multiple (asynchronously) * - * @param loanId Borrow loan ID (required) + * @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 Success -
- * @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); + 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 listCrossMarginRepaymentsCall(String currency, String loanId, Integer limit, Integer offset, Boolean reverse, 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/repayments"; + String localVarPath = "/margin/user/account"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); - if (currency != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); - } - - if (loanId != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("loan_id", loanId)); - } - - if (limit != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("limit", limit)); - } - - if (offset != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("offset", offset)); - } - - if (reverse != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("reverse", reverse)); + if (currencyPair != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency_pair", currencyPair)); } Map localVarHeaderParams = new HashMap(); @@ -1998,89 +556,44 @@ private okhttp3.Call listCrossMarginRepaymentsCall(String currency, String loanI return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } - @Deprecated @SuppressWarnings("rawtypes") - private okhttp3.Call listCrossMarginRepaymentsValidateBeforeCall(String currency, String loanId, Integer limit, Integer offset, Boolean reverse, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = listCrossMarginRepaymentsCall(currency, loanId, limit, offset, reverse, _callback); + private okhttp3.Call listMarginUserAccountValidateBeforeCall(String currencyPair, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = listMarginUserAccountCall(currencyPair, _callback); return localVarCall; } - private ApiResponse> listCrossMarginRepaymentsWithHttpInfo(String currency, String loanId, Integer limit, Integer offset, Boolean reverse) throws ApiException { - okhttp3.Call localVarCall = listCrossMarginRepaymentsValidateBeforeCall(currency, loanId, limit, offset, reverse, 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 listCrossMarginRepaymentsAsync(String currency, String loanId, Integer limit, Integer offset, Boolean reverse, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = listCrossMarginRepaymentsValidateBeforeCall(currency, loanId, limit, offset, reverse, _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 APIlistCrossMarginRepaymentsRequest { - private String currency; - private String loanId; - private Integer limit; - private Integer offset; - private Boolean reverse; - - private APIlistCrossMarginRepaymentsRequest() { - } - - /** - * Set currency - * @param currency (optional) - * @return APIlistCrossMarginRepaymentsRequest - */ - public APIlistCrossMarginRepaymentsRequest currency(String currency) { - this.currency = currency; - return this; - } - - /** - * Set loanId - * @param loanId (optional) - * @return APIlistCrossMarginRepaymentsRequest - */ - public APIlistCrossMarginRepaymentsRequest loanId(String loanId) { - this.loanId = loanId; - return this; - } - - /** - * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) - * @return APIlistCrossMarginRepaymentsRequest - */ - public APIlistCrossMarginRepaymentsRequest limit(Integer limit) { - this.limit = limit; - return this; - } + public class APIlistMarginUserAccountRequest { + private String currencyPair; - /** - * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) - * @return APIlistCrossMarginRepaymentsRequest - */ - public APIlistCrossMarginRepaymentsRequest offset(Integer offset) { - this.offset = offset; - return this; + private APIlistMarginUserAccountRequest() { } /** - * Set reverse - * @param reverse Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results (optional, default to true) - * @return APIlistCrossMarginRepaymentsRequest + * Set currencyPair + * @param currencyPair Currency pair (optional) + * @return APIlistMarginUserAccountRequest */ - public APIlistCrossMarginRepaymentsRequest reverse(Boolean reverse) { - this.reverse = reverse; + public APIlistMarginUserAccountRequest currencyPair(String currencyPair) { + this.currencyPair = currencyPair; return this; } /** - * Build call for listCrossMarginRepayments + * Build call for listMarginUserAccount * @param _callback ApiCallback API callback * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -2089,201 +602,75 @@ public APIlistCrossMarginRepaymentsRequest reverse(Boolean reverse) { Status Code Description Response Headers 200 List retrieved - - * @deprecated */ - @Deprecated public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { - return listCrossMarginRepaymentsCall(currency, loanId, limit, offset, reverse, _callback); + return listMarginUserAccountCall(currencyPair, _callback); } /** - * Execute listCrossMarginRepayments request - * @return List<CrossMarginRepayment> + * 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 -
- * @deprecated */ - @Deprecated - public List execute() throws ApiException { - ApiResponse> localVarResp = listCrossMarginRepaymentsWithHttpInfo(currency, loanId, limit, offset, reverse); + public List execute() throws ApiException { + ApiResponse> localVarResp = listMarginUserAccountWithHttpInfo(currencyPair); return localVarResp.getData(); } /** - * Execute listCrossMarginRepayments request with HTTP info returned - * @return ApiResponse<List<CrossMarginRepayment>> + * 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 -
- * @deprecated - */ - @Deprecated - public ApiResponse> executeWithHttpInfo() throws ApiException { - return listCrossMarginRepaymentsWithHttpInfo(currency, loanId, limit, offset, reverse); - } - - /** - * Execute listCrossMarginRepayments 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 -
- * @deprecated - */ - @Deprecated - public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { - return listCrossMarginRepaymentsAsync(currency, loanId, limit, offset, reverse, _callback); - } - } - - /** - * Retrieve cross margin repayments. (deprecated) - * Sort by creation time in descending order by default. Set `reverse=false` to return ascending results. - * @return APIlistCrossMarginRepaymentsRequest - * @http.response.details - - - -
Status Code Description Response Headers
200 List retrieved -
- * @deprecated - */ - @Deprecated - 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(); - } + */ + public ApiResponse> executeWithHttpInfo() throws ApiException { + return listMarginUserAccountWithHttpInfo(currencyPair); + } - /** - * 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); + /** + * 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); + } } /** - * 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 + * 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 Loan repaid -
200 List retrieved -
- * @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; + public APIlistMarginUserAccountRequest listMarginUserAccount() { + return new APIlistMarginUserAccountRequest(); } - private okhttp3.Call getCrossMarginInterestRecordsCall(String currency, Integer page, Integer limit, Long from, Long to, final ApiCallback _callback) throws ApiException { + private okhttp3.Call listMarginAccountBookCall(String currency, String currencyPair, String type, Long from, Long to, Integer page, Integer limit, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/margin/cross/interest_records"; + String localVarPath = "/margin/account_book"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -2291,12 +678,12 @@ private okhttp3.Call getCrossMarginInterestRecordsCall(String currency, Integer localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); } - if (page != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("page", page)); + if (currencyPair != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency_pair", currencyPair)); } - if (limit != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("limit", limit)); + if (type != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("type", type)); } if (from != null) { @@ -2307,6 +694,14 @@ private okhttp3.Call getCrossMarginInterestRecordsCall(String currency, Integer localVarQueryParams.addAll(localVarApiClient.parameterToPair("to", to)); } + if (page != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("page", page)); + } + + if (limit != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("limit", limit)); + } + Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); @@ -2328,190 +723,187 @@ private okhttp3.Call getCrossMarginInterestRecordsCall(String currency, Integer 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); + private okhttp3.Call listMarginAccountBookValidateBeforeCall(String currency, String currencyPair, String type, Long from, Long to, Integer page, Integer limit, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = listMarginAccountBookCall(currency, currencyPair, type, from, to, page, limit, _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(); + private ApiResponse> listMarginAccountBookWithHttpInfo(String currency, String currencyPair, String type, Long from, Long to, Integer page, Integer limit) throws ApiException { + okhttp3.Call localVarCall = listMarginAccountBookValidateBeforeCall(currency, currencyPair, type, from, to, page, limit, 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(); + private okhttp3.Call listMarginAccountBookAsync(String currency, String currencyPair, String type, Long from, Long to, Integer page, Integer limit, final ApiCallback> _callback) throws ApiException { + okhttp3.Call localVarCall = listMarginAccountBookValidateBeforeCall(currency, currencyPair, type, from, to, page, limit, _callback); + Type localVarReturnType = new TypeToken>(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } - public class APIgetCrossMarginInterestRecordsRequest { + public class APIlistMarginAccountBookRequest { private String currency; - private Integer page; - private Integer limit; + private String currencyPair; + private String type; private Long from; private Long to; + private Integer page; + private Integer limit; - private APIgetCrossMarginInterestRecordsRequest() { + private APIlistMarginAccountBookRequest() { } /** * Set currency - * @param currency Retrieve data of the specified currency (optional) - * @return APIgetCrossMarginInterestRecordsRequest + * @param currency List records related to specified currency only. If specified, `currency_pair` is also required. (optional) + * @return APIlistMarginAccountBookRequest */ - public APIgetCrossMarginInterestRecordsRequest currency(String currency) { + public APIlistMarginAccountBookRequest currency(String currency) { this.currency = currency; return this; } /** - * Set page - * @param page Page number (optional, default to 1) - * @return APIgetCrossMarginInterestRecordsRequest + * Set currencyPair + * @param currencyPair List records related to specified currency pair. Used in combination with `currency`. Ignored if `currency` is not provided (optional) + * @return APIlistMarginAccountBookRequest */ - public APIgetCrossMarginInterestRecordsRequest page(Integer page) { - this.page = page; + public APIlistMarginAccountBookRequest currencyPair(String currencyPair) { + this.currencyPair = currencyPair; return this; } /** - * Set limit - * @param limit Maximum response items. Default: 100, minimum: 1, Maximum: 100 (optional, default to 100) - * @return APIgetCrossMarginInterestRecordsRequest + * Set type + * @param type Only retrieve changes of the specified type. All types will be returned if not specified. (optional) + * @return APIlistMarginAccountBookRequest */ - public APIgetCrossMarginInterestRecordsRequest limit(Integer limit) { - this.limit = limit; + public APIlistMarginAccountBookRequest type(String type) { + this.type = type; return this; } /** * Set from - * @param from Start timestamp (optional) - * @return APIgetCrossMarginInterestRecordsRequest + * @param from Start timestamp of the query (optional) + * @return APIlistMarginAccountBookRequest */ - public APIgetCrossMarginInterestRecordsRequest from(Long from) { + public APIlistMarginAccountBookRequest from(Long from) { this.from = from; return this; } /** * Set to - * @param to End timestamp (optional) - * @return APIgetCrossMarginInterestRecordsRequest + * @param to Time range ending, default to current time (optional) + * @return APIlistMarginAccountBookRequest */ - public APIgetCrossMarginInterestRecordsRequest to(Long to) { + public APIlistMarginAccountBookRequest to(Long to) { this.to = to; return this; } /** - * Build call for getCrossMarginInterestRecords + * Set page + * @param page Page number (optional, default to 1) + * @return APIlistMarginAccountBookRequest + */ + public APIlistMarginAccountBookRequest page(Integer page) { + this.page = page; + return this; + } + + /** + * Set limit + * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @return APIlistMarginAccountBookRequest + */ + public APIlistMarginAccountBookRequest limit(Integer limit) { + this.limit = limit; + return this; + } + + /** + * Build call for listMarginAccountBook * @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 -
200 List retrieved -
- * @deprecated */ - @Deprecated public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { - return getCrossMarginInterestRecordsCall(currency, page, limit, from, to, _callback); + return listMarginAccountBookCall(currency, currencyPair, type, from, to, page, limit, _callback); } /** - * Execute getCrossMarginInterestRecords request - * @return List<UniLoanInterestRecord> + * Execute listMarginAccountBook request + * @return List<MarginAccountBook> * @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 List retrieved -
- * @deprecated */ - @Deprecated - public List execute() throws ApiException { - ApiResponse> localVarResp = getCrossMarginInterestRecordsWithHttpInfo(currency, page, limit, from, to); + public List execute() throws ApiException { + ApiResponse> localVarResp = listMarginAccountBookWithHttpInfo(currency, currencyPair, type, from, to, page, limit); return localVarResp.getData(); } /** - * Execute getCrossMarginInterestRecords request with HTTP info returned - * @return ApiResponse<List<UniLoanInterestRecord>> + * Execute listMarginAccountBook request with HTTP info returned + * @return ApiResponse<List<MarginAccountBook>> * @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 List retrieved -
- * @deprecated */ - @Deprecated - public ApiResponse> executeWithHttpInfo() throws ApiException { - return getCrossMarginInterestRecordsWithHttpInfo(currency, page, limit, from, to); + public ApiResponse> executeWithHttpInfo() throws ApiException { + return listMarginAccountBookWithHttpInfo(currency, currencyPair, type, from, to, page, limit); } /** - * Execute getCrossMarginInterestRecords request (asynchronously) + * Execute listMarginAccountBook 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 -
200 List retrieved -
- * @deprecated */ - @Deprecated - public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { - return getCrossMarginInterestRecordsAsync(currency, page, limit, from, to, _callback); + public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { + return listMarginAccountBookAsync(currency, currencyPair, type, from, to, page, limit, _callback); } } /** - * Interest records for the cross margin account. (deprecated) - * - * @return APIgetCrossMarginInterestRecordsRequest + * List margin account balance change history + * Only transferals from and to margin account are provided for now. Time range allows 30 days at most + * @return APIlistMarginAccountBookRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 List retrieved -
- * @deprecated */ - @Deprecated - public APIgetCrossMarginInterestRecordsRequest getCrossMarginInterestRecords() { - return new APIgetCrossMarginInterestRecordsRequest(); + public APIlistMarginAccountBookRequest listMarginAccountBook() { + return new APIlistMarginAccountBookRequest(); } - /** - * 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 { + private okhttp3.Call listFundingAccountsCall(String currency, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/margin/cross/transferable"; + String localVarPath = "/margin/funding_accounts"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -2540,105 +932,135 @@ public okhttp3.Call getCrossMarginTransferableCall(String currency, final ApiCal 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)"); + private okhttp3.Call listFundingAccountsValidateBeforeCall(String currency, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = listFundingAccountsCall(currency, _callback); + return localVarCall; + } + + + private ApiResponse> listFundingAccountsWithHttpInfo(String currency) throws ApiException { + okhttp3.Call localVarCall = listFundingAccountsValidateBeforeCall(currency, null); + Type localVarReturnType = new TypeToken>(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + private okhttp3.Call listFundingAccountsAsync(String currency, final ApiCallback> _callback) throws ApiException { + okhttp3.Call localVarCall = listFundingAccountsValidateBeforeCall(currency, _callback); + Type localVarReturnType = new TypeToken>(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + + public class APIlistFundingAccountsRequest { + private String currency; + + private APIlistFundingAccountsRequest() { + } + + /** + * Set currency + * @param currency Retrieve data of the specified currency (optional) + * @return APIlistFundingAccountsRequest + */ + public APIlistFundingAccountsRequest currency(String currency) { + this.currency = currency; + return this; + } + + /** + * Build call for listFundingAccounts + * @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 listFundingAccountsCall(currency, _callback); + } + + /** + * Execute listFundingAccounts request + * @return List<FundingAccount> + * @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 = listFundingAccountsWithHttpInfo(currency); + return localVarResp.getData(); + } + + /** + * Execute listFundingAccounts request with HTTP info returned + * @return ApiResponse<List<FundingAccount>> + * @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 listFundingAccountsWithHttpInfo(currency); } - 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); + /** + * Execute listFundingAccounts 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 listFundingAccountsAsync(currency, _callback); + } } /** - * Get the max transferable amount for a specific cross margin currency. (deprecated) (asynchronously) + * Funding account list * - * @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 + * @return APIlistFundingAccountsRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 List 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; + public APIlistFundingAccountsRequest listFundingAccounts() { + return new APIlistFundingAccountsRequest(); } /** - * Build call for getCrossMarginEstimateRate - * @param currencies An array of up to 10 specifying the currency name (required) + * Build call for getAutoRepayStatus * @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 Current auto repayment setting -
- * @deprecated */ - @Deprecated - public okhttp3.Call getCrossMarginEstimateRateCall(List currencies, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getAutoRepayStatusCall(final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/margin/cross/estimate_rate"; + String localVarPath = "/margin/auto_repay"; 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(); @@ -2660,103 +1082,86 @@ public okhttp3.Call getCrossMarginEstimateRateCall(List currencies, fina 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); + private okhttp3.Call getAutoRepayStatusValidateBeforeCall(final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = getAutoRepayStatusCall(_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> + * Retrieve user auto repayment setting + * + * @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 Successfully retrieved -
200 Current auto repayment setting -
- * @deprecated */ - @Deprecated - public Map getCrossMarginEstimateRate(List currencies) throws ApiException { - ApiResponse> localVarResp = getCrossMarginEstimateRateWithHttpInfo(currencies); + public AutoRepaySetting getAutoRepayStatus() throws ApiException { + ApiResponse localVarResp = getAutoRepayStatusWithHttpInfo(); 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>> + * Retrieve user auto repayment setting + * + * @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 Successfully retrieved -
200 Current auto repayment setting -
- * @deprecated */ - @Deprecated - public ApiResponse> getCrossMarginEstimateRateWithHttpInfo(List currencies) throws ApiException { - okhttp3.Call localVarCall = getCrossMarginEstimateRateValidateBeforeCall(currencies, null); - Type localVarReturnType = new TypeToken>(){}.getType(); + public ApiResponse getAutoRepayStatusWithHttpInfo() throws ApiException { + okhttp3.Call localVarCall = getAutoRepayStatusValidateBeforeCall(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) + * Retrieve user auto repayment setting (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 -
200 Current auto repayment setting -
- * @deprecated */ - @Deprecated - public okhttp3.Call getCrossMarginEstimateRateAsync(List currencies, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = getCrossMarginEstimateRateValidateBeforeCall(currencies, _callback); - Type localVarReturnType = new TypeToken>(){}.getType(); + public okhttp3.Call getAutoRepayStatusAsync(final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = getAutoRepayStatusValidateBeforeCall(_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) + * Build call for setAutoRepay + * @param status New auto repayment status. `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 Successfully retrieved -
200 Current auto repayment setting -
- * @deprecated */ - @Deprecated - public okhttp3.Call getCrossMarginBorrowableCall(String currency, final ApiCallback _callback) throws ApiException { + public okhttp3.Call setAutoRepayCall(String status, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/margin/cross/borrowable"; + String localVarPath = "/margin/auto_repay"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); - if (currency != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); + if (status != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("status", status)); } Map localVarHeaderParams = new HashMap(); @@ -2777,102 +1182,87 @@ public okhttp3.Call getCrossMarginBorrowableCall(String currency, final ApiCallb 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 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)"); + private okhttp3.Call setAutoRepayValidateBeforeCall(String status, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'status' is set + if (status == null) { + throw new ApiException("Missing the required parameter 'status' when calling setAutoRepay(Async)"); } - okhttp3.Call localVarCall = getCrossMarginBorrowableCall(currency, _callback); + okhttp3.Call localVarCall = setAutoRepayCall(status, _callback); return localVarCall; } /** - * Get the max borrowable amount for a specific cross margin currency. (deprecated) + * Update user's auto repayment setting * - * @param currency Retrieve data of the specified currency (required) - * @return UnifiedBorrowable + * @param status New auto repayment status. `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 Successfully retrieved -
200 Current auto repayment setting -
- * @deprecated */ - @Deprecated - public UnifiedBorrowable getCrossMarginBorrowable(String currency) throws ApiException { - ApiResponse localVarResp = getCrossMarginBorrowableWithHttpInfo(currency); + public AutoRepaySetting setAutoRepay(String status) throws ApiException { + ApiResponse localVarResp = setAutoRepayWithHttpInfo(status); return localVarResp.getData(); } /** - * Get the max borrowable amount for a specific cross margin currency. (deprecated) + * Update user's auto repayment setting * - * @param currency Retrieve data of the specified currency (required) - * @return ApiResponse<UnifiedBorrowable> + * @param status New auto repayment status. `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 Successfully retrieved -
200 Current auto repayment setting -
- * @deprecated */ - @Deprecated - public ApiResponse getCrossMarginBorrowableWithHttpInfo(String currency) throws ApiException { - okhttp3.Call localVarCall = getCrossMarginBorrowableValidateBeforeCall(currency, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse setAutoRepayWithHttpInfo(String status) throws ApiException { + okhttp3.Call localVarCall = setAutoRepayValidateBeforeCall(status, null); + Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * Get the max borrowable amount for a specific cross margin currency. (deprecated) (asynchronously) + * Update user's auto repayment setting (asynchronously) * - * @param currency Retrieve data of the specified currency (required) + * @param status New auto repayment status. `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 Successfully retrieved -
200 Current auto repayment setting -
- * @deprecated */ - @Deprecated - public okhttp3.Call getCrossMarginBorrowableAsync(String currency, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getCrossMarginBorrowableValidateBeforeCall(currency, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); + public okhttp3.Call setAutoRepayAsync(String status, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = setAutoRepayValidateBeforeCall(status, _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 { + private okhttp3.Call getMarginTransferableCall(String currency, String currencyPair, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/margin/user/loan_margin_tiers"; + String localVarPath = "/margin/transferable"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); + if (currency != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); + } + if (currencyPair != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency_pair", currencyPair)); } @@ -2899,93 +1289,149 @@ public okhttp3.Call getUserMarginTierCall(String currencyPair, final ApiCallback } @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)"); + private okhttp3.Call getMarginTransferableValidateBeforeCall(String currency, String currencyPair, 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 getMarginTransferable(Async)"); } - okhttp3.Call localVarCall = getUserMarginTierCall(currencyPair, _callback); + okhttp3.Call localVarCall = getMarginTransferableCall(currency, 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(); + + private ApiResponse getMarginTransferableWithHttpInfo(String currency, String currencyPair) throws ApiException { + okhttp3.Call localVarCall = getMarginTransferableValidateBeforeCall(currency, currencyPair, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + private okhttp3.Call getMarginTransferableAsync(String currency, String currencyPair, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = getMarginTransferableValidateBeforeCall(currency, currencyPair, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; } - /** - * 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); + public class APIgetMarginTransferableRequest { + private final String currency; + private String currencyPair; + + private APIgetMarginTransferableRequest(String currency) { + this.currency = currency; + } + + /** + * Set currencyPair + * @param currencyPair Currency pair (optional) + * @return APIgetMarginTransferableRequest + */ + public APIgetMarginTransferableRequest currencyPair(String currencyPair) { + this.currencyPair = currencyPair; + return this; + } + + /** + * Build call for getMarginTransferable + * @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 -
+ */ + public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { + return getMarginTransferableCall(currency, currencyPair, _callback); + } + + /** + * Execute getMarginTransferable request + * @return MarginTransferable + * @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 MarginTransferable execute() throws ApiException { + ApiResponse localVarResp = getMarginTransferableWithHttpInfo(currency, currencyPair); + return localVarResp.getData(); + } + + /** + * Execute getMarginTransferable request with HTTP info returned + * @return ApiResponse<MarginTransferable> + * @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 executeWithHttpInfo() throws ApiException { + return getMarginTransferableWithHttpInfo(currency, currencyPair); + } + + /** + * Execute getMarginTransferable 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 -
+ */ + public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { + return getMarginTransferableAsync(currency, currencyPair, _callback); + } } /** - * Check the user's own leverage lending gradient in the current market (asynchronously) + * Get the max transferable amount for a specific margin currency * - * @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 + * @param currency Retrieve data of the specified currency (required) + * @return APIgetMarginTransferableRequest * @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; + public APIgetMarginTransferableRequest getMarginTransferable(String currency) { + return new APIgetMarginTransferableRequest(currency); } - /** - * 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 { + private okhttp3.Call listCrossMarginLoansCall(Integer status, String currency, Integer limit, Integer offset, Boolean reverse, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/margin/loan_margin_tiers"; + String localVarPath = "/margin/cross/loans"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); - if (currencyPair != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency_pair", currencyPair)); + if (status != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("status", status)); + } + + if (currency != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); + } + + if (limit != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("limit", limit)); + } + + if (offset != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("offset", offset)); + } + + if (reverse != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("reverse", reverse)); } Map localVarHeaderParams = new HashMap(); @@ -3005,189 +1451,198 @@ public okhttp3.Call getMarketMarginTierCall(String currencyPair, final ApiCallba 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 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)"); + private okhttp3.Call listCrossMarginLoansValidateBeforeCall(Integer status, String currency, Integer limit, Integer offset, Boolean reverse, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'status' is set + if (status == null) { + throw new ApiException("Missing the required parameter 'status' when calling listCrossMarginLoans(Async)"); } - okhttp3.Call localVarCall = getMarketMarginTierCall(currencyPair, _callback); + okhttp3.Call localVarCall = listCrossMarginLoansCall(status, currency, limit, offset, reverse, _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(); + private ApiResponse> listCrossMarginLoansWithHttpInfo(Integer status, String currency, Integer limit, Integer offset, Boolean reverse) throws ApiException { + okhttp3.Call localVarCall = listCrossMarginLoansValidateBeforeCall(status, currency, limit, offset, reverse, 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(); + private okhttp3.Call listCrossMarginLoansAsync(Integer status, String currency, Integer limit, Integer offset, Boolean reverse, final ApiCallback> _callback) throws ApiException { + okhttp3.Call localVarCall = listCrossMarginLoansValidateBeforeCall(status, currency, limit, offset, reverse, _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; + public class APIlistCrossMarginLoansRequest { + private final Integer status; + private String currency; + private Integer limit; + private Integer offset; + private Boolean reverse; - // create path and map variables - String localVarPath = "/margin/leverage/user_market_setting"; + private APIlistCrossMarginLoansRequest(Integer status) { + this.status = status; + } - 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); + /** + * Set currency + * @param currency Filter by currency (optional) + * @return APIlistCrossMarginLoansRequest + */ + public APIlistCrossMarginLoansRequest currency(String currency) { + this.currency = currency; + return this; } - final String[] localVarContentTypes = { - "application/json" - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - localVarHeaderParams.put("Content-Type", localVarContentType); + /** + * Set limit + * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @return APIlistCrossMarginLoansRequest + */ + public APIlistCrossMarginLoansRequest limit(Integer limit) { + this.limit = limit; + return this; + } - String[] localVarAuthNames = new String[] { "apiv4" }; - return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } + /** + * Set offset + * @param offset List offset, starting from 0 (optional, default to 0) + * @return APIlistCrossMarginLoansRequest + */ + public APIlistCrossMarginLoansRequest offset(Integer offset) { + this.offset = offset; + return this; + } - @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)"); + /** + * Set reverse + * @param reverse Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results (optional, default to true) + * @return APIlistCrossMarginLoansRequest + */ + public APIlistCrossMarginLoansRequest reverse(Boolean reverse) { + this.reverse = reverse; + return this; + } + + /** + * Build call for listCrossMarginLoans + * @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 listCrossMarginLoansCall(status, currency, limit, offset, reverse, _callback); } - okhttp3.Call localVarCall = setUserMarketLeverageCall(marginMarketLeverage, _callback); - return localVarCall; - } + /** + * Execute listCrossMarginLoans request + * @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 Successfully retrieved -
+ * @deprecated + */ + @Deprecated + public List execute() throws ApiException { + ApiResponse> localVarResp = listCrossMarginLoansWithHttpInfo(status, currency, limit, offset, reverse); + return localVarResp.getData(); + } - /** - * 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); - } + /** + * Execute listCrossMarginLoans request with HTTP info returned + * @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 Successfully retrieved -
+ * @deprecated + */ + @Deprecated + public ApiResponse> executeWithHttpInfo() throws ApiException { + return listCrossMarginLoansWithHttpInfo(status, currency, limit, offset, reverse); + } - /** - * 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); + /** + * Execute listCrossMarginLoans 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 listCrossMarginLoansAsync(status, currency, limit, offset, reverse, _callback); + } } /** - * 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 + * List cross margin borrow history. (deprecated) + * Sort by creation time in descending order by default. Set `reverse=false` to return ascending results. + * @param status Filter by status. Supported values are 2 and 3. (deprecated.) (required) + * @return APIlistCrossMarginLoansRequest * @http.response.details - +
Status Code Description Response Headers
204 Success -
200 Successfully retrieved -
+ * @deprecated */ - public okhttp3.Call setUserMarketLeverageAsync(MarginMarketLeverage marginMarketLeverage, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = setUserMarketLeverageValidateBeforeCall(marginMarketLeverage, _callback); - localVarApiClient.executeAsync(localVarCall, _callback); - return localVarCall; + @Deprecated + public APIlistCrossMarginLoansRequest listCrossMarginLoans(Integer status) { + return new APIlistCrossMarginLoansRequest(status); } - private okhttp3.Call listMarginUserAccountCall(String currencyPair, final ApiCallback _callback) throws ApiException { + 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/user/account"; + String localVarPath = "/margin/cross/repayments"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); - if (currencyPair != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency_pair", currencyPair)); + if (currency != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); + } + + if (loanId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("loan_id", loanId)); + } + + if (limit != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("limit", limit)); + } + + if (offset != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("offset", offset)); + } + + if (reverse != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("reverse", reverse)); } Map localVarHeaderParams = new HashMap(); @@ -3211,44 +1666,89 @@ private okhttp3.Call listMarginUserAccountCall(String currencyPair, final ApiCal return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } + @Deprecated @SuppressWarnings("rawtypes") - private okhttp3.Call listMarginUserAccountValidateBeforeCall(String currencyPair, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = listMarginUserAccountCall(currencyPair, _callback); + private okhttp3.Call listCrossMarginRepaymentsValidateBeforeCall(String currency, String loanId, Integer limit, Integer offset, Boolean reverse, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = listCrossMarginRepaymentsCall(currency, loanId, limit, offset, reverse, _callback); return localVarCall; } - private ApiResponse> listMarginUserAccountWithHttpInfo(String currencyPair) throws ApiException { - okhttp3.Call localVarCall = listMarginUserAccountValidateBeforeCall(currencyPair, null); - Type localVarReturnType = new TypeToken>(){}.getType(); + private ApiResponse> listCrossMarginRepaymentsWithHttpInfo(String currency, String loanId, Integer limit, Integer offset, Boolean reverse) throws ApiException { + okhttp3.Call localVarCall = listCrossMarginRepaymentsValidateBeforeCall(currency, loanId, limit, offset, reverse, 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(); + private okhttp3.Call listCrossMarginRepaymentsAsync(String currency, String loanId, Integer limit, Integer offset, Boolean reverse, final ApiCallback> _callback) throws ApiException { + okhttp3.Call localVarCall = listCrossMarginRepaymentsValidateBeforeCall(currency, loanId, limit, offset, reverse, _callback); + Type localVarReturnType = new TypeToken>(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } - public class APIlistMarginUserAccountRequest { - private String currencyPair; + public class APIlistCrossMarginRepaymentsRequest { + private String currency; + private String loanId; + private Integer limit; + private Integer offset; + private Boolean reverse; - private APIlistMarginUserAccountRequest() { + private APIlistCrossMarginRepaymentsRequest() { } /** - * Set currencyPair - * @param currencyPair Currency pair (optional) - * @return APIlistMarginUserAccountRequest + * Set currency + * @param currency (optional) + * @return APIlistCrossMarginRepaymentsRequest */ - public APIlistMarginUserAccountRequest currencyPair(String currencyPair) { - this.currencyPair = currencyPair; + public APIlistCrossMarginRepaymentsRequest currency(String currency) { + this.currency = currency; return this; } /** - * Build call for listMarginUserAccount + * Set loanId + * @param loanId (optional) + * @return APIlistCrossMarginRepaymentsRequest + */ + public APIlistCrossMarginRepaymentsRequest loanId(String loanId) { + this.loanId = loanId; + return this; + } + + /** + * Set limit + * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @return APIlistCrossMarginRepaymentsRequest + */ + public APIlistCrossMarginRepaymentsRequest limit(Integer limit) { + this.limit = limit; + return this; + } + + /** + * Set offset + * @param offset List offset, starting from 0 (optional, default to 0) + * @return APIlistCrossMarginRepaymentsRequest + */ + public APIlistCrossMarginRepaymentsRequest offset(Integer offset) { + this.offset = offset; + return this; + } + + /** + * Set reverse + * @param reverse Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results (optional, default to true) + * @return APIlistCrossMarginRepaymentsRequest + */ + public APIlistCrossMarginRepaymentsRequest reverse(Boolean reverse) { + this.reverse = reverse; + return this; + } + + /** + * Build call for listCrossMarginRepayments * @param _callback ApiCallback API callback * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -3257,42 +1757,48 @@ public APIlistMarginUserAccountRequest currencyPair(String currencyPair) { Status Code Description Response Headers 200 List retrieved - + * @deprecated */ + @Deprecated public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { - return listMarginUserAccountCall(currencyPair, _callback); + return listCrossMarginRepaymentsCall(currency, loanId, limit, offset, reverse, _callback); } /** - * Execute listMarginUserAccount request - * @return List<MarginAccount> + * Execute listCrossMarginRepayments request + * @return List<CrossMarginRepayment> * @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 -
+ * @deprecated */ - public List execute() throws ApiException { - ApiResponse> localVarResp = listMarginUserAccountWithHttpInfo(currencyPair); + @Deprecated + public List execute() throws ApiException { + ApiResponse> localVarResp = listCrossMarginRepaymentsWithHttpInfo(currency, loanId, limit, offset, reverse); return localVarResp.getData(); } /** - * Execute listMarginUserAccount request with HTTP info returned - * @return ApiResponse<List<MarginAccount>> + * Execute listCrossMarginRepayments request with HTTP info returned + * @return ApiResponse<List<CrossMarginRepayment>> * @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 -
+ * @deprecated */ - public ApiResponse> executeWithHttpInfo() throws ApiException { - return listMarginUserAccountWithHttpInfo(currencyPair); + @Deprecated + public ApiResponse> executeWithHttpInfo() throws ApiException { + return listCrossMarginRepaymentsWithHttpInfo(currency, loanId, limit, offset, reverse); } /** - * Execute listMarginUserAccount request (asynchronously) + * Execute listCrossMarginRepayments 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 @@ -3301,24 +1807,28 @@ public ApiResponse> executeWithHttpInfo() throws ApiExceptio Status Code Description Response Headers 200 List retrieved - + * @deprecated */ - public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { - return listMarginUserAccountAsync(currencyPair, _callback); + @Deprecated + public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { + return listCrossMarginRepaymentsAsync(currency, loanId, limit, offset, reverse, _callback); } } /** - * Query the user's leverage account list - * Support querying risk rate per position account and margin rate per position account - * @return APIlistMarginUserAccountRequest + * Retrieve cross margin repayments. (deprecated) + * Sort by creation time in descending order by default. Set `reverse=false` to return ascending results. + * @return APIlistCrossMarginRepaymentsRequest * @http.response.details
Status Code Description Response Headers
200 List retrieved -
+ * @deprecated */ - public APIlistMarginUserAccountRequest listMarginUserAccount() { - return new APIlistMarginUserAccountRequest(); + @Deprecated + public APIlistCrossMarginRepaymentsRequest listCrossMarginRepayments() { + return new APIlistCrossMarginRepaymentsRequest(); } } diff --git a/src/main/java/io/gate/gateapi/api/MarginUniApi.java b/src/main/java/io/gate/gateapi/api/MarginUniApi.java index fe94879..eb3bf3f 100644 --- a/src/main/java/io/gate/gateapi/api/MarginUniApi.java +++ b/src/main/java/io/gate/gateapi/api/MarginUniApi.java @@ -150,24 +150,211 @@ public okhttp3.Call listUniCurrencyPairsAsync(final ApiCallback localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + if (currencyPair != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency_pair", currencyPair)); + } + + 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)); + } + + 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 listUniLoansValidateBeforeCall(String currencyPair, String currency, Integer page, Integer limit, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = listUniLoansCall(currencyPair, currency, page, limit, _callback); + return localVarCall; + } + + + private ApiResponse> listUniLoansWithHttpInfo(String currencyPair, String currency, Integer page, Integer limit) throws ApiException { + okhttp3.Call localVarCall = listUniLoansValidateBeforeCall(currencyPair, currency, page, limit, null); + Type localVarReturnType = new TypeToken>(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + private okhttp3.Call listUniLoansAsync(String currencyPair, String currency, Integer page, Integer limit, final ApiCallback> _callback) throws ApiException { + okhttp3.Call localVarCall = listUniLoansValidateBeforeCall(currencyPair, currency, page, limit, _callback); + Type localVarReturnType = new TypeToken>(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + + public class APIlistUniLoansRequest { + private String currencyPair; + private String currency; + private Integer page; + private Integer limit; + + private APIlistUniLoansRequest() { + } + + /** + * Set currencyPair + * @param currencyPair Currency pair (optional) + * @return APIlistUniLoansRequest + */ + public APIlistUniLoansRequest currencyPair(String currencyPair) { + this.currencyPair = currencyPair; + return this; + } + + /** + * Set currency + * @param currency Retrieve data of the specified currency (optional) + * @return APIlistUniLoansRequest + */ + public APIlistUniLoansRequest currency(String currency) { + this.currency = currency; + return this; + } + + /** + * Set page + * @param page Page number (optional, default to 1) + * @return APIlistUniLoansRequest + */ + public APIlistUniLoansRequest 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 APIlistUniLoansRequest + */ + public APIlistUniLoansRequest limit(Integer limit) { + this.limit = limit; + return this; + } + + /** + * Build call for listUniLoans + * @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 -
+ */ + public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { + return listUniLoansCall(currencyPair, currency, page, limit, _callback); + } + + /** + * Execute listUniLoans request + * @return List<UniLoan> + * @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 execute() throws ApiException { + ApiResponse> localVarResp = listUniLoansWithHttpInfo(currencyPair, currency, page, limit); + return localVarResp.getData(); + } + + /** + * Execute listUniLoans request with HTTP info returned + * @return ApiResponse<List<UniLoan>> + * @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> executeWithHttpInfo() throws ApiException { + return listUniLoansWithHttpInfo(currencyPair, currency, page, limit); + } + + /** + * Execute listUniLoans 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 -
+ */ + public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { + return listUniLoansAsync(currencyPair, currency, page, limit, _callback); + } + } + /** - * Build call for getUniCurrencyPair - * @param currencyPair Currency pair (required) + * List loans + * + * @return APIlistUniLoansRequest + * @http.response.details + + + +
Status Code Description Response Headers
200 Successfully retrieved -
+ */ + public APIlistUniLoansRequest listUniLoans() { + return new APIlistUniLoansRequest(); + } + + /** + * Build call for createUniLoan + * @param createUniLoan (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 Operated successfully -
*/ - public okhttp3.Call getUniCurrencyPairCall(String currencyPair, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; + public okhttp3.Call createUniLoanCall(CreateUniLoan createUniLoan, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = createUniLoan; // create path and map variables - String localVarPath = "/margin/uni/currency_pairs/{currency_pair}" - .replaceAll("\\{" + "currency_pair" + "\\}", localVarApiClient.escapeString(currencyPair)); + String localVarPath = "/margin/uni/loans"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -175,7 +362,7 @@ public okhttp3.Call getUniCurrencyPairCall(String currencyPair, final ApiCallbac Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "application/json" + }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -183,84 +370,81 @@ public okhttp3.Call getUniCurrencyPairCall(String currencyPair, final ApiCallbac } final String[] localVarContentTypes = { - + "application/json" }; 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); + String[] localVarAuthNames = new String[] { "apiv4" }; + return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") - private okhttp3.Call getUniCurrencyPairValidateBeforeCall(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 getUniCurrencyPair(Async)"); + private okhttp3.Call createUniLoanValidateBeforeCall(CreateUniLoan createUniLoan, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'createUniLoan' is set + if (createUniLoan == null) { + throw new ApiException("Missing the required parameter 'createUniLoan' when calling createUniLoan(Async)"); } - okhttp3.Call localVarCall = getUniCurrencyPairCall(currencyPair, _callback); + okhttp3.Call localVarCall = createUniLoanCall(createUniLoan, _callback); return localVarCall; } /** - * Get detail of lending market + * Borrow or repay * - * @param currencyPair Currency pair (required) - * @return UniCurrencyPair + * @param createUniLoan (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 Operated successfully -
*/ - public UniCurrencyPair getUniCurrencyPair(String currencyPair) throws ApiException { - ApiResponse localVarResp = getUniCurrencyPairWithHttpInfo(currencyPair); - return localVarResp.getData(); + public void createUniLoan(CreateUniLoan createUniLoan) throws ApiException { + createUniLoanWithHttpInfo(createUniLoan); } /** - * Get detail of lending market + * Borrow or repay * - * @param currencyPair Currency pair (required) - * @return ApiResponse<UniCurrencyPair> + * @param createUniLoan (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 Operated successfully -
*/ - public ApiResponse getUniCurrencyPairWithHttpInfo(String currencyPair) throws ApiException { - okhttp3.Call localVarCall = getUniCurrencyPairValidateBeforeCall(currencyPair, null); - Type localVarReturnType = new TypeToken(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); + public ApiResponse createUniLoanWithHttpInfo(CreateUniLoan createUniLoan) throws ApiException { + okhttp3.Call localVarCall = createUniLoanValidateBeforeCall(createUniLoan, null); + return localVarApiClient.execute(localVarCall); } /** - * Get detail of lending market (asynchronously) + * Borrow or repay (asynchronously) * - * @param currencyPair Currency pair (required) + * @param createUniLoan (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 Operated successfully -
*/ - public okhttp3.Call getUniCurrencyPairAsync(String currencyPair, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getUniCurrencyPairValidateBeforeCall(currencyPair, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + public okhttp3.Call createUniLoanAsync(CreateUniLoan createUniLoan, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = createUniLoanValidateBeforeCall(createUniLoan, _callback); + localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } /** - * Build call for getMarginUniEstimateRate - * @param currencies An array of up to 10 specifying the currency name (required) + * Build call for getUniBorrowable + * @param currency Retrieve data of the specified currency (required) + * @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 @@ -270,16 +454,20 @@ public okhttp3.Call getUniCurrencyPairAsync(String currencyPair, final ApiCallba 200 Successfully retrieved - */ - public okhttp3.Call getMarginUniEstimateRateCall(List currencies, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getUniBorrowableCall(String currency, String currencyPair, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/margin/uni/estimate_rate"; + String localVarPath = "/margin/uni/borrowable"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); - if (currencies != null) { - localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "currencies", currencies)); + if (currency != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); + } + + if (currencyPair != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency_pair", currencyPair)); } Map localVarHeaderParams = new HashMap(); @@ -304,21 +492,27 @@ public okhttp3.Call getMarginUniEstimateRateCall(List currencies, final } @SuppressWarnings("rawtypes") - private okhttp3.Call getMarginUniEstimateRateValidateBeforeCall(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 getMarginUniEstimateRate(Async)"); + private okhttp3.Call getUniBorrowableValidateBeforeCall(String currency, String currencyPair, 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 getUniBorrowable(Async)"); } - okhttp3.Call localVarCall = getMarginUniEstimateRateCall(currencies, _callback); + // verify the required parameter 'currencyPair' is set + if (currencyPair == null) { + throw new ApiException("Missing the required parameter 'currencyPair' when calling getUniBorrowable(Async)"); + } + + okhttp3.Call localVarCall = getUniBorrowableCall(currency, currencyPair, _callback); return localVarCall; } /** - * 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) - * @return Map<String, String> + * Get maximum borrowable + * + * @param currency Retrieve data of the specified currency (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 @@ -326,16 +520,17 @@ private okhttp3.Call getMarginUniEstimateRateValidateBeforeCall(List cur
200 Successfully retrieved -
*/ - public Map getMarginUniEstimateRate(List currencies) throws ApiException { - ApiResponse> localVarResp = getMarginUniEstimateRateWithHttpInfo(currencies); + public MaxUniBorrowable getUniBorrowable(String currency, String currencyPair) throws ApiException { + ApiResponse localVarResp = getUniBorrowableWithHttpInfo(currency, currencyPair); return localVarResp.getData(); } /** - * 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) - * @return ApiResponse<Map<String, String>> + * Get maximum borrowable + * + * @param currency Retrieve data of the specified currency (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 @@ -343,16 +538,17 @@ public Map getMarginUniEstimateRate(List currencies) thr
200 Successfully retrieved -
*/ - public ApiResponse> getMarginUniEstimateRateWithHttpInfo(List currencies) throws ApiException { - okhttp3.Call localVarCall = getMarginUniEstimateRateValidateBeforeCall(currencies, null); - Type localVarReturnType = new TypeToken>(){}.getType(); + public ApiResponse getUniBorrowableWithHttpInfo(String currency, String currencyPair) throws ApiException { + okhttp3.Call localVarCall = getUniBorrowableValidateBeforeCall(currency, currencyPair, null); + Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * 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) + * Get maximum borrowable (asynchronously) + * + * @param currency Retrieve data of the specified currency (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 @@ -362,37 +558,34 @@ public ApiResponse> getMarginUniEstimateRateWithHttpInfo(Lis 200 Successfully retrieved - */ - public okhttp3.Call getMarginUniEstimateRateAsync(List currencies, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = getMarginUniEstimateRateValidateBeforeCall(currencies, _callback); - Type localVarReturnType = new TypeToken>(){}.getType(); + public okhttp3.Call getUniBorrowableAsync(String currency, String currencyPair, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = getUniBorrowableValidateBeforeCall(currency, currencyPair, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } - private okhttp3.Call listUniLoansCall(String currencyPair, String currency, Integer page, Integer limit, final ApiCallback _callback) throws ApiException { + /** + * Build call for getUniCurrencyPair + * @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 getUniCurrencyPairCall(String currencyPair, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/margin/uni/loans"; + String localVarPath = "/margin/uni/currency_pairs/{currency_pair}" + .replaceAll("\\{" + "currency_pair" + "\\}", localVarApiClient.escapeString(currencyPair)); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); - if (currencyPair != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency_pair", currencyPair)); - } - - 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)); - } - Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); @@ -410,178 +603,105 @@ private okhttp3.Call listUniLoansCall(String currencyPair, String currency, Inte final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); - String[] localVarAuthNames = new String[] { "apiv4" }; + String[] localVarAuthNames = new String[] { }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") - private okhttp3.Call listUniLoansValidateBeforeCall(String currencyPair, String currency, Integer page, Integer limit, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = listUniLoansCall(currencyPair, currency, page, limit, _callback); - return localVarCall; - } - - - private ApiResponse> listUniLoansWithHttpInfo(String currencyPair, String currency, Integer page, Integer limit) throws ApiException { - okhttp3.Call localVarCall = listUniLoansValidateBeforeCall(currencyPair, currency, page, limit, null); - Type localVarReturnType = new TypeToken>(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - private okhttp3.Call listUniLoansAsync(String currencyPair, String currency, Integer page, Integer limit, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = listUniLoansValidateBeforeCall(currencyPair, currency, page, limit, _callback); - Type localVarReturnType = new TypeToken>(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - public class APIlistUniLoansRequest { - private String currencyPair; - private String currency; - private Integer page; - private Integer limit; - - private APIlistUniLoansRequest() { - } - - /** - * Set currencyPair - * @param currencyPair Currency pair (optional) - * @return APIlistUniLoansRequest - */ - public APIlistUniLoansRequest currencyPair(String currencyPair) { - this.currencyPair = currencyPair; - return this; - } - - /** - * Set currency - * @param currency Retrieve data of the specified currency (optional) - * @return APIlistUniLoansRequest - */ - public APIlistUniLoansRequest currency(String currency) { - this.currency = currency; - return this; - } - - /** - * Set page - * @param page Page number (optional, default to 1) - * @return APIlistUniLoansRequest - */ - public APIlistUniLoansRequest 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 APIlistUniLoansRequest - */ - public APIlistUniLoansRequest limit(Integer limit) { - this.limit = limit; - return this; - } - - /** - * Build call for listUniLoans - * @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 -
- */ - public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { - return listUniLoansCall(currencyPair, currency, page, limit, _callback); - } - - /** - * Execute listUniLoans request - * @return List<UniLoan> - * @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 execute() throws ApiException { - ApiResponse> localVarResp = listUniLoansWithHttpInfo(currencyPair, currency, page, limit); - return localVarResp.getData(); - } - - /** - * Execute listUniLoans request with HTTP info returned - * @return ApiResponse<List<UniLoan>> - * @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> executeWithHttpInfo() throws ApiException { - return listUniLoansWithHttpInfo(currencyPair, currency, page, limit); - } - - /** - * Execute listUniLoans 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 -
- */ - public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { - return listUniLoansAsync(currencyPair, currency, page, limit, _callback); + private okhttp3.Call getUniCurrencyPairValidateBeforeCall(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 getUniCurrencyPair(Async)"); } + + okhttp3.Call localVarCall = getUniCurrencyPairCall(currencyPair, _callback); + return localVarCall; } /** - * List loans + * Get detail of lending market * - * @return APIlistUniLoansRequest + * @param currencyPair Currency pair (required) + * @return UniCurrencyPair + * @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 APIlistUniLoansRequest listUniLoans() { - return new APIlistUniLoansRequest(); + public UniCurrencyPair getUniCurrencyPair(String currencyPair) throws ApiException { + ApiResponse localVarResp = getUniCurrencyPairWithHttpInfo(currencyPair); + return localVarResp.getData(); } /** - * Build call for createUniLoan - * @param createUniLoan (required) + * Get detail of lending market + * + * @param currencyPair Currency pair (required) + * @return ApiResponse<UniCurrencyPair> + * @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 getUniCurrencyPairWithHttpInfo(String currencyPair) throws ApiException { + okhttp3.Call localVarCall = getUniCurrencyPairValidateBeforeCall(currencyPair, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Get detail of lending 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 getUniCurrencyPairAsync(String currencyPair, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = getUniCurrencyPairValidateBeforeCall(currencyPair, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + + /** + * Build call for getMarginUniEstimateRate + * @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
204 Operated successfully -
200 Successfully retrieved -
*/ - public okhttp3.Call createUniLoanCall(CreateUniLoan createUniLoan, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = createUniLoan; + public okhttp3.Call getMarginUniEstimateRateCall(List currencies, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = null; // create path and map variables - String localVarPath = "/margin/uni/loans"; + String localVarPath = "/margin/uni/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) { @@ -589,74 +709,78 @@ public okhttp3.Call createUniLoanCall(CreateUniLoan createUniLoan, final ApiCall } 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); + return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") - private okhttp3.Call createUniLoanValidateBeforeCall(CreateUniLoan createUniLoan, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'createUniLoan' is set - if (createUniLoan == null) { - throw new ApiException("Missing the required parameter 'createUniLoan' when calling createUniLoan(Async)"); + private okhttp3.Call getMarginUniEstimateRateValidateBeforeCall(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 getMarginUniEstimateRate(Async)"); } - okhttp3.Call localVarCall = createUniLoanCall(createUniLoan, _callback); + okhttp3.Call localVarCall = getMarginUniEstimateRateCall(currencies, _callback); return localVarCall; } /** - * Borrow or repay - * - * @param createUniLoan (required) + * 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) + * @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
204 Operated successfully -
200 Successfully retrieved -
*/ - public void createUniLoan(CreateUniLoan createUniLoan) throws ApiException { - createUniLoanWithHttpInfo(createUniLoan); + public Map getMarginUniEstimateRate(List currencies) throws ApiException { + ApiResponse> localVarResp = getMarginUniEstimateRateWithHttpInfo(currencies); + return localVarResp.getData(); } /** - * Borrow or repay - * - * @param createUniLoan (required) - * @return ApiResponse<Void> + * 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) + * @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
204 Operated successfully -
200 Successfully retrieved -
*/ - public ApiResponse createUniLoanWithHttpInfo(CreateUniLoan createUniLoan) throws ApiException { - okhttp3.Call localVarCall = createUniLoanValidateBeforeCall(createUniLoan, null); - return localVarApiClient.execute(localVarCall); + public ApiResponse> getMarginUniEstimateRateWithHttpInfo(List currencies) throws ApiException { + okhttp3.Call localVarCall = getMarginUniEstimateRateValidateBeforeCall(currencies, null); + Type localVarReturnType = new TypeToken>(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * Borrow or repay (asynchronously) - * - * @param createUniLoan (required) + * 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) * @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 Operated successfully -
200 Successfully retrieved -
*/ - public okhttp3.Call createUniLoanAsync(CreateUniLoan createUniLoan, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = createUniLoanValidateBeforeCall(createUniLoan, _callback); - localVarApiClient.executeAsync(localVarCall, _callback); + public okhttp3.Call getMarginUniEstimateRateAsync(List currencies, final ApiCallback> _callback) throws ApiException { + okhttp3.Call localVarCall = getMarginUniEstimateRateValidateBeforeCall(currencies, _callback); + Type localVarReturnType = new TypeToken>(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } @@ -1081,128 +1205,4 @@ public APIlistUniLoanInterestRecordsRequest listUniLoanInterestRecords() { return new APIlistUniLoanInterestRecordsRequest(); } - /** - * Build call for getUniBorrowable - * @param currency Retrieve data of the specified currency (required) - * @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 getUniBorrowableCall(String currency, String currencyPair, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/margin/uni/borrowable"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - if (currency != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); - } - - 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 getUniBorrowableValidateBeforeCall(String currency, String currencyPair, 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 getUniBorrowable(Async)"); - } - - // verify the required parameter 'currencyPair' is set - if (currencyPair == null) { - throw new ApiException("Missing the required parameter 'currencyPair' when calling getUniBorrowable(Async)"); - } - - okhttp3.Call localVarCall = getUniBorrowableCall(currency, currencyPair, _callback); - return localVarCall; - } - - /** - * Get maximum borrowable - * - * @param currency Retrieve data of the specified currency (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 -
- */ - public MaxUniBorrowable getUniBorrowable(String currency, String currencyPair) throws ApiException { - ApiResponse localVarResp = getUniBorrowableWithHttpInfo(currency, currencyPair); - return localVarResp.getData(); - } - - /** - * Get maximum borrowable - * - * @param currency Retrieve data of the specified currency (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 -
- */ - public ApiResponse getUniBorrowableWithHttpInfo(String currency, String currencyPair) throws ApiException { - okhttp3.Call localVarCall = getUniBorrowableValidateBeforeCall(currency, currencyPair, null); - Type localVarReturnType = new TypeToken(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - /** - * Get maximum borrowable (asynchronously) - * - * @param currency Retrieve data of the specified currency (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 -
- */ - public okhttp3.Call getUniBorrowableAsync(String currency, String currencyPair, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getUniBorrowableValidateBeforeCall(currency, currencyPair, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - } diff --git a/src/main/java/io/gate/gateapi/api/SpotApi.java b/src/main/java/io/gate/gateapi/api/SpotApi.java index a7a7b44..57ec9a2 100644 --- a/src/main/java/io/gate/gateapi/api/SpotApi.java +++ b/src/main/java/io/gate/gateapi/api/SpotApi.java @@ -3250,7 +3250,7 @@ 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 + * 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, it supports modifying the price or quantity (choose one of two), and also supports modifying the price and quantity at the same time 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 * @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) @@ -3271,7 +3271,7 @@ 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 + * 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, it supports modifying the price or quantity (choose one of two), and also supports modifying the price and quantity at the same time 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 * @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) @@ -3293,7 +3293,7 @@ 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 + * 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, it supports modifying the price or quantity (choose one of two), and also supports modifying the price and quantity at the same time 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 * @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) 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..1f7b4d7 100644 --- a/src/main/java/io/gate/gateapi/models/CrossMarginBalance.java +++ b/src/main/java/io/gate/gateapi/models/CrossMarginBalance.java @@ -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) { @@ -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/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/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/SpotAccount.java b/src/main/java/io/gate/gateapi/models/SpotAccount.java index 929402d..4bf0813 100644 --- a/src/main/java/io/gate/gateapi/models/SpotAccount.java +++ b/src/main/java/io/gate/gateapi/models/SpotAccount.java @@ -39,6 +39,10 @@ public class SpotAccount { @SerializedName(SERIALIZED_NAME_UPDATE_ID) private Long updateId; + public static final String SERIALIZED_NAME_REFRESH_TIME = "refresh_time"; + @SerializedName(SERIALIZED_NAME_REFRESH_TIME) + private Long refreshTime; + public SpotAccount currency(String currency) { @@ -119,6 +123,26 @@ public Long getUpdateId() { public void setUpdateId(Long updateId) { this.updateId = updateId; } + + public SpotAccount refreshTime(Long refreshTime) { + + this.refreshTime = refreshTime; + return this; + } + + /** + * Asset Refresh Time (ms) + * @return refreshTime + **/ + @javax.annotation.Nullable + public Long getRefreshTime() { + return refreshTime; + } + + + public void setRefreshTime(Long refreshTime) { + this.refreshTime = refreshTime; + } @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -131,12 +155,13 @@ public boolean equals(java.lang.Object o) { return Objects.equals(this.currency, spotAccount.currency) && Objects.equals(this.available, spotAccount.available) && Objects.equals(this.locked, spotAccount.locked) && - Objects.equals(this.updateId, spotAccount.updateId); + Objects.equals(this.updateId, spotAccount.updateId) && + Objects.equals(this.refreshTime, spotAccount.refreshTime); } @Override public int hashCode() { - return Objects.hash(currency, available, locked, updateId); + return Objects.hash(currency, available, locked, updateId, refreshTime); } @@ -148,6 +173,7 @@ public String toString() { sb.append(" available: ").append(toIndentedString(available)).append("\n"); sb.append(" locked: ").append(toIndentedString(locked)).append("\n"); sb.append(" updateId: ").append(toIndentedString(updateId)).append("\n"); + sb.append(" refreshTime: ").append(toIndentedString(refreshTime)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/gate/gateapi/models/SubCrossMarginAccount.java b/src/main/java/io/gate/gateapi/models/SubCrossMarginAccount.java index cce97a1..5fed791 100644 --- a/src/main/java/io/gate/gateapi/models/SubCrossMarginAccount.java +++ b/src/main/java/io/gate/gateapi/models/SubCrossMarginAccount.java @@ -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) @@ -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; } 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 "); - } - -} - From 6e906c453daac9f426208e409d2452a6b9d98e18 Mon Sep 17 00:00:00 2001 From: gateio Date: Tue, 1 Jul 2025 13:02:42 +0000 Subject: [PATCH 02/14] update to v6.100.0 --- README.md | 50 +- build.gradle | 2 +- build.sbt | 2 +- docs/AccountBookResponse.md | 15 + docs/AccountsResponse.md | 15 + docs/AlphaApi.md | 601 ++++++++ docs/BrokerCommission1.md | 1 + docs/BrokerCommissionSubBrokerInfo.md | 14 + docs/BrokerTransaction1.md | 1 + docs/Contract.md | 2 + docs/Currency2.md | 15 + docs/EarnApi.md | 137 ++ docs/EarnUniApi.md | 8 +- docs/FindCoin.md | 10 + docs/FuturesApi.md | 8 +- ...eObject.md => FuturesPositionCrossMode.md} | 2 +- docs/MarginApi.md | 266 ++-- docs/MarginUniApi.md | 230 +-- docs/OrderResponse.md | 23 + docs/PlaceOrderRequest.md | 16 + docs/PlaceOrderResponse.md | 18 + docs/QuoteRequest.md | 15 + docs/QuoteResponse.md | 20 + docs/SubAccountApi.md | 6 +- docs/SubAccountKey.md | 2 +- docs/SubAccountTransfer.md | 6 +- docs/SubAccountTransferRecordItem.md | 18 + docs/SwapCoin.md | 14 + docs/Ticker2.md | 13 + docs/WalletApi.md | 6 +- pom.xml | 2 +- .../java/io/gate/gateapi/ApiCallback.java | 2 +- src/main/java/io/gate/gateapi/ApiClient.java | 4 +- .../java/io/gate/gateapi/ApiException.java | 2 +- .../java/io/gate/gateapi/ApiResponse.java | 2 +- .../java/io/gate/gateapi/Configuration.java | 2 +- .../gate/gateapi/GzipRequestInterceptor.java | 2 +- src/main/java/io/gate/gateapi/JSON.java | 2 +- src/main/java/io/gate/gateapi/Pair.java | 2 +- .../io/gate/gateapi/ProgressRequestBody.java | 2 +- .../io/gate/gateapi/ProgressResponseBody.java | 2 +- src/main/java/io/gate/gateapi/StringUtil.java | 2 +- .../java/io/gate/gateapi/api/AccountApi.java | 2 +- .../java/io/gate/gateapi/api/AlphaApi.java | 1236 +++++++++++++++++ .../gate/gateapi/api/CollateralLoanApi.java | 2 +- .../java/io/gate/gateapi/api/DeliveryApi.java | 2 +- .../java/io/gate/gateapi/api/EarnApi.java | 214 ++- .../java/io/gate/gateapi/api/EarnUniApi.java | 30 +- .../io/gate/gateapi/api/FlashSwapApi.java | 2 +- .../java/io/gate/gateapi/api/FuturesApi.java | 38 +- .../java/io/gate/gateapi/api/MarginApi.java | 1234 ++++++++-------- .../io/gate/gateapi/api/MarginUniApi.java | 744 +++++----- .../gateapi/api/MultiCollateralLoanApi.java | 2 +- .../java/io/gate/gateapi/api/OptionsApi.java | 2 +- .../java/io/gate/gateapi/api/RebateApi.java | 2 +- .../java/io/gate/gateapi/api/SpotApi.java | 2 +- .../io/gate/gateapi/api/SubAccountApi.java | 18 +- .../java/io/gate/gateapi/api/UnifiedApi.java | 2 +- .../java/io/gate/gateapi/api/WalletApi.java | 23 +- .../io/gate/gateapi/api/WithdrawalApi.java | 2 +- .../java/io/gate/gateapi/auth/ApiKeyAuth.java | 2 +- .../io/gate/gateapi/auth/Authentication.java | 2 +- .../io/gate/gateapi/auth/GateApiV4Auth.java | 2 +- .../io/gate/gateapi/auth/HttpBasicAuth.java | 2 +- .../io/gate/gateapi/auth/HttpBearerAuth.java | 2 +- .../gate/gateapi/models/AccountBalance.java | 2 +- .../gateapi/models/AccountBookResponse.java | 193 +++ .../io/gate/gateapi/models/AccountDetail.java | 2 +- .../gate/gateapi/models/AccountDetailKey.java | 2 +- .../gate/gateapi/models/AccountRateLimit.java | 2 +- .../gate/gateapi/models/AccountsResponse.java | 193 +++ .../gate/gateapi/models/AgencyCommission.java | 2 +- .../models/AgencyCommissionHistory.java | 2 +- .../gateapi/models/AgencyTransaction.java | 2 +- .../models/AgencyTransactionHistory.java | 2 +- .../gate/gateapi/models/AutoRepaySetting.java | 2 +- .../gate/gateapi/models/BatchAmendItem.java | 2 +- .../gateapi/models/BatchAmendOrderReq.java | 2 +- .../gateapi/models/BatchFuturesOrder.java | 2 +- .../io/gate/gateapi/models/BatchOrder.java | 2 +- .../gateapi/models/BorrowCurrencyInfo.java | 2 +- .../gate/gateapi/models/BrokerCommission.java | 2 +- .../gateapi/models/BrokerCommission1.java | 33 +- .../models/BrokerCommissionSubBrokerInfo.java | 167 +++ .../gateapi/models/BrokerTransaction.java | 2 +- .../gateapi/models/BrokerTransaction1.java | 33 +- .../gate/gateapi/models/CancelBatchOrder.java | 2 +- .../gateapi/models/CancelOrderResult.java | 2 +- .../gate/gateapi/models/CollateralAdjust.java | 2 +- .../gateapi/models/CollateralAdjustRes.java | 2 +- .../gate/gateapi/models/CollateralAlign.java | 2 +- .../gateapi/models/CollateralCurrency.java | 2 +- .../models/CollateralCurrencyInfo.java | 2 +- .../gateapi/models/CollateralCurrencyRes.java | 2 +- .../gateapi/models/CollateralCurrentRate.java | 2 +- .../gateapi/models/CollateralFixRate.java | 2 +- .../models/CollateralLoanCurrency.java | 2 +- .../io/gate/gateapi/models/CollateralLtv.java | 2 +- .../gate/gateapi/models/CollateralOrder.java | 2 +- .../gate/gateapi/models/CollateralRecord.java | 2 +- .../java/io/gate/gateapi/models/Contract.java | 58 +- .../io/gate/gateapi/models/ContractStat.java | 2 +- .../gateapi/models/ConvertSmallBalance.java | 2 +- .../models/CountdownCancelAllFuturesTask.java | 2 +- .../models/CountdownCancelAllOptionsTask.java | 2 +- .../models/CountdownCancelAllSpotTask.java | 2 +- .../gateapi/models/CreateCollateralOrder.java | 2 +- .../models/CreateMultiCollateralOrder.java | 2 +- .../io/gate/gateapi/models/CreateUniLend.java | 2 +- .../io/gate/gateapi/models/CreateUniLoan.java | 2 +- .../gateapi/models/CrossMarginBalance.java | 2 +- .../gate/gateapi/models/CrossMarginLoan.java | 2 +- .../gateapi/models/CrossMarginRepayment.java | 2 +- .../java/io/gate/gateapi/models/Currency.java | 2 +- .../io/gate/gateapi/models/Currency2.java | 245 ++++ .../io/gate/gateapi/models/CurrencyChain.java | 2 +- .../io/gate/gateapi/models/CurrencyPair.java | 2 +- .../io/gate/gateapi/models/CurrencyQuota.java | 2 +- .../java/io/gate/gateapi/models/DebitFee.java | 2 +- .../gateapi/models/DeliveryCandlestick.java | 2 +- .../gate/gateapi/models/DeliveryContract.java | 2 +- .../gateapi/models/DeliverySettlement.java | 2 +- .../gate/gateapi/models/DeliveryTicker.java | 2 +- .../gate/gateapi/models/DepositAddress.java | 2 +- .../io/gate/gateapi/models/DepositRecord.java | 2 +- .../io/gate/gateapi/models/DualGetOrders.java | 2 +- .../io/gate/gateapi/models/DualGetPlans.java | 2 +- .../io/gate/gateapi/models/Eth2RateList.java | 2 +- .../java/io/gate/gateapi/models/Eth2Swap.java | 2 +- .../java/io/gate/gateapi/models/FindCoin.java | 115 ++ .../gateapi/models/FlashSwapCurrencyPair.java | 2 +- .../gate/gateapi/models/FlashSwapOrder.java | 2 +- .../gateapi/models/FlashSwapOrderPreview.java | 2 +- .../gateapi/models/FlashSwapOrderRequest.java | 2 +- .../models/FlashSwapPreviewRequest.java | 2 +- .../gate/gateapi/models/FundingAccount.java | 2 +- .../gateapi/models/FundingRateRecord.java | 2 +- .../models/FutureCancelOrderResult.java | 2 +- .../gate/gateapi/models/FuturesAccount.java | 2 +- .../gateapi/models/FuturesAccountBook.java | 2 +- .../gateapi/models/FuturesAccountHistory.java | 2 +- .../gateapi/models/FuturesAutoDeleverage.java | 2 +- .../models/FuturesBatchAmendOrderRequest.java | 2 +- .../gateapi/models/FuturesCandlestick.java | 2 +- .../io/gate/gateapi/models/FuturesFee.java | 2 +- .../models/FuturesIndexConstituents.java | 2 +- .../gateapi/models/FuturesInitialOrder.java | 2 +- .../gateapi/models/FuturesLimitRiskTiers.java | 2 +- .../gate/gateapi/models/FuturesLiqOrder.java | 2 +- .../gate/gateapi/models/FuturesLiquidate.java | 2 +- .../io/gate/gateapi/models/FuturesOrder.java | 2 +- .../gateapi/models/FuturesOrderAmendment.java | 2 +- .../gate/gateapi/models/FuturesOrderBook.java | 2 +- .../gateapi/models/FuturesOrderBookItem.java | 2 +- ...ect.java => FuturesPositionCrossMode.java} | 18 +- .../gateapi/models/FuturesPremiumIndex.java | 2 +- .../gateapi/models/FuturesPriceTrigger.java | 2 +- .../models/FuturesPriceTriggeredOrder.java | 2 +- .../io/gate/gateapi/models/FuturesTicker.java | 2 +- .../io/gate/gateapi/models/FuturesTrade.java | 2 +- .../gate/gateapi/models/IndexConstituent.java | 2 +- .../gateapi/models/InlineResponse200.java | 2 +- .../gateapi/models/InlineResponse2001.java | 2 +- .../gate/gateapi/models/InsuranceRecord.java | 2 +- .../io/gate/gateapi/models/LedgerRecord.java | 2 +- .../gate/gateapi/models/LiquidateOrder.java | 2 +- .../io/gate/gateapi/models/MarginAccount.java | 2 +- .../gateapi/models/MarginAccountBook.java | 2 +- .../gateapi/models/MarginAccountCurrency.java | 2 +- .../gateapi/models/MarginLeverageTier.java | 2 +- .../gateapi/models/MarginMarketLeverage.java | 2 +- .../io/gate/gateapi/models/MarginTiers.java | 2 +- .../gateapi/models/MarginTransferable.java | 2 +- .../gate/gateapi/models/MaxUniBorrowable.java | 2 +- .../gate/gateapi/models/MockFuturesOrder.java | 2 +- .../gateapi/models/MockFuturesPosition.java | 2 +- .../gate/gateapi/models/MockMarginResult.java | 2 +- .../gate/gateapi/models/MockOptionsOrder.java | 2 +- .../gateapi/models/MockOptionsPosition.java | 2 +- .../io/gate/gateapi/models/MockRiskUnit.java | 2 +- .../gate/gateapi/models/MockSpotBalance.java | 2 +- .../io/gate/gateapi/models/MockSpotOrder.java | 2 +- .../gateapi/models/MultiChainAddressItem.java | 2 +- .../models/MultiCollateralCurrency.java | 2 +- .../gateapi/models/MultiCollateralItem.java | 2 +- .../gateapi/models/MultiCollateralOrder.java | 2 +- .../gateapi/models/MultiCollateralRecord.java | 2 +- .../models/MultiCollateralRecordCurrency.java | 2 +- .../io/gate/gateapi/models/MultiLoanItem.java | 2 +- .../gateapi/models/MultiLoanRepayItem.java | 2 +- .../gate/gateapi/models/MultiRepayRecord.java | 2 +- .../gate/gateapi/models/MultiRepayResp.java | 2 +- .../gate/gateapi/models/MyFuturesTrade.java | 2 +- .../models/MyFuturesTradeTimeRange.java | 2 +- .../io/gate/gateapi/models/OpenOrders.java | 2 +- .../gate/gateapi/models/OptionsAccount.java | 2 +- .../gateapi/models/OptionsAccountBook.java | 2 +- .../gateapi/models/OptionsCandlestick.java | 2 +- .../gate/gateapi/models/OptionsContract.java | 2 +- .../io/gate/gateapi/models/OptionsMMP.java | 2 +- .../gate/gateapi/models/OptionsMMPReset.java | 2 +- .../gateapi/models/OptionsMySettlements.java | 2 +- .../gate/gateapi/models/OptionsMyTrade.java | 2 +- .../io/gate/gateapi/models/OptionsOrder.java | 2 +- .../gate/gateapi/models/OptionsPosition.java | 2 +- .../gateapi/models/OptionsPositionClose.java | 2 +- .../models/OptionsPositionCloseOrder.java | 2 +- .../gateapi/models/OptionsSettlement.java | 2 +- .../io/gate/gateapi/models/OptionsTicker.java | 2 +- .../gateapi/models/OptionsUnderlying.java | 2 +- .../models/OptionsUnderlyingTicker.java | 2 +- .../java/io/gate/gateapi/models/Order.java | 2 +- .../io/gate/gateapi/models/OrderBook.java | 2 +- .../io/gate/gateapi/models/OrderCancel.java | 2 +- .../io/gate/gateapi/models/OrderPatch.java | 2 +- .../io/gate/gateapi/models/OrderResp.java | 2 +- .../io/gate/gateapi/models/OrderResponse.java | 401 ++++++ .../models/PartnerCommissionHistory.java | 2 +- .../io/gate/gateapi/models/PartnerSub.java | 2 +- .../gate/gateapi/models/PartnerSubList.java | 2 +- .../models/PartnerTransactionHistory.java | 2 +- .../io/gate/gateapi/models/PatchUniLend.java | 2 +- .../models/PlaceDualInvestmentOrder.java | 2 +- .../gateapi/models/PlaceOrderRequest.java | 214 +++ .../gateapi/models/PlaceOrderResponse.java | 271 ++++ .../java/io/gate/gateapi/models/Position.java | 2 +- .../io/gate/gateapi/models/PositionClose.java | 2 +- .../gateapi/models/PositionCloseOrder.java | 2 +- .../gate/gateapi/models/ProfitLossRange.java | 2 +- .../io/gate/gateapi/models/QuoteRequest.java | 189 +++ .../io/gate/gateapi/models/QuoteResponse.java | 323 +++++ .../gate/gateapi/models/RebateUserInfo.java | 2 +- .../gate/gateapi/models/RepayCurrencyRes.java | 2 +- .../io/gate/gateapi/models/RepayLoan.java | 2 +- .../gate/gateapi/models/RepayMultiLoan.java | 2 +- .../io/gate/gateapi/models/RepayRecord.java | 2 +- .../gateapi/models/RepayRecordCurrency.java | 2 +- .../models/RepayRecordLeftInterest.java | 2 +- .../models/RepayRecordRepaidCurrency.java | 2 +- .../models/RepayRecordTotalInterest.java | 2 +- .../io/gate/gateapi/models/RepayResp.java | 2 +- .../io/gate/gateapi/models/RiskUnits.java | 2 +- .../io/gate/gateapi/models/SavedAddress.java | 2 +- .../io/gate/gateapi/models/SmallBalance.java | 2 +- .../gateapi/models/SmallBalanceHistory.java | 2 +- .../io/gate/gateapi/models/SpotAccount.java | 2 +- .../gate/gateapi/models/SpotAccountBook.java | 2 +- .../gateapi/models/SpotCurrencyChain.java | 2 +- .../java/io/gate/gateapi/models/SpotFee.java | 2 +- .../gateapi/models/SpotInsuranceHistory.java | 2 +- .../gateapi/models/SpotPricePutOrder.java | 2 +- .../gate/gateapi/models/SpotPriceTrigger.java | 2 +- .../models/SpotPriceTriggeredOrder.java | 2 +- .../java/io/gate/gateapi/models/StpGroup.java | 2 +- .../io/gate/gateapi/models/StpGroupUser.java | 2 +- .../io/gate/gateapi/models/StructuredBuy.java | 2 +- .../models/StructuredGetProjectList.java | 2 +- .../gateapi/models/StructuredOrderList.java | 2 +- .../io/gate/gateapi/models/SubAccount.java | 2 +- .../gateapi/models/SubAccountBalance.java | 2 +- .../models/SubAccountCrossMarginBalance.java | 2 +- .../models/SubAccountFuturesBalance.java | 2 +- .../io/gate/gateapi/models/SubAccountKey.java | 6 +- .../gateapi/models/SubAccountKeyPerms.java | 2 +- .../models/SubAccountMarginBalance.java | 2 +- .../models/SubAccountToSubAccount.java | 2 +- .../gateapi/models/SubAccountTransfer.java | 84 +- .../models/SubAccountTransferRecordItem.java | 289 ++++ .../gateapi/models/SubCrossMarginAccount.java | 2 +- .../io/gate/gateapi/models/SubUserMode.java | 2 +- .../java/io/gate/gateapi/models/SwapCoin.java | 164 +++ .../io/gate/gateapi/models/SystemTime.java | 2 +- .../java/io/gate/gateapi/models/Ticker.java | 2 +- .../java/io/gate/gateapi/models/Ticker2.java | 193 +++ .../io/gate/gateapi/models/TotalBalance.java | 2 +- .../java/io/gate/gateapi/models/Trade.java | 2 +- .../java/io/gate/gateapi/models/TradeFee.java | 2 +- .../io/gate/gateapi/models/TransactionID.java | 2 +- .../java/io/gate/gateapi/models/Transfer.java | 2 +- .../gateapi/models/TransferOrderStatus.java | 2 +- .../gateapi/models/TransferablesResult.java | 2 +- .../gateapi/models/TriggerOrderResponse.java | 2 +- .../io/gate/gateapi/models/TriggerTime.java | 2 +- .../io/gate/gateapi/models/UidPushOrder.java | 2 +- .../gateapi/models/UidPushWithdrawal.java | 2 +- .../gateapi/models/UidPushWithdrawalResp.java | 2 +- .../io/gate/gateapi/models/UniCurrency.java | 2 +- .../gateapi/models/UniCurrencyInterest.java | 2 +- .../gate/gateapi/models/UniCurrencyPair.java | 2 +- .../gateapi/models/UniInterestRecord.java | 2 +- .../java/io/gate/gateapi/models/UniLend.java | 2 +- .../gate/gateapi/models/UniLendInterest.java | 2 +- .../io/gate/gateapi/models/UniLendRecord.java | 2 +- .../java/io/gate/gateapi/models/UniLoan.java | 2 +- .../gateapi/models/UniLoanInterestRecord.java | 2 +- .../io/gate/gateapi/models/UniLoanRecord.java | 2 +- .../gate/gateapi/models/UnifiedAccount.java | 2 +- .../gate/gateapi/models/UnifiedBalance.java | 2 +- .../gateapi/models/UnifiedBorrowable.java | 2 +- .../gateapi/models/UnifiedBorrowable1.java | 2 +- .../gate/gateapi/models/UnifiedCurrency.java | 2 +- .../gate/gateapi/models/UnifiedDiscount.java | 2 +- .../gateapi/models/UnifiedDiscountTiers.java | 2 +- .../models/UnifiedHistoryLoanRate.java | 2 +- .../models/UnifiedHistoryLoanRateRates.java | 2 +- .../gateapi/models/UnifiedLeverageConfig.java | 2 +- .../models/UnifiedLeverageSetting.java | 2 +- .../io/gate/gateapi/models/UnifiedLoan.java | 2 +- .../gateapi/models/UnifiedLoanRecord.java | 2 +- .../gateapi/models/UnifiedLoanResult.java | 2 +- .../gateapi/models/UnifiedMarginTiers.java | 2 +- .../gate/gateapi/models/UnifiedModeSet.java | 2 +- .../gateapi/models/UnifiedPortfolioInput.java | 2 +- .../models/UnifiedPortfolioOutput.java | 2 +- .../gate/gateapi/models/UnifiedRiskUnits.java | 2 +- .../gate/gateapi/models/UnifiedSettings.java | 2 +- .../gateapi/models/UnifiedTransferable.java | 2 +- .../io/gate/gateapi/models/UserLtvInfo.java | 2 +- .../java/io/gate/gateapi/models/UserSub.java | 2 +- .../gate/gateapi/models/UserSubRelation.java | 2 +- .../gate/gateapi/models/UserTotalAmount.java | 2 +- .../gate/gateapi/models/WithdrawStatus.java | 2 +- .../gate/gateapi/models/WithdrawalRecord.java | 2 +- 323 files changed, 7101 insertions(+), 1695 deletions(-) create mode 100644 docs/AccountBookResponse.md create mode 100644 docs/AccountsResponse.md create mode 100644 docs/AlphaApi.md create mode 100644 docs/BrokerCommissionSubBrokerInfo.md create mode 100644 docs/Currency2.md create mode 100644 docs/FindCoin.md rename docs/{InlineObject.md => FuturesPositionCrossMode.md} (90%) create mode 100644 docs/OrderResponse.md create mode 100644 docs/PlaceOrderRequest.md create mode 100644 docs/PlaceOrderResponse.md create mode 100644 docs/QuoteRequest.md create mode 100644 docs/QuoteResponse.md create mode 100644 docs/SubAccountTransferRecordItem.md create mode 100644 docs/SwapCoin.md create mode 100644 docs/Ticker2.md create mode 100644 src/main/java/io/gate/gateapi/api/AlphaApi.java create mode 100644 src/main/java/io/gate/gateapi/models/AccountBookResponse.java create mode 100644 src/main/java/io/gate/gateapi/models/AccountsResponse.java create mode 100644 src/main/java/io/gate/gateapi/models/BrokerCommissionSubBrokerInfo.java create mode 100644 src/main/java/io/gate/gateapi/models/Currency2.java create mode 100644 src/main/java/io/gate/gateapi/models/FindCoin.java rename src/main/java/io/gate/gateapi/models/{InlineObject.java => FuturesPositionCrossMode.java} (82%) create mode 100644 src/main/java/io/gate/gateapi/models/OrderResponse.java create mode 100644 src/main/java/io/gate/gateapi/models/PlaceOrderRequest.java create mode 100644 src/main/java/io/gate/gateapi/models/PlaceOrderResponse.java create mode 100644 src/main/java/io/gate/gateapi/models/QuoteRequest.java create mode 100644 src/main/java/io/gate/gateapi/models/QuoteResponse.java create mode 100644 src/main/java/io/gate/gateapi/models/SubAccountTransferRecordItem.java create mode 100644 src/main/java/io/gate/gateapi/models/SwapCoin.java create mode 100644 src/main/java/io/gate/gateapi/models/Ticker2.java diff --git a/README.md b/README.md index 26bdb3c..f2760a3 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,14 @@ Gate API v4 -- API version: 4.99.0 -- SDK version: 6.99.0 +- API version: 4.100.0 +- SDK version: 6.100.0 Welcome to Gate API APIv4 provides spot, margin and futures trading 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) *Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)* @@ -53,7 +54,7 @@ Add this dependency to your project's POM: io.gate gate-api - 6.99.0 + 6.100.0 compile ``` @@ -63,7 +64,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.99.0" +compile "io.gate:gate-api:6.100.0" ``` ### Others @@ -76,7 +77,7 @@ mvn clean package Then manually install the following JARs: -* `target/gate-api-6.99.0.jar` +* `target/gate-api-6.100.0.jar` * `target/lib/*.jar` To install the API client library to your local Maven repository, simply execute: @@ -150,6 +151,14 @@ Class | Method | HTTP request | Description *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. +*AlphaApi* | [**listAlphaAccounts**](docs/AlphaApi.md#listAlphaAccounts) | **GET** /alpha/accounts | API for Alpha Accounts +*AlphaApi* | [**listAlphaAccountBook**](docs/AlphaApi.md#listAlphaAccountBook) | **GET** /alpha/account_book | Alpha Asset Transaction API +*AlphaApi* | [**quoteAlphaOrder**](docs/AlphaApi.md#quoteAlphaOrder) | **POST** /alpha/quote | Alpha Quotation API +*AlphaApi* | [**listAlphaOrder**](docs/AlphaApi.md#listAlphaOrder) | **GET** /alpha/orders | Alpha 查询订单列表接口 +*AlphaApi* | [**placeAlphaOrder**](docs/AlphaApi.md#placeAlphaOrder) | **POST** /alpha/orders | Alpha Order Placement API +*AlphaApi* | [**getAlphaOrder**](docs/AlphaApi.md#getAlphaOrder) | **GET** /alpha/order | Alpha 查询单个订单接口 +*AlphaApi* | [**listAlphaCurrencies**](docs/AlphaApi.md#listAlphaCurrencies) | **GET** /alpha/currencies | 查询币种信息 +*AlphaApi* | [**listAlphaTickers**](docs/AlphaApi.md#listAlphaTickers) | **GET** /alpha/tickers | 查询币种ticker *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 @@ -197,6 +206,8 @@ Class | Method | HTTP request | Description *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 +*EarnApi* | [**findCoin**](docs/EarnApi.md#findCoin) | **GET** /earn/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 | 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 @@ -262,25 +273,25 @@ Class | Method | HTTP request | Description *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 *MarginApi* | [**listMarginAccounts**](docs/MarginApi.md#listMarginAccounts) | **GET** /margin/accounts | Margin account list -*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 *MarginApi* | [**listMarginAccountBook**](docs/MarginApi.md#listMarginAccountBook) | **GET** /margin/account_book | List 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* | [**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 *MarginApi* | [**listCrossMarginLoans**](docs/MarginApi.md#listCrossMarginLoans) | **GET** /margin/cross/loans | List cross margin borrow history. (deprecated) *MarginApi* | [**listCrossMarginRepayments**](docs/MarginApi.md#listCrossMarginRepayments) | **GET** /margin/cross/repayments | Retrieve cross margin repayments. (deprecated) *MarginUniApi* | [**listUniCurrencyPairs**](docs/MarginUniApi.md#listUniCurrencyPairs) | **GET** /margin/uni/currency_pairs | List lending markets -*MarginUniApi* | [**listUniLoans**](docs/MarginUniApi.md#listUniLoans) | **GET** /margin/uni/loans | List loans -*MarginUniApi* | [**createUniLoan**](docs/MarginUniApi.md#createUniLoan) | **POST** /margin/uni/loans | Borrow or repay -*MarginUniApi* | [**getUniBorrowable**](docs/MarginUniApi.md#getUniBorrowable) | **GET** /margin/uni/borrowable | Get maximum borrowable *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* | [**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 @@ -423,9 +434,11 @@ Class | Method | HTTP request | Description ## Documentation for Models - [AccountBalance](docs/AccountBalance.md) + - [AccountBookResponse](docs/AccountBookResponse.md) - [AccountDetail](docs/AccountDetail.md) - [AccountDetailKey](docs/AccountDetailKey.md) - [AccountRateLimit](docs/AccountRateLimit.md) + - [AccountsResponse](docs/AccountsResponse.md) - [AgencyCommission](docs/AgencyCommission.md) - [AgencyCommissionHistory](docs/AgencyCommissionHistory.md) - [AgencyTransaction](docs/AgencyTransaction.md) @@ -438,6 +451,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) @@ -468,6 +482,7 @@ Class | Method | HTTP request | Description - [CrossMarginLoan](docs/CrossMarginLoan.md) - [CrossMarginRepayment](docs/CrossMarginRepayment.md) - [Currency](docs/Currency.md) + - [Currency2](docs/Currency2.md) - [CurrencyChain](docs/CurrencyChain.md) - [CurrencyPair](docs/CurrencyPair.md) - [CurrencyQuota](docs/CurrencyQuota.md) @@ -482,6 +497,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) @@ -506,13 +522,13 @@ 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) - [FuturesTicker](docs/FuturesTicker.md) - [FuturesTrade](docs/FuturesTrade.md) - [IndexConstituent](docs/IndexConstituent.md) - - [InlineObject](docs/InlineObject.md) - [InlineResponse200](docs/InlineResponse200.md) - [InlineResponse2001](docs/InlineResponse2001.md) - [InsuranceRecord](docs/InsuranceRecord.md) @@ -568,16 +584,21 @@ Class | Method | HTTP request | Description - [OrderCancel](docs/OrderCancel.md) - [OrderPatch](docs/OrderPatch.md) - [OrderResp](docs/OrderResp.md) + - [OrderResponse](docs/OrderResponse.md) - [PartnerCommissionHistory](docs/PartnerCommissionHistory.md) - [PartnerSub](docs/PartnerSub.md) - [PartnerSubList](docs/PartnerSubList.md) - [PartnerTransactionHistory](docs/PartnerTransactionHistory.md) - [PatchUniLend](docs/PatchUniLend.md) - [PlaceDualInvestmentOrder](docs/PlaceDualInvestmentOrder.md) + - [PlaceOrderRequest](docs/PlaceOrderRequest.md) + - [PlaceOrderResponse](docs/PlaceOrderResponse.md) - [Position](docs/Position.md) - [PositionClose](docs/PositionClose.md) - [PositionCloseOrder](docs/PositionCloseOrder.md) - [ProfitLossRange](docs/ProfitLossRange.md) + - [QuoteRequest](docs/QuoteRequest.md) + - [QuoteResponse](docs/QuoteResponse.md) - [RebateUserInfo](docs/RebateUserInfo.md) - [RepayCurrencyRes](docs/RepayCurrencyRes.md) - [RepayLoan](docs/RepayLoan.md) @@ -614,10 +635,13 @@ 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) - [SystemTime](docs/SystemTime.md) - [Ticker](docs/Ticker.md) + - [Ticker2](docs/Ticker2.md) - [TotalBalance](docs/TotalBalance.md) - [Trade](docs/Trade.md) - [TradeFee](docs/TradeFee.md) diff --git a/build.gradle b/build.gradle index ea5ee91..9648d93 100644 --- a/build.gradle +++ b/build.gradle @@ -3,7 +3,7 @@ apply plugin: 'eclipse' apply plugin: 'java' group = 'io.gate' -version = '6.99.0' +version = '6.100.0' buildscript { repositories { diff --git a/build.sbt b/build.sbt index d02e701..d37ad1a 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.99.0", + version := "6.100.0", scalaVersion := "2.11.4", scalacOptions ++= Seq("-feature"), javacOptions in compile ++= Seq("-Xlint:deprecation"), diff --git a/docs/AccountBookResponse.md b/docs/AccountBookResponse.md new file mode 100644 index 0000000..abe96d0 --- /dev/null +++ b/docs/AccountBookResponse.md @@ -0,0 +1,15 @@ + +# AccountBookResponse + +Quotation Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Long** | Order ID | [optional] +**time** | **Long** | 操作时间戳 | [optional] +**currency** | **String** | Currency name | [optional] +**change** | **String** | Change amount | [optional] +**balance** | **String** | 变更后余额 | [optional] + diff --git a/docs/AccountsResponse.md b/docs/AccountsResponse.md new file mode 100644 index 0000000..47a37cd --- /dev/null +++ b/docs/AccountsResponse.md @@ -0,0 +1,15 @@ + +# AccountsResponse + +Quotation Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**currency** | **String** | Currency name | [optional] +**available** | **String** | Available Balance | [optional] +**locked** | **String** | 锁定余额 | [optional] +**tokenAddress** | **String** | token 地址 | [optional] +**chain** | **String** | 区块链名称 | [optional] + diff --git a/docs/AlphaApi.md b/docs/AlphaApi.md new file mode 100644 index 0000000..8825b1c --- /dev/null +++ b/docs/AlphaApi.md @@ -0,0 +1,601 @@ +# AlphaApi + +All URIs are relative to *https://api.gateio.ws/api/v4* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**listAlphaAccounts**](AlphaApi.md#listAlphaAccounts) | **GET** /alpha/accounts | API for Alpha Accounts +[**listAlphaAccountBook**](AlphaApi.md#listAlphaAccountBook) | **GET** /alpha/account_book | Alpha Asset Transaction API +[**quoteAlphaOrder**](AlphaApi.md#quoteAlphaOrder) | **POST** /alpha/quote | Alpha Quotation API +[**listAlphaOrder**](AlphaApi.md#listAlphaOrder) | **GET** /alpha/orders | Alpha 查询订单列表接口 +[**placeAlphaOrder**](AlphaApi.md#placeAlphaOrder) | **POST** /alpha/orders | Alpha Order Placement API +[**getAlphaOrder**](AlphaApi.md#getAlphaOrder) | **GET** /alpha/order | Alpha 查询单个订单接口 +[**listAlphaCurrencies**](AlphaApi.md#listAlphaCurrencies) | **GET** /alpha/currencies | 查询币种信息 +[**listAlphaTickers**](AlphaApi.md#listAlphaTickers) | **GET** /alpha/tickers | 查询币种ticker + + + +# **listAlphaAccounts** +> List<AccountsResponse> listAlphaAccounts() + +API for Alpha Accounts + +Query Position Assets + +### 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.AlphaApi; + +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"); + + AlphaApi apiInstance = new AlphaApi(defaultClient); + try { + List result = apiInstance.listAlphaAccounts(); + 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 AlphaApi#listAlphaAccounts"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List<AccountsResponse>**](AccountsResponse.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** | 查询持仓成功 | - | + + +# **listAlphaAccountBook** +> List<AccountBookResponse> listAlphaAccountBook(from).to(to).page(page).limit(limit).execute(); + +Alpha Asset Transaction API + +Query Asset Transactions + +### 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.AlphaApi; + +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"); + + AlphaApi apiInstance = new AlphaApi(defaultClient); + Long from = 56L; // Long | Start timestamp of the query + Long to = 56L; // Long | Time range ending, default to current time + Integer page = 56; // Integer | Page number + Integer limit = 56; // Integer | The maximum number of items per page is 100 + try { + List result = apiInstance.listAlphaAccountBook(from) + .to(to) + .page(page) + .limit(limit) + .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 AlphaApi#listAlphaAccountBook"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **from** | **Long**| Start timestamp of the query | + **to** | **Long**| Time range ending, default to current time | [optional] + **page** | **Integer**| Page number | [optional] + **limit** | **Integer**| The maximum number of items per page is 100 | [optional] + +### Return type + +[**List<AccountBookResponse>**](AccountBookResponse.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** | 查询流水成功 | - | + + +# **quoteAlphaOrder** +> QuoteResponse quoteAlphaOrder(quoteRequest) + +Alpha Quotation API + +The quote_id returned by the quotation API is valid for one minute.You must place the order within this time window;otherwise, the quote will expire and a new quotation request is required + +### 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.AlphaApi; + +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"); + + AlphaApi apiInstance = new AlphaApi(defaultClient); + QuoteRequest quoteRequest = new QuoteRequest(); // QuoteRequest | + try { + QuoteResponse result = apiInstance.quoteAlphaOrder(quoteRequest); + 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 AlphaApi#quoteAlphaOrder"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **quoteRequest** | [**QuoteRequest**](QuoteRequest.md)| | + +### Return type + +[**QuoteResponse**](QuoteResponse.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** | 询价成功 | - | + + +# **listAlphaOrder** +> List<OrderResponse> listAlphaOrder(currency, side, status).from(from).to(to).limit(limit).page(page).execute(); + +Alpha 查询订单列表接口 + +### 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.AlphaApi; + +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"); + + AlphaApi apiInstance = new AlphaApi(defaultClient); + String currency = "memeboxsst"; // String | Trading Symbol + String side = "buy"; // String | 买单或者卖单 - buy - sell + Integer status = 2; // Integer | Order Status - `0` : All - `1` : Processing - `2` : Successful - `3` : Failed - `4` : Canceled - `5` : Buy order placed but transfer not completed - `6` : Cancelled order with transfer not complete + Long from = 1627706330L; // Long | 查询订单的起始时间 + Long to = 1635329650L; // Long | 查询订单的结束时间，不指定则默认为当前时间 + Integer limit = 100; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 100 + Integer page = 1; // Integer | Page number + try { + List result = apiInstance.listAlphaOrder(currency, side, status) + .from(from) + .to(to) + .limit(limit) + .page(page) + .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 AlphaApi#listAlphaOrder"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **currency** | **String**| Trading Symbol | + **side** | **String**| 买单或者卖单 - buy - sell | + **status** | **Integer**| Order Status - `0` : All - `1` : Processing - `2` : Successful - `3` : Failed - `4` : Canceled - `5` : Buy order placed but transfer not completed - `6` : Cancelled order with transfer not complete | + **from** | **Long**| 查询订单的起始时间 | [optional] + **to** | **Long**| 查询订单的结束时间，不指定则默认为当前时间 | [optional] + **limit** | **Integer**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100] + **page** | **Integer**| Page number | [optional] [default to 1] + +### Return type + +[**List<OrderResponse>**](OrderResponse.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 | - | + + +# **placeAlphaOrder** +> PlaceOrderResponse placeAlphaOrder(placeOrderRequest) + +Alpha Order Placement API + +### 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.AlphaApi; + +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"); + + AlphaApi apiInstance = new AlphaApi(defaultClient); + PlaceOrderRequest placeOrderRequest = new PlaceOrderRequest(); // PlaceOrderRequest | + try { + PlaceOrderResponse result = apiInstance.placeAlphaOrder(placeOrderRequest); + 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 AlphaApi#placeAlphaOrder"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **placeOrderRequest** | [**PlaceOrderRequest**](PlaceOrderRequest.md)| | + +### Return type + +[**PlaceOrderResponse**](PlaceOrderResponse.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** | Success | - | + + +# **getAlphaOrder** +> OrderResponse getAlphaOrder(orderId) + +Alpha 查询单个订单接口 + +### 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.AlphaApi; + +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"); + + AlphaApi apiInstance = new AlphaApi(defaultClient); + String orderId = "fdaf12321"; // String | Order ID + try { + OrderResponse result = apiInstance.getAlphaOrder(orderId); + 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 AlphaApi#getAlphaOrder"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **orderId** | **String**| Order ID | + +### Return type + +[**OrderResponse**](OrderResponse.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** | 订单查询成功 | - | + + +# **listAlphaCurrencies** +> List<Currency2> listAlphaCurrencies().currency(currency).limit(limit).page(page).execute(); + +查询币种信息 + +When the currency parameter is provided, query and return information for the specified currency. When the currency parameter is not provided, return a paginated list of currencies. + +### 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.AlphaApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.gateio.ws/api/v4"); + + AlphaApi apiInstance = new AlphaApi(defaultClient); + String currency = "memeboxtrump"; // String | 根据币种符号查询币种信息 + Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer page = 1; // Integer | Page number + try { + List result = apiInstance.listAlphaCurrencies() + .currency(currency) + .limit(limit) + .page(page) + .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 AlphaApi#listAlphaCurrencies"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **currency** | **String**| 根据币种符号查询币种信息 | [optional] + **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **page** | **Integer**| Page number | [optional] [default to 1] + +### Return type + +[**List<Currency2>**](Currency2.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 | - | + + +# **listAlphaTickers** +> List<Ticker2> listAlphaTickers().currency(currency).limit(limit).page(page).execute(); + +查询币种ticker + +When the currency parameter is provided, query and return information for the specified ticker, When the currency parameter is not provided, return a paginated list of tickers. + +### 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.AlphaApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("https://api.gateio.ws/api/v4"); + + AlphaApi apiInstance = new AlphaApi(defaultClient); + String currency = "memeboxtrump"; // String | Retrieve data of the specified currency + Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + Integer page = 1; // Integer | Page number + try { + List result = apiInstance.listAlphaTickers() + .currency(currency) + .limit(limit) + .page(page) + .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 AlphaApi#listAlphaTickers"); + 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] + **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **page** | **Integer**| Page number | [optional] [default to 1] + +### Return type + +[**List<Ticker2>**](Ticker2.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 | - | + diff --git a/docs/BrokerCommission1.md b/docs/BrokerCommission1.md index 14a13a9..bba07b4 100644 --- a/docs/BrokerCommission1.md +++ b/docs/BrokerCommission1.md @@ -14,4 +14,5 @@ Name | Type | Description | Notes **rebateFee** | **String** | The income from rebates, converted to USDT | [optional] **source** | **String** | Rebate Type: Spot、Futures、Options | [optional] **currencyPair** | **String** | Currency pair | [optional] +**subBrokerInfo** | [**BrokerCommissionSubBrokerInfo**](BrokerCommissionSubBrokerInfo.md) | | [optional] diff --git a/docs/BrokerCommissionSubBrokerInfo.md b/docs/BrokerCommissionSubBrokerInfo.md new file mode 100644 index 0000000..a61d20b --- /dev/null +++ b/docs/BrokerCommissionSubBrokerInfo.md @@ -0,0 +1,14 @@ + +# BrokerCommissionSubBrokerInfo + +The sub broker info + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**userId** | **Long** | The sub broker user ID | [optional] +**originalCommissionRate** | **String** | The sub broker original commission rate | [optional] +**relativeCommissionRate** | **String** | The sub broker relative commission rate | [optional] +**commissionRate** | **String** | The sub broker actual commission rate | [optional] + diff --git a/docs/BrokerTransaction1.md b/docs/BrokerTransaction1.md index 9469854..da7b51c 100644 --- a/docs/BrokerTransaction1.md +++ b/docs/BrokerTransaction1.md @@ -13,4 +13,5 @@ Name | Type | Description | Notes **amount** | **String** | Commission Amount | [optional] **feeAsset** | **String** | Fee currency | [optional] **source** | **String** | Rebate Type: Spot、Futures、Options | [optional] +**subBrokerInfo** | [**BrokerCommissionSubBrokerInfo**](BrokerCommissionSubBrokerInfo.md) | | [optional] diff --git a/docs/Contract.md b/docs/Contract.md index c691186..bc3e83e 100644 --- a/docs/Contract.md +++ b/docs/Contract.md @@ -43,6 +43,8 @@ Name | Type | Description | Notes **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, trading, delisting, delisted | [optional] +**launchTime** | **Long** | 合约开盘时间 | [optional] ## Enum: TypeEnum diff --git a/docs/Currency2.md b/docs/Currency2.md new file mode 100644 index 0000000..c74c23c --- /dev/null +++ b/docs/Currency2.md @@ -0,0 +1,15 @@ + +# Currency2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**currency** | **String** | Currency symbol | [optional] +**name** | **String** | Currency name | [optional] +**chain** | **String** | The main chain corresponding to the coin | [optional] +**address** | **String** | Contract Address | [optional] +**amountPrecision** | **Integer** | Amount scale | [optional] +**precision** | **Integer** | Price scale | [optional] +**status** | **Integer** | 币种交易状态 - `1` : 正常交易 - `2` : 暂停交易 - `3` : 下架 | [optional] + diff --git a/docs/EarnApi.md b/docs/EarnApi.md index 2de1448..dd785f1 100644 --- a/docs/EarnApi.md +++ b/docs/EarnApi.md @@ -12,6 +12,8 @@ Method | HTTP request | Description [**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 | 链上赚币币种 +[**swapStakingCoin**](EarnApi.md#swapStakingCoin) | **POST** /earn/staking/swap | On-chain Token Swap for Earned Coins @@ -579,3 +581,138 @@ null (empty response body) |-------------|-------------|------------------| **200** | Success | - | + +# **findCoin** +> List<String> findCoin(findCoin) + +链上赚币币种 + +### 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 { + List 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 + +**List<String>** + +### Authorization + +[apiv4](../README.md#apiv4) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Successful | - | + + +# **swapStakingCoin** +> 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 { + apiInstance.swapStakingCoin(swapCoin); + } 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 + +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 | +|-------------|-------------|------------------| +**200** | swap success | - | + diff --git a/docs/EarnUniApi.md b/docs/EarnUniApi.md index 4d19c85..7dbe6a5 100644 --- a/docs/EarnUniApi.md +++ b/docs/EarnUniApi.md @@ -664,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-17 09:53+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-01 13:02+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 ### Example @@ -730,7 +730,7 @@ 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-17 09:53+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-01 13:02+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 | - | # **listUniRate** @@ -738,7 +738,7 @@ Name | Type | Description | Notes Currency estimate annualized interest rate -Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-06-17 09:53+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-01 13:02+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 ### Example @@ -796,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-17 09:53+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-01 13:02+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 | - | diff --git a/docs/FindCoin.md b/docs/FindCoin.md new file mode 100644 index 0000000..34f4993 --- /dev/null +++ b/docs/FindCoin.md @@ -0,0 +1,10 @@ + +# FindCoin + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**coin** | **String** | Currency | [optional] +**cointype** | **String** | Coin Type swap-Voucher lock-Locked | [optional] + diff --git a/docs/FuturesApi.md b/docs/FuturesApi.md index 2531d72..21f7052 100644 --- a/docs/FuturesApi.md +++ b/docs/FuturesApi.md @@ -1476,7 +1476,7 @@ Name | Type | Description | Notes # **updatePositionCrossMode** -> Position updatePositionCrossMode(settle, inlineObject) +> Position updatePositionCrossMode(settle, futuresPositionCrossMode) Switch to the full position-by-store mode @@ -1502,9 +1502,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 +1524,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 diff --git a/docs/InlineObject.md b/docs/FuturesPositionCrossMode.md similarity index 90% rename from docs/InlineObject.md rename to docs/FuturesPositionCrossMode.md index 1779c28..e4be434 100644 --- a/docs/InlineObject.md +++ b/docs/FuturesPositionCrossMode.md @@ -1,5 +1,5 @@ -# InlineObject +# FuturesPositionCrossMode ## Properties diff --git a/docs/MarginApi.md b/docs/MarginApi.md index dede4b8..68ae168 100644 --- a/docs/MarginApi.md +++ b/docs/MarginApi.md @@ -5,15 +5,15 @@ 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 -[**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 [**listMarginAccountBook**](MarginApi.md#listMarginAccountBook) | **GET** /margin/account_book | List 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 +[**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 [**listCrossMarginLoans**](MarginApi.md#listCrossMarginLoans) | **GET** /margin/cross/loans | List cross margin borrow history. (deprecated) [**listCrossMarginRepayments**](MarginApi.md#listCrossMarginRepayments) | **GET** /margin/cross/repayments | Retrieve cross margin repayments. (deprecated) @@ -88,11 +88,13 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | List retrieved | - | - -# **getUserMarginTier** -> List<MarginLeverageTier> getUserMarginTier(currencyPair) + +# **listMarginAccountBook** +> List<MarginAccountBook> listMarginAccountBook().currency(currency).currencyPair(currencyPair).type(type).from(from).to(to).page(page).limit(limit).execute(); -Check the user's own leverage lending gradient in the current market +List margin account balance change history + +Only transferals from and to margin account are provided for now. Time range allows 30 days at most ### Example @@ -115,15 +117,29 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginApi apiInstance = new MarginApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Currency pair + 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 + Integer page = 1; // Integer | Page number + Integer limit = 100; // Integer | Maximum number of records to be returned in a single list try { - List result = apiInstance.getUserMarginTier(currencyPair); + List result = apiInstance.listMarginAccountBook() + .currency(currency) + .currencyPair(currencyPair) + .type(type) + .from(from) + .to(to) + .page(page) + .limit(limit) + .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#getUserMarginTier"); + System.err.println("Exception when calling MarginApi#listMarginAccountBook"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -136,11 +152,17 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair | + **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] + **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] ### Return type -[**List<MarginLeverageTier>**](MarginLeverageTier.md) +[**List<MarginAccountBook>**](MarginAccountBook.md) ### Authorization @@ -154,13 +176,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | List retrieved | - | - -# **getMarketMarginTier** -> List<MarginLeverageTier> getMarketMarginTier(currencyPair) + +# **listFundingAccounts** +> List<FundingAccount> listFundingAccounts().currency(currency).execute(); -Query the current market leverage lending gradient +Funding account list ### Example @@ -170,6 +192,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; @@ -177,17 +200,22 @@ 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 + String currency = "BTC"; // String | Retrieve data of the specified currency try { - List result = apiInstance.getMarketMarginTier(currencyPair); + List result = apiInstance.listFundingAccounts() + .currency(currency) + .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#getMarketMarginTier"); + System.err.println("Exception when calling MarginApi#listFundingAccounts"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -200,15 +228,15 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair | + **currency** | **String**| Retrieve data of the specified currency | [optional] ### Return type -[**List<MarginLeverageTier>**](MarginLeverageTier.md) +[**List<FundingAccount>**](FundingAccount.md) ### Authorization -No authorization required +[apiv4](../README.md#apiv4) ### HTTP request headers @@ -218,13 +246,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | List retrieved | - | - -# **setUserMarketLeverage** -> setUserMarketLeverage(marginMarketLeverage) + +# **getAutoRepayStatus** +> AutoRepaySetting getAutoRepayStatus() -Set the user market leverage multiple +Retrieve user auto repayment setting ### Example @@ -247,14 +275,14 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginApi apiInstance = new MarginApi(defaultClient); - MarginMarketLeverage marginMarketLeverage = new MarginMarketLeverage(); // MarginMarketLeverage | try { - apiInstance.setUserMarketLeverage(marginMarketLeverage); + AutoRepaySetting result = apiInstance.getAutoRepayStatus(); + 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#setUserMarketLeverage"); + System.err.println("Exception when calling MarginApi#getAutoRepayStatus"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -264,14 +292,11 @@ public class Example { ``` ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **marginMarketLeverage** | [**MarginMarketLeverage**](MarginMarketLeverage.md)| | +This endpoint does not need any parameter. ### Return type -null (empty response body) +[**AutoRepaySetting**](AutoRepaySetting.md) ### Authorization @@ -279,21 +304,19 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined + - **Content-Type**: Not defined + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Success | - | - - -# **listMarginUserAccount** -> List<MarginAccount> listMarginUserAccount().currencyPair(currencyPair).execute(); +**200** | Current auto repayment setting | - | -Query the user's leverage account list + +# **setAutoRepay** +> AutoRepaySetting setAutoRepay(status) -Support querying risk rate per position account and margin rate per position account +Update user's auto repayment setting ### Example @@ -316,17 +339,15 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginApi apiInstance = new MarginApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Currency pair + String status = "on"; // String | New auto repayment status. `on` - enabled, `off` - disabled try { - List result = apiInstance.listMarginUserAccount() - .currencyPair(currencyPair) - .execute(); + AutoRepaySetting result = apiInstance.setAutoRepay(status); 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("Exception when calling MarginApi#setAutoRepay"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -339,11 +360,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair | [optional] + **status** | **String**| New auto repayment status. `on` - enabled, `off` - disabled | ### Return type -[**List<MarginAccount>**](MarginAccount.md) +[**AutoRepaySetting**](AutoRepaySetting.md) ### Authorization @@ -357,15 +378,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | - - -# **listMarginAccountBook** -> List<MarginAccountBook> listMarginAccountBook().currency(currency).currencyPair(currencyPair).type(type).from(from).to(to).page(page).limit(limit).execute(); +**200** | Current auto repayment setting | - | -List margin account balance change history + +# **getMarginTransferable** +> MarginTransferable getMarginTransferable(currency).currencyPair(currencyPair).execute(); -Only transferals from and to margin account are provided for now. Time range allows 30 days at most +Get the max transferable amount for a specific margin currency ### Example @@ -388,29 +407,18 @@ 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 - Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + String currency = "BTC"; // String | Retrieve data of the specified currency + String currencyPair = "BTC_USDT"; // String | Currency pair try { - List result = apiInstance.listMarginAccountBook() - .currency(currency) + MarginTransferable result = apiInstance.getMarginTransferable(currency) .currencyPair(currencyPair) - .type(type) - .from(from) - .to(to) - .page(page) - .limit(limit) .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#listMarginAccountBook"); + System.err.println("Exception when calling MarginApi#getMarginTransferable"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -423,17 +431,12 @@ 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] - **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] + **currency** | **String**| Retrieve data of the specified currency | + **currencyPair** | **String**| Currency pair | [optional] ### Return type -[**List<MarginAccountBook>**](MarginAccountBook.md) +[**MarginTransferable**](MarginTransferable.md) ### Authorization @@ -447,13 +450,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | Successfully retrieved | - | - -# **listFundingAccounts** -> List<FundingAccount> listFundingAccounts().currency(currency).execute(); + +# **getUserMarginTier** +> List<MarginLeverageTier> getUserMarginTier(currencyPair) -Funding account list +Check the user's own leverage lending gradient in the current market ### Example @@ -476,17 +479,15 @@ 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 currencyPair = "BTC_USDT"; // String | Currency pair try { - List result = apiInstance.listFundingAccounts() - .currency(currency) - .execute(); + 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#listFundingAccounts"); + System.err.println("Exception when calling MarginApi#getUserMarginTier"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -499,11 +500,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | [optional] + **currencyPair** | **String**| Currency pair | ### Return type -[**List<FundingAccount>**](FundingAccount.md) +[**List<MarginLeverageTier>**](MarginLeverageTier.md) ### Authorization @@ -517,13 +518,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | Successfully retrieved | - | - -# **getAutoRepayStatus** -> AutoRepaySetting getAutoRepayStatus() + +# **getMarketMarginTier** +> List<MarginLeverageTier> getMarketMarginTier(currencyPair) -Retrieve user auto repayment setting +Query the current market leverage lending gradient ### Example @@ -533,7 +534,6 @@ 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; @@ -541,19 +541,17 @@ 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 { - AutoRepaySetting result = apiInstance.getAutoRepayStatus(); + 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#getAutoRepayStatus"); + System.err.println("Exception when calling MarginApi#getMarketMarginTier"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -563,15 +561,18 @@ public class Example { ``` ### Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **currencyPair** | **String**| Currency pair | ### Return type -[**AutoRepaySetting**](AutoRepaySetting.md) +[**List<MarginLeverageTier>**](MarginLeverageTier.md) ### Authorization -[apiv4](../README.md#apiv4) +No authorization required ### HTTP request headers @@ -581,13 +582,13 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Current auto repayment setting | - | +**200** | Successfully retrieved | - | - -# **setAutoRepay** -> AutoRepaySetting setAutoRepay(status) + +# **setUserMarketLeverage** +> setUserMarketLeverage(marginMarketLeverage) -Update user's auto repayment setting +Set the user market leverage multiple ### Example @@ -610,15 +611,14 @@ 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 + MarginMarketLeverage marginMarketLeverage = new MarginMarketLeverage(); // MarginMarketLeverage | try { - AutoRepaySetting result = apiInstance.setAutoRepay(status); - 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#setAutoRepay"); + 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 +631,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **status** | **String**| New auto repayment status. `on` - enabled, `off` - disabled | + **marginMarketLeverage** | [**MarginMarketLeverage**](MarginMarketLeverage.md)| | ### Return type -[**AutoRepaySetting**](AutoRepaySetting.md) +null (empty response body) ### Authorization @@ -643,19 +643,21 @@ Name | Type | Description | Notes ### 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** | Current auto repayment setting | - | +**204** | Success | - | - -# **getMarginTransferable** -> MarginTransferable getMarginTransferable(currency).currencyPair(currencyPair).execute(); + +# **listMarginUserAccount** +> List<MarginAccount> listMarginUserAccount().currencyPair(currencyPair).execute(); -Get the max transferable amount for a specific margin currency +Query the user's leverage account list + +Support querying risk rate per position account and margin rate per position account ### Example @@ -678,10 +680,9 @@ 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 currencyPair = "BTC_USDT"; // String | Currency pair try { - MarginTransferable result = apiInstance.getMarginTransferable(currency) + List result = apiInstance.listMarginUserAccount() .currencyPair(currencyPair) .execute(); System.out.println(result); @@ -689,7 +690,7 @@ public class Example { 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#getMarginTransferable"); + System.err.println("Exception when calling MarginApi#listMarginUserAccount"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -702,12 +703,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | **currencyPair** | **String**| Currency pair | [optional] ### Return type -[**MarginTransferable**](MarginTransferable.md) +[**List<MarginAccount>**](MarginAccount.md) ### Authorization @@ -721,7 +721,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | List retrieved | - | # **listCrossMarginLoans** diff --git a/docs/MarginUniApi.md b/docs/MarginUniApi.md index 8aab8f4..2594a68 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 -[**listUniLoans**](MarginUniApi.md#listUniLoans) | **GET** /margin/uni/loans | List loans -[**createUniLoan**](MarginUniApi.md#createUniLoan) | **POST** /margin/uni/loans | Borrow or repay -[**getUniBorrowable**](MarginUniApi.md#getUniBorrowable) | **GET** /margin/uni/borrowable | Get maximum borrowable [**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 +[**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 @@ -74,11 +74,11 @@ No authorization required |-------------|-------------|------------------| **200** | Successfully retrieved | - | - -# **listUniLoans** -> List<UniLoan> listUniLoans().currencyPair(currencyPair).currency(currency).page(page).limit(limit).execute(); + +# **getUniCurrencyPair** +> UniCurrencyPair getUniCurrencyPair(currencyPair) -List loans +Get detail of lending market ### Example @@ -88,7 +88,6 @@ 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.MarginUniApi; @@ -96,28 +95,17 @@ 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"); MarginUniApi apiInstance = new MarginUniApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Currency pair - 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 + String currencyPair = "AE_USDT"; // String | Currency pair try { - List result = apiInstance.listUniLoans() - .currencyPair(currencyPair) - .currency(currency) - .page(page) - .limit(limit) - .execute(); + UniCurrencyPair result = apiInstance.getUniCurrencyPair(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 MarginUniApi#listUniLoans"); + System.err.println("Exception when calling MarginUniApi#getUniCurrencyPair"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -130,18 +118,15 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair | [optional] - **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] + **currencyPair** | **String**| Currency pair | ### Return type -[**List<UniLoan>**](UniLoan.md) +[**UniCurrencyPair**](UniCurrencyPair.md) ### Authorization -[apiv4](../README.md#apiv4) +No authorization required ### HTTP request headers @@ -153,11 +138,13 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | Successfully retrieved | - | - -# **createUniLoan** -> createUniLoan(createUniLoan) + +# **getMarginUniEstimateRate** +> Map<String, String> getMarginUniEstimateRate(currencies) -Borrow or repay +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. ### Example @@ -180,14 +167,15 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginUniApi apiInstance = new MarginUniApi(defaultClient); - CreateUniLoan createUniLoan = new CreateUniLoan(); // CreateUniLoan | + List currencies = Arrays.asList(); // List | An array of up to 10 specifying the currency name try { - apiInstance.createUniLoan(createUniLoan); + Map result = apiInstance.getMarginUniEstimateRate(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 MarginUniApi#createUniLoan"); + System.err.println("Exception when calling MarginUniApi#getMarginUniEstimateRate"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -200,11 +188,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **createUniLoan** | [**CreateUniLoan**](CreateUniLoan.md)| | + **currencies** | [**List<String>**](String.md)| An array of up to 10 specifying the currency name | ### Return type -null (empty response body) +**Map<String, String>** ### Authorization @@ -212,19 +200,19 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined + - **Content-Type**: Not defined + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Operated successfully | - | +**200** | Successfully retrieved | - | - -# **getUniBorrowable** -> MaxUniBorrowable getUniBorrowable(currency, currencyPair) + +# **listUniLoans** +> List<UniLoan> listUniLoans().currencyPair(currencyPair).currency(currency).page(page).limit(limit).execute(); -Get maximum borrowable +List loans ### Example @@ -247,16 +235,23 @@ 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 currencyPair = "BTC_USDT"; // String | Currency pair + 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 try { - MaxUniBorrowable result = apiInstance.getUniBorrowable(currency, currencyPair); + List result = apiInstance.listUniLoans() + .currencyPair(currencyPair) + .currency(currency) + .page(page) + .limit(limit) + .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 MarginUniApi#getUniBorrowable"); + System.err.println("Exception when calling MarginUniApi#listUniLoans"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -269,12 +264,14 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | - **currencyPair** | **String**| Currency pair | + **currencyPair** | **String**| Currency pair | [optional] + **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] ### Return type -[**MaxUniBorrowable**](MaxUniBorrowable.md) +[**List<UniLoan>**](UniLoan.md) ### Authorization @@ -290,11 +287,11 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | Successfully retrieved | - | - -# **getUniCurrencyPair** -> UniCurrencyPair getUniCurrencyPair(currencyPair) + +# **createUniLoan** +> createUniLoan(createUniLoan) -Get detail of lending market +Borrow or repay ### Example @@ -304,6 +301,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.MarginUniApi; @@ -311,17 +309,19 @@ 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"); MarginUniApi apiInstance = new MarginUniApi(defaultClient); - String currencyPair = "AE_USDT"; // String | Currency pair + CreateUniLoan createUniLoan = new CreateUniLoan(); // CreateUniLoan | try { - UniCurrencyPair result = apiInstance.getUniCurrencyPair(currencyPair); - System.out.println(result); + apiInstance.createUniLoan(createUniLoan); } 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 MarginUniApi#getUniCurrencyPair"); + System.err.println("Exception when calling MarginUniApi#createUniLoan"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -334,33 +334,31 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair | + **createUniLoan** | [**CreateUniLoan**](CreateUniLoan.md)| | ### Return type -[**UniCurrencyPair**](UniCurrencyPair.md) +null (empty response body) ### Authorization -No authorization required +[apiv4](../README.md#apiv4) ### 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 | - | - - -# **getMarginUniEstimateRate** -> Map<String, String> getMarginUniEstimateRate(currencies) +**204** | Operated successfully | - | -Estimate interest Rate + +# **listUniLoanRecords** +> List<UniLoanRecord> listUniLoanRecords().type(type).currency(currency).currencyPair(currencyPair).page(page).limit(limit).execute(); -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. +Get load records ### Example @@ -383,15 +381,25 @@ 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 + String type = "type_example"; // String | type: borrow - borrow, repay - repay + String currency = "BTC"; // String | Retrieve data of the specified currency + 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 try { - Map result = apiInstance.getMarginUniEstimateRate(currencies); + List result = apiInstance.listUniLoanRecords() + .type(type) + .currency(currency) + .currencyPair(currencyPair) + .page(page) + .limit(limit) + .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 MarginUniApi#getMarginUniEstimateRate"); + System.err.println("Exception when calling MarginUniApi#listUniLoanRecords"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -404,11 +412,15 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencies** | [**List<String>**](String.md)| An array of up to 10 specifying the currency name | + **type** | **String**| type: borrow - borrow, repay - repay | [optional] [enum: borrow, repay] + **currency** | **String**| Retrieve data of the specified currency | [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] ### Return type -**Map<String, String>** +[**List<UniLoanRecord>**](UniLoanRecord.md) ### Authorization @@ -424,11 +436,11 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | Successfully retrieved | - | - -# **listUniLoanRecords** -> List<UniLoanRecord> listUniLoanRecords().type(type).currency(currency).currencyPair(currencyPair).page(page).limit(limit).execute(); + +# **listUniLoanInterestRecords** +> List<UniLoanInterestRecord> listUniLoanInterestRecords().currencyPair(currencyPair).currency(currency).page(page).limit(limit).from(from).to(to).execute(); -Get load records +List interest records ### Example @@ -451,25 +463,27 @@ 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 currencyPair = "BTC_USDT"; // String | Currency pair + 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 + 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 try { - List result = apiInstance.listUniLoanRecords() - .type(type) - .currency(currency) + List result = apiInstance.listUniLoanInterestRecords() .currencyPair(currencyPair) + .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 MarginUniApi#listUniLoanRecords"); + System.err.println("Exception when calling MarginUniApi#listUniLoanInterestRecords"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -482,15 +496,16 @@ 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] **currencyPair** | **String**| Currency pair | [optional] + **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] + **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] ### Return type -[**List<UniLoanRecord>**](UniLoanRecord.md) +[**List<UniLoanInterestRecord>**](UniLoanInterestRecord.md) ### Authorization @@ -506,11 +521,11 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | Successfully retrieved | - | - -# **listUniLoanInterestRecords** -> List<UniLoanInterestRecord> listUniLoanInterestRecords().currencyPair(currencyPair).currency(currency).page(page).limit(limit).from(from).to(to).execute(); + +# **getUniBorrowable** +> MaxUniBorrowable getUniBorrowable(currency, currencyPair) -List interest records +Get maximum borrowable ### Example @@ -533,27 +548,16 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginUniApi apiInstance = new MarginUniApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Currency pair String currency = "BTC"; // String | Retrieve data of the specified currency - 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 + String currencyPair = "BTC_USDT"; // String | Currency pair try { - List result = apiInstance.listUniLoanInterestRecords() - .currencyPair(currencyPair) - .currency(currency) - .page(page) - .limit(limit) - .from(from) - .to(to) - .execute(); + MaxUniBorrowable result = apiInstance.getUniBorrowable(currency, 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 MarginUniApi#listUniLoanInterestRecords"); + System.err.println("Exception when calling MarginUniApi#getUniBorrowable"); System.err.println("Status code: " + e.getCode()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); @@ -566,16 +570,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair | [optional] - **currency** | **String**| Retrieve data of the specified 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 | [optional] - **to** | **Long**| End timestamp | [optional] + **currency** | **String**| Retrieve data of the specified currency | + **currencyPair** | **String**| Currency pair | ### Return type -[**List<UniLoanInterestRecord>**](UniLoanInterestRecord.md) +[**MaxUniBorrowable**](MaxUniBorrowable.md) ### Authorization diff --git a/docs/OrderResponse.md b/docs/OrderResponse.md new file mode 100644 index 0000000..e8ac550 --- /dev/null +++ b/docs/OrderResponse.md @@ -0,0 +1,23 @@ + +# OrderResponse + +下单返回 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**orderId** | **String** | Order ID | [optional] +**txHash** | **String** | Transaction Hash | [optional] +**side** | **String** | 买单或者卖单 - buy - sell | [optional] +**usdtAmount** | **String** | Amount | [optional] +**currency** | **String** | 币 | [optional] +**currencyAmount** | **String** | Currency amount | [optional] +**status** | **Integer** | Order Status - `0` : All - `1` : Processing - `2` : Successful - `3` : Failed - `4` : Canceled - `5` : Buy order placed but transfer not completed - `6` : Cancelled order with transfer not complete | [optional] +**gasMode** | **String** | Trading mode affects slippage selection - `speed` : Smart mode - `custom` : Custom mode, uses `slippage` parameter | [optional] +**chain** | **String** | 链 | [optional] +**gasFee** | **String** | Miner Fee (USDT-based) | [optional] +**transactionFee** | **String** | Trading Fee (USDT-based) | [optional] +**failedReason** | **String** | Failure reason (if any) | [optional] +**createTime** | **Long** | 创建时间（时间戳） | [optional] + diff --git a/docs/PlaceOrderRequest.md b/docs/PlaceOrderRequest.md new file mode 100644 index 0000000..6ddc70d --- /dev/null +++ b/docs/PlaceOrderRequest.md @@ -0,0 +1,16 @@ + +# PlaceOrderRequest + +下单请求 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**currency** | **String** | Trading Symbol | +**side** | **String** | 买单或者卖单 - buy - sell | +**amount** | **String** | Trade Quantity - `side` : `buy` refers to the quote currency, i.e., `USDT` - `side` : `sell` refers to the base currency | +**gasMode** | **String** | Trading mode affects slippage selection - `speed` : Smart mode - `custom` : Custom mode, uses `slippage` parameter | +**slippage** | **String** | Slippage value of 10 represents a 10% tolerance | [optional] +**quoteId** | **String** | The quote_id returned by the quotation API | + diff --git a/docs/PlaceOrderResponse.md b/docs/PlaceOrderResponse.md new file mode 100644 index 0000000..a9c07b5 --- /dev/null +++ b/docs/PlaceOrderResponse.md @@ -0,0 +1,18 @@ + +# PlaceOrderResponse + +下单返回 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**orderId** | **String** | Order ID | [optional] +**status** | **Integer** | Order Status - `0` : All - `1` : Processing - `2` : Successful - `3` : Failed - `4` : Canceled - `5` : Buy order placed but transfer not completed - `6` : Cancelled order with transfer not complete | [optional] +**side** | **String** | 买单或者卖单 - buy - sell | [optional] +**gasMode** | **String** | Trading mode affects slippage selection - `speed` : Smart mode - `custom` : Custom mode, uses `slippage` parameter | [optional] +**createTime** | **Long** | 创建时间 (时间戳) | [optional] +**amount** | **String** | Trade Quantity - `side` : `buy` refers to the quote currency, i.e., `USDT` - `side` : `sell` refers to the base currency | [optional] +**tokenAddress** | **String** | 币地址 | [optional] +**chain** | **String** | Chain name | [optional] + diff --git a/docs/QuoteRequest.md b/docs/QuoteRequest.md new file mode 100644 index 0000000..2d19ac0 --- /dev/null +++ b/docs/QuoteRequest.md @@ -0,0 +1,15 @@ + +# QuoteRequest + +Quotation Request + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**currency** | **String** | Trading Symbol | +**side** | **String** | 买单或者卖单 - buy - sell | +**amount** | **String** | Trade Quantity - `side` : `buy` refers to the quote currency, i.e., `USDT` - `side` : `sell` refers to the base currency | +**gasMode** | **String** | Trading mode affects slippage selection - `speed` : Smart mode - `custom` : Custom mode, uses `slippage` parameter | +**slippage** | **String** | Slippage value of 10 represents a 10% tolerance | [optional] + diff --git a/docs/QuoteResponse.md b/docs/QuoteResponse.md new file mode 100644 index 0000000..3c28182 --- /dev/null +++ b/docs/QuoteResponse.md @@ -0,0 +1,20 @@ + +# QuoteResponse + +Quotation Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**quoteId** | **String** | The quotation ID (quote_id) is used for placing orders and is valid for 1 minute | [optional] +**minAmount** | **String** | 最小下单量 | [optional] +**maxAmount** | **String** | 最大下单量 | [optional] +**price** | **String** | Coin Price (USDT-based) | [optional] +**slippage** | **String** | Slippage | [optional] +**estimateGasFeeAmountUsdt** | **String** | Estimated Network Fee (USDT-based) | [optional] +**orderFee** | **String** | Slippage value of 10 represents a 10% tolerance | [optional] +**targetTokenMinAmount** | **String** | 最小获得数量 | [optional] +**targetTokenMaxAmount** | **String** | 最大获得数量 | [optional] +**errorType** | **Integer** | Failure Type - `0` : Success - `1` : Exceeds maximum value - `2` : Below minimum value | [optional] + diff --git a/docs/SubAccountApi.md b/docs/SubAccountApi.md index 9f6c998..fc83e07 100644 --- a/docs/SubAccountApi.md +++ b/docs/SubAccountApi.md @@ -293,7 +293,7 @@ Name | Type | Description | Notes # **createSubAccountKeys** -> List<SubAccountKey> createSubAccountKeys(userId, subAccountKey) +> SubAccountKey createSubAccountKeys(userId, subAccountKey) Create API Key of the sub-account @@ -321,7 +321,7 @@ public class Example { 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())); @@ -345,7 +345,7 @@ Name | Type | Description | Notes ### Return type -[**List<SubAccountKey>**](SubAccountKey.md) +[**SubAccountKey**](SubAccountKey.md) ### Authorization diff --git a/docs/SubAccountKey.md b/docs/SubAccountKey.md index 7f3e84a..ac1ebca 100644 --- a/docs/SubAccountKey.md +++ b/docs/SubAccountKey.md @@ -5,7 +5,7 @@ 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] **perms** | [**List<SubAccountKeyPerms>**](SubAccountKeyPerms.md) | | [optional] diff --git a/docs/SubAccountTransfer.md b/docs/SubAccountTransfer.md index 02e08fb..869042b 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** | 操作的子账号交易账户， spot - 现货账户， futures - 永续合约账户， delivery - 交割合约账户, options - 期权账户 | [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] diff --git a/docs/SubAccountTransferRecordItem.md b/docs/SubAccountTransferRecordItem.md new file mode 100644 index 0000000..c42be4b --- /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** | 操作的子账号交易账户， spot - 现货账户， futures - 永续合约账户， delivery - 交割合约账户, options - 期权账户 | [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] + diff --git a/docs/SwapCoin.md b/docs/SwapCoin.md new file mode 100644 index 0000000..0b524b3 --- /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/Ticker2.md b/docs/Ticker2.md new file mode 100644 index 0000000..840ceee --- /dev/null +++ b/docs/Ticker2.md @@ -0,0 +1,13 @@ + +# Ticker2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**currency** | **String** | Currency symbol | [optional] +**last** | **String** | Last trading price | [optional] +**change** | **String** | Change percentage in the last 24h | [optional] +**volume** | **String** | 24h Trading Volume (USDT) | [optional] +**marketCap** | **String** | Current Coin Market Value | [optional] + diff --git a/docs/WalletApi.md b/docs/WalletApi.md index bc8ac1c..0182015 100644 --- a/docs/WalletApi.md +++ b/docs/WalletApi.md @@ -408,7 +408,7 @@ Name | Type | Description | Notes # **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 @@ -441,7 +441,7 @@ public class Example { Integer limit = 100; // Integer | Maximum number of records to be 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) @@ -474,7 +474,7 @@ Name | Type | Description | Notes ### Return type -[**List<SubAccountTransfer>**](SubAccountTransfer.md) +[**List<SubAccountTransferRecordItem>**](SubAccountTransferRecordItem.md) ### Authorization diff --git a/pom.xml b/pom.xml index e150c3a..4de7e6d 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ gate-api jar gate-api - 6.99.0 + 6.100.0 https://github.com/gateio/gateapi-java.git Java client for gateapi diff --git a/src/main/java/io/gate/gateapi/ApiCallback.java b/src/main/java/io/gate/gateapi/ApiCallback.java index 7a57edd..4953a2c 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/ApiClient.java b/src/main/java/io/gate/gateapi/ApiClient.java index 382395a..8718a9e 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 @@ -113,7 +113,7 @@ private void init() { json = new JSON(); // Set default User-Agent. - setUserAgent("OpenAPI-Generator/6.99.0/java"); + setUserAgent("OpenAPI-Generator/6.100.0/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..86ac20b 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/ApiResponse.java b/src/main/java/io/gate/gateapi/ApiResponse.java index d24de01..e3cbfa9 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/Configuration.java b/src/main/java/io/gate/gateapi/Configuration.java index e51b74d..db95190 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/GzipRequestInterceptor.java b/src/main/java/io/gate/gateapi/GzipRequestInterceptor.java index aa2a2b2..59f0a3e 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/JSON.java b/src/main/java/io/gate/gateapi/JSON.java index 4fd2743..a16cdcd 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/Pair.java b/src/main/java/io/gate/gateapi/Pair.java index 4d937f7..b9f5633 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/ProgressRequestBody.java b/src/main/java/io/gate/gateapi/ProgressRequestBody.java index a9ba389..f3bcfae 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/ProgressResponseBody.java b/src/main/java/io/gate/gateapi/ProgressResponseBody.java index 1e2c15a..22a92c7 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/StringUtil.java b/src/main/java/io/gate/gateapi/StringUtil.java index 860b4bf..5d828da 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/api/AccountApi.java b/src/main/java/io/gate/gateapi/api/AccountApi.java index a6fbab3..8e8aa4c 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/api/AlphaApi.java b/src/main/java/io/gate/gateapi/api/AlphaApi.java new file mode 100644 index 0000000..1d6860c --- /dev/null +++ b/src/main/java/io/gate/gateapi/api/AlphaApi.java @@ -0,0 +1,1236 @@ +/* + * Gate API v4 + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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.api; + +import io.gate.gateapi.ApiCallback; +import io.gate.gateapi.ApiClient; +import io.gate.gateapi.ApiException; +import io.gate.gateapi.ApiResponse; +import io.gate.gateapi.Configuration; +import io.gate.gateapi.Pair; + +import com.google.gson.reflect.TypeToken; + + +import io.gate.gateapi.models.AccountBookResponse; +import io.gate.gateapi.models.AccountsResponse; +import io.gate.gateapi.models.Currency2; +import io.gate.gateapi.models.OrderResponse; +import io.gate.gateapi.models.PlaceOrderRequest; +import io.gate.gateapi.models.PlaceOrderResponse; +import io.gate.gateapi.models.QuoteRequest; +import io.gate.gateapi.models.QuoteResponse; +import io.gate.gateapi.models.Ticker2; + +import java.lang.reflect.Type; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +public class AlphaApi { + private ApiClient localVarApiClient; + + public AlphaApi() { + this(Configuration.getDefaultApiClient()); + } + + public AlphaApi(ApiClient apiClient) { + this.localVarApiClient = apiClient; + } + + public ApiClient getApiClient() { + return localVarApiClient; + } + + public void setApiClient(ApiClient apiClient) { + this.localVarApiClient = apiClient; + } + + /** + * Build call for listAlphaAccounts + * @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 查询持仓成功 -
+ */ + public okhttp3.Call listAlphaAccountsCall(final ApiCallback _callback) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/alpha/accounts"; + + 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); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call listAlphaAccountsValidateBeforeCall(final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = listAlphaAccountsCall(_callback); + return localVarCall; + } + + /** + * API for Alpha Accounts + * Query Position Assets + * @return List<AccountsResponse> + * @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 查询持仓成功 -
+ */ + public List listAlphaAccounts() throws ApiException { + ApiResponse> localVarResp = listAlphaAccountsWithHttpInfo(); + return localVarResp.getData(); + } + + /** + * API for Alpha Accounts + * Query Position Assets + * @return ApiResponse<List<AccountsResponse>> + * @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 查询持仓成功 -
+ */ + public ApiResponse> listAlphaAccountsWithHttpInfo() throws ApiException { + okhttp3.Call localVarCall = listAlphaAccountsValidateBeforeCall(null); + Type localVarReturnType = new TypeToken>(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * API for Alpha Accounts (asynchronously) + * Query Position Assets + * @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 查询持仓成功 -
+ */ + public okhttp3.Call listAlphaAccountsAsync(final ApiCallback> _callback) throws ApiException { + okhttp3.Call localVarCall = listAlphaAccountsValidateBeforeCall(_callback); + Type localVarReturnType = new TypeToken>(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + + private okhttp3.Call listAlphaAccountBookCall(Long from, Long to, Integer page, Integer limit, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/alpha/account_book"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + 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)); + } + + 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 listAlphaAccountBookValidateBeforeCall(Long from, Long to, Integer page, Integer limit, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'from' is set + if (from == null) { + throw new ApiException("Missing the required parameter 'from' when calling listAlphaAccountBook(Async)"); + } + + okhttp3.Call localVarCall = listAlphaAccountBookCall(from, to, page, limit, _callback); + return localVarCall; + } + + + private ApiResponse> listAlphaAccountBookWithHttpInfo(Long from, Long to, Integer page, Integer limit) throws ApiException { + okhttp3.Call localVarCall = listAlphaAccountBookValidateBeforeCall(from, to, page, limit, null); + Type localVarReturnType = new TypeToken>(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + private okhttp3.Call listAlphaAccountBookAsync(Long from, Long to, Integer page, Integer limit, final ApiCallback> _callback) throws ApiException { + okhttp3.Call localVarCall = listAlphaAccountBookValidateBeforeCall(from, to, page, limit, _callback); + Type localVarReturnType = new TypeToken>(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + + public class APIlistAlphaAccountBookRequest { + private final Long from; + private Long to; + private Integer page; + private Integer limit; + + private APIlistAlphaAccountBookRequest(Long from) { + this.from = from; + } + + /** + * Set to + * @param to Time range ending, default to current time (optional) + * @return APIlistAlphaAccountBookRequest + */ + public APIlistAlphaAccountBookRequest to(Long to) { + this.to = to; + return this; + } + + /** + * Set page + * @param page Page number (optional) + * @return APIlistAlphaAccountBookRequest + */ + public APIlistAlphaAccountBookRequest page(Integer page) { + this.page = page; + return this; + } + + /** + * Set limit + * @param limit The maximum number of items per page is 100 (optional) + * @return APIlistAlphaAccountBookRequest + */ + public APIlistAlphaAccountBookRequest limit(Integer limit) { + this.limit = limit; + return this; + } + + /** + * Build call for listAlphaAccountBook + * @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 查询流水成功 -
+ */ + public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { + return listAlphaAccountBookCall(from, to, page, limit, _callback); + } + + /** + * Execute listAlphaAccountBook request + * @return List<AccountBookResponse> + * @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 查询流水成功 -
+ */ + public List execute() throws ApiException { + ApiResponse> localVarResp = listAlphaAccountBookWithHttpInfo(from, to, page, limit); + return localVarResp.getData(); + } + + /** + * Execute listAlphaAccountBook request with HTTP info returned + * @return ApiResponse<List<AccountBookResponse>> + * @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 查询流水成功 -
+ */ + public ApiResponse> executeWithHttpInfo() throws ApiException { + return listAlphaAccountBookWithHttpInfo(from, to, page, limit); + } + + /** + * Execute listAlphaAccountBook 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 查询流水成功 -
+ */ + public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { + return listAlphaAccountBookAsync(from, to, page, limit, _callback); + } + } + + /** + * Alpha Asset Transaction API + * Query Asset Transactions + * @param from Start timestamp of the query (required) + * @return APIlistAlphaAccountBookRequest + * @http.response.details + + + +
Status Code Description Response Headers
200 查询流水成功 -
+ */ + public APIlistAlphaAccountBookRequest listAlphaAccountBook(Long from) { + return new APIlistAlphaAccountBookRequest(from); + } + + /** + * Build call for quoteAlphaOrder + * @param quoteRequest (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 询价成功 -
+ */ + public okhttp3.Call quoteAlphaOrderCall(QuoteRequest quoteRequest, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = quoteRequest; + + // create path and map variables + String localVarPath = "/alpha/quote"; + + 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 quoteAlphaOrderValidateBeforeCall(QuoteRequest quoteRequest, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'quoteRequest' is set + if (quoteRequest == null) { + throw new ApiException("Missing the required parameter 'quoteRequest' when calling quoteAlphaOrder(Async)"); + } + + okhttp3.Call localVarCall = quoteAlphaOrderCall(quoteRequest, _callback); + return localVarCall; + } + + /** + * Alpha Quotation API + * The quote_id returned by the quotation API is valid for one minute.You must place the order within this time window;otherwise, the quote will expire and a new quotation request is required + * @param quoteRequest (required) + * @return QuoteResponse + * @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 询价成功 -
+ */ + public QuoteResponse quoteAlphaOrder(QuoteRequest quoteRequest) throws ApiException { + ApiResponse localVarResp = quoteAlphaOrderWithHttpInfo(quoteRequest); + return localVarResp.getData(); + } + + /** + * Alpha Quotation API + * The quote_id returned by the quotation API is valid for one minute.You must place the order within this time window;otherwise, the quote will expire and a new quotation request is required + * @param quoteRequest (required) + * @return ApiResponse<QuoteResponse> + * @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 询价成功 -
+ */ + public ApiResponse quoteAlphaOrderWithHttpInfo(QuoteRequest quoteRequest) throws ApiException { + okhttp3.Call localVarCall = quoteAlphaOrderValidateBeforeCall(quoteRequest, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Alpha Quotation API (asynchronously) + * The quote_id returned by the quotation API is valid for one minute.You must place the order within this time window;otherwise, the quote will expire and a new quotation request is required + * @param quoteRequest (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 询价成功 -
+ */ + public okhttp3.Call quoteAlphaOrderAsync(QuoteRequest quoteRequest, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = quoteAlphaOrderValidateBeforeCall(quoteRequest, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + + private okhttp3.Call listAlphaOrderCall(String currency, String side, Integer status, Long from, Long to, Integer limit, Integer page, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/alpha/orders"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + if (currency != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); + } + + if (side != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("side", side)); + } + + if (status != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("status", status)); + } + + if (from != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("from", from)); + } + + if (to != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("to", to)); + } + + if (limit != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("limit", limit)); + } + + if (page != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("page", page)); + } + + 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 listAlphaOrderValidateBeforeCall(String currency, String side, Integer status, Long from, Long to, Integer limit, Integer page, 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 listAlphaOrder(Async)"); + } + + // verify the required parameter 'side' is set + if (side == null) { + throw new ApiException("Missing the required parameter 'side' when calling listAlphaOrder(Async)"); + } + + // verify the required parameter 'status' is set + if (status == null) { + throw new ApiException("Missing the required parameter 'status' when calling listAlphaOrder(Async)"); + } + + okhttp3.Call localVarCall = listAlphaOrderCall(currency, side, status, from, to, limit, page, _callback); + return localVarCall; + } + + + private ApiResponse> listAlphaOrderWithHttpInfo(String currency, String side, Integer status, Long from, Long to, Integer limit, Integer page) throws ApiException { + okhttp3.Call localVarCall = listAlphaOrderValidateBeforeCall(currency, side, status, from, to, limit, page, null); + Type localVarReturnType = new TypeToken>(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + private okhttp3.Call listAlphaOrderAsync(String currency, String side, Integer status, Long from, Long to, Integer limit, Integer page, final ApiCallback> _callback) throws ApiException { + okhttp3.Call localVarCall = listAlphaOrderValidateBeforeCall(currency, side, status, from, to, limit, page, _callback); + Type localVarReturnType = new TypeToken>(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + + public class APIlistAlphaOrderRequest { + private final String currency; + private final String side; + private final Integer status; + private Long from; + private Long to; + private Integer limit; + private Integer page; + + private APIlistAlphaOrderRequest(String currency, String side, Integer status) { + this.currency = currency; + this.side = side; + this.status = status; + } + + /** + * Set from + * @param from 查询订单的起始时间 (optional) + * @return APIlistAlphaOrderRequest + */ + public APIlistAlphaOrderRequest from(Long from) { + this.from = from; + return this; + } + + /** + * Set to + * @param to 查询订单的结束时间，不指定则默认为当前时间 (optional) + * @return APIlistAlphaOrderRequest + */ + public APIlistAlphaOrderRequest to(Long to) { + this.to = to; + return this; + } + + /** + * Set limit + * @param limit Maximum response items. Default: 100, minimum: 1, Maximum: 100 (optional, default to 100) + * @return APIlistAlphaOrderRequest + */ + public APIlistAlphaOrderRequest limit(Integer limit) { + this.limit = limit; + return this; + } + + /** + * Set page + * @param page Page number (optional, default to 1) + * @return APIlistAlphaOrderRequest + */ + public APIlistAlphaOrderRequest page(Integer page) { + this.page = page; + return this; + } + + /** + * Build call for listAlphaOrder + * @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 listAlphaOrderCall(currency, side, status, from, to, limit, page, _callback); + } + + /** + * Execute listAlphaOrder request + * @return List<OrderResponse> + * @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 = listAlphaOrderWithHttpInfo(currency, side, status, from, to, limit, page); + return localVarResp.getData(); + } + + /** + * Execute listAlphaOrder request with HTTP info returned + * @return ApiResponse<List<OrderResponse>> + * @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 listAlphaOrderWithHttpInfo(currency, side, status, from, to, limit, page); + } + + /** + * Execute listAlphaOrder 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 listAlphaOrderAsync(currency, side, status, from, to, limit, page, _callback); + } + } + + /** + * Alpha 查询订单列表接口 + * + * @param currency Trading Symbol (required) + * @param side 买单或者卖单 - buy - sell (required) + * @param status Order Status - `0` : All - `1` : Processing - `2` : Successful - `3` : Failed - `4` : Canceled - `5` : Buy order placed but transfer not completed - `6` : Cancelled order with transfer not complete (required) + * @return APIlistAlphaOrderRequest + * @http.response.details + + + +
Status Code Description Response Headers
200 List retrieved -
+ */ + public APIlistAlphaOrderRequest listAlphaOrder(String currency, String side, Integer status) { + return new APIlistAlphaOrderRequest(currency, side, status); + } + + /** + * Build call for placeAlphaOrder + * @param placeOrderRequest (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 -
+ */ + public okhttp3.Call placeAlphaOrderCall(PlaceOrderRequest placeOrderRequest, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = placeOrderRequest; + + // create path and map variables + String localVarPath = "/alpha/orders"; + + 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 placeAlphaOrderValidateBeforeCall(PlaceOrderRequest placeOrderRequest, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'placeOrderRequest' is set + if (placeOrderRequest == null) { + throw new ApiException("Missing the required parameter 'placeOrderRequest' when calling placeAlphaOrder(Async)"); + } + + okhttp3.Call localVarCall = placeAlphaOrderCall(placeOrderRequest, _callback); + return localVarCall; + } + + /** + * Alpha Order Placement API + * + * @param placeOrderRequest (required) + * @return PlaceOrderResponse + * @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 -
+ */ + public PlaceOrderResponse placeAlphaOrder(PlaceOrderRequest placeOrderRequest) throws ApiException { + ApiResponse localVarResp = placeAlphaOrderWithHttpInfo(placeOrderRequest); + return localVarResp.getData(); + } + + /** + * Alpha Order Placement API + * + * @param placeOrderRequest (required) + * @return ApiResponse<PlaceOrderResponse> + * @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 -
+ */ + public ApiResponse placeAlphaOrderWithHttpInfo(PlaceOrderRequest placeOrderRequest) throws ApiException { + okhttp3.Call localVarCall = placeAlphaOrderValidateBeforeCall(placeOrderRequest, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Alpha Order Placement API (asynchronously) + * + * @param placeOrderRequest (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 -
+ */ + public okhttp3.Call placeAlphaOrderAsync(PlaceOrderRequest placeOrderRequest, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = placeAlphaOrderValidateBeforeCall(placeOrderRequest, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + + /** + * Build call for getAlphaOrder + * @param orderId Order 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 订单查询成功 -
+ */ + public okhttp3.Call getAlphaOrderCall(String orderId, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/alpha/order"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + if (orderId != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("order_id", orderId)); + } + + 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 getAlphaOrderValidateBeforeCall(String orderId, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'orderId' is set + if (orderId == null) { + throw new ApiException("Missing the required parameter 'orderId' when calling getAlphaOrder(Async)"); + } + + okhttp3.Call localVarCall = getAlphaOrderCall(orderId, _callback); + return localVarCall; + } + + /** + * Alpha 查询单个订单接口 + * + * @param orderId Order ID (required) + * @return OrderResponse + * @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 订单查询成功 -
+ */ + public OrderResponse getAlphaOrder(String orderId) throws ApiException { + ApiResponse localVarResp = getAlphaOrderWithHttpInfo(orderId); + return localVarResp.getData(); + } + + /** + * Alpha 查询单个订单接口 + * + * @param orderId Order ID (required) + * @return ApiResponse<OrderResponse> + * @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 订单查询成功 -
+ */ + public ApiResponse getAlphaOrderWithHttpInfo(String orderId) throws ApiException { + okhttp3.Call localVarCall = getAlphaOrderValidateBeforeCall(orderId, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Alpha 查询单个订单接口 (asynchronously) + * + * @param orderId Order 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 订单查询成功 -
+ */ + public okhttp3.Call getAlphaOrderAsync(String orderId, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = getAlphaOrderValidateBeforeCall(orderId, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + + private okhttp3.Call listAlphaCurrenciesCall(String currency, Integer limit, Integer page, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/alpha/currencies"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + if (currency != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); + } + + if (limit != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("limit", limit)); + } + + if (page != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("page", page)); + } + + 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 listAlphaCurrenciesValidateBeforeCall(String currency, Integer limit, Integer page, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = listAlphaCurrenciesCall(currency, limit, page, _callback); + return localVarCall; + } + + + private ApiResponse> listAlphaCurrenciesWithHttpInfo(String currency, Integer limit, Integer page) throws ApiException { + okhttp3.Call localVarCall = listAlphaCurrenciesValidateBeforeCall(currency, limit, page, null); + Type localVarReturnType = new TypeToken>(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + private okhttp3.Call listAlphaCurrenciesAsync(String currency, Integer limit, Integer page, final ApiCallback> _callback) throws ApiException { + okhttp3.Call localVarCall = listAlphaCurrenciesValidateBeforeCall(currency, limit, page, _callback); + Type localVarReturnType = new TypeToken>(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + + public class APIlistAlphaCurrenciesRequest { + private String currency; + private Integer limit; + private Integer page; + + private APIlistAlphaCurrenciesRequest() { + } + + /** + * Set currency + * @param currency 根据币种符号查询币种信息 (optional) + * @return APIlistAlphaCurrenciesRequest + */ + public APIlistAlphaCurrenciesRequest currency(String currency) { + this.currency = currency; + return this; + } + + /** + * Set limit + * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @return APIlistAlphaCurrenciesRequest + */ + public APIlistAlphaCurrenciesRequest limit(Integer limit) { + this.limit = limit; + return this; + } + + /** + * Set page + * @param page Page number (optional, default to 1) + * @return APIlistAlphaCurrenciesRequest + */ + public APIlistAlphaCurrenciesRequest page(Integer page) { + this.page = page; + return this; + } + + /** + * Build call for listAlphaCurrencies + * @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 -
+ */ + public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { + return listAlphaCurrenciesCall(currency, limit, page, _callback); + } + + /** + * Execute listAlphaCurrencies request + * @return List<Currency2> + * @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 execute() throws ApiException { + ApiResponse> localVarResp = listAlphaCurrenciesWithHttpInfo(currency, limit, page); + return localVarResp.getData(); + } + + /** + * Execute listAlphaCurrencies request with HTTP info returned + * @return ApiResponse<List<Currency2>> + * @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> executeWithHttpInfo() throws ApiException { + return listAlphaCurrenciesWithHttpInfo(currency, limit, page); + } + + /** + * Execute listAlphaCurrencies 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 -
+ */ + public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { + return listAlphaCurrenciesAsync(currency, limit, page, _callback); + } + } + + /** + * 查询币种信息 + * When the currency parameter is provided, query and return information for the specified currency. When the currency parameter is not provided, return a paginated list of currencies. + * @return APIlistAlphaCurrenciesRequest + * @http.response.details + + + +
Status Code Description Response Headers
200 Successfully retrieved -
+ */ + public APIlistAlphaCurrenciesRequest listAlphaCurrencies() { + return new APIlistAlphaCurrenciesRequest(); + } + + private okhttp3.Call listAlphaTickersCall(String currency, Integer limit, Integer page, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/alpha/tickers"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + if (currency != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); + } + + if (limit != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("limit", limit)); + } + + if (page != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("page", page)); + } + + 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 listAlphaTickersValidateBeforeCall(String currency, Integer limit, Integer page, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = listAlphaTickersCall(currency, limit, page, _callback); + return localVarCall; + } + + + private ApiResponse> listAlphaTickersWithHttpInfo(String currency, Integer limit, Integer page) throws ApiException { + okhttp3.Call localVarCall = listAlphaTickersValidateBeforeCall(currency, limit, page, null); + Type localVarReturnType = new TypeToken>(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + private okhttp3.Call listAlphaTickersAsync(String currency, Integer limit, Integer page, final ApiCallback> _callback) throws ApiException { + okhttp3.Call localVarCall = listAlphaTickersValidateBeforeCall(currency, limit, page, _callback); + Type localVarReturnType = new TypeToken>(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + + public class APIlistAlphaTickersRequest { + private String currency; + private Integer limit; + private Integer page; + + private APIlistAlphaTickersRequest() { + } + + /** + * Set currency + * @param currency Retrieve data of the specified currency (optional) + * @return APIlistAlphaTickersRequest + */ + public APIlistAlphaTickersRequest currency(String currency) { + this.currency = currency; + return this; + } + + /** + * Set limit + * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @return APIlistAlphaTickersRequest + */ + public APIlistAlphaTickersRequest limit(Integer limit) { + this.limit = limit; + return this; + } + + /** + * Set page + * @param page Page number (optional, default to 1) + * @return APIlistAlphaTickersRequest + */ + public APIlistAlphaTickersRequest page(Integer page) { + this.page = page; + return this; + } + + /** + * Build call for listAlphaTickers + * @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 -
+ */ + public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { + return listAlphaTickersCall(currency, limit, page, _callback); + } + + /** + * Execute listAlphaTickers request + * @return List<Ticker2> + * @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 execute() throws ApiException { + ApiResponse> localVarResp = listAlphaTickersWithHttpInfo(currency, limit, page); + return localVarResp.getData(); + } + + /** + * Execute listAlphaTickers request with HTTP info returned + * @return ApiResponse<List<Ticker2>> + * @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> executeWithHttpInfo() throws ApiException { + return listAlphaTickersWithHttpInfo(currency, limit, page); + } + + /** + * Execute listAlphaTickers 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 -
+ */ + public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { + return listAlphaTickersAsync(currency, limit, page, _callback); + } + } + + /** + * 查询币种ticker + * When the currency parameter is provided, query and return information for the specified ticker, When the currency parameter is not provided, return a paginated list of tickers. + * @return APIlistAlphaTickersRequest + * @http.response.details + + + +
Status Code Description Response Headers
200 Successfully retrieved -
+ */ + public APIlistAlphaTickersRequest listAlphaTickers() { + return new APIlistAlphaTickersRequest(); + } + +} diff --git a/src/main/java/io/gate/gateapi/api/CollateralLoanApi.java b/src/main/java/io/gate/gateapi/api/CollateralLoanApi.java index 7bad281..97106bb 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/api/DeliveryApi.java b/src/main/java/io/gate/gateapi/api/DeliveryApi.java index 388a8bb..9e38f40 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/api/EarnApi.java b/src/main/java/io/gate/gateapi/api/EarnApi.java index 4aa1b54..d88f0ef 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 @@ -24,10 +24,12 @@ 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 java.lang.reflect.Type; import java.util.ArrayList; @@ -1165,4 +1167,214 @@ 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 Successful -
+ */ + 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; + } + + /** + * 链上赚币币种 + * + * @param findCoin (required) + * @return List<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 Successful -
+ */ + public List findCoin(FindCoin findCoin) throws ApiException { + ApiResponse> localVarResp = findCoinWithHttpInfo(findCoin); + return localVarResp.getData(); + } + + /** + * 链上赚币币种 + * + * @param findCoin (required) + * @return ApiResponse<List<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 Successful -
+ */ + public ApiResponse> findCoinWithHttpInfo(FindCoin findCoin) throws ApiException { + okhttp3.Call localVarCall = findCoinValidateBeforeCall(findCoin, null); + Type localVarReturnType = new TypeToken>(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * 链上赚币币种 (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 Successful -
+ */ + 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 success -
+ */ + 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 = { + + }; + 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) + * @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 success -
+ */ + public void swapStakingCoin(SwapCoin swapCoin) throws ApiException { + swapStakingCoinWithHttpInfo(swapCoin); + } + + /** + * On-chain Token Swap for Earned Coins + * + * @param swapCoin (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 swap success -
+ */ + public ApiResponse swapStakingCoinWithHttpInfo(SwapCoin swapCoin) throws ApiException { + okhttp3.Call localVarCall = swapStakingCoinValidateBeforeCall(swapCoin, null); + return localVarApiClient.execute(localVarCall); + } + + /** + * 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 success -
+ */ + public okhttp3.Call swapStakingCoinAsync(SwapCoin swapCoin, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = swapStakingCoinValidateBeforeCall(swapCoin, _callback); + localVarApiClient.executeAsync(localVarCall, _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 aa88a2e..6834f81 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 @@ -1289,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-17 09:53+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-01 13:02+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 -
*/ public okhttp3.Call listUniChartCall(Long from, Long to, String asset, final ApiCallback _callback) throws ApiException { @@ -1356,7 +1356,7 @@ 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-17 09:53+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-01 13:02+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) * @param asset Currency name (required) @@ -1365,7 +1365,7 @@ private okhttp3.Call listUniChartValidateBeforeCall(Long from, Long to, String a * @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-17 09:53+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-01 13:02+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 -
*/ public List listUniChart(Long from, Long to, String asset) throws ApiException { @@ -1375,7 +1375,7 @@ 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-17 09:53+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-01 13:02+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) * @param asset Currency name (required) @@ -1384,7 +1384,7 @@ public List listUniChart(Long from, Long to, String asset) th * @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-17 09:53+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-01 13:02+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 -
*/ public ApiResponse> listUniChartWithHttpInfo(Long from, Long to, String asset) throws ApiException { @@ -1395,7 +1395,7 @@ 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-17 09:53+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-01 13:02+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) * @param asset Currency name (required) @@ -1405,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-17 09:53+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-01 13:02+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 -
*/ public okhttp3.Call listUniChartAsync(Long from, Long to, String asset, final ApiCallback> _callback) throws ApiException { @@ -1423,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-17 09:53+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-01 13:02+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 -
*/ public okhttp3.Call listUniRateCall(final ApiCallback _callback) throws ApiException { @@ -1463,13 +1463,13 @@ 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-17 09:53+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-01 13:02+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 * @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-17 09:53+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-01 13:02+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 -
*/ public List listUniRate() throws ApiException { @@ -1479,13 +1479,13 @@ 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-17 09:53+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-01 13:02+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 * @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-17 09:53+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-01 13:02+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 -
*/ public ApiResponse> listUniRateWithHttpInfo() throws ApiException { @@ -1496,14 +1496,14 @@ 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-17 09:53+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-01 13:02+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 _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-17 09:53+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-01 13:02+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 -
*/ 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..7b5363e 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/api/FuturesApi.java b/src/main/java/io/gate/gateapi/api/FuturesApi.java index ece4533..f4a5b31 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 @@ -39,11 +39,11 @@ 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.FuturesTicker; import io.gate.gateapi.models.FuturesTrade; -import io.gate.gateapi.models.InlineObject; import io.gate.gateapi.models.InsuranceRecord; import io.gate.gateapi.models.MyFuturesTrade; import io.gate.gateapi.models.MyFuturesTradeTimeRange; @@ -3323,7 +3323,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 +3333,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,18 +3364,18 @@ 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; } @@ -3383,7 +3383,7 @@ private okhttp3.Call updatePositionCrossModeValidateBeforeCall(String settle, In * Switch to the full position-by-store 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,8 +3392,8 @@ 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(); } @@ -3401,7 +3401,7 @@ public Position updatePositionCrossMode(String settle, InlineObject inlineObject * Switch to the full position-by-store 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,8 +3410,8 @@ 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); } @@ -3420,7 +3420,7 @@ public ApiResponse updatePositionCrossModeWithHttpInfo(String settle, * Switch to the full position-by-store 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,8 +3430,8 @@ 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; diff --git a/src/main/java/io/gate/gateapi/api/MarginApi.java b/src/main/java/io/gate/gateapi/api/MarginApi.java index b43a747..0ee8d51 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 @@ -198,139 +198,40 @@ public APIlistMarginAccountsRequest listMarginAccounts() { return new APIlistMarginAccountsRequest(); } - /** - * 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 { + private okhttp3.Call listMarginAccountBookCall(String currency, String currencyPair, String type, Long from, Long to, Integer page, Integer limit, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/margin/user/loan_margin_tiers"; + String localVarPath = "/margin/account_book"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); + if (currency != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); + } + 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); + if (type != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("type", type)); } - 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)"); + if (from != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("from", from)); } - 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; + if (to != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("to", to)); + } - // create path and map variables - String localVarPath = "/margin/loan_margin_tiers"; + if (page != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("page", page)); + } - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - if (currencyPair != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency_pair", currencyPair)); + if (limit != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("limit", limit)); } Map localVarHeaderParams = new HashMap(); @@ -350,189 +251,196 @@ public okhttp3.Call getMarketMarginTierCall(String currencyPair, final ApiCallba 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); } @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); + private okhttp3.Call listMarginAccountBookValidateBeforeCall(String currency, String currencyPair, String type, Long from, Long to, Integer page, Integer limit, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = listMarginAccountBookCall(currency, currencyPair, type, from, to, page, limit, _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(); + private ApiResponse> listMarginAccountBookWithHttpInfo(String currency, String currencyPair, String type, Long from, Long to, Integer page, Integer limit) throws ApiException { + okhttp3.Call localVarCall = listMarginAccountBookValidateBeforeCall(currency, currencyPair, type, from, to, page, limit, 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(); + private okhttp3.Call listMarginAccountBookAsync(String currency, String currencyPair, String type, Long from, Long to, Integer page, Integer limit, final ApiCallback> _callback) throws ApiException { + okhttp3.Call localVarCall = listMarginAccountBookValidateBeforeCall(currency, currencyPair, type, from, to, page, limit, _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; + public class APIlistMarginAccountBookRequest { + private String currency; + private String currencyPair; + private String type; + private Long from; + private Long to; + private Integer page; + private Integer limit; - // create path and map variables - String localVarPath = "/margin/leverage/user_market_setting"; + private APIlistMarginAccountBookRequest() { + } - 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); + /** + * Set currency + * @param currency List records related to specified currency only. If specified, `currency_pair` is also required. (optional) + * @return APIlistMarginAccountBookRequest + */ + public APIlistMarginAccountBookRequest currency(String currency) { + this.currency = currency; + return this; } - final String[] localVarContentTypes = { - "application/json" - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - localVarHeaderParams.put("Content-Type", localVarContentType); + /** + * Set currencyPair + * @param currencyPair List records related to specified currency pair. Used in combination with `currency`. Ignored if `currency` is not provided (optional) + * @return APIlistMarginAccountBookRequest + */ + public APIlistMarginAccountBookRequest currencyPair(String currencyPair) { + this.currencyPair = currencyPair; + return this; + } - String[] localVarAuthNames = new String[] { "apiv4" }; - return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } + /** + * Set type + * @param type Only retrieve changes of the specified type. All types will be returned if not specified. (optional) + * @return APIlistMarginAccountBookRequest + */ + public APIlistMarginAccountBookRequest type(String type) { + this.type = type; + return this; + } - @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)"); + /** + * Set from + * @param from Start timestamp of the query (optional) + * @return APIlistMarginAccountBookRequest + */ + public APIlistMarginAccountBookRequest from(Long from) { + this.from = from; + return this; } - okhttp3.Call localVarCall = setUserMarketLeverageCall(marginMarketLeverage, _callback); - return localVarCall; - } + /** + * Set to + * @param to Time range ending, default to current time (optional) + * @return APIlistMarginAccountBookRequest + */ + public APIlistMarginAccountBookRequest to(Long to) { + this.to = to; + return this; + } - /** - * 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 page + * @param page Page number (optional, default to 1) + * @return APIlistMarginAccountBookRequest + */ + public APIlistMarginAccountBookRequest page(Integer page) { + this.page = page; + return this; + } - /** - * 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 limit + * @param limit Maximum number of records to be returned in a single list (optional, default to 100) + * @return APIlistMarginAccountBookRequest + */ + public APIlistMarginAccountBookRequest limit(Integer limit) { + this.limit = limit; + return this; + } + + /** + * Build call for listMarginAccountBook + * @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 listMarginAccountBookCall(currency, currencyPair, type, from, to, page, limit, _callback); + } + + /** + * Execute listMarginAccountBook request + * @return List<MarginAccountBook> + * @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 = listMarginAccountBookWithHttpInfo(currency, currencyPair, type, from, to, page, limit); + return localVarResp.getData(); + } + + /** + * Execute listMarginAccountBook request with HTTP info returned + * @return ApiResponse<List<MarginAccountBook>> + * @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 listMarginAccountBookWithHttpInfo(currency, currencyPair, type, from, to, page, limit); + } + + /** + * Execute listMarginAccountBook 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 listMarginAccountBookAsync(currency, currencyPair, type, from, to, page, limit, _callback); + } } /** - * 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 + * List margin account balance change history + * Only transferals from and to margin account are provided for now. Time range allows 30 days at most + * @return APIlistMarginAccountBookRequest * @http.response.details - +
Status Code Description Response Headers
204 Success -
200 List retrieved -
*/ - public okhttp3.Call setUserMarketLeverageAsync(MarginMarketLeverage marginMarketLeverage, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = setUserMarketLeverageValidateBeforeCall(marginMarketLeverage, _callback); - localVarApiClient.executeAsync(localVarCall, _callback); - return localVarCall; + public APIlistMarginAccountBookRequest listMarginAccountBook() { + return new APIlistMarginAccountBookRequest(); } - private okhttp3.Call listMarginUserAccountCall(String currencyPair, final ApiCallback _callback) throws ApiException { + private okhttp3.Call listFundingAccountsCall(String currency, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/margin/user/account"; + String localVarPath = "/margin/funding_accounts"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); - if (currencyPair != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency_pair", currencyPair)); + if (currency != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); } Map localVarHeaderParams = new HashMap(); @@ -557,43 +465,43 @@ private okhttp3.Call listMarginUserAccountCall(String currencyPair, final ApiCal } @SuppressWarnings("rawtypes") - private okhttp3.Call listMarginUserAccountValidateBeforeCall(String currencyPair, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = listMarginUserAccountCall(currencyPair, _callback); + private okhttp3.Call listFundingAccountsValidateBeforeCall(String currency, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = listFundingAccountsCall(currency, _callback); return localVarCall; } - private ApiResponse> listMarginUserAccountWithHttpInfo(String currencyPair) throws ApiException { - okhttp3.Call localVarCall = listMarginUserAccountValidateBeforeCall(currencyPair, null); - Type localVarReturnType = new TypeToken>(){}.getType(); + private ApiResponse> listFundingAccountsWithHttpInfo(String currency) throws ApiException { + okhttp3.Call localVarCall = listFundingAccountsValidateBeforeCall(currency, 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(); + private okhttp3.Call listFundingAccountsAsync(String currency, final ApiCallback> _callback) throws ApiException { + okhttp3.Call localVarCall = listFundingAccountsValidateBeforeCall(currency, _callback); + Type localVarReturnType = new TypeToken>(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } - public class APIlistMarginUserAccountRequest { - private String currencyPair; + public class APIlistFundingAccountsRequest { + private String currency; - private APIlistMarginUserAccountRequest() { + private APIlistFundingAccountsRequest() { } /** - * Set currencyPair - * @param currencyPair Currency pair (optional) - * @return APIlistMarginUserAccountRequest + * Set currency + * @param currency Retrieve data of the specified currency (optional) + * @return APIlistFundingAccountsRequest */ - public APIlistMarginUserAccountRequest currencyPair(String currencyPair) { - this.currencyPair = currencyPair; + public APIlistFundingAccountsRequest currency(String currency) { + this.currency = currency; return this; } /** - * Build call for listMarginUserAccount + * Build call for listFundingAccounts * @param _callback ApiCallback API callback * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -604,12 +512,12 @@ public APIlistMarginUserAccountRequest currencyPair(String currencyPair) { */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { - return listMarginUserAccountCall(currencyPair, _callback); + return listFundingAccountsCall(currency, _callback); } /** - * Execute listMarginUserAccount request - * @return List<MarginAccount> + * Execute listFundingAccounts request + * @return List<FundingAccount> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -617,14 +525,14 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException {
200 List retrieved -
*/ - public List execute() throws ApiException { - ApiResponse> localVarResp = listMarginUserAccountWithHttpInfo(currencyPair); + public List execute() throws ApiException { + ApiResponse> localVarResp = listFundingAccountsWithHttpInfo(currency); return localVarResp.getData(); } /** - * Execute listMarginUserAccount request with HTTP info returned - * @return ApiResponse<List<MarginAccount>> + * Execute listFundingAccounts request with HTTP info returned + * @return ApiResponse<List<FundingAccount>> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -632,12 +540,12 @@ public List execute() throws ApiException {
200 List retrieved -
*/ - public ApiResponse> executeWithHttpInfo() throws ApiException { - return listMarginUserAccountWithHttpInfo(currencyPair); + public ApiResponse> executeWithHttpInfo() throws ApiException { + return listFundingAccountsWithHttpInfo(currency); } /** - * Execute listMarginUserAccount request (asynchronously) + * Execute listFundingAccounts 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 @@ -647,61 +555,44 @@ public ApiResponse> executeWithHttpInfo() throws ApiExceptio 200 List retrieved - */ - public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { - return listMarginUserAccountAsync(currencyPair, _callback); + public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { + return listFundingAccountsAsync(currency, _callback); } } /** - * Query the user's leverage account list - * Support querying risk rate per position account and margin rate per position account - * @return APIlistMarginUserAccountRequest + * Funding account list + * + * @return APIlistFundingAccountsRequest * @http.response.details
Status Code Description Response Headers
200 List retrieved -
*/ - public APIlistMarginUserAccountRequest listMarginUserAccount() { - return new APIlistMarginUserAccountRequest(); + public APIlistFundingAccountsRequest listFundingAccounts() { + return new APIlistFundingAccountsRequest(); } - private okhttp3.Call listMarginAccountBookCall(String currency, String currencyPair, String type, Long from, Long to, Integer page, Integer limit, final ApiCallback _callback) throws ApiException { + /** + * Build call for getAutoRepayStatus + * @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 -
+ */ + public okhttp3.Call getAutoRepayStatusCall(final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/margin/account_book"; + String localVarPath = "/margin/auto_repay"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); - if (currency != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); - } - - if (currencyPair != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency_pair", currencyPair)); - } - - if (type != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("type", type)); - } - - 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)); - } - Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); @@ -724,186 +615,179 @@ private okhttp3.Call listMarginAccountBookCall(String currency, String currencyP } @SuppressWarnings("rawtypes") - private okhttp3.Call listMarginAccountBookValidateBeforeCall(String currency, String currencyPair, String type, Long from, Long to, Integer page, Integer limit, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = listMarginAccountBookCall(currency, currencyPair, type, from, to, page, limit, _callback); + private okhttp3.Call getAutoRepayStatusValidateBeforeCall(final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = getAutoRepayStatusCall(_callback); return localVarCall; } + /** + * Retrieve user auto repayment setting + * + * @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 -
+ */ + public AutoRepaySetting getAutoRepayStatus() throws ApiException { + ApiResponse localVarResp = getAutoRepayStatusWithHttpInfo(); + return localVarResp.getData(); + } - private ApiResponse> listMarginAccountBookWithHttpInfo(String currency, String currencyPair, String type, Long from, Long to, Integer page, Integer limit) throws ApiException { - okhttp3.Call localVarCall = listMarginAccountBookValidateBeforeCall(currency, currencyPair, type, from, to, page, limit, null); - Type localVarReturnType = new TypeToken>(){}.getType(); + /** + * Retrieve user auto repayment setting + * + * @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 -
+ */ + public ApiResponse getAutoRepayStatusWithHttpInfo() throws ApiException { + okhttp3.Call localVarCall = getAutoRepayStatusValidateBeforeCall(null); + Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } - private okhttp3.Call listMarginAccountBookAsync(String currency, String currencyPair, String type, Long from, Long to, Integer page, Integer limit, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = listMarginAccountBookValidateBeforeCall(currency, currencyPair, type, from, to, page, limit, _callback); - Type localVarReturnType = new TypeToken>(){}.getType(); + /** + * Retrieve user auto repayment setting (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 Current auto repayment setting -
+ */ + public okhttp3.Call getAutoRepayStatusAsync(final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = getAutoRepayStatusValidateBeforeCall(_callback); + Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } - public class APIlistMarginAccountBookRequest { - private String currency; - private String currencyPair; - private String type; - private Long from; - private Long to; - private Integer page; - private Integer limit; - - private APIlistMarginAccountBookRequest() { - } - - /** - * Set currency - * @param currency List records related to specified currency only. If specified, `currency_pair` is also required. (optional) - * @return APIlistMarginAccountBookRequest - */ - public APIlistMarginAccountBookRequest currency(String currency) { - this.currency = currency; - return this; - } - - /** - * Set currencyPair - * @param currencyPair List records related to specified currency pair. Used in combination with `currency`. Ignored if `currency` is not provided (optional) - * @return APIlistMarginAccountBookRequest - */ - public APIlistMarginAccountBookRequest currencyPair(String currencyPair) { - this.currencyPair = currencyPair; - return this; - } + /** + * Build call for setAutoRepay + * @param status New auto repayment status. `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 -
+ */ + public okhttp3.Call setAutoRepayCall(String status, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = null; - /** - * Set type - * @param type Only retrieve changes of the specified type. All types will be returned if not specified. (optional) - * @return APIlistMarginAccountBookRequest - */ - public APIlistMarginAccountBookRequest type(String type) { - this.type = type; - return this; - } + // create path and map variables + String localVarPath = "/margin/auto_repay"; - /** - * Set from - * @param from Start timestamp of the query (optional) - * @return APIlistMarginAccountBookRequest - */ - public APIlistMarginAccountBookRequest from(Long from) { - this.from = from; - return this; + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + if (status != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("status", status)); } - /** - * Set to - * @param to Time range ending, default to current time (optional) - * @return APIlistMarginAccountBookRequest - */ - public APIlistMarginAccountBookRequest to(Long to) { - this.to = to; - return this; + 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); } - /** - * Set page - * @param page Page number (optional, default to 1) - * @return APIlistMarginAccountBookRequest - */ - public APIlistMarginAccountBookRequest page(Integer page) { - this.page = page; - return this; - } + final String[] localVarContentTypes = { + + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); - /** - * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) - * @return APIlistMarginAccountBookRequest - */ - public APIlistMarginAccountBookRequest limit(Integer limit) { - this.limit = limit; - return this; - } + String[] localVarAuthNames = new String[] { "apiv4" }; + return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } - /** - * Build call for listMarginAccountBook - * @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 listMarginAccountBookCall(currency, currencyPair, type, from, to, page, limit, _callback); + @SuppressWarnings("rawtypes") + private okhttp3.Call setAutoRepayValidateBeforeCall(String status, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'status' is set + if (status == null) { + throw new ApiException("Missing the required parameter 'status' when calling setAutoRepay(Async)"); } - /** - * Execute listMarginAccountBook request - * @return List<MarginAccountBook> - * @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 = listMarginAccountBookWithHttpInfo(currency, currencyPair, type, from, to, page, limit); - return localVarResp.getData(); - } + okhttp3.Call localVarCall = setAutoRepayCall(status, _callback); + return localVarCall; + } - /** - * Execute listMarginAccountBook request with HTTP info returned - * @return ApiResponse<List<MarginAccountBook>> - * @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 listMarginAccountBookWithHttpInfo(currency, currencyPair, type, from, to, page, limit); - } + /** + * Update user's auto repayment setting + * + * @param status New auto repayment status. `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 -
+ */ + public AutoRepaySetting setAutoRepay(String status) throws ApiException { + ApiResponse localVarResp = setAutoRepayWithHttpInfo(status); + return localVarResp.getData(); + } - /** - * Execute listMarginAccountBook 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 listMarginAccountBookAsync(currency, currencyPair, type, from, to, page, limit, _callback); - } + /** + * Update user's auto repayment setting + * + * @param status New auto repayment status. `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 -
+ */ + public ApiResponse setAutoRepayWithHttpInfo(String status) throws ApiException { + okhttp3.Call localVarCall = setAutoRepayValidateBeforeCall(status, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * List margin account balance change history - * Only transferals from and to margin account are provided for now. Time range allows 30 days at most - * @return APIlistMarginAccountBookRequest + * Update user's auto repayment setting (asynchronously) + * + * @param status New auto repayment status. `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 List retrieved -
200 Current auto repayment setting -
*/ - public APIlistMarginAccountBookRequest listMarginAccountBook() { - return new APIlistMarginAccountBookRequest(); + public okhttp3.Call setAutoRepayAsync(String status, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = setAutoRepayValidateBeforeCall(status, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; } - private okhttp3.Call listFundingAccountsCall(String currency, final ApiCallback _callback) throws ApiException { + private okhttp3.Call getMarginTransferableCall(String currency, String currencyPair, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/margin/funding_accounts"; + String localVarPath = "/margin/transferable"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -911,6 +795,10 @@ private okhttp3.Call listFundingAccountsCall(String currency, final ApiCallback localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); } + if (currencyPair != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency_pair", currencyPair)); + } + Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); @@ -933,134 +821,258 @@ private okhttp3.Call listFundingAccountsCall(String currency, final ApiCallback } @SuppressWarnings("rawtypes") - private okhttp3.Call listFundingAccountsValidateBeforeCall(String currency, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = listFundingAccountsCall(currency, _callback); + private okhttp3.Call getMarginTransferableValidateBeforeCall(String currency, String currencyPair, 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 getMarginTransferable(Async)"); + } + + okhttp3.Call localVarCall = getMarginTransferableCall(currency, currencyPair, _callback); return localVarCall; } - private ApiResponse> listFundingAccountsWithHttpInfo(String currency) throws ApiException { - okhttp3.Call localVarCall = listFundingAccountsValidateBeforeCall(currency, null); - Type localVarReturnType = new TypeToken>(){}.getType(); + private ApiResponse getMarginTransferableWithHttpInfo(String currency, String currencyPair) throws ApiException { + okhttp3.Call localVarCall = getMarginTransferableValidateBeforeCall(currency, currencyPair, null); + Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } - private okhttp3.Call listFundingAccountsAsync(String currency, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = listFundingAccountsValidateBeforeCall(currency, _callback); - Type localVarReturnType = new TypeToken>(){}.getType(); + private okhttp3.Call getMarginTransferableAsync(String currency, String currencyPair, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = getMarginTransferableValidateBeforeCall(currency, currencyPair, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } - public class APIlistFundingAccountsRequest { - private String currency; + public class APIgetMarginTransferableRequest { + private final String currency; + private String currencyPair; - private APIlistFundingAccountsRequest() { + private APIgetMarginTransferableRequest(String currency) { + this.currency = currency; } /** - * Set currency - * @param currency Retrieve data of the specified currency (optional) - * @return APIlistFundingAccountsRequest + * Set currencyPair + * @param currencyPair Currency pair (optional) + * @return APIgetMarginTransferableRequest */ - public APIlistFundingAccountsRequest currency(String currency) { - this.currency = currency; + public APIgetMarginTransferableRequest currencyPair(String currencyPair) { + this.currencyPair = currencyPair; return this; } /** - * Build call for listFundingAccounts + * Build call for getMarginTransferable * @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 Successfully retrieved -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { - return listFundingAccountsCall(currency, _callback); + return getMarginTransferableCall(currency, currencyPair, _callback); } /** - * Execute listFundingAccounts request - * @return List<FundingAccount> + * Execute getMarginTransferable request + * @return MarginTransferable * @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 Successfully retrieved -
*/ - public List execute() throws ApiException { - ApiResponse> localVarResp = listFundingAccountsWithHttpInfo(currency); + public MarginTransferable execute() throws ApiException { + ApiResponse localVarResp = getMarginTransferableWithHttpInfo(currency, currencyPair); return localVarResp.getData(); } /** - * Execute listFundingAccounts request with HTTP info returned - * @return ApiResponse<List<FundingAccount>> + * Execute getMarginTransferable request with HTTP info returned + * @return ApiResponse<MarginTransferable> * @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 Successfully retrieved -
*/ - public ApiResponse> executeWithHttpInfo() throws ApiException { - return listFundingAccountsWithHttpInfo(currency); + public ApiResponse executeWithHttpInfo() throws ApiException { + return getMarginTransferableWithHttpInfo(currency, currencyPair); } /** - * Execute listFundingAccounts request (asynchronously) + * Execute getMarginTransferable 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 Successfully retrieved -
*/ - public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { - return listFundingAccountsAsync(currency, _callback); + public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { + return getMarginTransferableAsync(currency, currencyPair, _callback); + } + } + + /** + * Get the max transferable amount for a specific margin currency + * + * @param currency Retrieve data of the specified currency (required) + * @return APIgetMarginTransferableRequest + * @http.response.details + + + +
Status Code Description Response Headers
200 Successfully retrieved -
+ */ + public APIgetMarginTransferableRequest getMarginTransferable(String currency) { + return new APIgetMarginTransferableRequest(currency); + } + + /** + * 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(); } /** - * Funding account list + * Check the user's own leverage lending gradient in the current market * - * @return APIlistFundingAccountsRequest + * @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 Successfully retrieved -
*/ - public APIlistFundingAccountsRequest listFundingAccounts() { - return new APIlistFundingAccountsRequest(); + public ApiResponse> getUserMarginTierWithHttpInfo(String currencyPair) throws ApiException { + okhttp3.Call localVarCall = getUserMarginTierValidateBeforeCall(currencyPair, null); + Type localVarReturnType = new TypeToken>(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * Build call for getAutoRepayStatus + * 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 Current auto repayment setting -
200 Successfully retrieved -
*/ - public okhttp3.Call getAutoRepayStatusCall(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/auto_repay"; + 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(); @@ -1078,97 +1090,101 @@ public okhttp3.Call getAutoRepayStatusCall(final ApiCallback _callback) throws A final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); - String[] localVarAuthNames = new String[] { "apiv4" }; + String[] localVarAuthNames = new String[] { }; return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") - private okhttp3.Call getAutoRepayStatusValidateBeforeCall(final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getAutoRepayStatusCall(_callback); + 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; } /** - * Retrieve user auto repayment setting + * Query the current market leverage lending gradient * - * @return AutoRepaySetting + * @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 Current auto repayment setting -
200 Successfully retrieved -
*/ - public AutoRepaySetting getAutoRepayStatus() throws ApiException { - ApiResponse localVarResp = getAutoRepayStatusWithHttpInfo(); + public List getMarketMarginTier(String currencyPair) throws ApiException { + ApiResponse> localVarResp = getMarketMarginTierWithHttpInfo(currencyPair); return localVarResp.getData(); } /** - * Retrieve user auto repayment setting + * Query the current market leverage lending gradient * - * @return ApiResponse<AutoRepaySetting> + * @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 Current auto repayment setting -
200 Successfully retrieved -
*/ - public ApiResponse getAutoRepayStatusWithHttpInfo() throws ApiException { - okhttp3.Call localVarCall = getAutoRepayStatusValidateBeforeCall(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 user auto repayment setting (asynchronously) + * 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 Current auto repayment setting -
200 Successfully retrieved -
*/ - public okhttp3.Call getAutoRepayStatusAsync(final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getAutoRepayStatusValidateBeforeCall(_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 setAutoRepay - * @param status New auto repayment status. `on` - enabled, `off` - disabled (required) + * 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 Current auto repayment setting -
204 Success -
*/ - public okhttp3.Call setAutoRepayCall(String status, 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/auto_repay"; + String localVarPath = "/margin/leverage/user_market_setting"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); - if (status != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("status", status)); - } - 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) { @@ -1176,7 +1192,7 @@ public okhttp3.Call setAutoRepayCall(String status, final ApiCallback _callback) } final String[] localVarContentTypes = { - + "application/json" }; final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); localVarHeaderParams.put("Content-Type", localVarContentType); @@ -1186,83 +1202,75 @@ public okhttp3.Call setAutoRepayCall(String status, final ApiCallback _callback) } @SuppressWarnings("rawtypes") - private okhttp3.Call setAutoRepayValidateBeforeCall(String status, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'status' is set - if (status == null) { - throw new ApiException("Missing the required parameter 'status' when calling setAutoRepay(Async)"); + 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 = setAutoRepayCall(status, _callback); + okhttp3.Call localVarCall = setUserMarketLeverageCall(marginMarketLeverage, _callback); return localVarCall; } /** - * Update user's auto repayment setting + * Set the user market leverage multiple * - * @param status New auto repayment status. `on` - enabled, `off` - disabled (required) - * @return AutoRepaySetting + * @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 Current auto repayment setting -
204 Success -
*/ - public AutoRepaySetting setAutoRepay(String status) throws ApiException { - ApiResponse localVarResp = setAutoRepayWithHttpInfo(status); - return localVarResp.getData(); + public void setUserMarketLeverage(MarginMarketLeverage marginMarketLeverage) throws ApiException { + setUserMarketLeverageWithHttpInfo(marginMarketLeverage); } /** - * Update user's auto repayment setting + * Set the user market leverage multiple * - * @param status New auto repayment status. `on` - enabled, `off` - disabled (required) - * @return ApiResponse<AutoRepaySetting> + * @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 Current auto repayment setting -
204 Success -
*/ - public ApiResponse setAutoRepayWithHttpInfo(String status) throws ApiException { - okhttp3.Call localVarCall = setAutoRepayValidateBeforeCall(status, 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); } /** - * Update user's auto repayment setting (asynchronously) + * Set the user market leverage multiple (asynchronously) * - * @param status New auto repayment status. `on` - enabled, `off` - disabled (required) + * @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 Current auto repayment setting -
204 Success -
*/ - public okhttp3.Call setAutoRepayAsync(String status, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = setAutoRepayValidateBeforeCall(status, _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 getMarginTransferableCall(String currency, String currencyPair, 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/transferable"; + String localVarPath = "/margin/user/account"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); - if (currency != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); - } - if (currencyPair != null) { localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency_pair", currencyPair)); } @@ -1289,121 +1297,113 @@ private okhttp3.Call getMarginTransferableCall(String currency, String currencyP } @SuppressWarnings("rawtypes") - private okhttp3.Call getMarginTransferableValidateBeforeCall(String currency, String currencyPair, 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 getMarginTransferable(Async)"); - } - - okhttp3.Call localVarCall = getMarginTransferableCall(currency, currencyPair, _callback); + private okhttp3.Call listMarginUserAccountValidateBeforeCall(String currencyPair, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = listMarginUserAccountCall(currencyPair, _callback); return localVarCall; } - private ApiResponse getMarginTransferableWithHttpInfo(String currency, String currencyPair) throws ApiException { - okhttp3.Call localVarCall = getMarginTransferableValidateBeforeCall(currency, currencyPair, 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 getMarginTransferableAsync(String currency, String currencyPair, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getMarginTransferableValidateBeforeCall(currency, currencyPair, _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 APIgetMarginTransferableRequest { - private final String currency; + public class APIlistMarginUserAccountRequest { private String currencyPair; - private APIgetMarginTransferableRequest(String currency) { - this.currency = currency; + private APIlistMarginUserAccountRequest() { } /** * Set currencyPair * @param currencyPair Currency pair (optional) - * @return APIgetMarginTransferableRequest + * @return APIlistMarginUserAccountRequest */ - public APIgetMarginTransferableRequest currencyPair(String currencyPair) { + public APIlistMarginUserAccountRequest currencyPair(String currencyPair) { this.currencyPair = currencyPair; return this; } /** - * Build call for getMarginTransferable + * 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 Successfully retrieved -
200 List retrieved -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { - return getMarginTransferableCall(currency, currencyPair, _callback); + return listMarginUserAccountCall(currencyPair, _callback); } /** - * Execute getMarginTransferable request - * @return MarginTransferable + * 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 Successfully retrieved -
200 List retrieved -
*/ - public MarginTransferable execute() throws ApiException { - ApiResponse localVarResp = getMarginTransferableWithHttpInfo(currency, currencyPair); + public List execute() throws ApiException { + ApiResponse> localVarResp = listMarginUserAccountWithHttpInfo(currencyPair); return localVarResp.getData(); } /** - * Execute getMarginTransferable request with HTTP info returned - * @return ApiResponse<MarginTransferable> + * 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 Successfully retrieved -
200 List retrieved -
*/ - public ApiResponse executeWithHttpInfo() throws ApiException { - return getMarginTransferableWithHttpInfo(currency, currencyPair); + public ApiResponse> executeWithHttpInfo() throws ApiException { + return listMarginUserAccountWithHttpInfo(currencyPair); } /** - * Execute getMarginTransferable 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 Successfully retrieved -
200 List retrieved -
*/ - public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { - return getMarginTransferableAsync(currency, currencyPair, _callback); + public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { + return listMarginUserAccountAsync(currencyPair, _callback); } } /** - * Get the max transferable amount for a specific margin currency - * - * @param currency Retrieve data of the specified currency (required) - * @return APIgetMarginTransferableRequest + * 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 Successfully retrieved -
200 List retrieved -
*/ - public APIgetMarginTransferableRequest getMarginTransferable(String currency) { - return new APIgetMarginTransferableRequest(currency); + 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 { diff --git a/src/main/java/io/gate/gateapi/api/MarginUniApi.java b/src/main/java/io/gate/gateapi/api/MarginUniApi.java index eb3bf3f..9b36535 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 @@ -150,211 +150,24 @@ public okhttp3.Call listUniCurrencyPairsAsync(final ApiCallback localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - if (currencyPair != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency_pair", currencyPair)); - } - - 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)); - } - - 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 listUniLoansValidateBeforeCall(String currencyPair, String currency, Integer page, Integer limit, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = listUniLoansCall(currencyPair, currency, page, limit, _callback); - return localVarCall; - } - - - private ApiResponse> listUniLoansWithHttpInfo(String currencyPair, String currency, Integer page, Integer limit) throws ApiException { - okhttp3.Call localVarCall = listUniLoansValidateBeforeCall(currencyPair, currency, page, limit, null); - Type localVarReturnType = new TypeToken>(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - private okhttp3.Call listUniLoansAsync(String currencyPair, String currency, Integer page, Integer limit, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = listUniLoansValidateBeforeCall(currencyPair, currency, page, limit, _callback); - Type localVarReturnType = new TypeToken>(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - public class APIlistUniLoansRequest { - private String currencyPair; - private String currency; - private Integer page; - private Integer limit; - - private APIlistUniLoansRequest() { - } - - /** - * Set currencyPair - * @param currencyPair Currency pair (optional) - * @return APIlistUniLoansRequest - */ - public APIlistUniLoansRequest currencyPair(String currencyPair) { - this.currencyPair = currencyPair; - return this; - } - - /** - * Set currency - * @param currency Retrieve data of the specified currency (optional) - * @return APIlistUniLoansRequest - */ - public APIlistUniLoansRequest currency(String currency) { - this.currency = currency; - return this; - } - - /** - * Set page - * @param page Page number (optional, default to 1) - * @return APIlistUniLoansRequest - */ - public APIlistUniLoansRequest 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 APIlistUniLoansRequest - */ - public APIlistUniLoansRequest limit(Integer limit) { - this.limit = limit; - return this; - } - - /** - * Build call for listUniLoans - * @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 -
- */ - public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { - return listUniLoansCall(currencyPair, currency, page, limit, _callback); - } - - /** - * Execute listUniLoans request - * @return List<UniLoan> - * @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 execute() throws ApiException { - ApiResponse> localVarResp = listUniLoansWithHttpInfo(currencyPair, currency, page, limit); - return localVarResp.getData(); - } - - /** - * Execute listUniLoans request with HTTP info returned - * @return ApiResponse<List<UniLoan>> - * @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> executeWithHttpInfo() throws ApiException { - return listUniLoansWithHttpInfo(currencyPair, currency, page, limit); - } - - /** - * Execute listUniLoans 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 -
- */ - public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { - return listUniLoansAsync(currencyPair, currency, page, limit, _callback); - } - } - /** - * List loans - * - * @return APIlistUniLoansRequest - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- */ - public APIlistUniLoansRequest listUniLoans() { - return new APIlistUniLoansRequest(); - } - - /** - * Build call for createUniLoan - * @param createUniLoan (required) + * Build call for getUniCurrencyPair + * @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
204 Operated successfully -
200 Successfully retrieved -
*/ - public okhttp3.Call createUniLoanCall(CreateUniLoan createUniLoan, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = createUniLoan; + public okhttp3.Call getUniCurrencyPairCall(String currencyPair, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = null; // create path and map variables - String localVarPath = "/margin/uni/loans"; + String localVarPath = "/margin/uni/currency_pairs/{currency_pair}" + .replaceAll("\\{" + "currency_pair" + "\\}", localVarApiClient.escapeString(currencyPair)); List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); @@ -362,7 +175,7 @@ public okhttp3.Call createUniLoanCall(CreateUniLoan createUniLoan, final ApiCall Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - + "application/json" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -370,81 +183,84 @@ public okhttp3.Call createUniLoanCall(CreateUniLoan createUniLoan, final ApiCall } 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); + String[] localVarAuthNames = new String[] { }; + return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); } @SuppressWarnings("rawtypes") - private okhttp3.Call createUniLoanValidateBeforeCall(CreateUniLoan createUniLoan, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'createUniLoan' is set - if (createUniLoan == null) { - throw new ApiException("Missing the required parameter 'createUniLoan' when calling createUniLoan(Async)"); + private okhttp3.Call getUniCurrencyPairValidateBeforeCall(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 getUniCurrencyPair(Async)"); } - okhttp3.Call localVarCall = createUniLoanCall(createUniLoan, _callback); + okhttp3.Call localVarCall = getUniCurrencyPairCall(currencyPair, _callback); return localVarCall; } /** - * Borrow or repay + * Get detail of lending market * - * @param createUniLoan (required) + * @param currencyPair Currency pair (required) + * @return UniCurrencyPair * @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 -
200 Successfully retrieved -
*/ - public void createUniLoan(CreateUniLoan createUniLoan) throws ApiException { - createUniLoanWithHttpInfo(createUniLoan); + public UniCurrencyPair getUniCurrencyPair(String currencyPair) throws ApiException { + ApiResponse localVarResp = getUniCurrencyPairWithHttpInfo(currencyPair); + return localVarResp.getData(); } /** - * Borrow or repay + * Get detail of lending market * - * @param createUniLoan (required) - * @return ApiResponse<Void> + * @param currencyPair Currency pair (required) + * @return ApiResponse<UniCurrencyPair> * @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 -
200 Successfully retrieved -
*/ - public ApiResponse createUniLoanWithHttpInfo(CreateUniLoan createUniLoan) throws ApiException { - okhttp3.Call localVarCall = createUniLoanValidateBeforeCall(createUniLoan, null); - return localVarApiClient.execute(localVarCall); + public ApiResponse getUniCurrencyPairWithHttpInfo(String currencyPair) throws ApiException { + okhttp3.Call localVarCall = getUniCurrencyPairValidateBeforeCall(currencyPair, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * Borrow or repay (asynchronously) + * Get detail of lending market (asynchronously) * - * @param createUniLoan (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
204 Operated successfully -
200 Successfully retrieved -
*/ - public okhttp3.Call createUniLoanAsync(CreateUniLoan createUniLoan, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = createUniLoanValidateBeforeCall(createUniLoan, _callback); - localVarApiClient.executeAsync(localVarCall, _callback); + public okhttp3.Call getUniCurrencyPairAsync(String currencyPair, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = getUniCurrencyPairValidateBeforeCall(currencyPair, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } /** - * Build call for getUniBorrowable - * @param currency Retrieve data of the specified currency (required) - * @param currencyPair Currency pair (required) + * Build call for getMarginUniEstimateRate + * @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 @@ -454,20 +270,16 @@ public okhttp3.Call createUniLoanAsync(CreateUniLoan createUniLoan, final ApiCal 200 Successfully retrieved - */ - public okhttp3.Call getUniBorrowableCall(String currency, String currencyPair, final ApiCallback _callback) throws ApiException { + public okhttp3.Call getMarginUniEstimateRateCall(List currencies, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/margin/uni/borrowable"; + String localVarPath = "/margin/uni/estimate_rate"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); - if (currency != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); - } - - if (currencyPair != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency_pair", currencyPair)); + if (currencies != null) { + localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "currencies", currencies)); } Map localVarHeaderParams = new HashMap(); @@ -492,27 +304,21 @@ public okhttp3.Call getUniBorrowableCall(String currency, String currencyPair, f } @SuppressWarnings("rawtypes") - private okhttp3.Call getUniBorrowableValidateBeforeCall(String currency, String currencyPair, 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 getUniBorrowable(Async)"); - } - - // verify the required parameter 'currencyPair' is set - if (currencyPair == null) { - throw new ApiException("Missing the required parameter 'currencyPair' when calling getUniBorrowable(Async)"); + private okhttp3.Call getMarginUniEstimateRateValidateBeforeCall(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 getMarginUniEstimateRate(Async)"); } - okhttp3.Call localVarCall = getUniBorrowableCall(currency, currencyPair, _callback); + okhttp3.Call localVarCall = getMarginUniEstimateRateCall(currencies, _callback); return localVarCall; } /** - * Get maximum borrowable - * - * @param currency Retrieve data of the specified currency (required) - * @param currencyPair Currency pair (required) - * @return MaxUniBorrowable + * 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) + * @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 @@ -520,17 +326,16 @@ private okhttp3.Call getUniBorrowableValidateBeforeCall(String currency, String
200 Successfully retrieved -
*/ - public MaxUniBorrowable getUniBorrowable(String currency, String currencyPair) throws ApiException { - ApiResponse localVarResp = getUniBorrowableWithHttpInfo(currency, currencyPair); + public Map getMarginUniEstimateRate(List currencies) throws ApiException { + ApiResponse> localVarResp = getMarginUniEstimateRateWithHttpInfo(currencies); return localVarResp.getData(); } /** - * Get maximum borrowable - * - * @param currency Retrieve data of the specified currency (required) - * @param currencyPair Currency pair (required) - * @return ApiResponse<MaxUniBorrowable> + * 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) + * @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 @@ -538,17 +343,16 @@ public MaxUniBorrowable getUniBorrowable(String currency, String currencyPair) t
200 Successfully retrieved -
*/ - public ApiResponse getUniBorrowableWithHttpInfo(String currency, String currencyPair) throws ApiException { - okhttp3.Call localVarCall = getUniBorrowableValidateBeforeCall(currency, currencyPair, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse> getMarginUniEstimateRateWithHttpInfo(List currencies) throws ApiException { + okhttp3.Call localVarCall = getMarginUniEstimateRateValidateBeforeCall(currencies, null); + Type localVarReturnType = new TypeToken>(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } /** - * Get maximum borrowable (asynchronously) - * - * @param currency Retrieve data of the specified currency (required) - * @param currencyPair Currency pair (required) + * 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) * @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 @@ -558,34 +362,37 @@ public ApiResponse getUniBorrowableWithHttpInfo(String currenc 200 Successfully retrieved - */ - public okhttp3.Call getUniBorrowableAsync(String currency, String currencyPair, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getUniBorrowableValidateBeforeCall(currency, currencyPair, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); + public okhttp3.Call getMarginUniEstimateRateAsync(List currencies, final ApiCallback> _callback) throws ApiException { + okhttp3.Call localVarCall = getMarginUniEstimateRateValidateBeforeCall(currencies, _callback); + Type localVarReturnType = new TypeToken>(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } - /** - * Build call for getUniCurrencyPair - * @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 getUniCurrencyPairCall(String currencyPair, final ApiCallback _callback) throws ApiException { + private okhttp3.Call listUniLoansCall(String currencyPair, String currency, Integer page, Integer limit, final ApiCallback _callback) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/margin/uni/currency_pairs/{currency_pair}" - .replaceAll("\\{" + "currency_pair" + "\\}", localVarApiClient.escapeString(currencyPair)); + String localVarPath = "/margin/uni/loans"; List localVarQueryParams = new ArrayList(); List localVarCollectionQueryParams = new ArrayList(); + if (currencyPair != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency_pair", currencyPair)); + } + + 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)); + } + Map localVarHeaderParams = new HashMap(); Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); @@ -603,105 +410,178 @@ public okhttp3.Call getUniCurrencyPairCall(String currencyPair, final ApiCallbac 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); } @SuppressWarnings("rawtypes") - private okhttp3.Call getUniCurrencyPairValidateBeforeCall(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 getUniCurrencyPair(Async)"); - } - - okhttp3.Call localVarCall = getUniCurrencyPairCall(currencyPair, _callback); + private okhttp3.Call listUniLoansValidateBeforeCall(String currencyPair, String currency, Integer page, Integer limit, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = listUniLoansCall(currencyPair, currency, page, limit, _callback); return localVarCall; } - /** - * Get detail of lending market - * - * @param currencyPair Currency pair (required) - * @return UniCurrencyPair - * @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 UniCurrencyPair getUniCurrencyPair(String currencyPair) throws ApiException { - ApiResponse localVarResp = getUniCurrencyPairWithHttpInfo(currencyPair); - return localVarResp.getData(); + + private ApiResponse> listUniLoansWithHttpInfo(String currencyPair, String currency, Integer page, Integer limit) throws ApiException { + okhttp3.Call localVarCall = listUniLoansValidateBeforeCall(currencyPair, currency, page, limit, null); + Type localVarReturnType = new TypeToken>(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); } - /** - * Get detail of lending market - * - * @param currencyPair Currency pair (required) - * @return ApiResponse<UniCurrencyPair> - * @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 getUniCurrencyPairWithHttpInfo(String currencyPair) throws ApiException { - okhttp3.Call localVarCall = getUniCurrencyPairValidateBeforeCall(currencyPair, null); - Type localVarReturnType = new TypeToken(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); + private okhttp3.Call listUniLoansAsync(String currencyPair, String currency, Integer page, Integer limit, final ApiCallback> _callback) throws ApiException { + okhttp3.Call localVarCall = listUniLoansValidateBeforeCall(currencyPair, currency, page, limit, _callback); + Type localVarReturnType = new TypeToken>(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + + public class APIlistUniLoansRequest { + private String currencyPair; + private String currency; + private Integer page; + private Integer limit; + + private APIlistUniLoansRequest() { + } + + /** + * Set currencyPair + * @param currencyPair Currency pair (optional) + * @return APIlistUniLoansRequest + */ + public APIlistUniLoansRequest currencyPair(String currencyPair) { + this.currencyPair = currencyPair; + return this; + } + + /** + * Set currency + * @param currency Retrieve data of the specified currency (optional) + * @return APIlistUniLoansRequest + */ + public APIlistUniLoansRequest currency(String currency) { + this.currency = currency; + return this; + } + + /** + * Set page + * @param page Page number (optional, default to 1) + * @return APIlistUniLoansRequest + */ + public APIlistUniLoansRequest 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 APIlistUniLoansRequest + */ + public APIlistUniLoansRequest limit(Integer limit) { + this.limit = limit; + return this; + } + + /** + * Build call for listUniLoans + * @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 -
+ */ + public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { + return listUniLoansCall(currencyPair, currency, page, limit, _callback); + } + + /** + * Execute listUniLoans request + * @return List<UniLoan> + * @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 execute() throws ApiException { + ApiResponse> localVarResp = listUniLoansWithHttpInfo(currencyPair, currency, page, limit); + return localVarResp.getData(); + } + + /** + * Execute listUniLoans request with HTTP info returned + * @return ApiResponse<List<UniLoan>> + * @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> executeWithHttpInfo() throws ApiException { + return listUniLoansWithHttpInfo(currencyPair, currency, page, limit); + } + + /** + * Execute listUniLoans 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 -
+ */ + public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { + return listUniLoansAsync(currencyPair, currency, page, limit, _callback); + } } /** - * Get detail of lending market (asynchronously) + * List loans * - * @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 + * @return APIlistUniLoansRequest * @http.response.details
Status Code Description Response Headers
200 Successfully retrieved -
*/ - public okhttp3.Call getUniCurrencyPairAsync(String currencyPair, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getUniCurrencyPairValidateBeforeCall(currencyPair, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; + public APIlistUniLoansRequest listUniLoans() { + return new APIlistUniLoansRequest(); } /** - * Build call for getMarginUniEstimateRate - * @param currencies An array of up to 10 specifying the currency name (required) + * Build call for createUniLoan + * @param createUniLoan (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 Operated successfully -
*/ - public okhttp3.Call getMarginUniEstimateRateCall(List currencies, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; + public okhttp3.Call createUniLoanCall(CreateUniLoan createUniLoan, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = createUniLoan; // create path and map variables - String localVarPath = "/margin/uni/estimate_rate"; + String localVarPath = "/margin/uni/loans"; 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) { @@ -709,78 +589,74 @@ public okhttp3.Call getMarginUniEstimateRateCall(List currencies, final } 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); } @SuppressWarnings("rawtypes") - private okhttp3.Call getMarginUniEstimateRateValidateBeforeCall(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 getMarginUniEstimateRate(Async)"); + private okhttp3.Call createUniLoanValidateBeforeCall(CreateUniLoan createUniLoan, final ApiCallback _callback) throws ApiException { + // verify the required parameter 'createUniLoan' is set + if (createUniLoan == null) { + throw new ApiException("Missing the required parameter 'createUniLoan' when calling createUniLoan(Async)"); } - okhttp3.Call localVarCall = getMarginUniEstimateRateCall(currencies, _callback); + okhttp3.Call localVarCall = createUniLoanCall(createUniLoan, _callback); return localVarCall; } /** - * 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) - * @return Map<String, String> + * Borrow or repay + * + * @param createUniLoan (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 Operated successfully -
*/ - public Map getMarginUniEstimateRate(List currencies) throws ApiException { - ApiResponse> localVarResp = getMarginUniEstimateRateWithHttpInfo(currencies); - return localVarResp.getData(); + public void createUniLoan(CreateUniLoan createUniLoan) throws ApiException { + createUniLoanWithHttpInfo(createUniLoan); } /** - * 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) - * @return ApiResponse<Map<String, String>> + * Borrow or repay + * + * @param createUniLoan (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 Operated successfully -
*/ - public ApiResponse> getMarginUniEstimateRateWithHttpInfo(List currencies) throws ApiException { - okhttp3.Call localVarCall = getMarginUniEstimateRateValidateBeforeCall(currencies, null); - Type localVarReturnType = new TypeToken>(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); + public ApiResponse createUniLoanWithHttpInfo(CreateUniLoan createUniLoan) throws ApiException { + okhttp3.Call localVarCall = createUniLoanValidateBeforeCall(createUniLoan, null); + return localVarApiClient.execute(localVarCall); } /** - * 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) + * Borrow or repay (asynchronously) + * + * @param createUniLoan (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 Operated successfully -
*/ - public okhttp3.Call getMarginUniEstimateRateAsync(List currencies, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = getMarginUniEstimateRateValidateBeforeCall(currencies, _callback); - Type localVarReturnType = new TypeToken>(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + public okhttp3.Call createUniLoanAsync(CreateUniLoan createUniLoan, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = createUniLoanValidateBeforeCall(createUniLoan, _callback); + localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } @@ -1205,4 +1081,128 @@ public APIlistUniLoanInterestRecordsRequest listUniLoanInterestRecords() { return new APIlistUniLoanInterestRecordsRequest(); } + /** + * Build call for getUniBorrowable + * @param currency Retrieve data of the specified currency (required) + * @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 getUniBorrowableCall(String currency, String currencyPair, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/margin/uni/borrowable"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + if (currency != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); + } + + 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 getUniBorrowableValidateBeforeCall(String currency, String currencyPair, 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 getUniBorrowable(Async)"); + } + + // verify the required parameter 'currencyPair' is set + if (currencyPair == null) { + throw new ApiException("Missing the required parameter 'currencyPair' when calling getUniBorrowable(Async)"); + } + + okhttp3.Call localVarCall = getUniBorrowableCall(currency, currencyPair, _callback); + return localVarCall; + } + + /** + * Get maximum borrowable + * + * @param currency Retrieve data of the specified currency (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 -
+ */ + public MaxUniBorrowable getUniBorrowable(String currency, String currencyPair) throws ApiException { + ApiResponse localVarResp = getUniBorrowableWithHttpInfo(currency, currencyPair); + return localVarResp.getData(); + } + + /** + * Get maximum borrowable + * + * @param currency Retrieve data of the specified currency (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 -
+ */ + public ApiResponse getUniBorrowableWithHttpInfo(String currency, String currencyPair) throws ApiException { + okhttp3.Call localVarCall = getUniBorrowableValidateBeforeCall(currency, currencyPair, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * Get maximum borrowable (asynchronously) + * + * @param currency Retrieve data of the specified currency (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 -
+ */ + public okhttp3.Call getUniBorrowableAsync(String currency, String currencyPair, final ApiCallback _callback) throws ApiException { + okhttp3.Call localVarCall = getUniBorrowableValidateBeforeCall(currency, currencyPair, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + } diff --git a/src/main/java/io/gate/gateapi/api/MultiCollateralLoanApi.java b/src/main/java/io/gate/gateapi/api/MultiCollateralLoanApi.java index 2498e2c..72b6fc0 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/api/OptionsApi.java b/src/main/java/io/gate/gateapi/api/OptionsApi.java index bf72060..6a67e6e 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/api/RebateApi.java b/src/main/java/io/gate/gateapi/api/RebateApi.java index e003871..f42cdbf 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/api/SpotApi.java b/src/main/java/io/gate/gateapi/api/SpotApi.java index 57ec9a2..36ac7e9 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/api/SubAccountApi.java b/src/main/java/io/gate/gateapi/api/SubAccountApi.java index c38c1c7..a997a64 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 @@ -579,7 +579,7 @@ private okhttp3.Call createSubAccountKeysValidateBeforeCall(Long userId, SubAcco * * @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 @@ -587,8 +587,8 @@ private okhttp3.Call createSubAccountKeysValidateBeforeCall(Long userId, SubAcco
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(); } @@ -597,7 +597,7 @@ public List createSubAccountKeys(Long userId, SubAccountKey subAc * * @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 @@ -605,9 +605,9 @@ public List createSubAccountKeys(Long userId, SubAccountKey subAc
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); } @@ -625,9 +625,9 @@ public ApiResponse> createSubAccountKeysWithHttpInfo(Long us 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; } diff --git a/src/main/java/io/gate/gateapi/api/UnifiedApi.java b/src/main/java/io/gate/gateapi/api/UnifiedApi.java index 9bbce68..17552a1 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/api/WalletApi.java b/src/main/java/io/gate/gateapi/api/WalletApi.java index d2d06df..881db12 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 @@ -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; @@ -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; } @@ -993,7 +994,7 @@ 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 @@ -1001,14 +1002,14 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException {
200 List retrieved -
*/ - 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 @@ -1016,7 +1017,7 @@ public List execute() throws ApiException {
200 List retrieved -
*/ - public ApiResponse> executeWithHttpInfo() throws ApiException { + public ApiResponse> executeWithHttpInfo() throws ApiException { return listSubAccountTransfersWithHttpInfo(subUid, from, to, limit, offset); } @@ -1031,7 +1032,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExc 200 List retrieved - */ - 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); } } diff --git a/src/main/java/io/gate/gateapi/api/WithdrawalApi.java b/src/main/java/io/gate/gateapi/api/WithdrawalApi.java index da7aace..fa3953c 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/auth/ApiKeyAuth.java b/src/main/java/io/gate/gateapi/auth/ApiKeyAuth.java index 6343a66..37cf408 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/auth/Authentication.java b/src/main/java/io/gate/gateapi/auth/Authentication.java index c5f00a3..390efb7 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/auth/GateApiV4Auth.java b/src/main/java/io/gate/gateapi/auth/GateApiV4Auth.java index f9fcad8..99d20e0 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/auth/HttpBasicAuth.java b/src/main/java/io/gate/gateapi/auth/HttpBasicAuth.java index ad2d6ac..297bfe4 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/auth/HttpBearerAuth.java b/src/main/java/io/gate/gateapi/auth/HttpBearerAuth.java index cead920..2be20ae 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/AccountBalance.java b/src/main/java/io/gate/gateapi/models/AccountBalance.java index 80f6227..b2d95a7 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/AccountBookResponse.java b/src/main/java/io/gate/gateapi/models/AccountBookResponse.java new file mode 100644 index 0000000..d920074 --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/AccountBookResponse.java @@ -0,0 +1,193 @@ +/* + * Gate API v4 + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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; + +/** + * Quotation Response + */ +public class AccountBookResponse { + public static final String SERIALIZED_NAME_ID = "id"; + @SerializedName(SERIALIZED_NAME_ID) + private Long 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 AccountBookResponse id(Long id) { + + this.id = id; + return this; + } + + /** + * Order ID + * @return id + **/ + @javax.annotation.Nullable + public Long getId() { + return id; + } + + + public void setId(Long id) { + this.id = id; + } + + public AccountBookResponse time(Long time) { + + this.time = time; + return this; + } + + /** + * 操作时间戳 + * @return time + **/ + @javax.annotation.Nullable + public Long getTime() { + return time; + } + + + public void setTime(Long time) { + this.time = time; + } + + public AccountBookResponse currency(String currency) { + + this.currency = currency; + return this; + } + + /** + * Currency name + * @return currency + **/ + @javax.annotation.Nullable + public String getCurrency() { + return currency; + } + + + public void setCurrency(String currency) { + this.currency = currency; + } + + public AccountBookResponse change(String change) { + + this.change = change; + return this; + } + + /** + * Change amount + * @return change + **/ + @javax.annotation.Nullable + public String getChange() { + return change; + } + + + public void setChange(String change) { + this.change = change; + } + + public AccountBookResponse balance(String balance) { + + this.balance = balance; + return this; + } + + /** + * 变更后余额 + * @return balance + **/ + @javax.annotation.Nullable + public String getBalance() { + return balance; + } + + + public void setBalance(String balance) { + this.balance = balance; + } + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + AccountBookResponse accountBookResponse = (AccountBookResponse) o; + return Objects.equals(this.id, accountBookResponse.id) && + Objects.equals(this.time, accountBookResponse.time) && + Objects.equals(this.currency, accountBookResponse.currency) && + Objects.equals(this.change, accountBookResponse.change) && + Objects.equals(this.balance, accountBookResponse.balance); + } + + @Override + public int hashCode() { + return Objects.hash(id, time, currency, change, balance); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class AccountBookResponse {\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("}"); + 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/AccountDetail.java b/src/main/java/io/gate/gateapi/models/AccountDetail.java index cb88f43..647b86c 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/AccountDetailKey.java b/src/main/java/io/gate/gateapi/models/AccountDetailKey.java index 2c6f05e..a8053e5 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/AccountRateLimit.java b/src/main/java/io/gate/gateapi/models/AccountRateLimit.java index d6a4513..5c2f684 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/AccountsResponse.java b/src/main/java/io/gate/gateapi/models/AccountsResponse.java new file mode 100644 index 0000000..01481a0 --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/AccountsResponse.java @@ -0,0 +1,193 @@ +/* + * Gate API v4 + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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; + +/** + * Quotation Response + */ +public class AccountsResponse { + public static final String SERIALIZED_NAME_CURRENCY = "currency"; + @SerializedName(SERIALIZED_NAME_CURRENCY) + private String currency; + + public static final String SERIALIZED_NAME_AVAILABLE = "available"; + @SerializedName(SERIALIZED_NAME_AVAILABLE) + private String available; + + public static final String SERIALIZED_NAME_LOCKED = "locked"; + @SerializedName(SERIALIZED_NAME_LOCKED) + private String locked; + + public static final String SERIALIZED_NAME_TOKEN_ADDRESS = "token_address"; + @SerializedName(SERIALIZED_NAME_TOKEN_ADDRESS) + private String tokenAddress; + + public static final String SERIALIZED_NAME_CHAIN = "chain"; + @SerializedName(SERIALIZED_NAME_CHAIN) + private String chain; + + + public AccountsResponse currency(String currency) { + + this.currency = currency; + return this; + } + + /** + * Currency name + * @return currency + **/ + @javax.annotation.Nullable + public String getCurrency() { + return currency; + } + + + public void setCurrency(String currency) { + this.currency = currency; + } + + public AccountsResponse available(String available) { + + this.available = available; + return this; + } + + /** + * Available Balance + * @return available + **/ + @javax.annotation.Nullable + public String getAvailable() { + return available; + } + + + public void setAvailable(String available) { + this.available = available; + } + + public AccountsResponse locked(String locked) { + + this.locked = locked; + return this; + } + + /** + * 锁定余额 + * @return locked + **/ + @javax.annotation.Nullable + public String getLocked() { + return locked; + } + + + public void setLocked(String locked) { + this.locked = locked; + } + + public AccountsResponse tokenAddress(String tokenAddress) { + + this.tokenAddress = tokenAddress; + return this; + } + + /** + * token 地址 + * @return tokenAddress + **/ + @javax.annotation.Nullable + public String getTokenAddress() { + return tokenAddress; + } + + + public void setTokenAddress(String tokenAddress) { + this.tokenAddress = tokenAddress; + } + + public AccountsResponse chain(String chain) { + + this.chain = chain; + return this; + } + + /** + * 区块链名称 + * @return chain + **/ + @javax.annotation.Nullable + public String getChain() { + return chain; + } + + + public void setChain(String chain) { + this.chain = chain; + } + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + AccountsResponse accountsResponse = (AccountsResponse) o; + return Objects.equals(this.currency, accountsResponse.currency) && + Objects.equals(this.available, accountsResponse.available) && + Objects.equals(this.locked, accountsResponse.locked) && + Objects.equals(this.tokenAddress, accountsResponse.tokenAddress) && + Objects.equals(this.chain, accountsResponse.chain); + } + + @Override + public int hashCode() { + return Objects.hash(currency, available, locked, tokenAddress, chain); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class AccountsResponse {\n"); + sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); + sb.append(" available: ").append(toIndentedString(available)).append("\n"); + sb.append(" locked: ").append(toIndentedString(locked)).append("\n"); + sb.append(" tokenAddress: ").append(toIndentedString(tokenAddress)).append("\n"); + sb.append(" chain: ").append(toIndentedString(chain)).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/AgencyCommission.java b/src/main/java/io/gate/gateapi/models/AgencyCommission.java index d3320fc..8171852 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/AgencyCommissionHistory.java b/src/main/java/io/gate/gateapi/models/AgencyCommissionHistory.java index dd4e664..5fbdc17 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/AgencyTransaction.java b/src/main/java/io/gate/gateapi/models/AgencyTransaction.java index d540e15..6628f54 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/AgencyTransactionHistory.java b/src/main/java/io/gate/gateapi/models/AgencyTransactionHistory.java index 0f7c5ab..510d774 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/AutoRepaySetting.java b/src/main/java/io/gate/gateapi/models/AutoRepaySetting.java index 288eae2..ddbee40 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/BatchAmendItem.java b/src/main/java/io/gate/gateapi/models/BatchAmendItem.java index 0f9c4d4..3aeb958 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/BatchAmendOrderReq.java b/src/main/java/io/gate/gateapi/models/BatchAmendOrderReq.java index 96e4d05..57fc9cb 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/BatchFuturesOrder.java b/src/main/java/io/gate/gateapi/models/BatchFuturesOrder.java index 02a7b10..182e716 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/BatchOrder.java b/src/main/java/io/gate/gateapi/models/BatchOrder.java index f3d7ef3..ec901d1 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/BorrowCurrencyInfo.java b/src/main/java/io/gate/gateapi/models/BorrowCurrencyInfo.java index c10a506..524d80b 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/BrokerCommission.java b/src/main/java/io/gate/gateapi/models/BrokerCommission.java index c2cb3d1..adbfdec 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/BrokerCommission1.java b/src/main/java/io/gate/gateapi/models/BrokerCommission1.java index fe4d793..479fe34 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 @@ -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,10 @@ 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 BrokerCommission1 commissionTime(Long commissionTime) { @@ -239,6 +244,26 @@ 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; + } @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -256,12 +281,13 @@ 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); } @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); } @@ -278,6 +304,7 @@ 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("}"); 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..4f5a83a --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/BrokerCommissionSubBrokerInfo.java @@ -0,0 +1,167 @@ +/* + * Gate API v4 + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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; + +/** + * The sub broker info + */ +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; + } + + /** + * The 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; + } + + /** + * The 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; + } + + /** + * The 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; + } + + /** + * The 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..62c9606 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/BrokerTransaction1.java b/src/main/java/io/gate/gateapi/models/BrokerTransaction1.java index 4e38a49..36b5444 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 @@ -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,10 @@ 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 BrokerTransaction1 transactionTime(Long transactionTime) { @@ -215,6 +220,26 @@ 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; + } @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -231,12 +256,13 @@ 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); } @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); } @@ -252,6 +278,7 @@ 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("}"); 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..e2e79a3 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/CancelOrderResult.java b/src/main/java/io/gate/gateapi/models/CancelOrderResult.java index 7e5bb4e..5464847 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/CollateralAdjust.java b/src/main/java/io/gate/gateapi/models/CollateralAdjust.java index ce56342..fa20e51 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/CollateralAdjustRes.java b/src/main/java/io/gate/gateapi/models/CollateralAdjustRes.java index e8cd013..0a93ae6 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/CollateralAlign.java b/src/main/java/io/gate/gateapi/models/CollateralAlign.java index 3dd0aed..99db007 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/CollateralCurrency.java b/src/main/java/io/gate/gateapi/models/CollateralCurrency.java index 042a3a3..67fc4dd 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/CollateralCurrencyInfo.java b/src/main/java/io/gate/gateapi/models/CollateralCurrencyInfo.java index f692695..ff7646e 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/CollateralCurrencyRes.java b/src/main/java/io/gate/gateapi/models/CollateralCurrencyRes.java index 29d3547..144f3ca 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/CollateralCurrentRate.java b/src/main/java/io/gate/gateapi/models/CollateralCurrentRate.java index 0f3a7b1..ede877e 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/CollateralFixRate.java b/src/main/java/io/gate/gateapi/models/CollateralFixRate.java index 4ec9869..9361585 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/CollateralLoanCurrency.java b/src/main/java/io/gate/gateapi/models/CollateralLoanCurrency.java index eec6011..46b0271 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/CollateralLtv.java b/src/main/java/io/gate/gateapi/models/CollateralLtv.java index 28c753c..1cf5fb9 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/CollateralOrder.java b/src/main/java/io/gate/gateapi/models/CollateralOrder.java index f1defb4..a1a3b02 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/CollateralRecord.java b/src/main/java/io/gate/gateapi/models/CollateralRecord.java index 9b505cb..0a7181e 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/Contract.java b/src/main/java/io/gate/gateapi/models/Contract.java index df9c60c..adc06f9 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 @@ -261,6 +261,14 @@ 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 Contract name(String name) { @@ -981,6 +989,46 @@ 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, trading, delisting, delisted + * @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; + } + + /** + * 合约开盘时间 + * @return launchTime + **/ + @javax.annotation.Nullable + public Long getLaunchTime() { + return launchTime; + } + + + public void setLaunchTime(Long launchTime) { + this.launchTime = launchTime; + } @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -1025,12 +1073,14 @@ 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); } @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); } @@ -1074,6 +1124,8 @@ 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("}"); 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..b020622 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/ConvertSmallBalance.java b/src/main/java/io/gate/gateapi/models/ConvertSmallBalance.java index 0ac22b9..c7c919b 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/CountdownCancelAllFuturesTask.java b/src/main/java/io/gate/gateapi/models/CountdownCancelAllFuturesTask.java index 380e9af..53ff573 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/CountdownCancelAllOptionsTask.java b/src/main/java/io/gate/gateapi/models/CountdownCancelAllOptionsTask.java index f42eaa9..a5e3b8f 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/CountdownCancelAllSpotTask.java b/src/main/java/io/gate/gateapi/models/CountdownCancelAllSpotTask.java index 8aaf766..2e54918 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/CreateCollateralOrder.java b/src/main/java/io/gate/gateapi/models/CreateCollateralOrder.java index d174174..864428d 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/CreateMultiCollateralOrder.java b/src/main/java/io/gate/gateapi/models/CreateMultiCollateralOrder.java index 27d1986..698b5c4 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/CreateUniLend.java b/src/main/java/io/gate/gateapi/models/CreateUniLend.java index a88136e..47b1a12 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/CreateUniLoan.java b/src/main/java/io/gate/gateapi/models/CreateUniLoan.java index 9404043..19d79e9 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/CrossMarginBalance.java b/src/main/java/io/gate/gateapi/models/CrossMarginBalance.java index 1f7b4d7..06fd6d8 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/CrossMarginLoan.java b/src/main/java/io/gate/gateapi/models/CrossMarginLoan.java index 879166c..57695df 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/CrossMarginRepayment.java b/src/main/java/io/gate/gateapi/models/CrossMarginRepayment.java index 25fe006..88576ac 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/Currency.java b/src/main/java/io/gate/gateapi/models/Currency.java index 8a9faca..1a2f624 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/Currency2.java b/src/main/java/io/gate/gateapi/models/Currency2.java new file mode 100644 index 0000000..0c6aeb1 --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/Currency2.java @@ -0,0 +1,245 @@ +/* + * Gate API v4 + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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; + +/** + * Currency2 + */ +public class Currency2 { + public static final String SERIALIZED_NAME_CURRENCY = "currency"; + @SerializedName(SERIALIZED_NAME_CURRENCY) + private String currency; + + public static final String SERIALIZED_NAME_NAME = "name"; + @SerializedName(SERIALIZED_NAME_NAME) + private String name; + + public static final String SERIALIZED_NAME_CHAIN = "chain"; + @SerializedName(SERIALIZED_NAME_CHAIN) + private String chain; + + public static final String SERIALIZED_NAME_ADDRESS = "address"; + @SerializedName(SERIALIZED_NAME_ADDRESS) + private String address; + + public static final String SERIALIZED_NAME_AMOUNT_PRECISION = "amount_precision"; + @SerializedName(SERIALIZED_NAME_AMOUNT_PRECISION) + private Integer amountPrecision; + + public static final String SERIALIZED_NAME_PRECISION = "precision"; + @SerializedName(SERIALIZED_NAME_PRECISION) + private Integer precision; + + public static final String SERIALIZED_NAME_STATUS = "status"; + @SerializedName(SERIALIZED_NAME_STATUS) + private Integer status; + + + public Currency2 currency(String currency) { + + this.currency = currency; + return this; + } + + /** + * Currency symbol + * @return currency + **/ + @javax.annotation.Nullable + public String getCurrency() { + return currency; + } + + + public void setCurrency(String currency) { + this.currency = currency; + } + + public Currency2 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 Currency2 chain(String chain) { + + this.chain = chain; + return this; + } + + /** + * The main chain corresponding to the coin + * @return chain + **/ + @javax.annotation.Nullable + public String getChain() { + return chain; + } + + + public void setChain(String chain) { + this.chain = chain; + } + + public Currency2 address(String address) { + + this.address = address; + return this; + } + + /** + * Contract Address + * @return address + **/ + @javax.annotation.Nullable + public String getAddress() { + return address; + } + + + public void setAddress(String address) { + this.address = address; + } + + public Currency2 amountPrecision(Integer amountPrecision) { + + this.amountPrecision = amountPrecision; + return this; + } + + /** + * Amount scale + * @return amountPrecision + **/ + @javax.annotation.Nullable + public Integer getAmountPrecision() { + return amountPrecision; + } + + + public void setAmountPrecision(Integer amountPrecision) { + this.amountPrecision = amountPrecision; + } + + public Currency2 precision(Integer precision) { + + this.precision = precision; + return this; + } + + /** + * Price scale + * @return precision + **/ + @javax.annotation.Nullable + public Integer getPrecision() { + return precision; + } + + + public void setPrecision(Integer precision) { + this.precision = precision; + } + + public Currency2 status(Integer status) { + + this.status = status; + return this; + } + + /** + * 币种交易状态 - `1` : 正常交易 - `2` : 暂停交易 - `3` : 下架 + * @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; + } + Currency2 currency2 = (Currency2) o; + return Objects.equals(this.currency, currency2.currency) && + Objects.equals(this.name, currency2.name) && + Objects.equals(this.chain, currency2.chain) && + Objects.equals(this.address, currency2.address) && + Objects.equals(this.amountPrecision, currency2.amountPrecision) && + Objects.equals(this.precision, currency2.precision) && + Objects.equals(this.status, currency2.status); + } + + @Override + public int hashCode() { + return Objects.hash(currency, name, chain, address, amountPrecision, precision, status); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Currency2 {\n"); + sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" chain: ").append(toIndentedString(chain)).append("\n"); + sb.append(" address: ").append(toIndentedString(address)).append("\n"); + sb.append(" amountPrecision: ").append(toIndentedString(amountPrecision)).append("\n"); + sb.append(" precision: ").append(toIndentedString(precision)).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/CurrencyChain.java b/src/main/java/io/gate/gateapi/models/CurrencyChain.java index 367f38c..1fd6c0e 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/CurrencyPair.java b/src/main/java/io/gate/gateapi/models/CurrencyPair.java index fbce991..ab044b2 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/CurrencyQuota.java b/src/main/java/io/gate/gateapi/models/CurrencyQuota.java index 273670e..e61e9e7 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/DebitFee.java b/src/main/java/io/gate/gateapi/models/DebitFee.java index 08bde04..35294ab 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/DeliveryCandlestick.java b/src/main/java/io/gate/gateapi/models/DeliveryCandlestick.java index 199db5c..512824e 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/DeliveryContract.java b/src/main/java/io/gate/gateapi/models/DeliveryContract.java index 6e25bdc..3f6d16f 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/DeliverySettlement.java b/src/main/java/io/gate/gateapi/models/DeliverySettlement.java index 47bed56..bccfec1 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/DeliveryTicker.java b/src/main/java/io/gate/gateapi/models/DeliveryTicker.java index a6d9403..4a7f00c 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/DepositAddress.java b/src/main/java/io/gate/gateapi/models/DepositAddress.java index 3d78fb4..3c530b8 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/DepositRecord.java b/src/main/java/io/gate/gateapi/models/DepositRecord.java index 74a75bf..e18d2c5 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/DualGetOrders.java b/src/main/java/io/gate/gateapi/models/DualGetOrders.java index 9fb2630..ab408e7 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/DualGetPlans.java b/src/main/java/io/gate/gateapi/models/DualGetPlans.java index 695d92e..ba618a5 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/Eth2RateList.java b/src/main/java/io/gate/gateapi/models/Eth2RateList.java index 2dfb0f9..743a92a 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/Eth2Swap.java b/src/main/java/io/gate/gateapi/models/Eth2Swap.java index 2f1e9d3..e84219c 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 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..8553441 --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/FindCoin.java @@ -0,0 +1,115 @@ +/* + * Gate API v4 + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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; + +/** + * FindCoin + */ +public class FindCoin { + public static final String SERIALIZED_NAME_COIN = "coin"; + @SerializedName(SERIALIZED_NAME_COIN) + private String coin; + + public static final String SERIALIZED_NAME_COINTYPE = "cointype"; + @SerializedName(SERIALIZED_NAME_COINTYPE) + private String cointype; + + + public FindCoin 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 FindCoin cointype(String cointype) { + + this.cointype = cointype; + return this; + } + + /** + * Coin Type swap-Voucher lock-Locked + * @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.coin, findCoin.coin) && + Objects.equals(this.cointype, findCoin.cointype); + } + + @Override + public int hashCode() { + return Objects.hash(coin, cointype); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FindCoin {\n"); + sb.append(" coin: ").append(toIndentedString(coin)).append("\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..8e5942a 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FlashSwapOrder.java b/src/main/java/io/gate/gateapi/models/FlashSwapOrder.java index 33a18db..abe691a 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FlashSwapOrderPreview.java b/src/main/java/io/gate/gateapi/models/FlashSwapOrderPreview.java index e56fdbd..7d1971d 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FlashSwapOrderRequest.java b/src/main/java/io/gate/gateapi/models/FlashSwapOrderRequest.java index 7ab95d9..716e539 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FlashSwapPreviewRequest.java b/src/main/java/io/gate/gateapi/models/FlashSwapPreviewRequest.java index 1e8d918..a34faea 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FundingAccount.java b/src/main/java/io/gate/gateapi/models/FundingAccount.java index 18f63b7..80aac52 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FundingRateRecord.java b/src/main/java/io/gate/gateapi/models/FundingRateRecord.java index 2170456..86c1347 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FutureCancelOrderResult.java b/src/main/java/io/gate/gateapi/models/FutureCancelOrderResult.java index cf7a71f..428404a 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesAccount.java b/src/main/java/io/gate/gateapi/models/FuturesAccount.java index 50bfe77..706a36e 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesAccountBook.java b/src/main/java/io/gate/gateapi/models/FuturesAccountBook.java index dd79e08..eb7457f 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesAccountHistory.java b/src/main/java/io/gate/gateapi/models/FuturesAccountHistory.java index 4d04443..b566a33 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesAutoDeleverage.java b/src/main/java/io/gate/gateapi/models/FuturesAutoDeleverage.java index da5ed89..2b468fa 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesBatchAmendOrderRequest.java b/src/main/java/io/gate/gateapi/models/FuturesBatchAmendOrderRequest.java index afa7427..8a61a42 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesCandlestick.java b/src/main/java/io/gate/gateapi/models/FuturesCandlestick.java index 9c9a5d4..f719f92 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesFee.java b/src/main/java/io/gate/gateapi/models/FuturesFee.java index cfd014d..d9d333b 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesIndexConstituents.java b/src/main/java/io/gate/gateapi/models/FuturesIndexConstituents.java index d377622..aacccfb 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesInitialOrder.java b/src/main/java/io/gate/gateapi/models/FuturesInitialOrder.java index 12ac61b..5459792 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesLimitRiskTiers.java b/src/main/java/io/gate/gateapi/models/FuturesLimitRiskTiers.java index 0dee8a3..adb1647 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesLiqOrder.java b/src/main/java/io/gate/gateapi/models/FuturesLiqOrder.java index fc06872..4273d26 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesLiquidate.java b/src/main/java/io/gate/gateapi/models/FuturesLiquidate.java index a313b7e..60518eb 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesOrder.java b/src/main/java/io/gate/gateapi/models/FuturesOrder.java index 29dfdbd..f334ab4 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesOrderAmendment.java b/src/main/java/io/gate/gateapi/models/FuturesOrderAmendment.java index 52d5c0e..1f785b7 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesOrderBook.java b/src/main/java/io/gate/gateapi/models/FuturesOrderBook.java index d8e0834..4434339 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesOrderBookItem.java b/src/main/java/io/gate/gateapi/models/FuturesOrderBookItem.java index f935930..638d744 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/InlineObject.java b/src/main/java/io/gate/gateapi/models/FuturesPositionCrossMode.java similarity index 82% rename from src/main/java/io/gate/gateapi/models/InlineObject.java rename to src/main/java/io/gate/gateapi/models/FuturesPositionCrossMode.java index fda33b4..29e5d24 100644 --- a/src/main/java/io/gate/gateapi/models/InlineObject.java +++ b/src/main/java/io/gate/gateapi/models/FuturesPositionCrossMode.java @@ -1,6 +1,6 @@ /* * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 @@ -20,9 +20,9 @@ import java.io.IOException; /** - * InlineObject + * FuturesPositionCrossMode */ -public class InlineObject { +public class FuturesPositionCrossMode { public static final String SERIALIZED_NAME_MODE = "mode"; @SerializedName(SERIALIZED_NAME_MODE) private String mode; @@ -32,7 +32,7 @@ public class InlineObject { private String contract; - public InlineObject mode(String mode) { + public FuturesPositionCrossMode mode(String mode) { this.mode = mode; return this; @@ -51,7 +51,7 @@ public void setMode(String mode) { this.mode = mode; } - public InlineObject contract(String contract) { + public FuturesPositionCrossMode contract(String contract) { this.contract = contract; return this; @@ -77,9 +77,9 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - InlineObject inlineObject = (InlineObject) o; - return Objects.equals(this.mode, inlineObject.mode) && - Objects.equals(this.contract, inlineObject.contract); + FuturesPositionCrossMode futuresPositionCrossMode = (FuturesPositionCrossMode) o; + return Objects.equals(this.mode, futuresPositionCrossMode.mode) && + Objects.equals(this.contract, futuresPositionCrossMode.contract); } @Override @@ -91,7 +91,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class InlineObject {\n"); + sb.append("class FuturesPositionCrossMode {\n"); sb.append(" mode: ").append(toIndentedString(mode)).append("\n"); sb.append(" contract: ").append(toIndentedString(contract)).append("\n"); sb.append("}"); diff --git a/src/main/java/io/gate/gateapi/models/FuturesPremiumIndex.java b/src/main/java/io/gate/gateapi/models/FuturesPremiumIndex.java index 065ec47..3ff242e 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesPriceTrigger.java b/src/main/java/io/gate/gateapi/models/FuturesPriceTrigger.java index 4e478ea..fae9a01 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesPriceTriggeredOrder.java b/src/main/java/io/gate/gateapi/models/FuturesPriceTriggeredOrder.java index a4a740a..e74c0d8 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesTicker.java b/src/main/java/io/gate/gateapi/models/FuturesTicker.java index 139fe72..6bfc231 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesTrade.java b/src/main/java/io/gate/gateapi/models/FuturesTrade.java index f5efbb5..7bf108c 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/IndexConstituent.java b/src/main/java/io/gate/gateapi/models/IndexConstituent.java index f32e40e..c593830 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/InlineResponse200.java b/src/main/java/io/gate/gateapi/models/InlineResponse200.java index 429503b..353f45a 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/InlineResponse2001.java b/src/main/java/io/gate/gateapi/models/InlineResponse2001.java index 6e5d827..d5dfb8a 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/InsuranceRecord.java b/src/main/java/io/gate/gateapi/models/InsuranceRecord.java index e498705..51e5f12 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/LedgerRecord.java b/src/main/java/io/gate/gateapi/models/LedgerRecord.java index f7436e3..a826352 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/LiquidateOrder.java b/src/main/java/io/gate/gateapi/models/LiquidateOrder.java index dbf7868..8b51faf 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MarginAccount.java b/src/main/java/io/gate/gateapi/models/MarginAccount.java index e4fbe49..e2f6402 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MarginAccountBook.java b/src/main/java/io/gate/gateapi/models/MarginAccountBook.java index e6f0d28..5a928e6 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MarginAccountCurrency.java b/src/main/java/io/gate/gateapi/models/MarginAccountCurrency.java index 93d76a0..3869319 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MarginLeverageTier.java b/src/main/java/io/gate/gateapi/models/MarginLeverageTier.java index 96b5802..d7e23d9 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MarginMarketLeverage.java b/src/main/java/io/gate/gateapi/models/MarginMarketLeverage.java index 5f76d1a..6ee72d3 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MarginTiers.java b/src/main/java/io/gate/gateapi/models/MarginTiers.java index cd000bd..9516b9a 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MarginTransferable.java b/src/main/java/io/gate/gateapi/models/MarginTransferable.java index ac3701a..71844ac 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MaxUniBorrowable.java b/src/main/java/io/gate/gateapi/models/MaxUniBorrowable.java index e7a1d07..3dc755e 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MockFuturesOrder.java b/src/main/java/io/gate/gateapi/models/MockFuturesOrder.java index 0cf585b..31a4683 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MockFuturesPosition.java b/src/main/java/io/gate/gateapi/models/MockFuturesPosition.java index 1d4c1ea..9523a50 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MockMarginResult.java b/src/main/java/io/gate/gateapi/models/MockMarginResult.java index 93c9f35..d4e1cc6 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MockOptionsOrder.java b/src/main/java/io/gate/gateapi/models/MockOptionsOrder.java index e2873af..74f1623 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MockOptionsPosition.java b/src/main/java/io/gate/gateapi/models/MockOptionsPosition.java index 8b2e63d..41aeac6 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MockRiskUnit.java b/src/main/java/io/gate/gateapi/models/MockRiskUnit.java index 571bce5..956264f 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MockSpotBalance.java b/src/main/java/io/gate/gateapi/models/MockSpotBalance.java index 12352f4..eee56f8 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MockSpotOrder.java b/src/main/java/io/gate/gateapi/models/MockSpotOrder.java index 02773f2..cccb76e 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MultiChainAddressItem.java b/src/main/java/io/gate/gateapi/models/MultiChainAddressItem.java index aa94839..4f62b77 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MultiCollateralCurrency.java b/src/main/java/io/gate/gateapi/models/MultiCollateralCurrency.java index fc0fca9..02bb1f4 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MultiCollateralItem.java b/src/main/java/io/gate/gateapi/models/MultiCollateralItem.java index 349f0de..9d15c20 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MultiCollateralOrder.java b/src/main/java/io/gate/gateapi/models/MultiCollateralOrder.java index a1bdf8c..b68861f 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MultiCollateralRecord.java b/src/main/java/io/gate/gateapi/models/MultiCollateralRecord.java index 7aba73c..fc0af56 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MultiCollateralRecordCurrency.java b/src/main/java/io/gate/gateapi/models/MultiCollateralRecordCurrency.java index 42de936..fb062b4 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MultiLoanItem.java b/src/main/java/io/gate/gateapi/models/MultiLoanItem.java index 8662414..91e2be9 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MultiLoanRepayItem.java b/src/main/java/io/gate/gateapi/models/MultiLoanRepayItem.java index 7ec8a7a..85ae87c 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MultiRepayRecord.java b/src/main/java/io/gate/gateapi/models/MultiRepayRecord.java index 5fc4cce..3325aad 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MultiRepayResp.java b/src/main/java/io/gate/gateapi/models/MultiRepayResp.java index 816cc0b..7d85509 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MyFuturesTrade.java b/src/main/java/io/gate/gateapi/models/MyFuturesTrade.java index 2177c2b..cd14480 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/MyFuturesTradeTimeRange.java b/src/main/java/io/gate/gateapi/models/MyFuturesTradeTimeRange.java index e771976..d8128f8 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/OpenOrders.java b/src/main/java/io/gate/gateapi/models/OpenOrders.java index 6040213..c14cf56 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsAccount.java b/src/main/java/io/gate/gateapi/models/OptionsAccount.java index cbadfa6..cc6f73c 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsAccountBook.java b/src/main/java/io/gate/gateapi/models/OptionsAccountBook.java index a71fbd2..3490ae4 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsCandlestick.java b/src/main/java/io/gate/gateapi/models/OptionsCandlestick.java index 2b4d7c4..331e1f1 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsContract.java b/src/main/java/io/gate/gateapi/models/OptionsContract.java index 5ec6cbd..dba3df5 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsMMP.java b/src/main/java/io/gate/gateapi/models/OptionsMMP.java index f30bff8..60701dc 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsMMPReset.java b/src/main/java/io/gate/gateapi/models/OptionsMMPReset.java index 6388b30..65e9c37 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsMySettlements.java b/src/main/java/io/gate/gateapi/models/OptionsMySettlements.java index d33a6fd..e6ed7c5 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsMyTrade.java b/src/main/java/io/gate/gateapi/models/OptionsMyTrade.java index c8e468f..2929920 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsOrder.java b/src/main/java/io/gate/gateapi/models/OptionsOrder.java index 32889d8..fe13a00 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsPosition.java b/src/main/java/io/gate/gateapi/models/OptionsPosition.java index 5fb1ede..e7e756a 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsPositionClose.java b/src/main/java/io/gate/gateapi/models/OptionsPositionClose.java index 2c88e19..6130434 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsPositionCloseOrder.java b/src/main/java/io/gate/gateapi/models/OptionsPositionCloseOrder.java index ab879d2..18f2577 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsSettlement.java b/src/main/java/io/gate/gateapi/models/OptionsSettlement.java index ead66e6..0ab9f9f 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsTicker.java b/src/main/java/io/gate/gateapi/models/OptionsTicker.java index b0a3d06..9777d52 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsUnderlying.java b/src/main/java/io/gate/gateapi/models/OptionsUnderlying.java index 074c737..7bc1fc1 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsUnderlyingTicker.java b/src/main/java/io/gate/gateapi/models/OptionsUnderlyingTicker.java index 363e1f3..af846c1 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/Order.java b/src/main/java/io/gate/gateapi/models/Order.java index fd70125..e71ae8a 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/OrderBook.java b/src/main/java/io/gate/gateapi/models/OrderBook.java index 72e5482..2318d53 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/OrderCancel.java b/src/main/java/io/gate/gateapi/models/OrderCancel.java index 7524b4e..9831954 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/OrderPatch.java b/src/main/java/io/gate/gateapi/models/OrderPatch.java index fcd63df..d0f1df0 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/OrderResp.java b/src/main/java/io/gate/gateapi/models/OrderResp.java index f15981c..d6963e6 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/OrderResponse.java b/src/main/java/io/gate/gateapi/models/OrderResponse.java new file mode 100644 index 0000000..0b0181a --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/OrderResponse.java @@ -0,0 +1,401 @@ +/* + * Gate API v4 + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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; + +/** + * 下单返回 + */ +public class OrderResponse { + public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; + @SerializedName(SERIALIZED_NAME_ORDER_ID) + private String orderId; + + public static final String SERIALIZED_NAME_TX_HASH = "tx_hash"; + @SerializedName(SERIALIZED_NAME_TX_HASH) + private String txHash; + + public static final String SERIALIZED_NAME_SIDE = "side"; + @SerializedName(SERIALIZED_NAME_SIDE) + private String side; + + public static final String SERIALIZED_NAME_USDT_AMOUNT = "usdt_amount"; + @SerializedName(SERIALIZED_NAME_USDT_AMOUNT) + private String usdtAmount; + + public static final String SERIALIZED_NAME_CURRENCY = "currency"; + @SerializedName(SERIALIZED_NAME_CURRENCY) + private String currency; + + public static final String SERIALIZED_NAME_CURRENCY_AMOUNT = "currency_amount"; + @SerializedName(SERIALIZED_NAME_CURRENCY_AMOUNT) + private String currencyAmount; + + public static final String SERIALIZED_NAME_STATUS = "status"; + @SerializedName(SERIALIZED_NAME_STATUS) + private Integer status; + + public static final String SERIALIZED_NAME_GAS_MODE = "gas_mode"; + @SerializedName(SERIALIZED_NAME_GAS_MODE) + private String gasMode; + + public static final String SERIALIZED_NAME_CHAIN = "chain"; + @SerializedName(SERIALIZED_NAME_CHAIN) + private String chain; + + public static final String SERIALIZED_NAME_GAS_FEE = "gas_fee"; + @SerializedName(SERIALIZED_NAME_GAS_FEE) + private String gasFee; + + public static final String SERIALIZED_NAME_TRANSACTION_FEE = "transaction_fee"; + @SerializedName(SERIALIZED_NAME_TRANSACTION_FEE) + private String transactionFee; + + public static final String SERIALIZED_NAME_FAILED_REASON = "failed_reason"; + @SerializedName(SERIALIZED_NAME_FAILED_REASON) + private String failedReason; + + public static final String SERIALIZED_NAME_CREATE_TIME = "create_time"; + @SerializedName(SERIALIZED_NAME_CREATE_TIME) + private Long createTime; + + + public OrderResponse orderId(String orderId) { + + this.orderId = orderId; + return this; + } + + /** + * Order ID + * @return orderId + **/ + @javax.annotation.Nullable + public String getOrderId() { + return orderId; + } + + + public void setOrderId(String orderId) { + this.orderId = orderId; + } + + public OrderResponse txHash(String txHash) { + + this.txHash = txHash; + return this; + } + + /** + * Transaction Hash + * @return txHash + **/ + @javax.annotation.Nullable + public String getTxHash() { + return txHash; + } + + + public void setTxHash(String txHash) { + this.txHash = txHash; + } + + public OrderResponse side(String side) { + + this.side = side; + return this; + } + + /** + * 买单或者卖单 - buy - sell + * @return side + **/ + @javax.annotation.Nullable + public String getSide() { + return side; + } + + + public void setSide(String side) { + this.side = side; + } + + public OrderResponse usdtAmount(String usdtAmount) { + + this.usdtAmount = usdtAmount; + return this; + } + + /** + * Amount + * @return usdtAmount + **/ + @javax.annotation.Nullable + public String getUsdtAmount() { + return usdtAmount; + } + + + public void setUsdtAmount(String usdtAmount) { + this.usdtAmount = usdtAmount; + } + + public OrderResponse currency(String currency) { + + this.currency = currency; + return this; + } + + /** + * 币 + * @return currency + **/ + @javax.annotation.Nullable + public String getCurrency() { + return currency; + } + + + public void setCurrency(String currency) { + this.currency = currency; + } + + public OrderResponse currencyAmount(String currencyAmount) { + + this.currencyAmount = currencyAmount; + return this; + } + + /** + * Currency amount + * @return currencyAmount + **/ + @javax.annotation.Nullable + public String getCurrencyAmount() { + return currencyAmount; + } + + + public void setCurrencyAmount(String currencyAmount) { + this.currencyAmount = currencyAmount; + } + + public OrderResponse status(Integer status) { + + this.status = status; + return this; + } + + /** + * Order Status - `0` : All - `1` : Processing - `2` : Successful - `3` : Failed - `4` : Canceled - `5` : Buy order placed but transfer not completed - `6` : Cancelled order with transfer not complete + * @return status + **/ + @javax.annotation.Nullable + public Integer getStatus() { + return status; + } + + + public void setStatus(Integer status) { + this.status = status; + } + + public OrderResponse gasMode(String gasMode) { + + this.gasMode = gasMode; + return this; + } + + /** + * Trading mode affects slippage selection - `speed` : Smart mode - `custom` : Custom mode, uses `slippage` parameter + * @return gasMode + **/ + @javax.annotation.Nullable + public String getGasMode() { + return gasMode; + } + + + public void setGasMode(String gasMode) { + this.gasMode = gasMode; + } + + public OrderResponse chain(String chain) { + + this.chain = chain; + return this; + } + + /** + * 链 + * @return chain + **/ + @javax.annotation.Nullable + public String getChain() { + return chain; + } + + + public void setChain(String chain) { + this.chain = chain; + } + + public OrderResponse gasFee(String gasFee) { + + this.gasFee = gasFee; + return this; + } + + /** + * Miner Fee (USDT-based) + * @return gasFee + **/ + @javax.annotation.Nullable + public String getGasFee() { + return gasFee; + } + + + public void setGasFee(String gasFee) { + this.gasFee = gasFee; + } + + public OrderResponse transactionFee(String transactionFee) { + + this.transactionFee = transactionFee; + return this; + } + + /** + * Trading Fee (USDT-based) + * @return transactionFee + **/ + @javax.annotation.Nullable + public String getTransactionFee() { + return transactionFee; + } + + + public void setTransactionFee(String transactionFee) { + this.transactionFee = transactionFee; + } + + public OrderResponse failedReason(String failedReason) { + + this.failedReason = failedReason; + return this; + } + + /** + * Failure reason (if any) + * @return failedReason + **/ + @javax.annotation.Nullable + public String getFailedReason() { + return failedReason; + } + + + public void setFailedReason(String failedReason) { + this.failedReason = failedReason; + } + + public OrderResponse createTime(Long createTime) { + + this.createTime = createTime; + return this; + } + + /** + * 创建时间（时间戳） + * @return createTime + **/ + @javax.annotation.Nullable + public Long getCreateTime() { + return createTime; + } + + + public void setCreateTime(Long createTime) { + this.createTime = createTime; + } + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + OrderResponse orderResponse = (OrderResponse) o; + return Objects.equals(this.orderId, orderResponse.orderId) && + Objects.equals(this.txHash, orderResponse.txHash) && + Objects.equals(this.side, orderResponse.side) && + Objects.equals(this.usdtAmount, orderResponse.usdtAmount) && + Objects.equals(this.currency, orderResponse.currency) && + Objects.equals(this.currencyAmount, orderResponse.currencyAmount) && + Objects.equals(this.status, orderResponse.status) && + Objects.equals(this.gasMode, orderResponse.gasMode) && + Objects.equals(this.chain, orderResponse.chain) && + Objects.equals(this.gasFee, orderResponse.gasFee) && + Objects.equals(this.transactionFee, orderResponse.transactionFee) && + Objects.equals(this.failedReason, orderResponse.failedReason) && + Objects.equals(this.createTime, orderResponse.createTime); + } + + @Override + public int hashCode() { + return Objects.hash(orderId, txHash, side, usdtAmount, currency, currencyAmount, status, gasMode, chain, gasFee, transactionFee, failedReason, createTime); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class OrderResponse {\n"); + sb.append(" orderId: ").append(toIndentedString(orderId)).append("\n"); + sb.append(" txHash: ").append(toIndentedString(txHash)).append("\n"); + sb.append(" side: ").append(toIndentedString(side)).append("\n"); + sb.append(" usdtAmount: ").append(toIndentedString(usdtAmount)).append("\n"); + sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); + sb.append(" currencyAmount: ").append(toIndentedString(currencyAmount)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).append("\n"); + sb.append(" gasMode: ").append(toIndentedString(gasMode)).append("\n"); + sb.append(" chain: ").append(toIndentedString(chain)).append("\n"); + sb.append(" gasFee: ").append(toIndentedString(gasFee)).append("\n"); + sb.append(" transactionFee: ").append(toIndentedString(transactionFee)).append("\n"); + sb.append(" failedReason: ").append(toIndentedString(failedReason)).append("\n"); + sb.append(" createTime: ").append(toIndentedString(createTime)).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/PartnerCommissionHistory.java b/src/main/java/io/gate/gateapi/models/PartnerCommissionHistory.java index a3f0cca..9ace806 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/PartnerSub.java b/src/main/java/io/gate/gateapi/models/PartnerSub.java index 05c49a6..c8d8cb6 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/PartnerSubList.java b/src/main/java/io/gate/gateapi/models/PartnerSubList.java index bb20615..a978ffa 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/PartnerTransactionHistory.java b/src/main/java/io/gate/gateapi/models/PartnerTransactionHistory.java index 3f4a366..e745b60 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/PatchUniLend.java b/src/main/java/io/gate/gateapi/models/PatchUniLend.java index 8cd0667..192d92c 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/PlaceDualInvestmentOrder.java b/src/main/java/io/gate/gateapi/models/PlaceDualInvestmentOrder.java index 62fbc1f..e7d4ab3 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/PlaceOrderRequest.java b/src/main/java/io/gate/gateapi/models/PlaceOrderRequest.java new file mode 100644 index 0000000..0adf878 --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/PlaceOrderRequest.java @@ -0,0 +1,214 @@ +/* + * Gate API v4 + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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; + +/** + * 下单请求 + */ +public class PlaceOrderRequest { + public static final String SERIALIZED_NAME_CURRENCY = "currency"; + @SerializedName(SERIALIZED_NAME_CURRENCY) + private String currency; + + 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_GAS_MODE = "gas_mode"; + @SerializedName(SERIALIZED_NAME_GAS_MODE) + private String gasMode; + + public static final String SERIALIZED_NAME_SLIPPAGE = "slippage"; + @SerializedName(SERIALIZED_NAME_SLIPPAGE) + private String slippage; + + public static final String SERIALIZED_NAME_QUOTE_ID = "quote_id"; + @SerializedName(SERIALIZED_NAME_QUOTE_ID) + private String quoteId; + + + public PlaceOrderRequest currency(String currency) { + + this.currency = currency; + return this; + } + + /** + * Trading Symbol + * @return currency + **/ + public String getCurrency() { + return currency; + } + + + public void setCurrency(String currency) { + this.currency = currency; + } + + public PlaceOrderRequest side(String side) { + + this.side = side; + return this; + } + + /** + * 买单或者卖单 - buy - sell + * @return side + **/ + public String getSide() { + return side; + } + + + public void setSide(String side) { + this.side = side; + } + + public PlaceOrderRequest amount(String amount) { + + this.amount = amount; + return this; + } + + /** + * Trade Quantity - `side` : `buy` refers to the quote currency, i.e., `USDT` - `side` : `sell` refers to the base currency + * @return amount + **/ + public String getAmount() { + return amount; + } + + + public void setAmount(String amount) { + this.amount = amount; + } + + public PlaceOrderRequest gasMode(String gasMode) { + + this.gasMode = gasMode; + return this; + } + + /** + * Trading mode affects slippage selection - `speed` : Smart mode - `custom` : Custom mode, uses `slippage` parameter + * @return gasMode + **/ + public String getGasMode() { + return gasMode; + } + + + public void setGasMode(String gasMode) { + this.gasMode = gasMode; + } + + public PlaceOrderRequest slippage(String slippage) { + + this.slippage = slippage; + return this; + } + + /** + * Slippage value of 10 represents a 10% tolerance + * @return slippage + **/ + @javax.annotation.Nullable + public String getSlippage() { + return slippage; + } + + + public void setSlippage(String slippage) { + this.slippage = slippage; + } + + public PlaceOrderRequest quoteId(String quoteId) { + + this.quoteId = quoteId; + return this; + } + + /** + * The quote_id returned by the quotation API + * @return quoteId + **/ + public String getQuoteId() { + return quoteId; + } + + + public void setQuoteId(String quoteId) { + this.quoteId = quoteId; + } + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PlaceOrderRequest placeOrderRequest = (PlaceOrderRequest) o; + return Objects.equals(this.currency, placeOrderRequest.currency) && + Objects.equals(this.side, placeOrderRequest.side) && + Objects.equals(this.amount, placeOrderRequest.amount) && + Objects.equals(this.gasMode, placeOrderRequest.gasMode) && + Objects.equals(this.slippage, placeOrderRequest.slippage) && + Objects.equals(this.quoteId, placeOrderRequest.quoteId); + } + + @Override + public int hashCode() { + return Objects.hash(currency, side, amount, gasMode, slippage, quoteId); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PlaceOrderRequest {\n"); + sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); + sb.append(" side: ").append(toIndentedString(side)).append("\n"); + sb.append(" amount: ").append(toIndentedString(amount)).append("\n"); + sb.append(" gasMode: ").append(toIndentedString(gasMode)).append("\n"); + sb.append(" slippage: ").append(toIndentedString(slippage)).append("\n"); + sb.append(" quoteId: ").append(toIndentedString(quoteId)).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/PlaceOrderResponse.java b/src/main/java/io/gate/gateapi/models/PlaceOrderResponse.java new file mode 100644 index 0000000..a39794f --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/PlaceOrderResponse.java @@ -0,0 +1,271 @@ +/* + * Gate API v4 + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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; + +/** + * 下单返回 + */ +public class PlaceOrderResponse { + public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; + @SerializedName(SERIALIZED_NAME_ORDER_ID) + private String orderId; + + public static final String SERIALIZED_NAME_STATUS = "status"; + @SerializedName(SERIALIZED_NAME_STATUS) + private Integer status; + + public static final String SERIALIZED_NAME_SIDE = "side"; + @SerializedName(SERIALIZED_NAME_SIDE) + private String side; + + public static final String SERIALIZED_NAME_GAS_MODE = "gas_mode"; + @SerializedName(SERIALIZED_NAME_GAS_MODE) + private String gasMode; + + public static final String SERIALIZED_NAME_CREATE_TIME = "create_time"; + @SerializedName(SERIALIZED_NAME_CREATE_TIME) + private Long createTime; + + public static final String SERIALIZED_NAME_AMOUNT = "amount"; + @SerializedName(SERIALIZED_NAME_AMOUNT) + private String amount; + + public static final String SERIALIZED_NAME_TOKEN_ADDRESS = "token_address"; + @SerializedName(SERIALIZED_NAME_TOKEN_ADDRESS) + private String tokenAddress; + + public static final String SERIALIZED_NAME_CHAIN = "chain"; + @SerializedName(SERIALIZED_NAME_CHAIN) + private String chain; + + + public PlaceOrderResponse orderId(String orderId) { + + this.orderId = orderId; + return this; + } + + /** + * Order ID + * @return orderId + **/ + @javax.annotation.Nullable + public String getOrderId() { + return orderId; + } + + + public void setOrderId(String orderId) { + this.orderId = orderId; + } + + public PlaceOrderResponse status(Integer status) { + + this.status = status; + return this; + } + + /** + * Order Status - `0` : All - `1` : Processing - `2` : Successful - `3` : Failed - `4` : Canceled - `5` : Buy order placed but transfer not completed - `6` : Cancelled order with transfer not complete + * @return status + **/ + @javax.annotation.Nullable + public Integer getStatus() { + return status; + } + + + public void setStatus(Integer status) { + this.status = status; + } + + public PlaceOrderResponse side(String side) { + + this.side = side; + return this; + } + + /** + * 买单或者卖单 - buy - sell + * @return side + **/ + @javax.annotation.Nullable + public String getSide() { + return side; + } + + + public void setSide(String side) { + this.side = side; + } + + public PlaceOrderResponse gasMode(String gasMode) { + + this.gasMode = gasMode; + return this; + } + + /** + * Trading mode affects slippage selection - `speed` : Smart mode - `custom` : Custom mode, uses `slippage` parameter + * @return gasMode + **/ + @javax.annotation.Nullable + public String getGasMode() { + return gasMode; + } + + + public void setGasMode(String gasMode) { + this.gasMode = gasMode; + } + + public PlaceOrderResponse createTime(Long createTime) { + + this.createTime = createTime; + return this; + } + + /** + * 创建时间 (时间戳) + * @return createTime + **/ + @javax.annotation.Nullable + public Long getCreateTime() { + return createTime; + } + + + public void setCreateTime(Long createTime) { + this.createTime = createTime; + } + + public PlaceOrderResponse amount(String amount) { + + this.amount = amount; + return this; + } + + /** + * Trade Quantity - `side` : `buy` refers to the quote currency, i.e., `USDT` - `side` : `sell` refers to the base currency + * @return amount + **/ + @javax.annotation.Nullable + public String getAmount() { + return amount; + } + + + public void setAmount(String amount) { + this.amount = amount; + } + + public PlaceOrderResponse tokenAddress(String tokenAddress) { + + this.tokenAddress = tokenAddress; + return this; + } + + /** + * 币地址 + * @return tokenAddress + **/ + @javax.annotation.Nullable + public String getTokenAddress() { + return tokenAddress; + } + + + public void setTokenAddress(String tokenAddress) { + this.tokenAddress = tokenAddress; + } + + public PlaceOrderResponse chain(String chain) { + + this.chain = chain; + return this; + } + + /** + * Chain name + * @return chain + **/ + @javax.annotation.Nullable + public String getChain() { + return chain; + } + + + public void setChain(String chain) { + this.chain = chain; + } + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PlaceOrderResponse placeOrderResponse = (PlaceOrderResponse) o; + return Objects.equals(this.orderId, placeOrderResponse.orderId) && + Objects.equals(this.status, placeOrderResponse.status) && + Objects.equals(this.side, placeOrderResponse.side) && + Objects.equals(this.gasMode, placeOrderResponse.gasMode) && + Objects.equals(this.createTime, placeOrderResponse.createTime) && + Objects.equals(this.amount, placeOrderResponse.amount) && + Objects.equals(this.tokenAddress, placeOrderResponse.tokenAddress) && + Objects.equals(this.chain, placeOrderResponse.chain); + } + + @Override + public int hashCode() { + return Objects.hash(orderId, status, side, gasMode, createTime, amount, tokenAddress, chain); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PlaceOrderResponse {\n"); + sb.append(" orderId: ").append(toIndentedString(orderId)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).append("\n"); + sb.append(" side: ").append(toIndentedString(side)).append("\n"); + sb.append(" gasMode: ").append(toIndentedString(gasMode)).append("\n"); + sb.append(" createTime: ").append(toIndentedString(createTime)).append("\n"); + sb.append(" amount: ").append(toIndentedString(amount)).append("\n"); + sb.append(" tokenAddress: ").append(toIndentedString(tokenAddress)).append("\n"); + sb.append(" chain: ").append(toIndentedString(chain)).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/Position.java b/src/main/java/io/gate/gateapi/models/Position.java index a7a4bd8..0c23eae 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/PositionClose.java b/src/main/java/io/gate/gateapi/models/PositionClose.java index 49cbf69..014bcbd 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/PositionCloseOrder.java b/src/main/java/io/gate/gateapi/models/PositionCloseOrder.java index 7f1dd25..bb36d41 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/ProfitLossRange.java b/src/main/java/io/gate/gateapi/models/ProfitLossRange.java index e1c55c6..1f73a8a 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/QuoteRequest.java b/src/main/java/io/gate/gateapi/models/QuoteRequest.java new file mode 100644 index 0000000..0498706 --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/QuoteRequest.java @@ -0,0 +1,189 @@ +/* + * Gate API v4 + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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; + +/** + * Quotation Request + */ +public class QuoteRequest { + public static final String SERIALIZED_NAME_CURRENCY = "currency"; + @SerializedName(SERIALIZED_NAME_CURRENCY) + private String currency; + + 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_GAS_MODE = "gas_mode"; + @SerializedName(SERIALIZED_NAME_GAS_MODE) + private String gasMode; + + public static final String SERIALIZED_NAME_SLIPPAGE = "slippage"; + @SerializedName(SERIALIZED_NAME_SLIPPAGE) + private String slippage; + + + public QuoteRequest currency(String currency) { + + this.currency = currency; + return this; + } + + /** + * Trading Symbol + * @return currency + **/ + public String getCurrency() { + return currency; + } + + + public void setCurrency(String currency) { + this.currency = currency; + } + + public QuoteRequest side(String side) { + + this.side = side; + return this; + } + + /** + * 买单或者卖单 - buy - sell + * @return side + **/ + public String getSide() { + return side; + } + + + public void setSide(String side) { + this.side = side; + } + + public QuoteRequest amount(String amount) { + + this.amount = amount; + return this; + } + + /** + * Trade Quantity - `side` : `buy` refers to the quote currency, i.e., `USDT` - `side` : `sell` refers to the base currency + * @return amount + **/ + public String getAmount() { + return amount; + } + + + public void setAmount(String amount) { + this.amount = amount; + } + + public QuoteRequest gasMode(String gasMode) { + + this.gasMode = gasMode; + return this; + } + + /** + * Trading mode affects slippage selection - `speed` : Smart mode - `custom` : Custom mode, uses `slippage` parameter + * @return gasMode + **/ + public String getGasMode() { + return gasMode; + } + + + public void setGasMode(String gasMode) { + this.gasMode = gasMode; + } + + public QuoteRequest slippage(String slippage) { + + this.slippage = slippage; + return this; + } + + /** + * Slippage value of 10 represents a 10% tolerance + * @return slippage + **/ + @javax.annotation.Nullable + public String getSlippage() { + return slippage; + } + + + public void setSlippage(String slippage) { + this.slippage = slippage; + } + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + QuoteRequest quoteRequest = (QuoteRequest) o; + return Objects.equals(this.currency, quoteRequest.currency) && + Objects.equals(this.side, quoteRequest.side) && + Objects.equals(this.amount, quoteRequest.amount) && + Objects.equals(this.gasMode, quoteRequest.gasMode) && + Objects.equals(this.slippage, quoteRequest.slippage); + } + + @Override + public int hashCode() { + return Objects.hash(currency, side, amount, gasMode, slippage); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class QuoteRequest {\n"); + sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); + sb.append(" side: ").append(toIndentedString(side)).append("\n"); + sb.append(" amount: ").append(toIndentedString(amount)).append("\n"); + sb.append(" gasMode: ").append(toIndentedString(gasMode)).append("\n"); + sb.append(" slippage: ").append(toIndentedString(slippage)).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/QuoteResponse.java b/src/main/java/io/gate/gateapi/models/QuoteResponse.java new file mode 100644 index 0000000..00cf02a --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/QuoteResponse.java @@ -0,0 +1,323 @@ +/* + * Gate API v4 + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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; + +/** + * Quotation Response + */ +public class QuoteResponse { + public static final String SERIALIZED_NAME_QUOTE_ID = "quote_id"; + @SerializedName(SERIALIZED_NAME_QUOTE_ID) + private String quoteId; + + public static final String SERIALIZED_NAME_MIN_AMOUNT = "min_amount"; + @SerializedName(SERIALIZED_NAME_MIN_AMOUNT) + private String minAmount; + + public static final String SERIALIZED_NAME_MAX_AMOUNT = "max_amount"; + @SerializedName(SERIALIZED_NAME_MAX_AMOUNT) + private String maxAmount; + + public static final String SERIALIZED_NAME_PRICE = "price"; + @SerializedName(SERIALIZED_NAME_PRICE) + private String price; + + public static final String SERIALIZED_NAME_SLIPPAGE = "slippage"; + @SerializedName(SERIALIZED_NAME_SLIPPAGE) + private String slippage; + + public static final String SERIALIZED_NAME_ESTIMATE_GAS_FEE_AMOUNT_USDT = "estimate_gas_fee_amount_usdt"; + @SerializedName(SERIALIZED_NAME_ESTIMATE_GAS_FEE_AMOUNT_USDT) + private String estimateGasFeeAmountUsdt; + + public static final String SERIALIZED_NAME_ORDER_FEE = "order_fee"; + @SerializedName(SERIALIZED_NAME_ORDER_FEE) + private String orderFee; + + public static final String SERIALIZED_NAME_TARGET_TOKEN_MIN_AMOUNT = "target_token_min_amount"; + @SerializedName(SERIALIZED_NAME_TARGET_TOKEN_MIN_AMOUNT) + private String targetTokenMinAmount; + + public static final String SERIALIZED_NAME_TARGET_TOKEN_MAX_AMOUNT = "target_token_max_amount"; + @SerializedName(SERIALIZED_NAME_TARGET_TOKEN_MAX_AMOUNT) + private String targetTokenMaxAmount; + + public static final String SERIALIZED_NAME_ERROR_TYPE = "error_type"; + @SerializedName(SERIALIZED_NAME_ERROR_TYPE) + private Integer errorType; + + + public QuoteResponse quoteId(String quoteId) { + + this.quoteId = quoteId; + return this; + } + + /** + * The quotation ID (quote_id) is used for placing orders and is valid for 1 minute + * @return quoteId + **/ + @javax.annotation.Nullable + public String getQuoteId() { + return quoteId; + } + + + public void setQuoteId(String quoteId) { + this.quoteId = quoteId; + } + + public QuoteResponse minAmount(String minAmount) { + + this.minAmount = minAmount; + return this; + } + + /** + * 最小下单量 + * @return minAmount + **/ + @javax.annotation.Nullable + public String getMinAmount() { + return minAmount; + } + + + public void setMinAmount(String minAmount) { + this.minAmount = minAmount; + } + + public QuoteResponse maxAmount(String maxAmount) { + + this.maxAmount = maxAmount; + return this; + } + + /** + * 最大下单量 + * @return maxAmount + **/ + @javax.annotation.Nullable + public String getMaxAmount() { + return maxAmount; + } + + + public void setMaxAmount(String maxAmount) { + this.maxAmount = maxAmount; + } + + public QuoteResponse price(String price) { + + this.price = price; + return this; + } + + /** + * Coin Price (USDT-based) + * @return price + **/ + @javax.annotation.Nullable + public String getPrice() { + return price; + } + + + public void setPrice(String price) { + this.price = price; + } + + public QuoteResponse slippage(String slippage) { + + this.slippage = slippage; + return this; + } + + /** + * Slippage + * @return slippage + **/ + @javax.annotation.Nullable + public String getSlippage() { + return slippage; + } + + + public void setSlippage(String slippage) { + this.slippage = slippage; + } + + public QuoteResponse estimateGasFeeAmountUsdt(String estimateGasFeeAmountUsdt) { + + this.estimateGasFeeAmountUsdt = estimateGasFeeAmountUsdt; + return this; + } + + /** + * Estimated Network Fee (USDT-based) + * @return estimateGasFeeAmountUsdt + **/ + @javax.annotation.Nullable + public String getEstimateGasFeeAmountUsdt() { + return estimateGasFeeAmountUsdt; + } + + + public void setEstimateGasFeeAmountUsdt(String estimateGasFeeAmountUsdt) { + this.estimateGasFeeAmountUsdt = estimateGasFeeAmountUsdt; + } + + public QuoteResponse orderFee(String orderFee) { + + this.orderFee = orderFee; + return this; + } + + /** + * Slippage value of 10 represents a 10% tolerance + * @return orderFee + **/ + @javax.annotation.Nullable + public String getOrderFee() { + return orderFee; + } + + + public void setOrderFee(String orderFee) { + this.orderFee = orderFee; + } + + public QuoteResponse targetTokenMinAmount(String targetTokenMinAmount) { + + this.targetTokenMinAmount = targetTokenMinAmount; + return this; + } + + /** + * 最小获得数量 + * @return targetTokenMinAmount + **/ + @javax.annotation.Nullable + public String getTargetTokenMinAmount() { + return targetTokenMinAmount; + } + + + public void setTargetTokenMinAmount(String targetTokenMinAmount) { + this.targetTokenMinAmount = targetTokenMinAmount; + } + + public QuoteResponse targetTokenMaxAmount(String targetTokenMaxAmount) { + + this.targetTokenMaxAmount = targetTokenMaxAmount; + return this; + } + + /** + * 最大获得数量 + * @return targetTokenMaxAmount + **/ + @javax.annotation.Nullable + public String getTargetTokenMaxAmount() { + return targetTokenMaxAmount; + } + + + public void setTargetTokenMaxAmount(String targetTokenMaxAmount) { + this.targetTokenMaxAmount = targetTokenMaxAmount; + } + + public QuoteResponse errorType(Integer errorType) { + + this.errorType = errorType; + return this; + } + + /** + * Failure Type - `0` : Success - `1` : Exceeds maximum value - `2` : Below minimum value + * @return errorType + **/ + @javax.annotation.Nullable + public Integer getErrorType() { + return errorType; + } + + + public void setErrorType(Integer errorType) { + this.errorType = errorType; + } + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + QuoteResponse quoteResponse = (QuoteResponse) o; + return Objects.equals(this.quoteId, quoteResponse.quoteId) && + Objects.equals(this.minAmount, quoteResponse.minAmount) && + Objects.equals(this.maxAmount, quoteResponse.maxAmount) && + Objects.equals(this.price, quoteResponse.price) && + Objects.equals(this.slippage, quoteResponse.slippage) && + Objects.equals(this.estimateGasFeeAmountUsdt, quoteResponse.estimateGasFeeAmountUsdt) && + Objects.equals(this.orderFee, quoteResponse.orderFee) && + Objects.equals(this.targetTokenMinAmount, quoteResponse.targetTokenMinAmount) && + Objects.equals(this.targetTokenMaxAmount, quoteResponse.targetTokenMaxAmount) && + Objects.equals(this.errorType, quoteResponse.errorType); + } + + @Override + public int hashCode() { + return Objects.hash(quoteId, minAmount, maxAmount, price, slippage, estimateGasFeeAmountUsdt, orderFee, targetTokenMinAmount, targetTokenMaxAmount, errorType); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class QuoteResponse {\n"); + sb.append(" quoteId: ").append(toIndentedString(quoteId)).append("\n"); + sb.append(" minAmount: ").append(toIndentedString(minAmount)).append("\n"); + sb.append(" maxAmount: ").append(toIndentedString(maxAmount)).append("\n"); + sb.append(" price: ").append(toIndentedString(price)).append("\n"); + sb.append(" slippage: ").append(toIndentedString(slippage)).append("\n"); + sb.append(" estimateGasFeeAmountUsdt: ").append(toIndentedString(estimateGasFeeAmountUsdt)).append("\n"); + sb.append(" orderFee: ").append(toIndentedString(orderFee)).append("\n"); + sb.append(" targetTokenMinAmount: ").append(toIndentedString(targetTokenMinAmount)).append("\n"); + sb.append(" targetTokenMaxAmount: ").append(toIndentedString(targetTokenMaxAmount)).append("\n"); + sb.append(" errorType: ").append(toIndentedString(errorType)).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/RebateUserInfo.java b/src/main/java/io/gate/gateapi/models/RebateUserInfo.java index 9da84bb..df358c5 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/RepayCurrencyRes.java b/src/main/java/io/gate/gateapi/models/RepayCurrencyRes.java index 0d9576b..213e833 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/RepayLoan.java b/src/main/java/io/gate/gateapi/models/RepayLoan.java index 5b78c48..351d6c1 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/RepayMultiLoan.java b/src/main/java/io/gate/gateapi/models/RepayMultiLoan.java index 362e2a6..1207c76 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/RepayRecord.java b/src/main/java/io/gate/gateapi/models/RepayRecord.java index 6b7fa64..f122899 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/RepayRecordCurrency.java b/src/main/java/io/gate/gateapi/models/RepayRecordCurrency.java index dc3e902..d4a2dde 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/RepayRecordLeftInterest.java b/src/main/java/io/gate/gateapi/models/RepayRecordLeftInterest.java index 248b868..86f9235 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/RepayRecordRepaidCurrency.java b/src/main/java/io/gate/gateapi/models/RepayRecordRepaidCurrency.java index 882f006..9d90d87 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/RepayRecordTotalInterest.java b/src/main/java/io/gate/gateapi/models/RepayRecordTotalInterest.java index 24f8c6e..0fd40d6 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/RepayResp.java b/src/main/java/io/gate/gateapi/models/RepayResp.java index 72cb7d7..3d28af0 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/RiskUnits.java b/src/main/java/io/gate/gateapi/models/RiskUnits.java index 4689568..36e53aa 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/SavedAddress.java b/src/main/java/io/gate/gateapi/models/SavedAddress.java index 76b0d9d..c36db4f 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/SmallBalance.java b/src/main/java/io/gate/gateapi/models/SmallBalance.java index bd7f842..1b7e13d 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/SmallBalanceHistory.java b/src/main/java/io/gate/gateapi/models/SmallBalanceHistory.java index 42b4e86..33d0681 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/SpotAccount.java b/src/main/java/io/gate/gateapi/models/SpotAccount.java index 4bf0813..d751e8b 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/SpotAccountBook.java b/src/main/java/io/gate/gateapi/models/SpotAccountBook.java index 82b375e..03b6e22 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/SpotCurrencyChain.java b/src/main/java/io/gate/gateapi/models/SpotCurrencyChain.java index 399e6ff..0c6ade0 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/SpotFee.java b/src/main/java/io/gate/gateapi/models/SpotFee.java index dcefeb9..1ee5406 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/SpotInsuranceHistory.java b/src/main/java/io/gate/gateapi/models/SpotInsuranceHistory.java index 8fb839d..90764c1 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/SpotPricePutOrder.java b/src/main/java/io/gate/gateapi/models/SpotPricePutOrder.java index 23be167..9c8b45a 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/SpotPriceTrigger.java b/src/main/java/io/gate/gateapi/models/SpotPriceTrigger.java index 2ba9356..e1f6ccd 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/SpotPriceTriggeredOrder.java b/src/main/java/io/gate/gateapi/models/SpotPriceTriggeredOrder.java index b38d095..5f47309 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/StpGroup.java b/src/main/java/io/gate/gateapi/models/StpGroup.java index e50faf2..fc0bb30 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/StpGroupUser.java b/src/main/java/io/gate/gateapi/models/StpGroupUser.java index 864e5fc..bb95acb 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/StructuredBuy.java b/src/main/java/io/gate/gateapi/models/StructuredBuy.java index d262e96..f73f553 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/StructuredGetProjectList.java b/src/main/java/io/gate/gateapi/models/StructuredGetProjectList.java index f0dddf8..c528ccf 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/StructuredOrderList.java b/src/main/java/io/gate/gateapi/models/StructuredOrderList.java index 9a266de..f8080e8 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/SubAccount.java b/src/main/java/io/gate/gateapi/models/SubAccount.java index ede3d21..ca93612 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/SubAccountBalance.java b/src/main/java/io/gate/gateapi/models/SubAccountBalance.java index 836efb6..bde6280 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/SubAccountCrossMarginBalance.java b/src/main/java/io/gate/gateapi/models/SubAccountCrossMarginBalance.java index b8045f2..7b75403 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/SubAccountFuturesBalance.java b/src/main/java/io/gate/gateapi/models/SubAccountFuturesBalance.java index da7fe1c..55ecc8c 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/SubAccountKey.java b/src/main/java/io/gate/gateapi/models/SubAccountKey.java index 3ffbd44..40293ab 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 @@ -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; } diff --git a/src/main/java/io/gate/gateapi/models/SubAccountKeyPerms.java b/src/main/java/io/gate/gateapi/models/SubAccountKeyPerms.java index bdcd639..37c942b 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/SubAccountMarginBalance.java b/src/main/java/io/gate/gateapi/models/SubAccountMarginBalance.java index 7540dec..0d93608 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/SubAccountToSubAccount.java b/src/main/java/io/gate/gateapi/models/SubAccountToSubAccount.java index 89f839c..5487c2b 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/SubAccountTransfer.java b/src/main/java/io/gate/gateapi/models/SubAccountTransfer.java index 26aa343..21c9149 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 @@ -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 + * 操作的子账号交易账户， spot - 现货账户， futures - 永续合约账户， delivery - 交割合约账户, options - 期权账户 * @return subAccountType **/ @javax.annotation.Nullable @@ -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; @@ -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..29c838d --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/SubAccountTransferRecordItem.java @@ -0,0 +1,289 @@ +/* + * Gate API v4 + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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; + +/** + * 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; + } + + /** + * 操作的子账号交易账户， spot - 现货账户， futures - 永续合约账户， delivery - 交割合约账户, options - 期权账户 + * @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; + } + + /** + * Where the operation is initiated from + * @return source + **/ + @javax.annotation.Nullable + public String getSource() { + return source; + } + + + public SubAccountTransferRecordItem clientOrderId(String clientOrderId) { + + this.clientOrderId = clientOrderId; + return this; + } + + /** + * 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. + * @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 5fed791..b45231e 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/SubUserMode.java b/src/main/java/io/gate/gateapi/models/SubUserMode.java index 93b2948..ab1fa47 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 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..e537e69 --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/SwapCoin.java @@ -0,0 +1,164 @@ +/* + * Gate API v4 + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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; + +/** + * 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/SystemTime.java b/src/main/java/io/gate/gateapi/models/SystemTime.java index 6308689..26fafce 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/Ticker.java b/src/main/java/io/gate/gateapi/models/Ticker.java index 0fcb1f7..f012674 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/Ticker2.java b/src/main/java/io/gate/gateapi/models/Ticker2.java new file mode 100644 index 0000000..0f23fee --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/Ticker2.java @@ -0,0 +1,193 @@ +/* + * Gate API v4 + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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; + +/** + * Ticker2 + */ +public class Ticker2 { + public static final String SERIALIZED_NAME_CURRENCY = "currency"; + @SerializedName(SERIALIZED_NAME_CURRENCY) + private String currency; + + public static final String SERIALIZED_NAME_LAST = "last"; + @SerializedName(SERIALIZED_NAME_LAST) + private String last; + + public static final String SERIALIZED_NAME_CHANGE = "change"; + @SerializedName(SERIALIZED_NAME_CHANGE) + private String change; + + public static final String SERIALIZED_NAME_VOLUME = "volume"; + @SerializedName(SERIALIZED_NAME_VOLUME) + private String volume; + + public static final String SERIALIZED_NAME_MARKET_CAP = "market_cap"; + @SerializedName(SERIALIZED_NAME_MARKET_CAP) + private String marketCap; + + + public Ticker2 currency(String currency) { + + this.currency = currency; + return this; + } + + /** + * Currency symbol + * @return currency + **/ + @javax.annotation.Nullable + public String getCurrency() { + return currency; + } + + + public void setCurrency(String currency) { + this.currency = currency; + } + + public Ticker2 last(String last) { + + this.last = last; + return this; + } + + /** + * Last trading price + * @return last + **/ + @javax.annotation.Nullable + public String getLast() { + return last; + } + + + public void setLast(String last) { + this.last = last; + } + + public Ticker2 change(String change) { + + this.change = change; + return this; + } + + /** + * Change percentage in the last 24h + * @return change + **/ + @javax.annotation.Nullable + public String getChange() { + return change; + } + + + public void setChange(String change) { + this.change = change; + } + + public Ticker2 volume(String volume) { + + this.volume = volume; + return this; + } + + /** + * 24h Trading Volume (USDT) + * @return volume + **/ + @javax.annotation.Nullable + public String getVolume() { + return volume; + } + + + public void setVolume(String volume) { + this.volume = volume; + } + + public Ticker2 marketCap(String marketCap) { + + this.marketCap = marketCap; + return this; + } + + /** + * Current Coin Market Value + * @return marketCap + **/ + @javax.annotation.Nullable + public String getMarketCap() { + return marketCap; + } + + + public void setMarketCap(String marketCap) { + this.marketCap = marketCap; + } + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Ticker2 ticker2 = (Ticker2) o; + return Objects.equals(this.currency, ticker2.currency) && + Objects.equals(this.last, ticker2.last) && + Objects.equals(this.change, ticker2.change) && + Objects.equals(this.volume, ticker2.volume) && + Objects.equals(this.marketCap, ticker2.marketCap); + } + + @Override + public int hashCode() { + return Objects.hash(currency, last, change, volume, marketCap); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Ticker2 {\n"); + sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); + sb.append(" last: ").append(toIndentedString(last)).append("\n"); + sb.append(" change: ").append(toIndentedString(change)).append("\n"); + sb.append(" volume: ").append(toIndentedString(volume)).append("\n"); + sb.append(" marketCap: ").append(toIndentedString(marketCap)).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/TotalBalance.java b/src/main/java/io/gate/gateapi/models/TotalBalance.java index bd6dd04..40e3883 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/Trade.java b/src/main/java/io/gate/gateapi/models/Trade.java index e53cebc..b7c012a 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/TradeFee.java b/src/main/java/io/gate/gateapi/models/TradeFee.java index 7ab4987..be4429a 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/TransactionID.java b/src/main/java/io/gate/gateapi/models/TransactionID.java index 8556e32..874664f 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/Transfer.java b/src/main/java/io/gate/gateapi/models/Transfer.java index ee3067c..99b0e1b 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/TransferOrderStatus.java b/src/main/java/io/gate/gateapi/models/TransferOrderStatus.java index 0d39c9a..7e5f475 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/TransferablesResult.java b/src/main/java/io/gate/gateapi/models/TransferablesResult.java index b66b414..dffcea6 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/TriggerOrderResponse.java b/src/main/java/io/gate/gateapi/models/TriggerOrderResponse.java index 8d8f072..28fa91f 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/TriggerTime.java b/src/main/java/io/gate/gateapi/models/TriggerTime.java index 2981afb..22f34f5 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UidPushOrder.java b/src/main/java/io/gate/gateapi/models/UidPushOrder.java index f6fdeef..907e68a 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UidPushWithdrawal.java b/src/main/java/io/gate/gateapi/models/UidPushWithdrawal.java index 1b68439..ea92c87 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UidPushWithdrawalResp.java b/src/main/java/io/gate/gateapi/models/UidPushWithdrawalResp.java index 46929bf..cd4272a 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UniCurrency.java b/src/main/java/io/gate/gateapi/models/UniCurrency.java index b002cf5..8335fdc 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UniCurrencyInterest.java b/src/main/java/io/gate/gateapi/models/UniCurrencyInterest.java index 58573df..78d7a2f 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UniCurrencyPair.java b/src/main/java/io/gate/gateapi/models/UniCurrencyPair.java index c83a614..883646c 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UniInterestRecord.java b/src/main/java/io/gate/gateapi/models/UniInterestRecord.java index 1c6809b..93895e2 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UniLend.java b/src/main/java/io/gate/gateapi/models/UniLend.java index 64305b1..dd52d07 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UniLendInterest.java b/src/main/java/io/gate/gateapi/models/UniLendInterest.java index cc77201..5f46761 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UniLendRecord.java b/src/main/java/io/gate/gateapi/models/UniLendRecord.java index 22da10b..6dedfc6 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UniLoan.java b/src/main/java/io/gate/gateapi/models/UniLoan.java index dd1f922..8a3673b 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UniLoanInterestRecord.java b/src/main/java/io/gate/gateapi/models/UniLoanInterestRecord.java index 15edbe2..cf867aa 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UniLoanRecord.java b/src/main/java/io/gate/gateapi/models/UniLoanRecord.java index 0a40aec..723fcc4 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedAccount.java b/src/main/java/io/gate/gateapi/models/UnifiedAccount.java index b1119a7..2b625ec 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedBalance.java b/src/main/java/io/gate/gateapi/models/UnifiedBalance.java index 9c5615a..a1368e1 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedBorrowable.java b/src/main/java/io/gate/gateapi/models/UnifiedBorrowable.java index 436159b..ff44ea0 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedBorrowable1.java b/src/main/java/io/gate/gateapi/models/UnifiedBorrowable1.java index 9f3e292..d0c64a5 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedCurrency.java b/src/main/java/io/gate/gateapi/models/UnifiedCurrency.java index 01c3cb7..1c9fcda 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedDiscount.java b/src/main/java/io/gate/gateapi/models/UnifiedDiscount.java index 1cb6bcc..660c902 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedDiscountTiers.java b/src/main/java/io/gate/gateapi/models/UnifiedDiscountTiers.java index de7625f..b8ca30c 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedHistoryLoanRate.java b/src/main/java/io/gate/gateapi/models/UnifiedHistoryLoanRate.java index 4c0fe2c..712da6f 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedHistoryLoanRateRates.java b/src/main/java/io/gate/gateapi/models/UnifiedHistoryLoanRateRates.java index 82da3d4..a976886 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedLeverageConfig.java b/src/main/java/io/gate/gateapi/models/UnifiedLeverageConfig.java index b9c3c20..74304f8 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedLeverageSetting.java b/src/main/java/io/gate/gateapi/models/UnifiedLeverageSetting.java index 7ed4c19..846dbbe 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedLoan.java b/src/main/java/io/gate/gateapi/models/UnifiedLoan.java index ba5dae6..c579627 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedLoanRecord.java b/src/main/java/io/gate/gateapi/models/UnifiedLoanRecord.java index 0a9e362..d1d8266 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedLoanResult.java b/src/main/java/io/gate/gateapi/models/UnifiedLoanResult.java index f34c9ce..0159733 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedMarginTiers.java b/src/main/java/io/gate/gateapi/models/UnifiedMarginTiers.java index 963b2aa..8370cae 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedModeSet.java b/src/main/java/io/gate/gateapi/models/UnifiedModeSet.java index 5e724ba..9c97c9b 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedPortfolioInput.java b/src/main/java/io/gate/gateapi/models/UnifiedPortfolioInput.java index ab36e64..5bcbc05 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedPortfolioOutput.java b/src/main/java/io/gate/gateapi/models/UnifiedPortfolioOutput.java index c8adf73..c87da6c 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedRiskUnits.java b/src/main/java/io/gate/gateapi/models/UnifiedRiskUnits.java index 6c8effe..3ad309c 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedSettings.java b/src/main/java/io/gate/gateapi/models/UnifiedSettings.java index 718ad35..6f0859e 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedTransferable.java b/src/main/java/io/gate/gateapi/models/UnifiedTransferable.java index bf15f53..7a88c6e 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UserLtvInfo.java b/src/main/java/io/gate/gateapi/models/UserLtvInfo.java index 797c6c5..e0751ba 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UserSub.java b/src/main/java/io/gate/gateapi/models/UserSub.java index 536943b..c08f3b4 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UserSubRelation.java b/src/main/java/io/gate/gateapi/models/UserSubRelation.java index 065ec11..2e9314f 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/UserTotalAmount.java b/src/main/java/io/gate/gateapi/models/UserTotalAmount.java index ea6ec78..3a68b81 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/WithdrawStatus.java b/src/main/java/io/gate/gateapi/models/WithdrawStatus.java index dc72aad..e8ba68f 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 diff --git a/src/main/java/io/gate/gateapi/models/WithdrawalRecord.java b/src/main/java/io/gate/gateapi/models/WithdrawalRecord.java index c027354..eaac616 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. + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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 From 07d7cb99f7958342549c41c47b91bf72d96dda5a Mon Sep 17 00:00:00 2001 From: gateio Date: Wed, 2 Jul 2025 10:25:57 +0000 Subject: [PATCH 03/14] update to v6.100.1 --- .github/workflows/maven-publish.yml | 8 +- README.md | 30 +- build.gradle | 2 +- build.sbt | 2 +- docs/AccountBookResponse.md | 15 - docs/AccountsResponse.md | 15 - docs/AlphaApi.md | 601 -------- docs/Currency2.md | 15 - docs/EarnUniApi.md | 8 +- docs/OrderResponse.md | 23 - docs/PlaceOrderRequest.md | 16 - docs/PlaceOrderResponse.md | 18 - docs/QuoteRequest.md | 15 - docs/QuoteResponse.md | 20 - docs/SpotAccount.md | 1 - docs/Ticker2.md | 13 - docs/UnifiedAccount.md | 1 + docs/UnifiedApi.md | 71 +- docs/UnifiedBalance.md | 1 + docs/UnifiedCollateralReq.md | 18 + docs/UnifiedCollateralRes.md | 11 + pom.xml | 8 +- settings.xml | 4 +- src/main/java/io/gate/gateapi/ApiClient.java | 2 +- .../java/io/gate/gateapi/api/AlphaApi.java | 1236 ----------------- .../java/io/gate/gateapi/api/EarnUniApi.java | 28 +- .../java/io/gate/gateapi/api/UnifiedApi.java | 115 +- .../gateapi/models/AccountBookResponse.java | 193 --- .../gate/gateapi/models/AccountsResponse.java | 193 --- .../io/gate/gateapi/models/Currency2.java | 245 ---- .../io/gate/gateapi/models/OrderResponse.java | 401 ------ .../gateapi/models/PlaceOrderRequest.java | 214 --- .../gateapi/models/PlaceOrderResponse.java | 271 ---- .../io/gate/gateapi/models/QuoteRequest.java | 189 --- .../io/gate/gateapi/models/QuoteResponse.java | 323 ----- .../io/gate/gateapi/models/SpotAccount.java | 30 +- .../java/io/gate/gateapi/models/Ticker2.java | 193 --- .../gate/gateapi/models/UnifiedAccount.java | 30 +- .../gate/gateapi/models/UnifiedBalance.java | 30 +- .../gateapi/models/UnifiedCollateralReq.java | 206 +++ .../gateapi/models/UnifiedCollateralRes.java | 89 ++ 41 files changed, 605 insertions(+), 4299 deletions(-) delete mode 100644 docs/AccountBookResponse.md delete mode 100644 docs/AccountsResponse.md delete mode 100644 docs/AlphaApi.md delete mode 100644 docs/Currency2.md delete mode 100644 docs/OrderResponse.md delete mode 100644 docs/PlaceOrderRequest.md delete mode 100644 docs/PlaceOrderResponse.md delete mode 100644 docs/QuoteRequest.md delete mode 100644 docs/QuoteResponse.md delete mode 100644 docs/Ticker2.md create mode 100644 docs/UnifiedCollateralReq.md create mode 100644 docs/UnifiedCollateralRes.md delete mode 100644 src/main/java/io/gate/gateapi/api/AlphaApi.java delete mode 100644 src/main/java/io/gate/gateapi/models/AccountBookResponse.java delete mode 100644 src/main/java/io/gate/gateapi/models/AccountsResponse.java delete mode 100644 src/main/java/io/gate/gateapi/models/Currency2.java delete mode 100644 src/main/java/io/gate/gateapi/models/OrderResponse.java delete mode 100644 src/main/java/io/gate/gateapi/models/PlaceOrderRequest.java delete mode 100644 src/main/java/io/gate/gateapi/models/PlaceOrderResponse.java delete mode 100644 src/main/java/io/gate/gateapi/models/QuoteRequest.java delete mode 100644 src/main/java/io/gate/gateapi/models/QuoteResponse.java delete mode 100644 src/main/java/io/gate/gateapi/models/Ticker2.java create mode 100644 src/main/java/io/gate/gateapi/models/UnifiedCollateralReq.java create mode 100644 src/main/java/io/gate/gateapi/models/UnifiedCollateralRes.java 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 f2760a3..948cd62 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ Gate API v4 -- API version: 4.100.0 -- SDK version: 6.100.0 +- API version: 4.100.1 +- SDK version: 6.100.1 Welcome to Gate API @@ -54,7 +54,7 @@ Add this dependency to your project's POM: io.gate gate-api - 6.100.0 + 6.100.1 compile ``` @@ -64,7 +64,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.100.0" +compile "io.gate:gate-api:6.100.1" ``` ### Others @@ -77,7 +77,7 @@ mvn clean package Then manually install the following JARs: -* `target/gate-api-6.100.0.jar` +* `target/gate-api-6.100.1.jar` * `target/lib/*.jar` To install the API client library to your local Maven repository, simply execute: @@ -151,14 +151,6 @@ Class | Method | HTTP request | Description *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. -*AlphaApi* | [**listAlphaAccounts**](docs/AlphaApi.md#listAlphaAccounts) | **GET** /alpha/accounts | API for Alpha Accounts -*AlphaApi* | [**listAlphaAccountBook**](docs/AlphaApi.md#listAlphaAccountBook) | **GET** /alpha/account_book | Alpha Asset Transaction API -*AlphaApi* | [**quoteAlphaOrder**](docs/AlphaApi.md#quoteAlphaOrder) | **POST** /alpha/quote | Alpha Quotation API -*AlphaApi* | [**listAlphaOrder**](docs/AlphaApi.md#listAlphaOrder) | **GET** /alpha/orders | Alpha 查询订单列表接口 -*AlphaApi* | [**placeAlphaOrder**](docs/AlphaApi.md#placeAlphaOrder) | **POST** /alpha/orders | Alpha Order Placement API -*AlphaApi* | [**getAlphaOrder**](docs/AlphaApi.md#getAlphaOrder) | **GET** /alpha/order | Alpha 查询单个订单接口 -*AlphaApi* | [**listAlphaCurrencies**](docs/AlphaApi.md#listAlphaCurrencies) | **GET** /alpha/currencies | 查询币种信息 -*AlphaApi* | [**listAlphaTickers**](docs/AlphaApi.md#listAlphaTickers) | **GET** /alpha/tickers | 查询币种ticker *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 @@ -405,6 +397,7 @@ Class | Method | HTTP request | Description *UnifiedApi* | [**setUserLeverageCurrencySetting**](docs/UnifiedApi.md#setUserLeverageCurrencySetting) | **POST** /unified/leverage/user_currency_setting | Set the 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 +*UnifiedApi* | [**setUnifiedCollateral**](docs/UnifiedApi.md#setUnifiedCollateral) | **POST** /unified/collateral_currencies | 设置抵押币种 *WalletApi* | [**listCurrencyChains**](docs/WalletApi.md#listCurrencyChains) | **GET** /wallet/currency_chains | List 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 @@ -434,11 +427,9 @@ Class | Method | HTTP request | Description ## Documentation for Models - [AccountBalance](docs/AccountBalance.md) - - [AccountBookResponse](docs/AccountBookResponse.md) - [AccountDetail](docs/AccountDetail.md) - [AccountDetailKey](docs/AccountDetailKey.md) - [AccountRateLimit](docs/AccountRateLimit.md) - - [AccountsResponse](docs/AccountsResponse.md) - [AgencyCommission](docs/AgencyCommission.md) - [AgencyCommissionHistory](docs/AgencyCommissionHistory.md) - [AgencyTransaction](docs/AgencyTransaction.md) @@ -482,7 +473,6 @@ Class | Method | HTTP request | Description - [CrossMarginLoan](docs/CrossMarginLoan.md) - [CrossMarginRepayment](docs/CrossMarginRepayment.md) - [Currency](docs/Currency.md) - - [Currency2](docs/Currency2.md) - [CurrencyChain](docs/CurrencyChain.md) - [CurrencyPair](docs/CurrencyPair.md) - [CurrencyQuota](docs/CurrencyQuota.md) @@ -584,21 +574,16 @@ Class | Method | HTTP request | Description - [OrderCancel](docs/OrderCancel.md) - [OrderPatch](docs/OrderPatch.md) - [OrderResp](docs/OrderResp.md) - - [OrderResponse](docs/OrderResponse.md) - [PartnerCommissionHistory](docs/PartnerCommissionHistory.md) - [PartnerSub](docs/PartnerSub.md) - [PartnerSubList](docs/PartnerSubList.md) - [PartnerTransactionHistory](docs/PartnerTransactionHistory.md) - [PatchUniLend](docs/PatchUniLend.md) - [PlaceDualInvestmentOrder](docs/PlaceDualInvestmentOrder.md) - - [PlaceOrderRequest](docs/PlaceOrderRequest.md) - - [PlaceOrderResponse](docs/PlaceOrderResponse.md) - [Position](docs/Position.md) - [PositionClose](docs/PositionClose.md) - [PositionCloseOrder](docs/PositionCloseOrder.md) - [ProfitLossRange](docs/ProfitLossRange.md) - - [QuoteRequest](docs/QuoteRequest.md) - - [QuoteResponse](docs/QuoteResponse.md) - [RebateUserInfo](docs/RebateUserInfo.md) - [RepayCurrencyRes](docs/RepayCurrencyRes.md) - [RepayLoan](docs/RepayLoan.md) @@ -641,7 +626,6 @@ Class | Method | HTTP request | Description - [SwapCoin](docs/SwapCoin.md) - [SystemTime](docs/SystemTime.md) - [Ticker](docs/Ticker.md) - - [Ticker2](docs/Ticker2.md) - [TotalBalance](docs/TotalBalance.md) - [Trade](docs/Trade.md) - [TradeFee](docs/TradeFee.md) @@ -668,6 +652,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) diff --git a/build.gradle b/build.gradle index 9648d93..954e21f 100644 --- a/build.gradle +++ b/build.gradle @@ -3,7 +3,7 @@ apply plugin: 'eclipse' apply plugin: 'java' group = 'io.gate' -version = '6.100.0' +version = '6.100.1' buildscript { repositories { diff --git a/build.sbt b/build.sbt index d37ad1a..7e20389 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.100.0", + version := "6.100.1", scalaVersion := "2.11.4", scalacOptions ++= Seq("-feature"), javacOptions in compile ++= Seq("-Xlint:deprecation"), diff --git a/docs/AccountBookResponse.md b/docs/AccountBookResponse.md deleted file mode 100644 index abe96d0..0000000 --- a/docs/AccountBookResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - -# AccountBookResponse - -Quotation Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **Long** | Order ID | [optional] -**time** | **Long** | 操作时间戳 | [optional] -**currency** | **String** | Currency name | [optional] -**change** | **String** | Change amount | [optional] -**balance** | **String** | 变更后余额 | [optional] - diff --git a/docs/AccountsResponse.md b/docs/AccountsResponse.md deleted file mode 100644 index 47a37cd..0000000 --- a/docs/AccountsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ - -# AccountsResponse - -Quotation Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**currency** | **String** | Currency name | [optional] -**available** | **String** | Available Balance | [optional] -**locked** | **String** | 锁定余额 | [optional] -**tokenAddress** | **String** | token 地址 | [optional] -**chain** | **String** | 区块链名称 | [optional] - diff --git a/docs/AlphaApi.md b/docs/AlphaApi.md deleted file mode 100644 index 8825b1c..0000000 --- a/docs/AlphaApi.md +++ /dev/null @@ -1,601 +0,0 @@ -# AlphaApi - -All URIs are relative to *https://api.gateio.ws/api/v4* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**listAlphaAccounts**](AlphaApi.md#listAlphaAccounts) | **GET** /alpha/accounts | API for Alpha Accounts -[**listAlphaAccountBook**](AlphaApi.md#listAlphaAccountBook) | **GET** /alpha/account_book | Alpha Asset Transaction API -[**quoteAlphaOrder**](AlphaApi.md#quoteAlphaOrder) | **POST** /alpha/quote | Alpha Quotation API -[**listAlphaOrder**](AlphaApi.md#listAlphaOrder) | **GET** /alpha/orders | Alpha 查询订单列表接口 -[**placeAlphaOrder**](AlphaApi.md#placeAlphaOrder) | **POST** /alpha/orders | Alpha Order Placement API -[**getAlphaOrder**](AlphaApi.md#getAlphaOrder) | **GET** /alpha/order | Alpha 查询单个订单接口 -[**listAlphaCurrencies**](AlphaApi.md#listAlphaCurrencies) | **GET** /alpha/currencies | 查询币种信息 -[**listAlphaTickers**](AlphaApi.md#listAlphaTickers) | **GET** /alpha/tickers | 查询币种ticker - - - -# **listAlphaAccounts** -> List<AccountsResponse> listAlphaAccounts() - -API for Alpha Accounts - -Query Position Assets - -### 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.AlphaApi; - -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"); - - AlphaApi apiInstance = new AlphaApi(defaultClient); - try { - List result = apiInstance.listAlphaAccounts(); - 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 AlphaApi#listAlphaAccounts"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**List<AccountsResponse>**](AccountsResponse.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** | 查询持仓成功 | - | - - -# **listAlphaAccountBook** -> List<AccountBookResponse> listAlphaAccountBook(from).to(to).page(page).limit(limit).execute(); - -Alpha Asset Transaction API - -Query Asset Transactions - -### 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.AlphaApi; - -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"); - - AlphaApi apiInstance = new AlphaApi(defaultClient); - Long from = 56L; // Long | Start timestamp of the query - Long to = 56L; // Long | Time range ending, default to current time - Integer page = 56; // Integer | Page number - Integer limit = 56; // Integer | The maximum number of items per page is 100 - try { - List result = apiInstance.listAlphaAccountBook(from) - .to(to) - .page(page) - .limit(limit) - .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 AlphaApi#listAlphaAccountBook"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **from** | **Long**| Start timestamp of the query | - **to** | **Long**| Time range ending, default to current time | [optional] - **page** | **Integer**| Page number | [optional] - **limit** | **Integer**| The maximum number of items per page is 100 | [optional] - -### Return type - -[**List<AccountBookResponse>**](AccountBookResponse.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** | 查询流水成功 | - | - - -# **quoteAlphaOrder** -> QuoteResponse quoteAlphaOrder(quoteRequest) - -Alpha Quotation API - -The quote_id returned by the quotation API is valid for one minute.You must place the order within this time window;otherwise, the quote will expire and a new quotation request is required - -### 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.AlphaApi; - -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"); - - AlphaApi apiInstance = new AlphaApi(defaultClient); - QuoteRequest quoteRequest = new QuoteRequest(); // QuoteRequest | - try { - QuoteResponse result = apiInstance.quoteAlphaOrder(quoteRequest); - 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 AlphaApi#quoteAlphaOrder"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **quoteRequest** | [**QuoteRequest**](QuoteRequest.md)| | - -### Return type - -[**QuoteResponse**](QuoteResponse.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** | 询价成功 | - | - - -# **listAlphaOrder** -> List<OrderResponse> listAlphaOrder(currency, side, status).from(from).to(to).limit(limit).page(page).execute(); - -Alpha 查询订单列表接口 - -### 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.AlphaApi; - -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"); - - AlphaApi apiInstance = new AlphaApi(defaultClient); - String currency = "memeboxsst"; // String | Trading Symbol - String side = "buy"; // String | 买单或者卖单 - buy - sell - Integer status = 2; // Integer | Order Status - `0` : All - `1` : Processing - `2` : Successful - `3` : Failed - `4` : Canceled - `5` : Buy order placed but transfer not completed - `6` : Cancelled order with transfer not complete - Long from = 1627706330L; // Long | 查询订单的起始时间 - Long to = 1635329650L; // Long | 查询订单的结束时间，不指定则默认为当前时间 - Integer limit = 100; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 100 - Integer page = 1; // Integer | Page number - try { - List result = apiInstance.listAlphaOrder(currency, side, status) - .from(from) - .to(to) - .limit(limit) - .page(page) - .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 AlphaApi#listAlphaOrder"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **currency** | **String**| Trading Symbol | - **side** | **String**| 买单或者卖单 - buy - sell | - **status** | **Integer**| Order Status - `0` : All - `1` : Processing - `2` : Successful - `3` : Failed - `4` : Canceled - `5` : Buy order placed but transfer not completed - `6` : Cancelled order with transfer not complete | - **from** | **Long**| 查询订单的起始时间 | [optional] - **to** | **Long**| 查询订单的结束时间，不指定则默认为当前时间 | [optional] - **limit** | **Integer**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100] - **page** | **Integer**| Page number | [optional] [default to 1] - -### Return type - -[**List<OrderResponse>**](OrderResponse.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 | - | - - -# **placeAlphaOrder** -> PlaceOrderResponse placeAlphaOrder(placeOrderRequest) - -Alpha Order Placement API - -### 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.AlphaApi; - -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"); - - AlphaApi apiInstance = new AlphaApi(defaultClient); - PlaceOrderRequest placeOrderRequest = new PlaceOrderRequest(); // PlaceOrderRequest | - try { - PlaceOrderResponse result = apiInstance.placeAlphaOrder(placeOrderRequest); - 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 AlphaApi#placeAlphaOrder"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **placeOrderRequest** | [**PlaceOrderRequest**](PlaceOrderRequest.md)| | - -### Return type - -[**PlaceOrderResponse**](PlaceOrderResponse.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** | Success | - | - - -# **getAlphaOrder** -> OrderResponse getAlphaOrder(orderId) - -Alpha 查询单个订单接口 - -### 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.AlphaApi; - -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"); - - AlphaApi apiInstance = new AlphaApi(defaultClient); - String orderId = "fdaf12321"; // String | Order ID - try { - OrderResponse result = apiInstance.getAlphaOrder(orderId); - 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 AlphaApi#getAlphaOrder"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **orderId** | **String**| Order ID | - -### Return type - -[**OrderResponse**](OrderResponse.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** | 订单查询成功 | - | - - -# **listAlphaCurrencies** -> List<Currency2> listAlphaCurrencies().currency(currency).limit(limit).page(page).execute(); - -查询币种信息 - -When the currency parameter is provided, query and return information for the specified currency. When the currency parameter is not provided, return a paginated list of currencies. - -### 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.AlphaApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("https://api.gateio.ws/api/v4"); - - AlphaApi apiInstance = new AlphaApi(defaultClient); - String currency = "memeboxtrump"; // String | 根据币种符号查询币种信息 - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list - Integer page = 1; // Integer | Page number - try { - List result = apiInstance.listAlphaCurrencies() - .currency(currency) - .limit(limit) - .page(page) - .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 AlphaApi#listAlphaCurrencies"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **currency** | **String**| 根据币种符号查询币种信息 | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] - **page** | **Integer**| Page number | [optional] [default to 1] - -### Return type - -[**List<Currency2>**](Currency2.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 | - | - - -# **listAlphaTickers** -> List<Ticker2> listAlphaTickers().currency(currency).limit(limit).page(page).execute(); - -查询币种ticker - -When the currency parameter is provided, query and return information for the specified ticker, When the currency parameter is not provided, return a paginated list of tickers. - -### 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.AlphaApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("https://api.gateio.ws/api/v4"); - - AlphaApi apiInstance = new AlphaApi(defaultClient); - String currency = "memeboxtrump"; // String | Retrieve data of the specified currency - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list - Integer page = 1; // Integer | Page number - try { - List result = apiInstance.listAlphaTickers() - .currency(currency) - .limit(limit) - .page(page) - .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 AlphaApi#listAlphaTickers"); - 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] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] - **page** | **Integer**| Page number | [optional] [default to 1] - -### Return type - -[**List<Ticker2>**](Ticker2.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 | - | - diff --git a/docs/Currency2.md b/docs/Currency2.md deleted file mode 100644 index c74c23c..0000000 --- a/docs/Currency2.md +++ /dev/null @@ -1,15 +0,0 @@ - -# Currency2 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**currency** | **String** | Currency symbol | [optional] -**name** | **String** | Currency name | [optional] -**chain** | **String** | The main chain corresponding to the coin | [optional] -**address** | **String** | Contract Address | [optional] -**amountPrecision** | **Integer** | Amount scale | [optional] -**precision** | **Integer** | Price scale | [optional] -**status** | **Integer** | 币种交易状态 - `1` : 正常交易 - `2` : 暂停交易 - `3` : 下架 | [optional] - diff --git a/docs/EarnUniApi.md b/docs/EarnUniApi.md index 7dbe6a5..fc24566 100644 --- a/docs/EarnUniApi.md +++ b/docs/EarnUniApi.md @@ -664,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-07-01 13:02+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-02 10:25+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 ### Example @@ -730,7 +730,7 @@ 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-07-01 13:02+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-02 10:25+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 | - | # **listUniRate** @@ -738,7 +738,7 @@ Name | Type | Description | Notes Currency estimate annualized interest rate -Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-01 13:02+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-02 10:25+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 ### Example @@ -796,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-07-01 13:02+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-02 10:25+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 | - | diff --git a/docs/OrderResponse.md b/docs/OrderResponse.md deleted file mode 100644 index e8ac550..0000000 --- a/docs/OrderResponse.md +++ /dev/null @@ -1,23 +0,0 @@ - -# OrderResponse - -下单返回 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**orderId** | **String** | Order ID | [optional] -**txHash** | **String** | Transaction Hash | [optional] -**side** | **String** | 买单或者卖单 - buy - sell | [optional] -**usdtAmount** | **String** | Amount | [optional] -**currency** | **String** | 币 | [optional] -**currencyAmount** | **String** | Currency amount | [optional] -**status** | **Integer** | Order Status - `0` : All - `1` : Processing - `2` : Successful - `3` : Failed - `4` : Canceled - `5` : Buy order placed but transfer not completed - `6` : Cancelled order with transfer not complete | [optional] -**gasMode** | **String** | Trading mode affects slippage selection - `speed` : Smart mode - `custom` : Custom mode, uses `slippage` parameter | [optional] -**chain** | **String** | 链 | [optional] -**gasFee** | **String** | Miner Fee (USDT-based) | [optional] -**transactionFee** | **String** | Trading Fee (USDT-based) | [optional] -**failedReason** | **String** | Failure reason (if any) | [optional] -**createTime** | **Long** | 创建时间（时间戳） | [optional] - diff --git a/docs/PlaceOrderRequest.md b/docs/PlaceOrderRequest.md deleted file mode 100644 index 6ddc70d..0000000 --- a/docs/PlaceOrderRequest.md +++ /dev/null @@ -1,16 +0,0 @@ - -# PlaceOrderRequest - -下单请求 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**currency** | **String** | Trading Symbol | -**side** | **String** | 买单或者卖单 - buy - sell | -**amount** | **String** | Trade Quantity - `side` : `buy` refers to the quote currency, i.e., `USDT` - `side` : `sell` refers to the base currency | -**gasMode** | **String** | Trading mode affects slippage selection - `speed` : Smart mode - `custom` : Custom mode, uses `slippage` parameter | -**slippage** | **String** | Slippage value of 10 represents a 10% tolerance | [optional] -**quoteId** | **String** | The quote_id returned by the quotation API | - diff --git a/docs/PlaceOrderResponse.md b/docs/PlaceOrderResponse.md deleted file mode 100644 index a9c07b5..0000000 --- a/docs/PlaceOrderResponse.md +++ /dev/null @@ -1,18 +0,0 @@ - -# PlaceOrderResponse - -下单返回 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**orderId** | **String** | Order ID | [optional] -**status** | **Integer** | Order Status - `0` : All - `1` : Processing - `2` : Successful - `3` : Failed - `4` : Canceled - `5` : Buy order placed but transfer not completed - `6` : Cancelled order with transfer not complete | [optional] -**side** | **String** | 买单或者卖单 - buy - sell | [optional] -**gasMode** | **String** | Trading mode affects slippage selection - `speed` : Smart mode - `custom` : Custom mode, uses `slippage` parameter | [optional] -**createTime** | **Long** | 创建时间 (时间戳) | [optional] -**amount** | **String** | Trade Quantity - `side` : `buy` refers to the quote currency, i.e., `USDT` - `side` : `sell` refers to the base currency | [optional] -**tokenAddress** | **String** | 币地址 | [optional] -**chain** | **String** | Chain name | [optional] - diff --git a/docs/QuoteRequest.md b/docs/QuoteRequest.md deleted file mode 100644 index 2d19ac0..0000000 --- a/docs/QuoteRequest.md +++ /dev/null @@ -1,15 +0,0 @@ - -# QuoteRequest - -Quotation Request - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**currency** | **String** | Trading Symbol | -**side** | **String** | 买单或者卖单 - buy - sell | -**amount** | **String** | Trade Quantity - `side` : `buy` refers to the quote currency, i.e., `USDT` - `side` : `sell` refers to the base currency | -**gasMode** | **String** | Trading mode affects slippage selection - `speed` : Smart mode - `custom` : Custom mode, uses `slippage` parameter | -**slippage** | **String** | Slippage value of 10 represents a 10% tolerance | [optional] - diff --git a/docs/QuoteResponse.md b/docs/QuoteResponse.md deleted file mode 100644 index 3c28182..0000000 --- a/docs/QuoteResponse.md +++ /dev/null @@ -1,20 +0,0 @@ - -# QuoteResponse - -Quotation Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**quoteId** | **String** | The quotation ID (quote_id) is used for placing orders and is valid for 1 minute | [optional] -**minAmount** | **String** | 最小下单量 | [optional] -**maxAmount** | **String** | 最大下单量 | [optional] -**price** | **String** | Coin Price (USDT-based) | [optional] -**slippage** | **String** | Slippage | [optional] -**estimateGasFeeAmountUsdt** | **String** | Estimated Network Fee (USDT-based) | [optional] -**orderFee** | **String** | Slippage value of 10 represents a 10% tolerance | [optional] -**targetTokenMinAmount** | **String** | 最小获得数量 | [optional] -**targetTokenMaxAmount** | **String** | 最大获得数量 | [optional] -**errorType** | **Integer** | Failure Type - `0` : Success - `1` : Exceeds maximum value - `2` : Below minimum value | [optional] - diff --git a/docs/SpotAccount.md b/docs/SpotAccount.md index 87cba1e..167c46d 100644 --- a/docs/SpotAccount.md +++ b/docs/SpotAccount.md @@ -9,5 +9,4 @@ Name | Type | Description | Notes **available** | **String** | Available amount | [optional] **locked** | **String** | Locked amount, used in trading | [optional] **updateId** | **Long** | Version number | [optional] -**refreshTime** | **Long** | Asset Refresh Time (ms) | [optional] diff --git a/docs/Ticker2.md b/docs/Ticker2.md deleted file mode 100644 index 840ceee..0000000 --- a/docs/Ticker2.md +++ /dev/null @@ -1,13 +0,0 @@ - -# Ticker2 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**currency** | **String** | Currency symbol | [optional] -**last** | **String** | Last trading price | [optional] -**change** | **String** | Change percentage in the last 24h | [optional] -**volume** | **String** | 24h Trading Volume (USDT) | [optional] -**marketCap** | **String** | Current Coin Market Value | [optional] - diff --git a/docs/UnifiedAccount.md b/docs/UnifiedAccount.md index 1dcaf5d..a77dbee 100644 --- a/docs/UnifiedAccount.md +++ b/docs/UnifiedAccount.md @@ -24,4 +24,5 @@ Name | Type | Description | Notes **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] +**isAllCollateral** | **Boolean** | 是否所有币种均作为保证金，true - 所有币种作为保证金，false - 否 | [optional] diff --git a/docs/UnifiedApi.md b/docs/UnifiedApi.md index ed84a98..52e97e1 100644 --- a/docs/UnifiedApi.md +++ b/docs/UnifiedApi.md @@ -25,6 +25,7 @@ Method | HTTP request | Description [**setUserLeverageCurrencySetting**](UnifiedApi.md#setUserLeverageCurrencySetting) | **POST** /unified/leverage/user_currency_setting | Set the 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 +[**setUnifiedCollateral**](UnifiedApi.md#setUnifiedCollateral) | **POST** /unified/collateral_currencies | 设置抵押币种 @@ -825,7 +826,7 @@ This endpoint does not need any parameter. 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\" } ``` +每种账户模式的切换只需要传对应账户模式的参数，同时支持在切换账户模式时打开或关闭对应账户模式下的配置开关 - 开通经典账户模式时，mode=classic ``` PUT /unified/unified_mode { \"mode\": \"classic\" } ``` - 开通跨币种保证金模式，mode=multi_currency ``` PUT /unified/unified_mode { \"mode\": \"multi_currency\", \"settings\": { \"usdt_futures\": true } } ``` - 开通组合保证金模式时，mode=portfolio ``` PUT /unified/unified_mode { \"mode\": \"portfolio\", \"settings\": { \"spot_hedge\": true } } ``` - 开通单币种保证金模式时，mode=single_currency ``` PUT /unified/unified_mode { \"mode\": \"single_currency\" } ``` ### Example @@ -1491,3 +1492,71 @@ No authorization required |-------------|-------------|------------------| **200** | Successfully retrieved | - | + +# **setUnifiedCollateral** +> UnifiedCollateralRes setUnifiedCollateral(unifiedCollateralReq) + +设置抵押币种 + +### 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** | 更新成功 | - | + diff --git a/docs/UnifiedBalance.md b/docs/UnifiedBalance.md index 7142311..b47aba2 100644 --- a/docs/UnifiedBalance.md +++ b/docs/UnifiedBalance.md @@ -24,4 +24,5 @@ Name | Type | Description | Notes **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] +**enabledCollateral** | **Boolean** | 币种开启作为保证金，true - 启用，false - 未启用 | [optional] diff --git a/docs/UnifiedCollateralReq.md b/docs/UnifiedCollateralReq.md new file mode 100644 index 0000000..1252a81 --- /dev/null +++ b/docs/UnifiedCollateralReq.md @@ -0,0 +1,18 @@ + +# UnifiedCollateralReq + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**collateralType** | [**CollateralTypeEnum**](#CollateralTypeEnum) | 用户设置抵押物模式 0(all)-全部币种作为抵押物,1(custom)-自定义币种作为抵押物,collateral_type为0(all)时，enable_list与disable_list参数无效 | [optional] +**enableList** | **List<String>** | 币种列表，collateral_type=1(custom)表示追加的逻辑 | [optional] +**disableList** | **List<String>** | 取消列表，表示取消的逻辑 | [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..e36c9d1 --- /dev/null +++ b/docs/UnifiedCollateralRes.md @@ -0,0 +1,11 @@ + +# UnifiedCollateralRes + +统一账户抵押模式设置返回 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**isSuccess** | **Boolean** | 是否设置成功 | [optional] + diff --git a/pom.xml b/pom.xml index 4de7e6d..73a68d4 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ gate-api jar gate-api - 6.100.0 + 6.100.1 https://github.com/gateio/gateapi-java.git Java client for gateapi @@ -189,7 +189,7 @@ true ossrh - https://s01.oss.sonatype.org/ + https://ossrh-staging-api.central.sonatype.com true @@ -230,11 +230,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/ApiClient.java b/src/main/java/io/gate/gateapi/ApiClient.java index 8718a9e..275300b 100644 --- a/src/main/java/io/gate/gateapi/ApiClient.java +++ b/src/main/java/io/gate/gateapi/ApiClient.java @@ -113,7 +113,7 @@ private void init() { json = new JSON(); // Set default User-Agent. - setUserAgent("OpenAPI-Generator/6.100.0/java"); + setUserAgent("OpenAPI-Generator/6.100.1/java"); authentications = new HashMap(); } diff --git a/src/main/java/io/gate/gateapi/api/AlphaApi.java b/src/main/java/io/gate/gateapi/api/AlphaApi.java deleted file mode 100644 index 1d6860c..0000000 --- a/src/main/java/io/gate/gateapi/api/AlphaApi.java +++ /dev/null @@ -1,1236 +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.api; - -import io.gate.gateapi.ApiCallback; -import io.gate.gateapi.ApiClient; -import io.gate.gateapi.ApiException; -import io.gate.gateapi.ApiResponse; -import io.gate.gateapi.Configuration; -import io.gate.gateapi.Pair; - -import com.google.gson.reflect.TypeToken; - - -import io.gate.gateapi.models.AccountBookResponse; -import io.gate.gateapi.models.AccountsResponse; -import io.gate.gateapi.models.Currency2; -import io.gate.gateapi.models.OrderResponse; -import io.gate.gateapi.models.PlaceOrderRequest; -import io.gate.gateapi.models.PlaceOrderResponse; -import io.gate.gateapi.models.QuoteRequest; -import io.gate.gateapi.models.QuoteResponse; -import io.gate.gateapi.models.Ticker2; - -import java.lang.reflect.Type; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -public class AlphaApi { - private ApiClient localVarApiClient; - - public AlphaApi() { - this(Configuration.getDefaultApiClient()); - } - - public AlphaApi(ApiClient apiClient) { - this.localVarApiClient = apiClient; - } - - public ApiClient getApiClient() { - return localVarApiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.localVarApiClient = apiClient; - } - - /** - * Build call for listAlphaAccounts - * @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 查询持仓成功 -
- */ - public okhttp3.Call listAlphaAccountsCall(final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/alpha/accounts"; - - 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); - } - - @SuppressWarnings("rawtypes") - private okhttp3.Call listAlphaAccountsValidateBeforeCall(final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = listAlphaAccountsCall(_callback); - return localVarCall; - } - - /** - * API for Alpha Accounts - * Query Position Assets - * @return List<AccountsResponse> - * @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 查询持仓成功 -
- */ - public List listAlphaAccounts() throws ApiException { - ApiResponse> localVarResp = listAlphaAccountsWithHttpInfo(); - return localVarResp.getData(); - } - - /** - * API for Alpha Accounts - * Query Position Assets - * @return ApiResponse<List<AccountsResponse>> - * @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 查询持仓成功 -
- */ - public ApiResponse> listAlphaAccountsWithHttpInfo() throws ApiException { - okhttp3.Call localVarCall = listAlphaAccountsValidateBeforeCall(null); - Type localVarReturnType = new TypeToken>(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - /** - * API for Alpha Accounts (asynchronously) - * Query Position Assets - * @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 查询持仓成功 -
- */ - public okhttp3.Call listAlphaAccountsAsync(final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = listAlphaAccountsValidateBeforeCall(_callback); - Type localVarReturnType = new TypeToken>(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - private okhttp3.Call listAlphaAccountBookCall(Long from, Long to, Integer page, Integer limit, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/alpha/account_book"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - 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)); - } - - 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 listAlphaAccountBookValidateBeforeCall(Long from, Long to, Integer page, Integer limit, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'from' is set - if (from == null) { - throw new ApiException("Missing the required parameter 'from' when calling listAlphaAccountBook(Async)"); - } - - okhttp3.Call localVarCall = listAlphaAccountBookCall(from, to, page, limit, _callback); - return localVarCall; - } - - - private ApiResponse> listAlphaAccountBookWithHttpInfo(Long from, Long to, Integer page, Integer limit) throws ApiException { - okhttp3.Call localVarCall = listAlphaAccountBookValidateBeforeCall(from, to, page, limit, null); - Type localVarReturnType = new TypeToken>(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - private okhttp3.Call listAlphaAccountBookAsync(Long from, Long to, Integer page, Integer limit, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = listAlphaAccountBookValidateBeforeCall(from, to, page, limit, _callback); - Type localVarReturnType = new TypeToken>(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - public class APIlistAlphaAccountBookRequest { - private final Long from; - private Long to; - private Integer page; - private Integer limit; - - private APIlistAlphaAccountBookRequest(Long from) { - this.from = from; - } - - /** - * Set to - * @param to Time range ending, default to current time (optional) - * @return APIlistAlphaAccountBookRequest - */ - public APIlistAlphaAccountBookRequest to(Long to) { - this.to = to; - return this; - } - - /** - * Set page - * @param page Page number (optional) - * @return APIlistAlphaAccountBookRequest - */ - public APIlistAlphaAccountBookRequest page(Integer page) { - this.page = page; - return this; - } - - /** - * Set limit - * @param limit The maximum number of items per page is 100 (optional) - * @return APIlistAlphaAccountBookRequest - */ - public APIlistAlphaAccountBookRequest limit(Integer limit) { - this.limit = limit; - return this; - } - - /** - * Build call for listAlphaAccountBook - * @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 查询流水成功 -
- */ - public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { - return listAlphaAccountBookCall(from, to, page, limit, _callback); - } - - /** - * Execute listAlphaAccountBook request - * @return List<AccountBookResponse> - * @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 查询流水成功 -
- */ - public List execute() throws ApiException { - ApiResponse> localVarResp = listAlphaAccountBookWithHttpInfo(from, to, page, limit); - return localVarResp.getData(); - } - - /** - * Execute listAlphaAccountBook request with HTTP info returned - * @return ApiResponse<List<AccountBookResponse>> - * @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 查询流水成功 -
- */ - public ApiResponse> executeWithHttpInfo() throws ApiException { - return listAlphaAccountBookWithHttpInfo(from, to, page, limit); - } - - /** - * Execute listAlphaAccountBook 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 查询流水成功 -
- */ - public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { - return listAlphaAccountBookAsync(from, to, page, limit, _callback); - } - } - - /** - * Alpha Asset Transaction API - * Query Asset Transactions - * @param from Start timestamp of the query (required) - * @return APIlistAlphaAccountBookRequest - * @http.response.details - - - -
Status Code Description Response Headers
200 查询流水成功 -
- */ - public APIlistAlphaAccountBookRequest listAlphaAccountBook(Long from) { - return new APIlistAlphaAccountBookRequest(from); - } - - /** - * Build call for quoteAlphaOrder - * @param quoteRequest (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 询价成功 -
- */ - public okhttp3.Call quoteAlphaOrderCall(QuoteRequest quoteRequest, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = quoteRequest; - - // create path and map variables - String localVarPath = "/alpha/quote"; - - 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 quoteAlphaOrderValidateBeforeCall(QuoteRequest quoteRequest, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'quoteRequest' is set - if (quoteRequest == null) { - throw new ApiException("Missing the required parameter 'quoteRequest' when calling quoteAlphaOrder(Async)"); - } - - okhttp3.Call localVarCall = quoteAlphaOrderCall(quoteRequest, _callback); - return localVarCall; - } - - /** - * Alpha Quotation API - * The quote_id returned by the quotation API is valid for one minute.You must place the order within this time window;otherwise, the quote will expire and a new quotation request is required - * @param quoteRequest (required) - * @return QuoteResponse - * @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 询价成功 -
- */ - public QuoteResponse quoteAlphaOrder(QuoteRequest quoteRequest) throws ApiException { - ApiResponse localVarResp = quoteAlphaOrderWithHttpInfo(quoteRequest); - return localVarResp.getData(); - } - - /** - * Alpha Quotation API - * The quote_id returned by the quotation API is valid for one minute.You must place the order within this time window;otherwise, the quote will expire and a new quotation request is required - * @param quoteRequest (required) - * @return ApiResponse<QuoteResponse> - * @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 询价成功 -
- */ - public ApiResponse quoteAlphaOrderWithHttpInfo(QuoteRequest quoteRequest) throws ApiException { - okhttp3.Call localVarCall = quoteAlphaOrderValidateBeforeCall(quoteRequest, null); - Type localVarReturnType = new TypeToken(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - /** - * Alpha Quotation API (asynchronously) - * The quote_id returned by the quotation API is valid for one minute.You must place the order within this time window;otherwise, the quote will expire and a new quotation request is required - * @param quoteRequest (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 询价成功 -
- */ - public okhttp3.Call quoteAlphaOrderAsync(QuoteRequest quoteRequest, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = quoteAlphaOrderValidateBeforeCall(quoteRequest, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - private okhttp3.Call listAlphaOrderCall(String currency, String side, Integer status, Long from, Long to, Integer limit, Integer page, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/alpha/orders"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - if (currency != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); - } - - if (side != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("side", side)); - } - - if (status != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("status", status)); - } - - if (from != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("from", from)); - } - - if (to != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("to", to)); - } - - if (limit != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("limit", limit)); - } - - if (page != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("page", page)); - } - - 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 listAlphaOrderValidateBeforeCall(String currency, String side, Integer status, Long from, Long to, Integer limit, Integer page, 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 listAlphaOrder(Async)"); - } - - // verify the required parameter 'side' is set - if (side == null) { - throw new ApiException("Missing the required parameter 'side' when calling listAlphaOrder(Async)"); - } - - // verify the required parameter 'status' is set - if (status == null) { - throw new ApiException("Missing the required parameter 'status' when calling listAlphaOrder(Async)"); - } - - okhttp3.Call localVarCall = listAlphaOrderCall(currency, side, status, from, to, limit, page, _callback); - return localVarCall; - } - - - private ApiResponse> listAlphaOrderWithHttpInfo(String currency, String side, Integer status, Long from, Long to, Integer limit, Integer page) throws ApiException { - okhttp3.Call localVarCall = listAlphaOrderValidateBeforeCall(currency, side, status, from, to, limit, page, null); - Type localVarReturnType = new TypeToken>(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - private okhttp3.Call listAlphaOrderAsync(String currency, String side, Integer status, Long from, Long to, Integer limit, Integer page, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = listAlphaOrderValidateBeforeCall(currency, side, status, from, to, limit, page, _callback); - Type localVarReturnType = new TypeToken>(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - public class APIlistAlphaOrderRequest { - private final String currency; - private final String side; - private final Integer status; - private Long from; - private Long to; - private Integer limit; - private Integer page; - - private APIlistAlphaOrderRequest(String currency, String side, Integer status) { - this.currency = currency; - this.side = side; - this.status = status; - } - - /** - * Set from - * @param from 查询订单的起始时间 (optional) - * @return APIlistAlphaOrderRequest - */ - public APIlistAlphaOrderRequest from(Long from) { - this.from = from; - return this; - } - - /** - * Set to - * @param to 查询订单的结束时间，不指定则默认为当前时间 (optional) - * @return APIlistAlphaOrderRequest - */ - public APIlistAlphaOrderRequest to(Long to) { - this.to = to; - return this; - } - - /** - * Set limit - * @param limit Maximum response items. Default: 100, minimum: 1, Maximum: 100 (optional, default to 100) - * @return APIlistAlphaOrderRequest - */ - public APIlistAlphaOrderRequest limit(Integer limit) { - this.limit = limit; - return this; - } - - /** - * Set page - * @param page Page number (optional, default to 1) - * @return APIlistAlphaOrderRequest - */ - public APIlistAlphaOrderRequest page(Integer page) { - this.page = page; - return this; - } - - /** - * Build call for listAlphaOrder - * @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 listAlphaOrderCall(currency, side, status, from, to, limit, page, _callback); - } - - /** - * Execute listAlphaOrder request - * @return List<OrderResponse> - * @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 = listAlphaOrderWithHttpInfo(currency, side, status, from, to, limit, page); - return localVarResp.getData(); - } - - /** - * Execute listAlphaOrder request with HTTP info returned - * @return ApiResponse<List<OrderResponse>> - * @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 listAlphaOrderWithHttpInfo(currency, side, status, from, to, limit, page); - } - - /** - * Execute listAlphaOrder 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 listAlphaOrderAsync(currency, side, status, from, to, limit, page, _callback); - } - } - - /** - * Alpha 查询订单列表接口 - * - * @param currency Trading Symbol (required) - * @param side 买单或者卖单 - buy - sell (required) - * @param status Order Status - `0` : All - `1` : Processing - `2` : Successful - `3` : Failed - `4` : Canceled - `5` : Buy order placed but transfer not completed - `6` : Cancelled order with transfer not complete (required) - * @return APIlistAlphaOrderRequest - * @http.response.details - - - -
Status Code Description Response Headers
200 List retrieved -
- */ - public APIlistAlphaOrderRequest listAlphaOrder(String currency, String side, Integer status) { - return new APIlistAlphaOrderRequest(currency, side, status); - } - - /** - * Build call for placeAlphaOrder - * @param placeOrderRequest (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 -
- */ - public okhttp3.Call placeAlphaOrderCall(PlaceOrderRequest placeOrderRequest, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = placeOrderRequest; - - // create path and map variables - String localVarPath = "/alpha/orders"; - - 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 placeAlphaOrderValidateBeforeCall(PlaceOrderRequest placeOrderRequest, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'placeOrderRequest' is set - if (placeOrderRequest == null) { - throw new ApiException("Missing the required parameter 'placeOrderRequest' when calling placeAlphaOrder(Async)"); - } - - okhttp3.Call localVarCall = placeAlphaOrderCall(placeOrderRequest, _callback); - return localVarCall; - } - - /** - * Alpha Order Placement API - * - * @param placeOrderRequest (required) - * @return PlaceOrderResponse - * @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 -
- */ - public PlaceOrderResponse placeAlphaOrder(PlaceOrderRequest placeOrderRequest) throws ApiException { - ApiResponse localVarResp = placeAlphaOrderWithHttpInfo(placeOrderRequest); - return localVarResp.getData(); - } - - /** - * Alpha Order Placement API - * - * @param placeOrderRequest (required) - * @return ApiResponse<PlaceOrderResponse> - * @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 -
- */ - public ApiResponse placeAlphaOrderWithHttpInfo(PlaceOrderRequest placeOrderRequest) throws ApiException { - okhttp3.Call localVarCall = placeAlphaOrderValidateBeforeCall(placeOrderRequest, null); - Type localVarReturnType = new TypeToken(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - /** - * Alpha Order Placement API (asynchronously) - * - * @param placeOrderRequest (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 -
- */ - public okhttp3.Call placeAlphaOrderAsync(PlaceOrderRequest placeOrderRequest, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = placeAlphaOrderValidateBeforeCall(placeOrderRequest, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - /** - * Build call for getAlphaOrder - * @param orderId Order 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 订单查询成功 -
- */ - public okhttp3.Call getAlphaOrderCall(String orderId, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/alpha/order"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - if (orderId != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("order_id", orderId)); - } - - 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 getAlphaOrderValidateBeforeCall(String orderId, final ApiCallback _callback) throws ApiException { - // verify the required parameter 'orderId' is set - if (orderId == null) { - throw new ApiException("Missing the required parameter 'orderId' when calling getAlphaOrder(Async)"); - } - - okhttp3.Call localVarCall = getAlphaOrderCall(orderId, _callback); - return localVarCall; - } - - /** - * Alpha 查询单个订单接口 - * - * @param orderId Order ID (required) - * @return OrderResponse - * @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 订单查询成功 -
- */ - public OrderResponse getAlphaOrder(String orderId) throws ApiException { - ApiResponse localVarResp = getAlphaOrderWithHttpInfo(orderId); - return localVarResp.getData(); - } - - /** - * Alpha 查询单个订单接口 - * - * @param orderId Order ID (required) - * @return ApiResponse<OrderResponse> - * @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 订单查询成功 -
- */ - public ApiResponse getAlphaOrderWithHttpInfo(String orderId) throws ApiException { - okhttp3.Call localVarCall = getAlphaOrderValidateBeforeCall(orderId, null); - Type localVarReturnType = new TypeToken(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - /** - * Alpha 查询单个订单接口 (asynchronously) - * - * @param orderId Order 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 订单查询成功 -
- */ - public okhttp3.Call getAlphaOrderAsync(String orderId, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = getAlphaOrderValidateBeforeCall(orderId, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - private okhttp3.Call listAlphaCurrenciesCall(String currency, Integer limit, Integer page, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/alpha/currencies"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - if (currency != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); - } - - if (limit != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("limit", limit)); - } - - if (page != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("page", page)); - } - - 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 listAlphaCurrenciesValidateBeforeCall(String currency, Integer limit, Integer page, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = listAlphaCurrenciesCall(currency, limit, page, _callback); - return localVarCall; - } - - - private ApiResponse> listAlphaCurrenciesWithHttpInfo(String currency, Integer limit, Integer page) throws ApiException { - okhttp3.Call localVarCall = listAlphaCurrenciesValidateBeforeCall(currency, limit, page, null); - Type localVarReturnType = new TypeToken>(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - private okhttp3.Call listAlphaCurrenciesAsync(String currency, Integer limit, Integer page, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = listAlphaCurrenciesValidateBeforeCall(currency, limit, page, _callback); - Type localVarReturnType = new TypeToken>(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - public class APIlistAlphaCurrenciesRequest { - private String currency; - private Integer limit; - private Integer page; - - private APIlistAlphaCurrenciesRequest() { - } - - /** - * Set currency - * @param currency 根据币种符号查询币种信息 (optional) - * @return APIlistAlphaCurrenciesRequest - */ - public APIlistAlphaCurrenciesRequest currency(String currency) { - this.currency = currency; - return this; - } - - /** - * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) - * @return APIlistAlphaCurrenciesRequest - */ - public APIlistAlphaCurrenciesRequest limit(Integer limit) { - this.limit = limit; - return this; - } - - /** - * Set page - * @param page Page number (optional, default to 1) - * @return APIlistAlphaCurrenciesRequest - */ - public APIlistAlphaCurrenciesRequest page(Integer page) { - this.page = page; - return this; - } - - /** - * Build call for listAlphaCurrencies - * @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 -
- */ - public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { - return listAlphaCurrenciesCall(currency, limit, page, _callback); - } - - /** - * Execute listAlphaCurrencies request - * @return List<Currency2> - * @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 execute() throws ApiException { - ApiResponse> localVarResp = listAlphaCurrenciesWithHttpInfo(currency, limit, page); - return localVarResp.getData(); - } - - /** - * Execute listAlphaCurrencies request with HTTP info returned - * @return ApiResponse<List<Currency2>> - * @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> executeWithHttpInfo() throws ApiException { - return listAlphaCurrenciesWithHttpInfo(currency, limit, page); - } - - /** - * Execute listAlphaCurrencies 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 -
- */ - public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { - return listAlphaCurrenciesAsync(currency, limit, page, _callback); - } - } - - /** - * 查询币种信息 - * When the currency parameter is provided, query and return information for the specified currency. When the currency parameter is not provided, return a paginated list of currencies. - * @return APIlistAlphaCurrenciesRequest - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- */ - public APIlistAlphaCurrenciesRequest listAlphaCurrencies() { - return new APIlistAlphaCurrenciesRequest(); - } - - private okhttp3.Call listAlphaTickersCall(String currency, Integer limit, Integer page, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/alpha/tickers"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - if (currency != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("currency", currency)); - } - - if (limit != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("limit", limit)); - } - - if (page != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("page", page)); - } - - 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 listAlphaTickersValidateBeforeCall(String currency, Integer limit, Integer page, final ApiCallback _callback) throws ApiException { - okhttp3.Call localVarCall = listAlphaTickersCall(currency, limit, page, _callback); - return localVarCall; - } - - - private ApiResponse> listAlphaTickersWithHttpInfo(String currency, Integer limit, Integer page) throws ApiException { - okhttp3.Call localVarCall = listAlphaTickersValidateBeforeCall(currency, limit, page, null); - Type localVarReturnType = new TypeToken>(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - private okhttp3.Call listAlphaTickersAsync(String currency, Integer limit, Integer page, final ApiCallback> _callback) throws ApiException { - okhttp3.Call localVarCall = listAlphaTickersValidateBeforeCall(currency, limit, page, _callback); - Type localVarReturnType = new TypeToken>(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - - public class APIlistAlphaTickersRequest { - private String currency; - private Integer limit; - private Integer page; - - private APIlistAlphaTickersRequest() { - } - - /** - * Set currency - * @param currency Retrieve data of the specified currency (optional) - * @return APIlistAlphaTickersRequest - */ - public APIlistAlphaTickersRequest currency(String currency) { - this.currency = currency; - return this; - } - - /** - * Set limit - * @param limit Maximum number of records to be returned in a single list (optional, default to 100) - * @return APIlistAlphaTickersRequest - */ - public APIlistAlphaTickersRequest limit(Integer limit) { - this.limit = limit; - return this; - } - - /** - * Set page - * @param page Page number (optional, default to 1) - * @return APIlistAlphaTickersRequest - */ - public APIlistAlphaTickersRequest page(Integer page) { - this.page = page; - return this; - } - - /** - * Build call for listAlphaTickers - * @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 -
- */ - public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { - return listAlphaTickersCall(currency, limit, page, _callback); - } - - /** - * Execute listAlphaTickers request - * @return List<Ticker2> - * @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 execute() throws ApiException { - ApiResponse> localVarResp = listAlphaTickersWithHttpInfo(currency, limit, page); - return localVarResp.getData(); - } - - /** - * Execute listAlphaTickers request with HTTP info returned - * @return ApiResponse<List<Ticker2>> - * @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> executeWithHttpInfo() throws ApiException { - return listAlphaTickersWithHttpInfo(currency, limit, page); - } - - /** - * Execute listAlphaTickers 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 -
- */ - public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { - return listAlphaTickersAsync(currency, limit, page, _callback); - } - } - - /** - * 查询币种ticker - * When the currency parameter is provided, query and return information for the specified ticker, When the currency parameter is not provided, return a paginated list of tickers. - * @return APIlistAlphaTickersRequest - * @http.response.details - - - -
Status Code Description Response Headers
200 Successfully retrieved -
- */ - public APIlistAlphaTickersRequest listAlphaTickers() { - return new APIlistAlphaTickersRequest(); - } - -} diff --git a/src/main/java/io/gate/gateapi/api/EarnUniApi.java b/src/main/java/io/gate/gateapi/api/EarnUniApi.java index 6834f81..5b73d0f 100644 --- a/src/main/java/io/gate/gateapi/api/EarnUniApi.java +++ b/src/main/java/io/gate/gateapi/api/EarnUniApi.java @@ -1289,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-07-01 13:02+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-02 10:25+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 -
*/ public okhttp3.Call listUniChartCall(Long from, Long to, String asset, final ApiCallback _callback) throws ApiException { @@ -1356,7 +1356,7 @@ 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-07-01 13:02+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-02 10:25+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) * @param asset Currency name (required) @@ -1365,7 +1365,7 @@ private okhttp3.Call listUniChartValidateBeforeCall(Long from, Long to, String a * @http.response.details - +
Status Code Description Response Headers
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-01 13:02+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-02 10:25+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 -
*/ public List listUniChart(Long from, Long to, String asset) throws ApiException { @@ -1375,7 +1375,7 @@ 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-07-01 13:02+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-02 10:25+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) * @param asset Currency name (required) @@ -1384,7 +1384,7 @@ public List listUniChart(Long from, Long to, String asset) th * @http.response.details - +
Status Code Description Response Headers
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-01 13:02+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-02 10:25+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 -
*/ public ApiResponse> listUniChartWithHttpInfo(Long from, Long to, String asset) throws ApiException { @@ -1395,7 +1395,7 @@ 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-07-01 13:02+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-02 10:25+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) * @param asset Currency name (required) @@ -1405,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-07-01 13:02+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-02 10:25+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 -
*/ public okhttp3.Call listUniChartAsync(Long from, Long to, String asset, final ApiCallback> _callback) throws ApiException { @@ -1423,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-07-01 13:02+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-02 10:25+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 -
*/ public okhttp3.Call listUniRateCall(final ApiCallback _callback) throws ApiException { @@ -1463,13 +1463,13 @@ 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-07-01 13:02+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-02 10:25+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 * @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-07-01 13:02+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-02 10:25+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 -
*/ public List listUniRate() throws ApiException { @@ -1479,13 +1479,13 @@ 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-07-01 13:02+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-02 10:25+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 * @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-07-01 13:02+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-02 10:25+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 -
*/ public ApiResponse> listUniRateWithHttpInfo() throws ApiException { @@ -1496,14 +1496,14 @@ 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-07-01 13:02+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-02 10:25+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 _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-07-01 13:02+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-02 10:25+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 -
*/ public okhttp3.Call listUniRateAsync(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 17552a1..1c854ad 100644 --- a/src/main/java/io/gate/gateapi/api/UnifiedApi.java +++ b/src/main/java/io/gate/gateapi/api/UnifiedApi.java @@ -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; @@ -1619,7 +1621,7 @@ 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\" } ``` + * 每种账户模式的切换只需要传对应账户模式的参数，同时支持在切换账户模式时打开或关闭对应账户模式下的配置开关 - 开通经典账户模式时，mode=classic ``` PUT /unified/unified_mode { \"mode\": \"classic\" } ``` - 开通跨币种保证金模式，mode=multi_currency ``` PUT /unified/unified_mode { \"mode\": \"multi_currency\", \"settings\": { \"usdt_futures\": true } } ``` - 开通组合保证金模式时，mode=portfolio ``` PUT /unified/unified_mode { \"mode\": \"portfolio\", \"settings\": { \"spot_hedge\": true } } ``` - 开通单币种保证金模式时，mode=single_currency ``` PUT /unified/unified_mode { \"mode\": \"single_currency\" } ``` * @param unifiedModeSet (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1634,7 +1636,7 @@ 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\" } ``` + * 每种账户模式的切换只需要传对应账户模式的参数，同时支持在切换账户模式时打开或关闭对应账户模式下的配置开关 - 开通经典账户模式时，mode=classic ``` PUT /unified/unified_mode { \"mode\": \"classic\" } ``` - 开通跨币种保证金模式，mode=multi_currency ``` PUT /unified/unified_mode { \"mode\": \"multi_currency\", \"settings\": { \"usdt_futures\": true } } ``` - 开通组合保证金模式时，mode=portfolio ``` PUT /unified/unified_mode { \"mode\": \"portfolio\", \"settings\": { \"spot_hedge\": true } } ``` - 开通单币种保证金模式时，mode=single_currency ``` PUT /unified/unified_mode { \"mode\": \"single_currency\" } ``` * @param unifiedModeSet (required) * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -1651,7 +1653,7 @@ 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\" } ``` + * 每种账户模式的切换只需要传对应账户模式的参数，同时支持在切换账户模式时打开或关闭对应账户模式下的配置开关 - 开通经典账户模式时，mode=classic ``` PUT /unified/unified_mode { \"mode\": \"classic\" } ``` - 开通跨币种保证金模式，mode=multi_currency ``` PUT /unified/unified_mode { \"mode\": \"multi_currency\", \"settings\": { \"usdt_futures\": true } } ``` - 开通组合保证金模式时，mode=portfolio ``` PUT /unified/unified_mode { \"mode\": \"portfolio\", \"settings\": { \"spot_hedge\": true } } ``` - 开通单币种保证金模式时，mode=single_currency ``` PUT /unified/unified_mode { \"mode\": \"single_currency\" } ``` * @param unifiedModeSet (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -2767,4 +2769,111 @@ 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 更新成功 -
+ */ + 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; + } + + /** + * 设置抵押币种 + * + * @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 更新成功 -
+ */ + public UnifiedCollateralRes setUnifiedCollateral(UnifiedCollateralReq unifiedCollateralReq) throws ApiException { + ApiResponse localVarResp = setUnifiedCollateralWithHttpInfo(unifiedCollateralReq); + return localVarResp.getData(); + } + + /** + * 设置抵押币种 + * + * @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 更新成功 -
+ */ + public ApiResponse setUnifiedCollateralWithHttpInfo(UnifiedCollateralReq unifiedCollateralReq) throws ApiException { + okhttp3.Call localVarCall = setUnifiedCollateralValidateBeforeCall(unifiedCollateralReq, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * 设置抵押币种 (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 更新成功 -
+ */ + 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/models/AccountBookResponse.java b/src/main/java/io/gate/gateapi/models/AccountBookResponse.java deleted file mode 100644 index d920074..0000000 --- a/src/main/java/io/gate/gateapi/models/AccountBookResponse.java +++ /dev/null @@ -1,193 +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; - -/** - * Quotation Response - */ -public class AccountBookResponse { - public static final String SERIALIZED_NAME_ID = "id"; - @SerializedName(SERIALIZED_NAME_ID) - private Long 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 AccountBookResponse id(Long id) { - - this.id = id; - return this; - } - - /** - * Order ID - * @return id - **/ - @javax.annotation.Nullable - public Long getId() { - return id; - } - - - public void setId(Long id) { - this.id = id; - } - - public AccountBookResponse time(Long time) { - - this.time = time; - return this; - } - - /** - * 操作时间戳 - * @return time - **/ - @javax.annotation.Nullable - public Long getTime() { - return time; - } - - - public void setTime(Long time) { - this.time = time; - } - - public AccountBookResponse currency(String currency) { - - this.currency = currency; - return this; - } - - /** - * Currency name - * @return currency - **/ - @javax.annotation.Nullable - public String getCurrency() { - return currency; - } - - - public void setCurrency(String currency) { - this.currency = currency; - } - - public AccountBookResponse change(String change) { - - this.change = change; - return this; - } - - /** - * Change amount - * @return change - **/ - @javax.annotation.Nullable - public String getChange() { - return change; - } - - - public void setChange(String change) { - this.change = change; - } - - public AccountBookResponse balance(String balance) { - - this.balance = balance; - return this; - } - - /** - * 变更后余额 - * @return balance - **/ - @javax.annotation.Nullable - public String getBalance() { - return balance; - } - - - public void setBalance(String balance) { - this.balance = balance; - } - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - AccountBookResponse accountBookResponse = (AccountBookResponse) o; - return Objects.equals(this.id, accountBookResponse.id) && - Objects.equals(this.time, accountBookResponse.time) && - Objects.equals(this.currency, accountBookResponse.currency) && - Objects.equals(this.change, accountBookResponse.change) && - Objects.equals(this.balance, accountBookResponse.balance); - } - - @Override - public int hashCode() { - return Objects.hash(id, time, currency, change, balance); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class AccountBookResponse {\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("}"); - 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/AccountsResponse.java b/src/main/java/io/gate/gateapi/models/AccountsResponse.java deleted file mode 100644 index 01481a0..0000000 --- a/src/main/java/io/gate/gateapi/models/AccountsResponse.java +++ /dev/null @@ -1,193 +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; - -/** - * Quotation Response - */ -public class AccountsResponse { - public static final String SERIALIZED_NAME_CURRENCY = "currency"; - @SerializedName(SERIALIZED_NAME_CURRENCY) - private String currency; - - public static final String SERIALIZED_NAME_AVAILABLE = "available"; - @SerializedName(SERIALIZED_NAME_AVAILABLE) - private String available; - - public static final String SERIALIZED_NAME_LOCKED = "locked"; - @SerializedName(SERIALIZED_NAME_LOCKED) - private String locked; - - public static final String SERIALIZED_NAME_TOKEN_ADDRESS = "token_address"; - @SerializedName(SERIALIZED_NAME_TOKEN_ADDRESS) - private String tokenAddress; - - public static final String SERIALIZED_NAME_CHAIN = "chain"; - @SerializedName(SERIALIZED_NAME_CHAIN) - private String chain; - - - public AccountsResponse currency(String currency) { - - this.currency = currency; - return this; - } - - /** - * Currency name - * @return currency - **/ - @javax.annotation.Nullable - public String getCurrency() { - return currency; - } - - - public void setCurrency(String currency) { - this.currency = currency; - } - - public AccountsResponse available(String available) { - - this.available = available; - return this; - } - - /** - * Available Balance - * @return available - **/ - @javax.annotation.Nullable - public String getAvailable() { - return available; - } - - - public void setAvailable(String available) { - this.available = available; - } - - public AccountsResponse locked(String locked) { - - this.locked = locked; - return this; - } - - /** - * 锁定余额 - * @return locked - **/ - @javax.annotation.Nullable - public String getLocked() { - return locked; - } - - - public void setLocked(String locked) { - this.locked = locked; - } - - public AccountsResponse tokenAddress(String tokenAddress) { - - this.tokenAddress = tokenAddress; - return this; - } - - /** - * token 地址 - * @return tokenAddress - **/ - @javax.annotation.Nullable - public String getTokenAddress() { - return tokenAddress; - } - - - public void setTokenAddress(String tokenAddress) { - this.tokenAddress = tokenAddress; - } - - public AccountsResponse chain(String chain) { - - this.chain = chain; - return this; - } - - /** - * 区块链名称 - * @return chain - **/ - @javax.annotation.Nullable - public String getChain() { - return chain; - } - - - public void setChain(String chain) { - this.chain = chain; - } - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - AccountsResponse accountsResponse = (AccountsResponse) o; - return Objects.equals(this.currency, accountsResponse.currency) && - Objects.equals(this.available, accountsResponse.available) && - Objects.equals(this.locked, accountsResponse.locked) && - Objects.equals(this.tokenAddress, accountsResponse.tokenAddress) && - Objects.equals(this.chain, accountsResponse.chain); - } - - @Override - public int hashCode() { - return Objects.hash(currency, available, locked, tokenAddress, chain); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class AccountsResponse {\n"); - sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); - sb.append(" available: ").append(toIndentedString(available)).append("\n"); - sb.append(" locked: ").append(toIndentedString(locked)).append("\n"); - sb.append(" tokenAddress: ").append(toIndentedString(tokenAddress)).append("\n"); - sb.append(" chain: ").append(toIndentedString(chain)).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/Currency2.java b/src/main/java/io/gate/gateapi/models/Currency2.java deleted file mode 100644 index 0c6aeb1..0000000 --- a/src/main/java/io/gate/gateapi/models/Currency2.java +++ /dev/null @@ -1,245 +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; - -/** - * Currency2 - */ -public class Currency2 { - public static final String SERIALIZED_NAME_CURRENCY = "currency"; - @SerializedName(SERIALIZED_NAME_CURRENCY) - private String currency; - - public static final String SERIALIZED_NAME_NAME = "name"; - @SerializedName(SERIALIZED_NAME_NAME) - private String name; - - public static final String SERIALIZED_NAME_CHAIN = "chain"; - @SerializedName(SERIALIZED_NAME_CHAIN) - private String chain; - - public static final String SERIALIZED_NAME_ADDRESS = "address"; - @SerializedName(SERIALIZED_NAME_ADDRESS) - private String address; - - public static final String SERIALIZED_NAME_AMOUNT_PRECISION = "amount_precision"; - @SerializedName(SERIALIZED_NAME_AMOUNT_PRECISION) - private Integer amountPrecision; - - public static final String SERIALIZED_NAME_PRECISION = "precision"; - @SerializedName(SERIALIZED_NAME_PRECISION) - private Integer precision; - - public static final String SERIALIZED_NAME_STATUS = "status"; - @SerializedName(SERIALIZED_NAME_STATUS) - private Integer status; - - - public Currency2 currency(String currency) { - - this.currency = currency; - return this; - } - - /** - * Currency symbol - * @return currency - **/ - @javax.annotation.Nullable - public String getCurrency() { - return currency; - } - - - public void setCurrency(String currency) { - this.currency = currency; - } - - public Currency2 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 Currency2 chain(String chain) { - - this.chain = chain; - return this; - } - - /** - * The main chain corresponding to the coin - * @return chain - **/ - @javax.annotation.Nullable - public String getChain() { - return chain; - } - - - public void setChain(String chain) { - this.chain = chain; - } - - public Currency2 address(String address) { - - this.address = address; - return this; - } - - /** - * Contract Address - * @return address - **/ - @javax.annotation.Nullable - public String getAddress() { - return address; - } - - - public void setAddress(String address) { - this.address = address; - } - - public Currency2 amountPrecision(Integer amountPrecision) { - - this.amountPrecision = amountPrecision; - return this; - } - - /** - * Amount scale - * @return amountPrecision - **/ - @javax.annotation.Nullable - public Integer getAmountPrecision() { - return amountPrecision; - } - - - public void setAmountPrecision(Integer amountPrecision) { - this.amountPrecision = amountPrecision; - } - - public Currency2 precision(Integer precision) { - - this.precision = precision; - return this; - } - - /** - * Price scale - * @return precision - **/ - @javax.annotation.Nullable - public Integer getPrecision() { - return precision; - } - - - public void setPrecision(Integer precision) { - this.precision = precision; - } - - public Currency2 status(Integer status) { - - this.status = status; - return this; - } - - /** - * 币种交易状态 - `1` : 正常交易 - `2` : 暂停交易 - `3` : 下架 - * @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; - } - Currency2 currency2 = (Currency2) o; - return Objects.equals(this.currency, currency2.currency) && - Objects.equals(this.name, currency2.name) && - Objects.equals(this.chain, currency2.chain) && - Objects.equals(this.address, currency2.address) && - Objects.equals(this.amountPrecision, currency2.amountPrecision) && - Objects.equals(this.precision, currency2.precision) && - Objects.equals(this.status, currency2.status); - } - - @Override - public int hashCode() { - return Objects.hash(currency, name, chain, address, amountPrecision, precision, status); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class Currency2 {\n"); - sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" chain: ").append(toIndentedString(chain)).append("\n"); - sb.append(" address: ").append(toIndentedString(address)).append("\n"); - sb.append(" amountPrecision: ").append(toIndentedString(amountPrecision)).append("\n"); - sb.append(" precision: ").append(toIndentedString(precision)).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/OrderResponse.java b/src/main/java/io/gate/gateapi/models/OrderResponse.java deleted file mode 100644 index 0b0181a..0000000 --- a/src/main/java/io/gate/gateapi/models/OrderResponse.java +++ /dev/null @@ -1,401 +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; - -/** - * 下单返回 - */ -public class OrderResponse { - public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; - @SerializedName(SERIALIZED_NAME_ORDER_ID) - private String orderId; - - public static final String SERIALIZED_NAME_TX_HASH = "tx_hash"; - @SerializedName(SERIALIZED_NAME_TX_HASH) - private String txHash; - - public static final String SERIALIZED_NAME_SIDE = "side"; - @SerializedName(SERIALIZED_NAME_SIDE) - private String side; - - public static final String SERIALIZED_NAME_USDT_AMOUNT = "usdt_amount"; - @SerializedName(SERIALIZED_NAME_USDT_AMOUNT) - private String usdtAmount; - - public static final String SERIALIZED_NAME_CURRENCY = "currency"; - @SerializedName(SERIALIZED_NAME_CURRENCY) - private String currency; - - public static final String SERIALIZED_NAME_CURRENCY_AMOUNT = "currency_amount"; - @SerializedName(SERIALIZED_NAME_CURRENCY_AMOUNT) - private String currencyAmount; - - public static final String SERIALIZED_NAME_STATUS = "status"; - @SerializedName(SERIALIZED_NAME_STATUS) - private Integer status; - - public static final String SERIALIZED_NAME_GAS_MODE = "gas_mode"; - @SerializedName(SERIALIZED_NAME_GAS_MODE) - private String gasMode; - - public static final String SERIALIZED_NAME_CHAIN = "chain"; - @SerializedName(SERIALIZED_NAME_CHAIN) - private String chain; - - public static final String SERIALIZED_NAME_GAS_FEE = "gas_fee"; - @SerializedName(SERIALIZED_NAME_GAS_FEE) - private String gasFee; - - public static final String SERIALIZED_NAME_TRANSACTION_FEE = "transaction_fee"; - @SerializedName(SERIALIZED_NAME_TRANSACTION_FEE) - private String transactionFee; - - public static final String SERIALIZED_NAME_FAILED_REASON = "failed_reason"; - @SerializedName(SERIALIZED_NAME_FAILED_REASON) - private String failedReason; - - public static final String SERIALIZED_NAME_CREATE_TIME = "create_time"; - @SerializedName(SERIALIZED_NAME_CREATE_TIME) - private Long createTime; - - - public OrderResponse orderId(String orderId) { - - this.orderId = orderId; - return this; - } - - /** - * Order ID - * @return orderId - **/ - @javax.annotation.Nullable - public String getOrderId() { - return orderId; - } - - - public void setOrderId(String orderId) { - this.orderId = orderId; - } - - public OrderResponse txHash(String txHash) { - - this.txHash = txHash; - return this; - } - - /** - * Transaction Hash - * @return txHash - **/ - @javax.annotation.Nullable - public String getTxHash() { - return txHash; - } - - - public void setTxHash(String txHash) { - this.txHash = txHash; - } - - public OrderResponse side(String side) { - - this.side = side; - return this; - } - - /** - * 买单或者卖单 - buy - sell - * @return side - **/ - @javax.annotation.Nullable - public String getSide() { - return side; - } - - - public void setSide(String side) { - this.side = side; - } - - public OrderResponse usdtAmount(String usdtAmount) { - - this.usdtAmount = usdtAmount; - return this; - } - - /** - * Amount - * @return usdtAmount - **/ - @javax.annotation.Nullable - public String getUsdtAmount() { - return usdtAmount; - } - - - public void setUsdtAmount(String usdtAmount) { - this.usdtAmount = usdtAmount; - } - - public OrderResponse currency(String currency) { - - this.currency = currency; - return this; - } - - /** - * 币 - * @return currency - **/ - @javax.annotation.Nullable - public String getCurrency() { - return currency; - } - - - public void setCurrency(String currency) { - this.currency = currency; - } - - public OrderResponse currencyAmount(String currencyAmount) { - - this.currencyAmount = currencyAmount; - return this; - } - - /** - * Currency amount - * @return currencyAmount - **/ - @javax.annotation.Nullable - public String getCurrencyAmount() { - return currencyAmount; - } - - - public void setCurrencyAmount(String currencyAmount) { - this.currencyAmount = currencyAmount; - } - - public OrderResponse status(Integer status) { - - this.status = status; - return this; - } - - /** - * Order Status - `0` : All - `1` : Processing - `2` : Successful - `3` : Failed - `4` : Canceled - `5` : Buy order placed but transfer not completed - `6` : Cancelled order with transfer not complete - * @return status - **/ - @javax.annotation.Nullable - public Integer getStatus() { - return status; - } - - - public void setStatus(Integer status) { - this.status = status; - } - - public OrderResponse gasMode(String gasMode) { - - this.gasMode = gasMode; - return this; - } - - /** - * Trading mode affects slippage selection - `speed` : Smart mode - `custom` : Custom mode, uses `slippage` parameter - * @return gasMode - **/ - @javax.annotation.Nullable - public String getGasMode() { - return gasMode; - } - - - public void setGasMode(String gasMode) { - this.gasMode = gasMode; - } - - public OrderResponse chain(String chain) { - - this.chain = chain; - return this; - } - - /** - * 链 - * @return chain - **/ - @javax.annotation.Nullable - public String getChain() { - return chain; - } - - - public void setChain(String chain) { - this.chain = chain; - } - - public OrderResponse gasFee(String gasFee) { - - this.gasFee = gasFee; - return this; - } - - /** - * Miner Fee (USDT-based) - * @return gasFee - **/ - @javax.annotation.Nullable - public String getGasFee() { - return gasFee; - } - - - public void setGasFee(String gasFee) { - this.gasFee = gasFee; - } - - public OrderResponse transactionFee(String transactionFee) { - - this.transactionFee = transactionFee; - return this; - } - - /** - * Trading Fee (USDT-based) - * @return transactionFee - **/ - @javax.annotation.Nullable - public String getTransactionFee() { - return transactionFee; - } - - - public void setTransactionFee(String transactionFee) { - this.transactionFee = transactionFee; - } - - public OrderResponse failedReason(String failedReason) { - - this.failedReason = failedReason; - return this; - } - - /** - * Failure reason (if any) - * @return failedReason - **/ - @javax.annotation.Nullable - public String getFailedReason() { - return failedReason; - } - - - public void setFailedReason(String failedReason) { - this.failedReason = failedReason; - } - - public OrderResponse createTime(Long createTime) { - - this.createTime = createTime; - return this; - } - - /** - * 创建时间（时间戳） - * @return createTime - **/ - @javax.annotation.Nullable - public Long getCreateTime() { - return createTime; - } - - - public void setCreateTime(Long createTime) { - this.createTime = createTime; - } - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - OrderResponse orderResponse = (OrderResponse) o; - return Objects.equals(this.orderId, orderResponse.orderId) && - Objects.equals(this.txHash, orderResponse.txHash) && - Objects.equals(this.side, orderResponse.side) && - Objects.equals(this.usdtAmount, orderResponse.usdtAmount) && - Objects.equals(this.currency, orderResponse.currency) && - Objects.equals(this.currencyAmount, orderResponse.currencyAmount) && - Objects.equals(this.status, orderResponse.status) && - Objects.equals(this.gasMode, orderResponse.gasMode) && - Objects.equals(this.chain, orderResponse.chain) && - Objects.equals(this.gasFee, orderResponse.gasFee) && - Objects.equals(this.transactionFee, orderResponse.transactionFee) && - Objects.equals(this.failedReason, orderResponse.failedReason) && - Objects.equals(this.createTime, orderResponse.createTime); - } - - @Override - public int hashCode() { - return Objects.hash(orderId, txHash, side, usdtAmount, currency, currencyAmount, status, gasMode, chain, gasFee, transactionFee, failedReason, createTime); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class OrderResponse {\n"); - sb.append(" orderId: ").append(toIndentedString(orderId)).append("\n"); - sb.append(" txHash: ").append(toIndentedString(txHash)).append("\n"); - sb.append(" side: ").append(toIndentedString(side)).append("\n"); - sb.append(" usdtAmount: ").append(toIndentedString(usdtAmount)).append("\n"); - sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); - sb.append(" currencyAmount: ").append(toIndentedString(currencyAmount)).append("\n"); - sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append(" gasMode: ").append(toIndentedString(gasMode)).append("\n"); - sb.append(" chain: ").append(toIndentedString(chain)).append("\n"); - sb.append(" gasFee: ").append(toIndentedString(gasFee)).append("\n"); - sb.append(" transactionFee: ").append(toIndentedString(transactionFee)).append("\n"); - sb.append(" failedReason: ").append(toIndentedString(failedReason)).append("\n"); - sb.append(" createTime: ").append(toIndentedString(createTime)).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/PlaceOrderRequest.java b/src/main/java/io/gate/gateapi/models/PlaceOrderRequest.java deleted file mode 100644 index 0adf878..0000000 --- a/src/main/java/io/gate/gateapi/models/PlaceOrderRequest.java +++ /dev/null @@ -1,214 +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; - -/** - * 下单请求 - */ -public class PlaceOrderRequest { - public static final String SERIALIZED_NAME_CURRENCY = "currency"; - @SerializedName(SERIALIZED_NAME_CURRENCY) - private String currency; - - 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_GAS_MODE = "gas_mode"; - @SerializedName(SERIALIZED_NAME_GAS_MODE) - private String gasMode; - - public static final String SERIALIZED_NAME_SLIPPAGE = "slippage"; - @SerializedName(SERIALIZED_NAME_SLIPPAGE) - private String slippage; - - public static final String SERIALIZED_NAME_QUOTE_ID = "quote_id"; - @SerializedName(SERIALIZED_NAME_QUOTE_ID) - private String quoteId; - - - public PlaceOrderRequest currency(String currency) { - - this.currency = currency; - return this; - } - - /** - * Trading Symbol - * @return currency - **/ - public String getCurrency() { - return currency; - } - - - public void setCurrency(String currency) { - this.currency = currency; - } - - public PlaceOrderRequest side(String side) { - - this.side = side; - return this; - } - - /** - * 买单或者卖单 - buy - sell - * @return side - **/ - public String getSide() { - return side; - } - - - public void setSide(String side) { - this.side = side; - } - - public PlaceOrderRequest amount(String amount) { - - this.amount = amount; - return this; - } - - /** - * Trade Quantity - `side` : `buy` refers to the quote currency, i.e., `USDT` - `side` : `sell` refers to the base currency - * @return amount - **/ - public String getAmount() { - return amount; - } - - - public void setAmount(String amount) { - this.amount = amount; - } - - public PlaceOrderRequest gasMode(String gasMode) { - - this.gasMode = gasMode; - return this; - } - - /** - * Trading mode affects slippage selection - `speed` : Smart mode - `custom` : Custom mode, uses `slippage` parameter - * @return gasMode - **/ - public String getGasMode() { - return gasMode; - } - - - public void setGasMode(String gasMode) { - this.gasMode = gasMode; - } - - public PlaceOrderRequest slippage(String slippage) { - - this.slippage = slippage; - return this; - } - - /** - * Slippage value of 10 represents a 10% tolerance - * @return slippage - **/ - @javax.annotation.Nullable - public String getSlippage() { - return slippage; - } - - - public void setSlippage(String slippage) { - this.slippage = slippage; - } - - public PlaceOrderRequest quoteId(String quoteId) { - - this.quoteId = quoteId; - return this; - } - - /** - * The quote_id returned by the quotation API - * @return quoteId - **/ - public String getQuoteId() { - return quoteId; - } - - - public void setQuoteId(String quoteId) { - this.quoteId = quoteId; - } - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PlaceOrderRequest placeOrderRequest = (PlaceOrderRequest) o; - return Objects.equals(this.currency, placeOrderRequest.currency) && - Objects.equals(this.side, placeOrderRequest.side) && - Objects.equals(this.amount, placeOrderRequest.amount) && - Objects.equals(this.gasMode, placeOrderRequest.gasMode) && - Objects.equals(this.slippage, placeOrderRequest.slippage) && - Objects.equals(this.quoteId, placeOrderRequest.quoteId); - } - - @Override - public int hashCode() { - return Objects.hash(currency, side, amount, gasMode, slippage, quoteId); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PlaceOrderRequest {\n"); - sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); - sb.append(" side: ").append(toIndentedString(side)).append("\n"); - sb.append(" amount: ").append(toIndentedString(amount)).append("\n"); - sb.append(" gasMode: ").append(toIndentedString(gasMode)).append("\n"); - sb.append(" slippage: ").append(toIndentedString(slippage)).append("\n"); - sb.append(" quoteId: ").append(toIndentedString(quoteId)).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/PlaceOrderResponse.java b/src/main/java/io/gate/gateapi/models/PlaceOrderResponse.java deleted file mode 100644 index a39794f..0000000 --- a/src/main/java/io/gate/gateapi/models/PlaceOrderResponse.java +++ /dev/null @@ -1,271 +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; - -/** - * 下单返回 - */ -public class PlaceOrderResponse { - public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; - @SerializedName(SERIALIZED_NAME_ORDER_ID) - private String orderId; - - public static final String SERIALIZED_NAME_STATUS = "status"; - @SerializedName(SERIALIZED_NAME_STATUS) - private Integer status; - - public static final String SERIALIZED_NAME_SIDE = "side"; - @SerializedName(SERIALIZED_NAME_SIDE) - private String side; - - public static final String SERIALIZED_NAME_GAS_MODE = "gas_mode"; - @SerializedName(SERIALIZED_NAME_GAS_MODE) - private String gasMode; - - public static final String SERIALIZED_NAME_CREATE_TIME = "create_time"; - @SerializedName(SERIALIZED_NAME_CREATE_TIME) - private Long createTime; - - public static final String SERIALIZED_NAME_AMOUNT = "amount"; - @SerializedName(SERIALIZED_NAME_AMOUNT) - private String amount; - - public static final String SERIALIZED_NAME_TOKEN_ADDRESS = "token_address"; - @SerializedName(SERIALIZED_NAME_TOKEN_ADDRESS) - private String tokenAddress; - - public static final String SERIALIZED_NAME_CHAIN = "chain"; - @SerializedName(SERIALIZED_NAME_CHAIN) - private String chain; - - - public PlaceOrderResponse orderId(String orderId) { - - this.orderId = orderId; - return this; - } - - /** - * Order ID - * @return orderId - **/ - @javax.annotation.Nullable - public String getOrderId() { - return orderId; - } - - - public void setOrderId(String orderId) { - this.orderId = orderId; - } - - public PlaceOrderResponse status(Integer status) { - - this.status = status; - return this; - } - - /** - * Order Status - `0` : All - `1` : Processing - `2` : Successful - `3` : Failed - `4` : Canceled - `5` : Buy order placed but transfer not completed - `6` : Cancelled order with transfer not complete - * @return status - **/ - @javax.annotation.Nullable - public Integer getStatus() { - return status; - } - - - public void setStatus(Integer status) { - this.status = status; - } - - public PlaceOrderResponse side(String side) { - - this.side = side; - return this; - } - - /** - * 买单或者卖单 - buy - sell - * @return side - **/ - @javax.annotation.Nullable - public String getSide() { - return side; - } - - - public void setSide(String side) { - this.side = side; - } - - public PlaceOrderResponse gasMode(String gasMode) { - - this.gasMode = gasMode; - return this; - } - - /** - * Trading mode affects slippage selection - `speed` : Smart mode - `custom` : Custom mode, uses `slippage` parameter - * @return gasMode - **/ - @javax.annotation.Nullable - public String getGasMode() { - return gasMode; - } - - - public void setGasMode(String gasMode) { - this.gasMode = gasMode; - } - - public PlaceOrderResponse createTime(Long createTime) { - - this.createTime = createTime; - return this; - } - - /** - * 创建时间 (时间戳) - * @return createTime - **/ - @javax.annotation.Nullable - public Long getCreateTime() { - return createTime; - } - - - public void setCreateTime(Long createTime) { - this.createTime = createTime; - } - - public PlaceOrderResponse amount(String amount) { - - this.amount = amount; - return this; - } - - /** - * Trade Quantity - `side` : `buy` refers to the quote currency, i.e., `USDT` - `side` : `sell` refers to the base currency - * @return amount - **/ - @javax.annotation.Nullable - public String getAmount() { - return amount; - } - - - public void setAmount(String amount) { - this.amount = amount; - } - - public PlaceOrderResponse tokenAddress(String tokenAddress) { - - this.tokenAddress = tokenAddress; - return this; - } - - /** - * 币地址 - * @return tokenAddress - **/ - @javax.annotation.Nullable - public String getTokenAddress() { - return tokenAddress; - } - - - public void setTokenAddress(String tokenAddress) { - this.tokenAddress = tokenAddress; - } - - public PlaceOrderResponse chain(String chain) { - - this.chain = chain; - return this; - } - - /** - * Chain name - * @return chain - **/ - @javax.annotation.Nullable - public String getChain() { - return chain; - } - - - public void setChain(String chain) { - this.chain = chain; - } - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PlaceOrderResponse placeOrderResponse = (PlaceOrderResponse) o; - return Objects.equals(this.orderId, placeOrderResponse.orderId) && - Objects.equals(this.status, placeOrderResponse.status) && - Objects.equals(this.side, placeOrderResponse.side) && - Objects.equals(this.gasMode, placeOrderResponse.gasMode) && - Objects.equals(this.createTime, placeOrderResponse.createTime) && - Objects.equals(this.amount, placeOrderResponse.amount) && - Objects.equals(this.tokenAddress, placeOrderResponse.tokenAddress) && - Objects.equals(this.chain, placeOrderResponse.chain); - } - - @Override - public int hashCode() { - return Objects.hash(orderId, status, side, gasMode, createTime, amount, tokenAddress, chain); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PlaceOrderResponse {\n"); - sb.append(" orderId: ").append(toIndentedString(orderId)).append("\n"); - sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append(" side: ").append(toIndentedString(side)).append("\n"); - sb.append(" gasMode: ").append(toIndentedString(gasMode)).append("\n"); - sb.append(" createTime: ").append(toIndentedString(createTime)).append("\n"); - sb.append(" amount: ").append(toIndentedString(amount)).append("\n"); - sb.append(" tokenAddress: ").append(toIndentedString(tokenAddress)).append("\n"); - sb.append(" chain: ").append(toIndentedString(chain)).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/QuoteRequest.java b/src/main/java/io/gate/gateapi/models/QuoteRequest.java deleted file mode 100644 index 0498706..0000000 --- a/src/main/java/io/gate/gateapi/models/QuoteRequest.java +++ /dev/null @@ -1,189 +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; - -/** - * Quotation Request - */ -public class QuoteRequest { - public static final String SERIALIZED_NAME_CURRENCY = "currency"; - @SerializedName(SERIALIZED_NAME_CURRENCY) - private String currency; - - 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_GAS_MODE = "gas_mode"; - @SerializedName(SERIALIZED_NAME_GAS_MODE) - private String gasMode; - - public static final String SERIALIZED_NAME_SLIPPAGE = "slippage"; - @SerializedName(SERIALIZED_NAME_SLIPPAGE) - private String slippage; - - - public QuoteRequest currency(String currency) { - - this.currency = currency; - return this; - } - - /** - * Trading Symbol - * @return currency - **/ - public String getCurrency() { - return currency; - } - - - public void setCurrency(String currency) { - this.currency = currency; - } - - public QuoteRequest side(String side) { - - this.side = side; - return this; - } - - /** - * 买单或者卖单 - buy - sell - * @return side - **/ - public String getSide() { - return side; - } - - - public void setSide(String side) { - this.side = side; - } - - public QuoteRequest amount(String amount) { - - this.amount = amount; - return this; - } - - /** - * Trade Quantity - `side` : `buy` refers to the quote currency, i.e., `USDT` - `side` : `sell` refers to the base currency - * @return amount - **/ - public String getAmount() { - return amount; - } - - - public void setAmount(String amount) { - this.amount = amount; - } - - public QuoteRequest gasMode(String gasMode) { - - this.gasMode = gasMode; - return this; - } - - /** - * Trading mode affects slippage selection - `speed` : Smart mode - `custom` : Custom mode, uses `slippage` parameter - * @return gasMode - **/ - public String getGasMode() { - return gasMode; - } - - - public void setGasMode(String gasMode) { - this.gasMode = gasMode; - } - - public QuoteRequest slippage(String slippage) { - - this.slippage = slippage; - return this; - } - - /** - * Slippage value of 10 represents a 10% tolerance - * @return slippage - **/ - @javax.annotation.Nullable - public String getSlippage() { - return slippage; - } - - - public void setSlippage(String slippage) { - this.slippage = slippage; - } - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - QuoteRequest quoteRequest = (QuoteRequest) o; - return Objects.equals(this.currency, quoteRequest.currency) && - Objects.equals(this.side, quoteRequest.side) && - Objects.equals(this.amount, quoteRequest.amount) && - Objects.equals(this.gasMode, quoteRequest.gasMode) && - Objects.equals(this.slippage, quoteRequest.slippage); - } - - @Override - public int hashCode() { - return Objects.hash(currency, side, amount, gasMode, slippage); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class QuoteRequest {\n"); - sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); - sb.append(" side: ").append(toIndentedString(side)).append("\n"); - sb.append(" amount: ").append(toIndentedString(amount)).append("\n"); - sb.append(" gasMode: ").append(toIndentedString(gasMode)).append("\n"); - sb.append(" slippage: ").append(toIndentedString(slippage)).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/QuoteResponse.java b/src/main/java/io/gate/gateapi/models/QuoteResponse.java deleted file mode 100644 index 00cf02a..0000000 --- a/src/main/java/io/gate/gateapi/models/QuoteResponse.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; - -/** - * Quotation Response - */ -public class QuoteResponse { - public static final String SERIALIZED_NAME_QUOTE_ID = "quote_id"; - @SerializedName(SERIALIZED_NAME_QUOTE_ID) - private String quoteId; - - public static final String SERIALIZED_NAME_MIN_AMOUNT = "min_amount"; - @SerializedName(SERIALIZED_NAME_MIN_AMOUNT) - private String minAmount; - - public static final String SERIALIZED_NAME_MAX_AMOUNT = "max_amount"; - @SerializedName(SERIALIZED_NAME_MAX_AMOUNT) - private String maxAmount; - - public static final String SERIALIZED_NAME_PRICE = "price"; - @SerializedName(SERIALIZED_NAME_PRICE) - private String price; - - public static final String SERIALIZED_NAME_SLIPPAGE = "slippage"; - @SerializedName(SERIALIZED_NAME_SLIPPAGE) - private String slippage; - - public static final String SERIALIZED_NAME_ESTIMATE_GAS_FEE_AMOUNT_USDT = "estimate_gas_fee_amount_usdt"; - @SerializedName(SERIALIZED_NAME_ESTIMATE_GAS_FEE_AMOUNT_USDT) - private String estimateGasFeeAmountUsdt; - - public static final String SERIALIZED_NAME_ORDER_FEE = "order_fee"; - @SerializedName(SERIALIZED_NAME_ORDER_FEE) - private String orderFee; - - public static final String SERIALIZED_NAME_TARGET_TOKEN_MIN_AMOUNT = "target_token_min_amount"; - @SerializedName(SERIALIZED_NAME_TARGET_TOKEN_MIN_AMOUNT) - private String targetTokenMinAmount; - - public static final String SERIALIZED_NAME_TARGET_TOKEN_MAX_AMOUNT = "target_token_max_amount"; - @SerializedName(SERIALIZED_NAME_TARGET_TOKEN_MAX_AMOUNT) - private String targetTokenMaxAmount; - - public static final String SERIALIZED_NAME_ERROR_TYPE = "error_type"; - @SerializedName(SERIALIZED_NAME_ERROR_TYPE) - private Integer errorType; - - - public QuoteResponse quoteId(String quoteId) { - - this.quoteId = quoteId; - return this; - } - - /** - * The quotation ID (quote_id) is used for placing orders and is valid for 1 minute - * @return quoteId - **/ - @javax.annotation.Nullable - public String getQuoteId() { - return quoteId; - } - - - public void setQuoteId(String quoteId) { - this.quoteId = quoteId; - } - - public QuoteResponse minAmount(String minAmount) { - - this.minAmount = minAmount; - return this; - } - - /** - * 最小下单量 - * @return minAmount - **/ - @javax.annotation.Nullable - public String getMinAmount() { - return minAmount; - } - - - public void setMinAmount(String minAmount) { - this.minAmount = minAmount; - } - - public QuoteResponse maxAmount(String maxAmount) { - - this.maxAmount = maxAmount; - return this; - } - - /** - * 最大下单量 - * @return maxAmount - **/ - @javax.annotation.Nullable - public String getMaxAmount() { - return maxAmount; - } - - - public void setMaxAmount(String maxAmount) { - this.maxAmount = maxAmount; - } - - public QuoteResponse price(String price) { - - this.price = price; - return this; - } - - /** - * Coin Price (USDT-based) - * @return price - **/ - @javax.annotation.Nullable - public String getPrice() { - return price; - } - - - public void setPrice(String price) { - this.price = price; - } - - public QuoteResponse slippage(String slippage) { - - this.slippage = slippage; - return this; - } - - /** - * Slippage - * @return slippage - **/ - @javax.annotation.Nullable - public String getSlippage() { - return slippage; - } - - - public void setSlippage(String slippage) { - this.slippage = slippage; - } - - public QuoteResponse estimateGasFeeAmountUsdt(String estimateGasFeeAmountUsdt) { - - this.estimateGasFeeAmountUsdt = estimateGasFeeAmountUsdt; - return this; - } - - /** - * Estimated Network Fee (USDT-based) - * @return estimateGasFeeAmountUsdt - **/ - @javax.annotation.Nullable - public String getEstimateGasFeeAmountUsdt() { - return estimateGasFeeAmountUsdt; - } - - - public void setEstimateGasFeeAmountUsdt(String estimateGasFeeAmountUsdt) { - this.estimateGasFeeAmountUsdt = estimateGasFeeAmountUsdt; - } - - public QuoteResponse orderFee(String orderFee) { - - this.orderFee = orderFee; - return this; - } - - /** - * Slippage value of 10 represents a 10% tolerance - * @return orderFee - **/ - @javax.annotation.Nullable - public String getOrderFee() { - return orderFee; - } - - - public void setOrderFee(String orderFee) { - this.orderFee = orderFee; - } - - public QuoteResponse targetTokenMinAmount(String targetTokenMinAmount) { - - this.targetTokenMinAmount = targetTokenMinAmount; - return this; - } - - /** - * 最小获得数量 - * @return targetTokenMinAmount - **/ - @javax.annotation.Nullable - public String getTargetTokenMinAmount() { - return targetTokenMinAmount; - } - - - public void setTargetTokenMinAmount(String targetTokenMinAmount) { - this.targetTokenMinAmount = targetTokenMinAmount; - } - - public QuoteResponse targetTokenMaxAmount(String targetTokenMaxAmount) { - - this.targetTokenMaxAmount = targetTokenMaxAmount; - return this; - } - - /** - * 最大获得数量 - * @return targetTokenMaxAmount - **/ - @javax.annotation.Nullable - public String getTargetTokenMaxAmount() { - return targetTokenMaxAmount; - } - - - public void setTargetTokenMaxAmount(String targetTokenMaxAmount) { - this.targetTokenMaxAmount = targetTokenMaxAmount; - } - - public QuoteResponse errorType(Integer errorType) { - - this.errorType = errorType; - return this; - } - - /** - * Failure Type - `0` : Success - `1` : Exceeds maximum value - `2` : Below minimum value - * @return errorType - **/ - @javax.annotation.Nullable - public Integer getErrorType() { - return errorType; - } - - - public void setErrorType(Integer errorType) { - this.errorType = errorType; - } - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - QuoteResponse quoteResponse = (QuoteResponse) o; - return Objects.equals(this.quoteId, quoteResponse.quoteId) && - Objects.equals(this.minAmount, quoteResponse.minAmount) && - Objects.equals(this.maxAmount, quoteResponse.maxAmount) && - Objects.equals(this.price, quoteResponse.price) && - Objects.equals(this.slippage, quoteResponse.slippage) && - Objects.equals(this.estimateGasFeeAmountUsdt, quoteResponse.estimateGasFeeAmountUsdt) && - Objects.equals(this.orderFee, quoteResponse.orderFee) && - Objects.equals(this.targetTokenMinAmount, quoteResponse.targetTokenMinAmount) && - Objects.equals(this.targetTokenMaxAmount, quoteResponse.targetTokenMaxAmount) && - Objects.equals(this.errorType, quoteResponse.errorType); - } - - @Override - public int hashCode() { - return Objects.hash(quoteId, minAmount, maxAmount, price, slippage, estimateGasFeeAmountUsdt, orderFee, targetTokenMinAmount, targetTokenMaxAmount, errorType); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class QuoteResponse {\n"); - sb.append(" quoteId: ").append(toIndentedString(quoteId)).append("\n"); - sb.append(" minAmount: ").append(toIndentedString(minAmount)).append("\n"); - sb.append(" maxAmount: ").append(toIndentedString(maxAmount)).append("\n"); - sb.append(" price: ").append(toIndentedString(price)).append("\n"); - sb.append(" slippage: ").append(toIndentedString(slippage)).append("\n"); - sb.append(" estimateGasFeeAmountUsdt: ").append(toIndentedString(estimateGasFeeAmountUsdt)).append("\n"); - sb.append(" orderFee: ").append(toIndentedString(orderFee)).append("\n"); - sb.append(" targetTokenMinAmount: ").append(toIndentedString(targetTokenMinAmount)).append("\n"); - sb.append(" targetTokenMaxAmount: ").append(toIndentedString(targetTokenMaxAmount)).append("\n"); - sb.append(" errorType: ").append(toIndentedString(errorType)).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/SpotAccount.java b/src/main/java/io/gate/gateapi/models/SpotAccount.java index d751e8b..27e0b92 100644 --- a/src/main/java/io/gate/gateapi/models/SpotAccount.java +++ b/src/main/java/io/gate/gateapi/models/SpotAccount.java @@ -39,10 +39,6 @@ public class SpotAccount { @SerializedName(SERIALIZED_NAME_UPDATE_ID) private Long updateId; - public static final String SERIALIZED_NAME_REFRESH_TIME = "refresh_time"; - @SerializedName(SERIALIZED_NAME_REFRESH_TIME) - private Long refreshTime; - public SpotAccount currency(String currency) { @@ -123,26 +119,6 @@ public Long getUpdateId() { public void setUpdateId(Long updateId) { this.updateId = updateId; } - - public SpotAccount refreshTime(Long refreshTime) { - - this.refreshTime = refreshTime; - return this; - } - - /** - * Asset Refresh Time (ms) - * @return refreshTime - **/ - @javax.annotation.Nullable - public Long getRefreshTime() { - return refreshTime; - } - - - public void setRefreshTime(Long refreshTime) { - this.refreshTime = refreshTime; - } @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -155,13 +131,12 @@ public boolean equals(java.lang.Object o) { return Objects.equals(this.currency, spotAccount.currency) && Objects.equals(this.available, spotAccount.available) && Objects.equals(this.locked, spotAccount.locked) && - Objects.equals(this.updateId, spotAccount.updateId) && - Objects.equals(this.refreshTime, spotAccount.refreshTime); + Objects.equals(this.updateId, spotAccount.updateId); } @Override public int hashCode() { - return Objects.hash(currency, available, locked, updateId, refreshTime); + return Objects.hash(currency, available, locked, updateId); } @@ -173,7 +148,6 @@ public String toString() { sb.append(" available: ").append(toIndentedString(available)).append("\n"); sb.append(" locked: ").append(toIndentedString(locked)).append("\n"); sb.append(" updateId: ").append(toIndentedString(updateId)).append("\n"); - sb.append(" refreshTime: ").append(toIndentedString(refreshTime)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/gate/gateapi/models/Ticker2.java b/src/main/java/io/gate/gateapi/models/Ticker2.java deleted file mode 100644 index 0f23fee..0000000 --- a/src/main/java/io/gate/gateapi/models/Ticker2.java +++ /dev/null @@ -1,193 +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; - -/** - * Ticker2 - */ -public class Ticker2 { - public static final String SERIALIZED_NAME_CURRENCY = "currency"; - @SerializedName(SERIALIZED_NAME_CURRENCY) - private String currency; - - public static final String SERIALIZED_NAME_LAST = "last"; - @SerializedName(SERIALIZED_NAME_LAST) - private String last; - - public static final String SERIALIZED_NAME_CHANGE = "change"; - @SerializedName(SERIALIZED_NAME_CHANGE) - private String change; - - public static final String SERIALIZED_NAME_VOLUME = "volume"; - @SerializedName(SERIALIZED_NAME_VOLUME) - private String volume; - - public static final String SERIALIZED_NAME_MARKET_CAP = "market_cap"; - @SerializedName(SERIALIZED_NAME_MARKET_CAP) - private String marketCap; - - - public Ticker2 currency(String currency) { - - this.currency = currency; - return this; - } - - /** - * Currency symbol - * @return currency - **/ - @javax.annotation.Nullable - public String getCurrency() { - return currency; - } - - - public void setCurrency(String currency) { - this.currency = currency; - } - - public Ticker2 last(String last) { - - this.last = last; - return this; - } - - /** - * Last trading price - * @return last - **/ - @javax.annotation.Nullable - public String getLast() { - return last; - } - - - public void setLast(String last) { - this.last = last; - } - - public Ticker2 change(String change) { - - this.change = change; - return this; - } - - /** - * Change percentage in the last 24h - * @return change - **/ - @javax.annotation.Nullable - public String getChange() { - return change; - } - - - public void setChange(String change) { - this.change = change; - } - - public Ticker2 volume(String volume) { - - this.volume = volume; - return this; - } - - /** - * 24h Trading Volume (USDT) - * @return volume - **/ - @javax.annotation.Nullable - public String getVolume() { - return volume; - } - - - public void setVolume(String volume) { - this.volume = volume; - } - - public Ticker2 marketCap(String marketCap) { - - this.marketCap = marketCap; - return this; - } - - /** - * Current Coin Market Value - * @return marketCap - **/ - @javax.annotation.Nullable - public String getMarketCap() { - return marketCap; - } - - - public void setMarketCap(String marketCap) { - this.marketCap = marketCap; - } - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - Ticker2 ticker2 = (Ticker2) o; - return Objects.equals(this.currency, ticker2.currency) && - Objects.equals(this.last, ticker2.last) && - Objects.equals(this.change, ticker2.change) && - Objects.equals(this.volume, ticker2.volume) && - Objects.equals(this.marketCap, ticker2.marketCap); - } - - @Override - public int hashCode() { - return Objects.hash(currency, last, change, volume, marketCap); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class Ticker2 {\n"); - sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); - sb.append(" last: ").append(toIndentedString(last)).append("\n"); - sb.append(" change: ").append(toIndentedString(change)).append("\n"); - sb.append(" volume: ").append(toIndentedString(volume)).append("\n"); - sb.append(" marketCap: ").append(toIndentedString(marketCap)).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/UnifiedAccount.java b/src/main/java/io/gate/gateapi/models/UnifiedAccount.java index 2b625ec..3c1bb9b 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedAccount.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedAccount.java @@ -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) { @@ -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; + } + + /** + * 是否所有币种均作为保证金，true - 所有币种作为保证金，false - 否 + * @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 a1368e1..7648e43 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedBalance.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedBalance.java @@ -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) { @@ -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; + } + + /** + * 币种开启作为保证金，true - 启用，false - 未启用 + * @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/UnifiedCollateralReq.java b/src/main/java/io/gate/gateapi/models/UnifiedCollateralReq.java new file mode 100644 index 0000000..034928e --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/UnifiedCollateralReq.java @@ -0,0 +1,206 @@ +/* + * Gate API v4 + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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; +import java.util.ArrayList; +import java.util.List; + +/** + * UnifiedCollateralReq + */ +public class UnifiedCollateralReq { + /** + * 用户设置抵押物模式 0(all)-全部币种作为抵押物,1(custom)-自定义币种作为抵押物,collateral_type为0(all)时，enable_list与disable_list参数无效 + */ + @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; + } + + /** + * 用户设置抵押物模式 0(all)-全部币种作为抵押物,1(custom)-自定义币种作为抵押物,collateral_type为0(all)时，enable_list与disable_list参数无效 + * @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; + } + + /** + * 币种列表，collateral_type=1(custom)表示追加的逻辑 + * @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; + } + + /** + * 取消列表，表示取消的逻辑 + * @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..e6c809e --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/UnifiedCollateralRes.java @@ -0,0 +1,89 @@ +/* + * Gate API v4 + * Welcome to Gate API APIv4 provides spot, margin and futures trading 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; + +/** + * 统一账户抵押模式设置返回 + */ +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; + } + + /** + * 是否设置成功 + * @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 "); + } + +} + From 0c21c9f8301fcd7193f08ef52913eaecaccb4e40 Mon Sep 17 00:00:00 2001 From: gateio Date: Wed, 2 Jul 2025 10:39:10 +0000 Subject: [PATCH 04/14] update to v6.100.1 --- docs/EarnUniApi.md | 8 +++--- .../java/io/gate/gateapi/api/EarnUniApi.java | 28 +++++++++---------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/EarnUniApi.md b/docs/EarnUniApi.md index fc24566..cb59fc2 100644 --- a/docs/EarnUniApi.md +++ b/docs/EarnUniApi.md @@ -664,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-07-02 10:25+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-02 10:38+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 ### Example @@ -730,7 +730,7 @@ 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-07-02 10:25+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-02 10:38+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 | - | # **listUniRate** @@ -738,7 +738,7 @@ Name | Type | Description | Notes Currency estimate annualized interest rate -Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-02 10:25+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-02 10:38+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 ### Example @@ -796,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-07-02 10:25+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-02 10:38+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 | - | diff --git a/src/main/java/io/gate/gateapi/api/EarnUniApi.java b/src/main/java/io/gate/gateapi/api/EarnUniApi.java index 5b73d0f..4310502 100644 --- a/src/main/java/io/gate/gateapi/api/EarnUniApi.java +++ b/src/main/java/io/gate/gateapi/api/EarnUniApi.java @@ -1289,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-07-02 10:25+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-02 10:38+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 -
*/ public okhttp3.Call listUniChartCall(Long from, Long to, String asset, final ApiCallback _callback) throws ApiException { @@ -1356,7 +1356,7 @@ 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-07-02 10:25+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-02 10:38+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) * @param asset Currency name (required) @@ -1365,7 +1365,7 @@ private okhttp3.Call listUniChartValidateBeforeCall(Long from, Long to, String a * @http.response.details - +
Status Code Description Response Headers
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-02 10:25+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-02 10:38+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 -
*/ public List listUniChart(Long from, Long to, String asset) throws ApiException { @@ -1375,7 +1375,7 @@ 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-07-02 10:25+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-02 10:38+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) * @param asset Currency name (required) @@ -1384,7 +1384,7 @@ public List listUniChart(Long from, Long to, String asset) th * @http.response.details - +
Status Code Description Response Headers
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-02 10:25+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-02 10:38+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 -
*/ public ApiResponse> listUniChartWithHttpInfo(Long from, Long to, String asset) throws ApiException { @@ -1395,7 +1395,7 @@ 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-07-02 10:25+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-02 10:38+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) * @param asset Currency name (required) @@ -1405,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-07-02 10:25+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-02 10:38+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 -
*/ public okhttp3.Call listUniChartAsync(Long from, Long to, String asset, final ApiCallback> _callback) throws ApiException { @@ -1423,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-07-02 10:25+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-02 10:38+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 -
*/ public okhttp3.Call listUniRateCall(final ApiCallback _callback) throws ApiException { @@ -1463,13 +1463,13 @@ 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-07-02 10:25+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-02 10:38+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 * @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-07-02 10:25+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-02 10:38+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 -
*/ public List listUniRate() throws ApiException { @@ -1479,13 +1479,13 @@ 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-07-02 10:25+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-02 10:38+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 * @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-07-02 10:25+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-02 10:38+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 -
*/ public ApiResponse> listUniRateWithHttpInfo() throws ApiException { @@ -1496,14 +1496,14 @@ 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-07-02 10:25+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-02 10:38+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 _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-07-02 10:25+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-02 10:38+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 -
*/ public okhttp3.Call listUniRateAsync(final ApiCallback> _callback) throws ApiException { From bd9a1295465f45a2cf9d5c2b5587170bf26b4ce2 Mon Sep 17 00:00:00 2001 From: gateio Date: Wed, 2 Jul 2025 10:51:06 +0000 Subject: [PATCH 05/14] update to v6.100.2 --- README.md | 10 +++---- build.gradle | 2 +- build.sbt | 2 +- docs/EarnUniApi.md | 8 +++--- pom.xml | 8 ++++-- src/main/java/io/gate/gateapi/ApiClient.java | 2 +- .../java/io/gate/gateapi/api/EarnUniApi.java | 28 +++++++++---------- 7 files changed, 32 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 948cd62..a6d1458 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ Gate API v4 -- API version: 4.100.1 -- SDK version: 6.100.1 +- API version: 4.100.2 +- SDK version: 6.100.2 Welcome to Gate API @@ -54,7 +54,7 @@ Add this dependency to your project's POM: io.gate gate-api - 6.100.1 + 6.100.2 compile ``` @@ -64,7 +64,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.100.1" +compile "io.gate:gate-api:6.100.2" ``` ### Others @@ -77,7 +77,7 @@ mvn clean package Then manually install the following JARs: -* `target/gate-api-6.100.1.jar` +* `target/gate-api-6.100.2.jar` * `target/lib/*.jar` To install the API client library to your local Maven repository, simply execute: diff --git a/build.gradle b/build.gradle index 954e21f..3dd4ca7 100644 --- a/build.gradle +++ b/build.gradle @@ -3,7 +3,7 @@ apply plugin: 'eclipse' apply plugin: 'java' group = 'io.gate' -version = '6.100.1' +version = '6.100.2' buildscript { repositories { diff --git a/build.sbt b/build.sbt index 7e20389..766e606 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.100.1", + version := "6.100.2", scalaVersion := "2.11.4", scalacOptions ++= Seq("-feature"), javacOptions in compile ++= Seq("-Xlint:deprecation"), diff --git a/docs/EarnUniApi.md b/docs/EarnUniApi.md index cb59fc2..d18219a 100644 --- a/docs/EarnUniApi.md +++ b/docs/EarnUniApi.md @@ -664,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-07-02 10:38+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-02 10:50+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 ### Example @@ -730,7 +730,7 @@ 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-07-02 10:38+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-02 10:50+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 | - | # **listUniRate** @@ -738,7 +738,7 @@ Name | Type | Description | Notes Currency estimate annualized interest rate -Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-02 10:38+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-02 10:50+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 ### Example @@ -796,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-07-02 10:38+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-02 10:50+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 | - | diff --git a/pom.xml b/pom.xml index 73a68d4..e0fe6f7 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ gate-api jar gate-api - 6.100.1 + 6.100.2 https://github.com/gateio/gateapi-java.git Java client for gateapi @@ -185,12 +185,16 @@ org.sonatype.plugins nexus-staging-maven-plugin - 1.6.7 + 1.6.13 true ossrh https://ossrh-staging-api.central.sonatype.com true + 20 + 10 + true + true diff --git a/src/main/java/io/gate/gateapi/ApiClient.java b/src/main/java/io/gate/gateapi/ApiClient.java index 275300b..0edaca8 100644 --- a/src/main/java/io/gate/gateapi/ApiClient.java +++ b/src/main/java/io/gate/gateapi/ApiClient.java @@ -113,7 +113,7 @@ private void init() { json = new JSON(); // Set default User-Agent. - setUserAgent("OpenAPI-Generator/6.100.1/java"); + setUserAgent("OpenAPI-Generator/6.100.2/java"); authentications = new HashMap(); } diff --git a/src/main/java/io/gate/gateapi/api/EarnUniApi.java b/src/main/java/io/gate/gateapi/api/EarnUniApi.java index 4310502..ce75cc6 100644 --- a/src/main/java/io/gate/gateapi/api/EarnUniApi.java +++ b/src/main/java/io/gate/gateapi/api/EarnUniApi.java @@ -1289,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-07-02 10:38+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-02 10:50+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 -
*/ public okhttp3.Call listUniChartCall(Long from, Long to, String asset, final ApiCallback _callback) throws ApiException { @@ -1356,7 +1356,7 @@ 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-07-02 10:38+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-02 10:50+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) * @param asset Currency name (required) @@ -1365,7 +1365,7 @@ private okhttp3.Call listUniChartValidateBeforeCall(Long from, Long to, String a * @http.response.details - +
Status Code Description Response Headers
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-02 10:38+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-02 10:50+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 -
*/ public List listUniChart(Long from, Long to, String asset) throws ApiException { @@ -1375,7 +1375,7 @@ 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-07-02 10:38+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-02 10:50+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) * @param asset Currency name (required) @@ -1384,7 +1384,7 @@ public List listUniChart(Long from, Long to, String asset) th * @http.response.details - +
Status Code Description Response Headers
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-02 10:38+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-02 10:50+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 -
*/ public ApiResponse> listUniChartWithHttpInfo(Long from, Long to, String asset) throws ApiException { @@ -1395,7 +1395,7 @@ 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-07-02 10:38+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-02 10:50+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) * @param asset Currency name (required) @@ -1405,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-07-02 10:38+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-02 10:50+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 -
*/ public okhttp3.Call listUniChartAsync(Long from, Long to, String asset, final ApiCallback> _callback) throws ApiException { @@ -1423,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-07-02 10:38+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-02 10:50+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 -
*/ public okhttp3.Call listUniRateCall(final ApiCallback _callback) throws ApiException { @@ -1463,13 +1463,13 @@ 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-07-02 10:38+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-02 10:50+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 * @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-07-02 10:38+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-02 10:50+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 -
*/ public List listUniRate() throws ApiException { @@ -1479,13 +1479,13 @@ 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-07-02 10:38+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-02 10:50+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 * @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-07-02 10:38+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-02 10:50+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 -
*/ public ApiResponse> listUniRateWithHttpInfo() throws ApiException { @@ -1496,14 +1496,14 @@ 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-07-02 10:38+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-02 10:50+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 _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-07-02 10:38+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-02 10:50+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 -
*/ public okhttp3.Call listUniRateAsync(final ApiCallback> _callback) throws ApiException { From 13b5a4c0f13aeb4c311a702e841df6fe52e3a935 Mon Sep 17 00:00:00 2001 From: gateio Date: Tue, 15 Jul 2025 06:11:18 +0000 Subject: [PATCH 06/14] update to v2.102.0 --- README.md | 26 +- build.gradle | 2 +- build.sbt | 2 +- docs/AccountApi.md | 2 +- docs/AccountDetail.md | 2 +- docs/BatchAmendItem.md | 4 +- docs/BatchOrder.md | 4 +- docs/CollateralLoanApi.md | 4 +- docs/Contract.md | 4 +- docs/CountdownCancelAllFuturesTask.md | 2 +- docs/CountdownCancelAllOptionsTask.md | 2 +- docs/CountdownCancelAllSpotTask.md | 2 +- docs/CurrencyPair.md | 1 + docs/DeliveryApi.md | 38 +-- docs/DeliveryContract.md | 2 +- docs/EarnApi.md | 29 +- docs/EarnUniApi.md | 26 +- docs/FlashSwapOrderPreview.md | 4 +- docs/FlashSwapOrderRequest.md | 4 +- docs/FuturesAccount.md | 1 + docs/FuturesAccountBook.md | 2 +- docs/FuturesApi.md | 159 +++++++--- docs/FuturesLimitRiskTiers.md | 1 + docs/FuturesRiskLimitTier.md | 16 + docs/MarginUniApi.md | 8 +- docs/MultiCollateralLoanApi.md | 22 +- docs/OptionsApi.md | 70 ++--- docs/Order.md | 4 +- docs/OrderCancel.md | 4 +- docs/OrderPatch.md | 4 +- docs/Position.md | 2 + docs/SpotApi.md | 20 +- docs/SpotPricePutOrder.md | 2 +- docs/SpotPriceTrigger.md | 2 +- docs/SubAccountToSubAccount.md | 2 +- docs/SubAccountTransfer.md | 2 +- docs/SubAccountTransferRecordItem.md | 2 +- docs/SwapCoinStruct.md | 17 + docs/Trade.md | 2 +- docs/UniCurrencyInterest.md | 2 +- docs/UniInterestRecord.md | 2 +- docs/UniLend.md | 2 +- docs/UnifiedAccount.md | 2 +- docs/UnifiedApi.md | 8 +- docs/UnifiedBalance.md | 2 +- docs/UnifiedCollateralReq.md | 6 +- docs/UnifiedCollateralRes.md | 4 +- docs/UnifiedLoanRecord.md | 2 +- docs/WalletApi.md | 2 +- docs/WithdrawalRecord.md | 2 +- pom.xml | 4 +- .../java/io/gate/gateapi/ApiCallback.java | 4 +- src/main/java/io/gate/gateapi/ApiClient.java | 6 +- .../java/io/gate/gateapi/ApiException.java | 4 +- .../java/io/gate/gateapi/ApiResponse.java | 4 +- .../java/io/gate/gateapi/Configuration.java | 4 +- .../gate/gateapi/GzipRequestInterceptor.java | 4 +- src/main/java/io/gate/gateapi/JSON.java | 4 +- src/main/java/io/gate/gateapi/Pair.java | 4 +- .../io/gate/gateapi/ProgressRequestBody.java | 4 +- .../io/gate/gateapi/ProgressResponseBody.java | 4 +- src/main/java/io/gate/gateapi/StringUtil.java | 4 +- .../java/io/gate/gateapi/api/AccountApi.java | 10 +- .../gate/gateapi/api/CollateralLoanApi.java | 6 +- .../java/io/gate/gateapi/api/DeliveryApi.java | 38 +-- .../java/io/gate/gateapi/api/EarnApi.java | 39 ++- .../java/io/gate/gateapi/api/EarnUniApi.java | 46 +-- .../io/gate/gateapi/api/FlashSwapApi.java | 4 +- .../java/io/gate/gateapi/api/FuturesApi.java | 220 ++++++++++--- .../java/io/gate/gateapi/api/MarginApi.java | 4 +- .../io/gate/gateapi/api/MarginUniApi.java | 8 +- .../gateapi/api/MultiCollateralLoanApi.java | 28 +- .../java/io/gate/gateapi/api/OptionsApi.java | 48 +-- .../java/io/gate/gateapi/api/RebateApi.java | 4 +- .../java/io/gate/gateapi/api/SpotApi.java | 36 +-- .../io/gate/gateapi/api/SubAccountApi.java | 4 +- .../java/io/gate/gateapi/api/UnifiedApi.java | 24 +- .../java/io/gate/gateapi/api/WalletApi.java | 6 +- .../io/gate/gateapi/api/WithdrawalApi.java | 4 +- .../java/io/gate/gateapi/auth/ApiKeyAuth.java | 4 +- .../io/gate/gateapi/auth/Authentication.java | 4 +- .../io/gate/gateapi/auth/GateApiV4Auth.java | 4 +- .../io/gate/gateapi/auth/HttpBasicAuth.java | 4 +- .../io/gate/gateapi/auth/HttpBearerAuth.java | 4 +- .../gate/gateapi/models/AccountBalance.java | 4 +- .../io/gate/gateapi/models/AccountDetail.java | 6 +- .../gate/gateapi/models/AccountDetailKey.java | 4 +- .../gate/gateapi/models/AccountRateLimit.java | 4 +- .../gate/gateapi/models/AgencyCommission.java | 4 +- .../models/AgencyCommissionHistory.java | 4 +- .../gateapi/models/AgencyTransaction.java | 4 +- .../models/AgencyTransactionHistory.java | 4 +- .../gate/gateapi/models/AutoRepaySetting.java | 4 +- .../gate/gateapi/models/BatchAmendItem.java | 8 +- .../gateapi/models/BatchAmendOrderReq.java | 4 +- .../gateapi/models/BatchFuturesOrder.java | 4 +- .../io/gate/gateapi/models/BatchOrder.java | 12 +- .../gateapi/models/BorrowCurrencyInfo.java | 4 +- .../gate/gateapi/models/BrokerCommission.java | 4 +- .../gateapi/models/BrokerCommission1.java | 4 +- .../models/BrokerCommissionSubBrokerInfo.java | 4 +- .../gateapi/models/BrokerTransaction.java | 4 +- .../gateapi/models/BrokerTransaction1.java | 4 +- .../gate/gateapi/models/CancelBatchOrder.java | 4 +- .../gateapi/models/CancelOrderResult.java | 4 +- .../gate/gateapi/models/CollateralAdjust.java | 4 +- .../gateapi/models/CollateralAdjustRes.java | 4 +- .../gate/gateapi/models/CollateralAlign.java | 4 +- .../gateapi/models/CollateralCurrency.java | 4 +- .../models/CollateralCurrencyInfo.java | 4 +- .../gateapi/models/CollateralCurrencyRes.java | 4 +- .../gateapi/models/CollateralCurrentRate.java | 4 +- .../gateapi/models/CollateralFixRate.java | 4 +- .../models/CollateralLoanCurrency.java | 4 +- .../io/gate/gateapi/models/CollateralLtv.java | 4 +- .../gate/gateapi/models/CollateralOrder.java | 4 +- .../gate/gateapi/models/CollateralRecord.java | 4 +- .../java/io/gate/gateapi/models/Contract.java | 8 +- .../io/gate/gateapi/models/ContractStat.java | 4 +- .../gateapi/models/ConvertSmallBalance.java | 4 +- .../models/CountdownCancelAllFuturesTask.java | 6 +- .../models/CountdownCancelAllOptionsTask.java | 6 +- .../models/CountdownCancelAllSpotTask.java | 6 +- .../gateapi/models/CreateCollateralOrder.java | 4 +- .../models/CreateMultiCollateralOrder.java | 4 +- .../io/gate/gateapi/models/CreateUniLend.java | 4 +- .../io/gate/gateapi/models/CreateUniLoan.java | 4 +- .../gateapi/models/CrossMarginBalance.java | 4 +- .../gate/gateapi/models/CrossMarginLoan.java | 4 +- .../gateapi/models/CrossMarginRepayment.java | 4 +- .../java/io/gate/gateapi/models/Currency.java | 4 +- .../io/gate/gateapi/models/CurrencyChain.java | 4 +- .../io/gate/gateapi/models/CurrencyPair.java | 34 +- .../io/gate/gateapi/models/CurrencyQuota.java | 4 +- .../java/io/gate/gateapi/models/DebitFee.java | 4 +- .../gateapi/models/DeliveryCandlestick.java | 4 +- .../gate/gateapi/models/DeliveryContract.java | 6 +- .../gateapi/models/DeliverySettlement.java | 4 +- .../gate/gateapi/models/DeliveryTicker.java | 4 +- .../gate/gateapi/models/DepositAddress.java | 4 +- .../io/gate/gateapi/models/DepositRecord.java | 4 +- .../io/gate/gateapi/models/DualGetOrders.java | 4 +- .../io/gate/gateapi/models/DualGetPlans.java | 4 +- .../io/gate/gateapi/models/Eth2RateList.java | 4 +- .../java/io/gate/gateapi/models/Eth2Swap.java | 4 +- .../java/io/gate/gateapi/models/FindCoin.java | 4 +- .../gateapi/models/FlashSwapCurrencyPair.java | 4 +- .../gate/gateapi/models/FlashSwapOrder.java | 4 +- .../gateapi/models/FlashSwapOrderPreview.java | 8 +- .../gateapi/models/FlashSwapOrderRequest.java | 8 +- .../models/FlashSwapPreviewRequest.java | 4 +- .../gate/gateapi/models/FundingAccount.java | 4 +- .../gateapi/models/FundingRateRecord.java | 4 +- .../models/FutureCancelOrderResult.java | 4 +- .../gate/gateapi/models/FuturesAccount.java | 32 +- .../gateapi/models/FuturesAccountBook.java | 6 +- .../gateapi/models/FuturesAccountHistory.java | 4 +- .../gateapi/models/FuturesAutoDeleverage.java | 4 +- .../models/FuturesBatchAmendOrderRequest.java | 4 +- .../gateapi/models/FuturesCandlestick.java | 4 +- .../io/gate/gateapi/models/FuturesFee.java | 4 +- .../models/FuturesIndexConstituents.java | 4 +- .../gateapi/models/FuturesInitialOrder.java | 4 +- .../gateapi/models/FuturesLimitRiskTiers.java | 34 +- .../gate/gateapi/models/FuturesLiqOrder.java | 4 +- .../gate/gateapi/models/FuturesLiquidate.java | 4 +- .../io/gate/gateapi/models/FuturesOrder.java | 4 +- .../gateapi/models/FuturesOrderAmendment.java | 4 +- .../gate/gateapi/models/FuturesOrderBook.java | 4 +- .../gateapi/models/FuturesOrderBookItem.java | 4 +- .../models/FuturesPositionCrossMode.java | 4 +- .../gateapi/models/FuturesPremiumIndex.java | 4 +- .../gateapi/models/FuturesPriceTrigger.java | 4 +- .../models/FuturesPriceTriggeredOrder.java | 4 +- .../gateapi/models/FuturesRiskLimitTier.java | 219 +++++++++++++ .../io/gate/gateapi/models/FuturesTicker.java | 4 +- .../io/gate/gateapi/models/FuturesTrade.java | 4 +- .../gate/gateapi/models/IndexConstituent.java | 4 +- .../gateapi/models/InlineResponse200.java | 4 +- .../gateapi/models/InlineResponse2001.java | 4 +- .../gate/gateapi/models/InsuranceRecord.java | 4 +- .../io/gate/gateapi/models/LedgerRecord.java | 4 +- .../gate/gateapi/models/LiquidateOrder.java | 4 +- .../io/gate/gateapi/models/MarginAccount.java | 4 +- .../gateapi/models/MarginAccountBook.java | 4 +- .../gateapi/models/MarginAccountCurrency.java | 4 +- .../gateapi/models/MarginLeverageTier.java | 4 +- .../gateapi/models/MarginMarketLeverage.java | 4 +- .../io/gate/gateapi/models/MarginTiers.java | 4 +- .../gateapi/models/MarginTransferable.java | 4 +- .../gate/gateapi/models/MaxUniBorrowable.java | 4 +- .../gate/gateapi/models/MockFuturesOrder.java | 4 +- .../gateapi/models/MockFuturesPosition.java | 4 +- .../gate/gateapi/models/MockMarginResult.java | 4 +- .../gate/gateapi/models/MockOptionsOrder.java | 4 +- .../gateapi/models/MockOptionsPosition.java | 4 +- .../io/gate/gateapi/models/MockRiskUnit.java | 4 +- .../gate/gateapi/models/MockSpotBalance.java | 4 +- .../io/gate/gateapi/models/MockSpotOrder.java | 4 +- .../gateapi/models/MultiChainAddressItem.java | 4 +- .../models/MultiCollateralCurrency.java | 4 +- .../gateapi/models/MultiCollateralItem.java | 4 +- .../gateapi/models/MultiCollateralOrder.java | 4 +- .../gateapi/models/MultiCollateralRecord.java | 4 +- .../models/MultiCollateralRecordCurrency.java | 4 +- .../io/gate/gateapi/models/MultiLoanItem.java | 4 +- .../gateapi/models/MultiLoanRepayItem.java | 4 +- .../gate/gateapi/models/MultiRepayRecord.java | 4 +- .../gate/gateapi/models/MultiRepayResp.java | 4 +- .../gate/gateapi/models/MyFuturesTrade.java | 4 +- .../models/MyFuturesTradeTimeRange.java | 4 +- .../io/gate/gateapi/models/OpenOrders.java | 4 +- .../gate/gateapi/models/OptionsAccount.java | 4 +- .../gateapi/models/OptionsAccountBook.java | 4 +- .../gateapi/models/OptionsCandlestick.java | 4 +- .../gate/gateapi/models/OptionsContract.java | 4 +- .../io/gate/gateapi/models/OptionsMMP.java | 4 +- .../gate/gateapi/models/OptionsMMPReset.java | 4 +- .../gateapi/models/OptionsMySettlements.java | 4 +- .../gate/gateapi/models/OptionsMyTrade.java | 4 +- .../io/gate/gateapi/models/OptionsOrder.java | 4 +- .../gate/gateapi/models/OptionsPosition.java | 4 +- .../gateapi/models/OptionsPositionClose.java | 4 +- .../models/OptionsPositionCloseOrder.java | 4 +- .../gateapi/models/OptionsSettlement.java | 4 +- .../io/gate/gateapi/models/OptionsTicker.java | 4 +- .../gateapi/models/OptionsUnderlying.java | 4 +- .../models/OptionsUnderlyingTicker.java | 4 +- .../java/io/gate/gateapi/models/Order.java | 12 +- .../io/gate/gateapi/models/OrderBook.java | 4 +- .../io/gate/gateapi/models/OrderCancel.java | 12 +- .../io/gate/gateapi/models/OrderPatch.java | 8 +- .../io/gate/gateapi/models/OrderResp.java | 4 +- .../models/PartnerCommissionHistory.java | 4 +- .../io/gate/gateapi/models/PartnerSub.java | 4 +- .../gate/gateapi/models/PartnerSubList.java | 4 +- .../models/PartnerTransactionHistory.java | 4 +- .../io/gate/gateapi/models/PatchUniLend.java | 4 +- .../models/PlaceDualInvestmentOrder.java | 4 +- .../java/io/gate/gateapi/models/Position.java | 40 ++- .../io/gate/gateapi/models/PositionClose.java | 4 +- .../gateapi/models/PositionCloseOrder.java | 4 +- .../gate/gateapi/models/ProfitLossRange.java | 4 +- .../gate/gateapi/models/RebateUserInfo.java | 4 +- .../gate/gateapi/models/RepayCurrencyRes.java | 4 +- .../io/gate/gateapi/models/RepayLoan.java | 4 +- .../gate/gateapi/models/RepayMultiLoan.java | 4 +- .../io/gate/gateapi/models/RepayRecord.java | 4 +- .../gateapi/models/RepayRecordCurrency.java | 4 +- .../models/RepayRecordLeftInterest.java | 4 +- .../models/RepayRecordRepaidCurrency.java | 4 +- .../models/RepayRecordTotalInterest.java | 4 +- .../io/gate/gateapi/models/RepayResp.java | 4 +- .../io/gate/gateapi/models/RiskUnits.java | 4 +- .../io/gate/gateapi/models/SavedAddress.java | 4 +- .../io/gate/gateapi/models/SmallBalance.java | 4 +- .../gateapi/models/SmallBalanceHistory.java | 4 +- .../io/gate/gateapi/models/SpotAccount.java | 4 +- .../gate/gateapi/models/SpotAccountBook.java | 4 +- .../gateapi/models/SpotCurrencyChain.java | 4 +- .../java/io/gate/gateapi/models/SpotFee.java | 4 +- .../gateapi/models/SpotInsuranceHistory.java | 4 +- .../gateapi/models/SpotPricePutOrder.java | 8 +- .../gate/gateapi/models/SpotPriceTrigger.java | 8 +- .../models/SpotPriceTriggeredOrder.java | 4 +- .../java/io/gate/gateapi/models/StpGroup.java | 4 +- .../io/gate/gateapi/models/StpGroupUser.java | 4 +- .../io/gate/gateapi/models/StructuredBuy.java | 4 +- .../models/StructuredGetProjectList.java | 4 +- .../gateapi/models/StructuredOrderList.java | 4 +- .../io/gate/gateapi/models/SubAccount.java | 4 +- .../gateapi/models/SubAccountBalance.java | 4 +- .../models/SubAccountCrossMarginBalance.java | 4 +- .../models/SubAccountFuturesBalance.java | 4 +- .../io/gate/gateapi/models/SubAccountKey.java | 4 +- .../gateapi/models/SubAccountKeyPerms.java | 4 +- .../models/SubAccountMarginBalance.java | 4 +- .../models/SubAccountToSubAccount.java | 6 +- .../gateapi/models/SubAccountTransfer.java | 6 +- .../models/SubAccountTransferRecordItem.java | 6 +- .../gateapi/models/SubCrossMarginAccount.java | 4 +- .../io/gate/gateapi/models/SubUserMode.java | 4 +- .../java/io/gate/gateapi/models/SwapCoin.java | 4 +- .../gate/gateapi/models/SwapCoinStruct.java | 297 ++++++++++++++++++ .../io/gate/gateapi/models/SystemTime.java | 4 +- .../java/io/gate/gateapi/models/Ticker.java | 4 +- .../io/gate/gateapi/models/TotalBalance.java | 4 +- .../java/io/gate/gateapi/models/Trade.java | 8 +- .../java/io/gate/gateapi/models/TradeFee.java | 4 +- .../io/gate/gateapi/models/TransactionID.java | 4 +- .../java/io/gate/gateapi/models/Transfer.java | 4 +- .../gateapi/models/TransferOrderStatus.java | 4 +- .../gateapi/models/TransferablesResult.java | 4 +- .../gateapi/models/TriggerOrderResponse.java | 4 +- .../io/gate/gateapi/models/TriggerTime.java | 4 +- .../io/gate/gateapi/models/UidPushOrder.java | 4 +- .../gateapi/models/UidPushWithdrawal.java | 4 +- .../gateapi/models/UidPushWithdrawalResp.java | 4 +- .../io/gate/gateapi/models/UniCurrency.java | 4 +- .../gateapi/models/UniCurrencyInterest.java | 6 +- .../gate/gateapi/models/UniCurrencyPair.java | 4 +- .../gateapi/models/UniInterestRecord.java | 6 +- .../java/io/gate/gateapi/models/UniLend.java | 6 +- .../gate/gateapi/models/UniLendInterest.java | 4 +- .../io/gate/gateapi/models/UniLendRecord.java | 4 +- .../java/io/gate/gateapi/models/UniLoan.java | 4 +- .../gateapi/models/UniLoanInterestRecord.java | 4 +- .../io/gate/gateapi/models/UniLoanRecord.java | 4 +- .../gate/gateapi/models/UnifiedAccount.java | 6 +- .../gate/gateapi/models/UnifiedBalance.java | 6 +- .../gateapi/models/UnifiedBorrowable.java | 4 +- .../gateapi/models/UnifiedBorrowable1.java | 4 +- .../gateapi/models/UnifiedCollateralReq.java | 12 +- .../gateapi/models/UnifiedCollateralRes.java | 8 +- .../gate/gateapi/models/UnifiedCurrency.java | 4 +- .../gate/gateapi/models/UnifiedDiscount.java | 4 +- .../gateapi/models/UnifiedDiscountTiers.java | 4 +- .../models/UnifiedHistoryLoanRate.java | 4 +- .../models/UnifiedHistoryLoanRateRates.java | 4 +- .../gateapi/models/UnifiedLeverageConfig.java | 4 +- .../models/UnifiedLeverageSetting.java | 4 +- .../io/gate/gateapi/models/UnifiedLoan.java | 4 +- .../gateapi/models/UnifiedLoanRecord.java | 6 +- .../gateapi/models/UnifiedLoanResult.java | 4 +- .../gateapi/models/UnifiedMarginTiers.java | 4 +- .../gate/gateapi/models/UnifiedModeSet.java | 4 +- .../gateapi/models/UnifiedPortfolioInput.java | 4 +- .../models/UnifiedPortfolioOutput.java | 4 +- .../gate/gateapi/models/UnifiedRiskUnits.java | 4 +- .../gate/gateapi/models/UnifiedSettings.java | 4 +- .../gateapi/models/UnifiedTransferable.java | 4 +- .../io/gate/gateapi/models/UserLtvInfo.java | 4 +- .../java/io/gate/gateapi/models/UserSub.java | 4 +- .../gate/gateapi/models/UserSubRelation.java | 4 +- .../gate/gateapi/models/UserTotalAmount.java | 4 +- .../gate/gateapi/models/WithdrawStatus.java | 4 +- .../gate/gateapi/models/WithdrawalRecord.java | 6 +- 337 files changed, 1871 insertions(+), 1008 deletions(-) create mode 100644 docs/FuturesRiskLimitTier.md create mode 100644 docs/SwapCoinStruct.md create mode 100644 src/main/java/io/gate/gateapi/models/FuturesRiskLimitTier.java create mode 100644 src/main/java/io/gate/gateapi/models/SwapCoinStruct.java diff --git a/README.md b/README.md index a6d1458..dcbeb61 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,15 @@ # gate-api -Gate API v4 +Gate API -- API version: 4.100.2 -- SDK version: 6.100.2 +- API version: v4.102.0 +- SDK version: 6.102.0 Welcome to Gate API + APIv4 provides operations 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)* @@ -54,7 +53,7 @@ Add this dependency to your project's POM: io.gate gate-api - 6.100.2 + 6.102.0 compile ``` @@ -64,7 +63,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.100.2" +compile "io.gate:gate-api:6.102.0" ``` ### Others @@ -77,7 +76,7 @@ mvn clean package Then manually install the following JARs: -* `target/gate-api-6.100.2.jar` +* `target/gate-api-6.102.0.jar` * `target/lib/*.jar` To install the API client library to your local Maven repository, simply execute: @@ -198,7 +197,7 @@ Class | Method | HTTP request | Description *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 -*EarnApi* | [**findCoin**](docs/EarnApi.md#findCoin) | **GET** /earn/staking/coins | 链上赚币币种 +*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 | List currencies for lending *EarnUniApi* | [**getUniCurrency**](docs/EarnUniApi.md#getUniCurrency) | **GET** /earn/uni/currencies/{currency} | Get currency detail for lending @@ -259,6 +258,7 @@ Class | Method | HTTP request | Description *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* | [**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 | 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 @@ -397,7 +397,7 @@ Class | Method | HTTP request | Description *UnifiedApi* | [**setUserLeverageCurrencySetting**](docs/UnifiedApi.md#setUserLeverageCurrencySetting) | **POST** /unified/leverage/user_currency_setting | Set the 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 -*UnifiedApi* | [**setUnifiedCollateral**](docs/UnifiedApi.md#setUnifiedCollateral) | **POST** /unified/collateral_currencies | 设置抵押币种 +*UnifiedApi* | [**setUnifiedCollateral**](docs/UnifiedApi.md#setUnifiedCollateral) | **POST** /unified/collateral_currencies | Set Collateral Currency *WalletApi* | [**listCurrencyChains**](docs/WalletApi.md#listCurrencyChains) | **GET** /wallet/currency_chains | List 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 @@ -516,6 +516,7 @@ Class | Method | HTTP request | Description - [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) @@ -624,6 +625,7 @@ Class | Method | HTTP request | Description - [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) diff --git a/build.gradle b/build.gradle index 3dd4ca7..56c2a5a 100644 --- a/build.gradle +++ b/build.gradle @@ -3,7 +3,7 @@ apply plugin: 'eclipse' apply plugin: 'java' group = 'io.gate' -version = '6.100.2' +version = '6.102.0' buildscript { repositories { diff --git a/build.sbt b/build.sbt index 766e606..ec2355f 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.100.2", + version := "6.102.0", 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..5941052 100644 --- a/docs/AccountApi.md +++ b/docs/AccountApi.md @@ -291,7 +291,7 @@ Name | Type | Description | Notes 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 +Only the main account that created this STP group can query the account ### Example diff --git a/docs/AccountDetail.md b/docs/AccountDetail.md index fe95b76..e23a262 100644 --- a/docs/AccountDetail.md +++ b/docs/AccountDetail.md @@ -12,5 +12,5 @@ Name | Type | Description | Notes **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 - Copy trading follower 3 - Both leader and follower | [optional] diff --git a/docs/BatchAmendItem.md b/docs/BatchAmendItem.md index 6cf798b..9c0f769 100644 --- a/docs/BatchAmendItem.md +++ b/docs/BatchAmendItem.md @@ -10,8 +10,8 @@ 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). | **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] +**amount** | **String** | Trading Quantity. Only one of amountor pricecan be specified. | [optional] +**price** | **String** | Trading Price. Only one of amountor pricecan be specified. | [optional] **amendText** | **String** | Custom info during amending order | [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/BatchOrder.md b/docs/BatchOrder.md index 6c9653f..df65c20 100644 --- a/docs/BatchOrder.md +++ b/docs/BatchOrder.md @@ -20,9 +20,9 @@ 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] diff --git a/docs/CollateralLoanApi.md b/docs/CollateralLoanApi.md index 8117fa0..73fef6a 100644 --- a/docs/CollateralLoanApi.md +++ b/docs/CollateralLoanApi.md @@ -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 | 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. 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**| The parameter loan_currency is used to specify the borrowing currency. If loan_currency is not provided, the API will return all supported borrowing currencies. | [optional] ### Return type diff --git a/docs/Contract.md b/docs/Contract.md index bc3e83e..14046b7 100644 --- a/docs/Contract.md +++ b/docs/Contract.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes **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] +**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] @@ -44,7 +44,7 @@ Name | Type | Description | Notes **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, trading, delisting, delisted | [optional] -**launchTime** | **Long** | 合约开盘时间 | [optional] +**launchTime** | **Long** | Contract expiry timestamp | [optional] ## Enum: TypeEnum diff --git a/docs/CountdownCancelAllFuturesTask.md b/docs/CountdownCancelAllFuturesTask.md index e148bc8..b7a1523 100644 --- a/docs/CountdownCancelAllFuturesTask.md +++ b/docs/CountdownCancelAllFuturesTask.md @@ -7,6 +7,6 @@ Countdown cancel task detail 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..fc87f87 100644 --- a/docs/CountdownCancelAllOptionsTask.md +++ b/docs/CountdownCancelAllOptionsTask.md @@ -7,7 +7,7 @@ Countdown cancel task detail 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..27388e9 100644 --- a/docs/CountdownCancelAllSpotTask.md +++ b/docs/CountdownCancelAllSpotTask.md @@ -7,6 +7,6 @@ Countdown cancel task detail 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/CurrencyPair.md b/docs/CurrencyPair.md index 1ed4f0b..2fd80e0 100644 --- a/docs/CurrencyPair.md +++ b/docs/CurrencyPair.md @@ -25,6 +25,7 @@ Name | Type | Description | Notes **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/DeliveryApi.md b/docs/DeliveryApi.md index 63f29c3..4d55208 100644 --- a/docs/DeliveryApi.md +++ b/docs/DeliveryApi.md @@ -194,7 +194,7 @@ public class Example { 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 + Boolean withId = false; // Boolean | Whether to return depth update ID. This ID increments by 1 each time. try { FuturesOrderBook result = apiInstance.listDeliveryOrderBook(settle, contract) .interval(interval) @@ -223,7 +223,7 @@ Name | Type | Description | Notes **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] + **withId** | **Boolean**| Whether to return depth update ID. This ID increments by 1 each time. | [optional] [default to false] ### Return type @@ -241,7 +241,7 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order book retrieved | - | +**200** | Depth query successful | - | # **listDeliveryTrades** @@ -269,7 +269,7 @@ public class Example { 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 + String lastId = "12345"; // String | 以上个列表的最后一条记录的 ID 作为下个列表的起点。 该字段不再继续支持，新的请求请使用 `from` 和 `to` 字段来限定时间范围 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 try { @@ -300,7 +300,7 @@ 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] + **lastId** | **String**| 以上个列表的最后一条记录的 ID 作为下个列表的起点。 该字段不再继续支持，新的请求请使用 `from` 和 `to` 字段来限定时间范围 | [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] @@ -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 + 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 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 + String interval = "5m"; // String | Time interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial timeweek 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] + **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 | [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] + **interval** | **String**| Time interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial timeweek | [optional] [default to 5m] [enum: 10s, 30s, 1m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 7d, 1w, 30d] ### Return type @@ -636,8 +636,8 @@ 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 + 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 | 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 try { List result = apiInstance.listDeliveryAccountBook(settle) @@ -666,8 +666,8 @@ 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] + **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**| 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] ### Return type @@ -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 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 | ### Return type @@ -1076,7 +1076,7 @@ public class Example { String contract = "BTC_USDT_20200814"; // String | Futures contract Integer limit = 100; // Integer | Maximum number of records to be 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 | Specify the currency name to query in batches, and support up to 100 pass parameters at a time. Integer countTotal = 0; // Integer | Whether to return total number matched. Default to 0(no return) try { List result = apiInstance.listDeliveryOrders(settle, status) @@ -1109,7 +1109,7 @@ Name | Type | Description | Notes **contract** | **String**| Futures contract | [optional] **limit** | **Integer**| Maximum number of records to be 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**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time. | [optional] **countTotal** | **Integer**| Whether to return total number matched. Default to 0(no return) | [optional] [default to 0] [enum: 0, 1] ### Return type @@ -1450,7 +1450,7 @@ public class Example { 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 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 | Specify the currency name to query in batches, and support up to 100 pass parameters at a time. Integer countTotal = 0; // Integer | Whether to return total number matched. Default to 0(no return) try { List result = apiInstance.getMyDeliveryTrades(settle) @@ -1484,7 +1484,7 @@ Name | Type | Description | Notes **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] **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**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time. | [optional] **countTotal** | **Integer**| Whether to return total number matched. Default to 0(no return) | [optional] [default to 0] [enum: 0, 1] ### Return type diff --git a/docs/DeliveryContract.md b/docs/DeliveryContract.md index e61232d..0473943 100644 --- a/docs/DeliveryContract.md +++ b/docs/DeliveryContract.md @@ -35,7 +35,7 @@ Name | Type | Description | Notes **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] +**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] diff --git a/docs/EarnApi.md b/docs/EarnApi.md index dd785f1..93bbb72 100644 --- a/docs/EarnApi.md +++ b/docs/EarnApi.md @@ -12,7 +12,7 @@ Method | HTTP request | Description [**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 | 链上赚币币种 +[**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 @@ -384,8 +384,8 @@ 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 try { @@ -412,8 +412,8 @@ 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] @@ -462,8 +462,8 @@ 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 try { @@ -491,8 +491,8 @@ 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] @@ -585,7 +585,7 @@ null (empty response body) # **findCoin** > List<String> findCoin(findCoin) -链上赚币币种 +Staking Coins ### Example @@ -651,7 +651,7 @@ Name | Type | Description | Notes # **swapStakingCoin** -> swapStakingCoin(swapCoin) +> SwapCoinStruct swapStakingCoin(swapCoin) On-chain Token Swap for Earned Coins @@ -678,7 +678,8 @@ public class Example { EarnApi apiInstance = new EarnApi(defaultClient); SwapCoin swapCoin = new SwapCoin(); // SwapCoin | try { - apiInstance.swapStakingCoin(swapCoin); + 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(); @@ -700,7 +701,7 @@ Name | Type | Description | Notes ### Return type -null (empty response body) +[**SwapCoinStruct**](SwapCoinStruct.md) ### Authorization @@ -709,7 +710,7 @@ null (empty response body) ### HTTP request headers - **Content-Type**: application/json - - **Accept**: Not defined + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | diff --git a/docs/EarnUniApi.md b/docs/EarnUniApi.md index d18219a..964cfa0 100644 --- a/docs/EarnUniApi.md +++ b/docs/EarnUniApi.md @@ -223,7 +223,7 @@ Name | Type | Description | Notes 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. +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 determination, no interest will be earned 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 @@ -385,8 +385,8 @@ public class Example { 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 + 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 | type: lend - lend, redeem - redeem try { List result = apiInstance.listUniLendRecords() @@ -418,8 +418,8 @@ 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] + **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**| type: lend - lend, redeem - redeem | [optional] [enum: lend, redeem] ### Return type @@ -538,8 +538,8 @@ public class Example { 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 + 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) @@ -569,8 +569,8 @@ 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] + **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 @@ -664,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-07-02 10:50+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-15 06:10+0000 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 @@ -730,7 +730,7 @@ 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-07-02 10:50+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-15 06:10+0000 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** @@ -738,7 +738,7 @@ Name | Type | Description | Notes Currency estimate annualized interest rate -Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-02 10:50+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-15 06:10+0000 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 @@ -796,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-07-02 10:50+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-15 06:10+0000 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/FlashSwapOrderPreview.md b/docs/FlashSwapOrderPreview.md index bba0595..bf76ffe 100644 --- a/docs/FlashSwapOrderPreview.md +++ b/docs/FlashSwapOrderPreview.md @@ -8,9 +8,9 @@ Initiate a flash swap order preview 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/FuturesAccount.md b/docs/FuturesAccount.md index d2099e2..4ede5c7 100644 --- a/docs/FuturesAccount.md +++ b/docs/FuturesAccount.md @@ -29,5 +29,6 @@ Name | Type | Description | Notes **isolatedPositionMargin** | **String** | Ware -position margin, suitable for the new classic account margin model | [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..7b87091 100644 --- a/docs/FuturesAccountBook.md +++ b/docs/FuturesAccountBook.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **text** | **String** | Comment | [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 21f7052..4a6f999 100644 --- a/docs/FuturesApi.md +++ b/docs/FuturesApi.md @@ -47,6 +47,7 @@ Method | HTTP request | Description [**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 +[**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 | 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 @@ -220,7 +221,7 @@ public class Example { 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 + Boolean withId = false; // Boolean | Whether to return depth update ID. This ID increments by 1 each time. try { FuturesOrderBook result = apiInstance.listFuturesOrderBook(settle, contract) .interval(interval) @@ -249,7 +250,7 @@ Name | Type | Description | Notes **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] + **withId** | **Boolean**| Whether to return depth update ID. This ID increments by 1 each time. | [optional] [default to false] ### Return type @@ -267,7 +268,7 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order book retrieved | - | +**200** | Depth query successful | - | # **listFuturesTrades** @@ -379,7 +380,7 @@ 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 + 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 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 try { @@ -410,7 +411,7 @@ 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] + **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 | [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"] @@ -460,7 +461,7 @@ 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 + 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 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 try { @@ -491,7 +492,7 @@ 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] + **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 | [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"] @@ -607,8 +608,8 @@ public class Example { 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 + 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) @@ -636,8 +637,8 @@ 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] + **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 @@ -873,7 +874,7 @@ No authorization required 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. +The maximum time interval between `from` and `to` is **3600 seconds**. Certain private fields will **not be returned** in public endpoints; refer to individual field descriptions for details. ### Example @@ -894,8 +895,8 @@ 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 + 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 to be returned in a single list try { List result = apiInstance.listLiquidatedOrders(settle) @@ -924,8 +925,8 @@ 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] + **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 to be returned in a single list | [optional] [default to 100] ### Return type @@ -1096,7 +1097,7 @@ Name | Type | Description | Notes Query account book -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。 2023-10-30 can be filtered。 2023-10-30 can be filtered。 ### Example @@ -1123,8 +1124,8 @@ public class Example { 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 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 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 try { List result = apiInstance.listFuturesAccountBook(settle) @@ -1157,8 +1158,8 @@ Name | Type | Description | Notes **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] **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] **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] ### Return type @@ -1357,7 +1358,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 try { Position result = apiInstance.updatePositionMargin(settle, contract, change); System.out.println(result); @@ -1380,7 +1381,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 | ### Return type @@ -1622,7 +1623,7 @@ Name | Type | Description | Notes Enable or disable dual 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 ### Example @@ -1788,7 +1789,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 String dualSide = "dual_long"; // String | Long or short position try { List result = apiInstance.updateDualModePositionMargin(settle, contract, change, dualSide); @@ -1812,7 +1813,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 | **dualSide** | **String**| Long or short position | ### Return type @@ -2013,7 +2014,7 @@ public class Example { 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 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 | Specify the currency name to query in batches, and support up to 100 pass parameters at a time. try { List result = apiInstance.listFuturesOrders(settle, status) .contract(contract) @@ -2044,7 +2045,7 @@ Name | Type | Description | Notes **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] **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**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time. | [optional] ### Return type @@ -2170,7 +2171,7 @@ 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 ordersspecified. Set to bid to cancel all buy orders, set to ask to cancel all try { List result = apiInstance.cancelFuturesOrders(settle, contract, xGateExptime, side); System.out.println(result); @@ -2194,7 +2195,7 @@ 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 ordersspecified. Set to bid to cancel all buy orders, set to ask to cancel all | [optional] ### Return type @@ -2243,8 +2244,8 @@ 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 + 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 to be returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 try { @@ -2275,8 +2276,8 @@ 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] + **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 to be returned in a single list | [optional] [default to 100] **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] @@ -2705,8 +2706,8 @@ 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 + 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 to be returned in a single list Integer offset = 0; // Integer | List offset, starting from 0 String role = "maker"; // String | Query role, maker or taker. @@ -2739,8 +2740,8 @@ 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] + **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 to be 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] @@ -2794,8 +2795,8 @@ public class Example { 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 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 String side = "short"; // String | Query side. long or shot String pnl = "profit"; // String | Query profit or loss try { @@ -2830,8 +2831,8 @@ Name | Type | Description | Notes **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] **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] **side** | **String**| Query side. long or shot | [optional] **pnl** | **String**| Query profit or loss | [optional] @@ -3015,7 +3016,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 set a new countdown 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 @@ -3159,7 +3160,7 @@ Name | Type | Description | Notes 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. +Multiple different order IDs can be specified. A maximum of 20 records ### Example @@ -3233,7 +3234,7 @@ Name | Type | Description | Notes Batch modify orders with 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. A maximum of 10 orders can ### Example @@ -3301,6 +3302,74 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | Request is 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** | Successfully retrieved | - | + # **listPriceTriggeredOrders** > List<FuturesPriceTriggeredOrder> listPriceTriggeredOrders(settle, status).contract(contract).limit(limit).offset(offset).execute(); diff --git a/docs/FuturesLimitRiskTiers.md b/docs/FuturesLimitRiskTiers.md index 86dd259..3772c40 100644 --- a/docs/FuturesLimitRiskTiers.md +++ b/docs/FuturesLimitRiskTiers.md @@ -13,4 +13,5 @@ Name | Type | Description | Notes **maintenanceRate** | **String** | Maintenance margin rate | [optional] **leverageMax** | **String** | Maximum leverage | [optional] **contract** | **String** | Markets, visible only during market pagination requests | [optional] +**deduction** | **String** | Maintenance margin quick calculation deduction | [optional] diff --git a/docs/FuturesRiskLimitTier.md b/docs/FuturesRiskLimitTier.md new file mode 100644 index 0000000..6a8a60a --- /dev/null +++ b/docs/FuturesRiskLimitTier.md @@ -0,0 +1,16 @@ + +# FuturesRiskLimitTier + +Information for each tier of the risk limit ladder + +## 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 | [optional] + diff --git a/docs/MarginUniApi.md b/docs/MarginUniApi.md index 2594a68..913debc 100644 --- a/docs/MarginUniApi.md +++ b/docs/MarginUniApi.md @@ -467,8 +467,8 @@ public class Example { String currency = "BTC"; // String | Retrieve data of the specified currency 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 + 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) @@ -500,8 +500,8 @@ Name | Type | Description | Notes **currency** | **String**| Retrieve data of the specified 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 | [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 diff --git a/docs/MultiCollateralLoanApi.md b/docs/MultiCollateralLoanApi.md index bc7ee1e..88527e5 100644 --- a/docs/MultiCollateralLoanApi.md +++ b/docs/MultiCollateralLoanApi.md @@ -47,8 +47,8 @@ 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 + String sort = "ltv_asc"; // String | Query the current interest rate of the currency in the previous hour + 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) @@ -76,8 +76,8 @@ 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] + **sort** | **String**| Query the current interest rate of the currency in the previous hour | [optional] + **orderType** | **String**| Order type: current - Query current orders, fixed - Query fixed orders, defaults to current orders if not specified | [optional] ### Return type @@ -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 + String currency = "BTC"; // String | When it is a collateral currency, multiple currencies can be passed separated by commas;when it is a borrowing currency, only one currenc 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** | **String**| When it is a collateral currency, multiple currencies can be passed separated by commas;when it is a borrowing currency, only one currenc | ### Return type @@ -793,7 +793,7 @@ No authorization required 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. +Query the current interest rate of the currency in the previous hour. ### Example @@ -812,7 +812,7 @@ 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. + List currencies = Arrays.asList(); // List | Specify currency name query array, separated by commas, maximum 100items. String vipLevel = "\"0\""; // String | VIP level, defaults to 0 if not transferred try { List result = apiInstance.getMultiCollateralCurrentRate(currencies) @@ -836,7 +836,7 @@ 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. | + **currencies** | [**List<String>**](String.md)| Specify currency name query array, separated by commas, maximum 100items. | **vipLevel** | **String**| VIP level, defaults to 0 if not transferred | [optional] [default to "0"] ### Return type diff --git a/docs/OptionsApi.md b/docs/OptionsApi.md index 4ad94e4..7666997 100644 --- a/docs/OptionsApi.md +++ b/docs/OptionsApi.md @@ -316,8 +316,8 @@ public class Example { 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 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) @@ -346,8 +346,8 @@ 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] **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 @@ -466,8 +466,8 @@ public class Example { 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 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) @@ -498,8 +498,8 @@ Name | Type | Description | Notes **contract** | **String**| Options contract name | [optional] **limit** | **Integer**| Maximum number of records to be 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 @@ -547,7 +547,7 @@ public class Example { 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 + Boolean withId = false; // Boolean | Whether to return depth update ID. This ID increments by 1 each time. try { FuturesOrderBook result = apiInstance.listOptionsOrderBook(contract) .interval(interval) @@ -575,7 +575,7 @@ 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] + **withId** | **Boolean**| Whether to return depth update ID. This ID increments by 1 each time. | [optional] [default to false] ### Return type @@ -593,7 +593,7 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order book retrieved | - | +**200** | Depth query successful | - | # **listOptionsTickers** @@ -748,8 +748,8 @@ 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 + 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 | Interval time between data points try { List result = apiInstance.listOptionsCandlesticks(contract) @@ -778,8 +778,8 @@ 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] + **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**| Interval time between data points | [optional] [default to 5m] [enum: 1m, 5m, 15m, 30m, 1h] ### Return type @@ -825,8 +825,8 @@ 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 + 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 | Interval time between data points try { List result = apiInstance.listOptionsUnderlyingCandlesticks(underlying) @@ -855,8 +855,8 @@ 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] + **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**| Interval time between data points | [optional] [default to 5m] [enum: 1m, 5m, 15m, 30m, 1h] ### Return type @@ -904,8 +904,8 @@ public class Example { 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 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) @@ -937,8 +937,8 @@ Name | Type | Description | Notes **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] **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 @@ -1051,8 +1051,8 @@ public class Example { OptionsApi apiInstance = new OptionsApi(defaultClient); Integer limit = 100; // Integer | Maximum number of records to be 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 String type = "dnw"; // String | Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - set: settlement PNL try { List result = apiInstance.listOptionsAccountBook() @@ -1082,8 +1082,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **Integer**| Maximum number of records to be 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] **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] ### Return type @@ -1346,8 +1346,8 @@ public class Example { String underlying = "BTC_USDT"; // String | Underlying Integer limit = 100; // Integer | Maximum number of records to be 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) @@ -1380,8 +1380,8 @@ Name | Type | Description | Notes **underlying** | **String**| Underlying | [optional] **limit** | **Integer**| Maximum number of records to be 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 @@ -1778,8 +1778,8 @@ public class Example { 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 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) @@ -1810,8 +1810,8 @@ Name | Type | Description | Notes **contract** | **String**| Options contract name | [optional] **limit** | **Integer**| Maximum number of records to be 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 diff --git a/docs/Order.md b/docs/Order.md index b23d699..5e94950 100644 --- a/docs/Order.md +++ b/docs/Order.md @@ -16,9 +16,9 @@ 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 | +**side** | [**SideEnum**](#SideEnum) | Buy or sell order | **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] **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] diff --git a/docs/OrderCancel.md b/docs/OrderCancel.md index 0f53c85..3b56848 100644 --- a/docs/OrderCancel.md +++ b/docs/OrderCancel.md @@ -19,9 +19,9 @@ 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 | +**side** | [**SideEnum**](#SideEnum) | Buy or sell order | **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] **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] diff --git a/docs/OrderPatch.md b/docs/OrderPatch.md index 68d10c6..5fca380 100644 --- a/docs/OrderPatch.md +++ b/docs/OrderPatch.md @@ -9,8 +9,8 @@ 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] +**amount** | **String** | Trading Quantity. Either amountor pricemust be specified | [optional] +**price** | **String** | Trading Price. Either amountor pricemust be specified | [optional] **amendText** | **String** | Custom info during amending order | [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/Position.md b/docs/Position.md index e39a338..166fab9 100644 --- a/docs/Position.md +++ b/docs/Position.md @@ -38,6 +38,8 @@ Name | Type | Description | Notes **updateTime** | **Long** | Last update time | [optional] [readonly] **updateId** | **Long** | Update id. Each time the position is updated, the value will be +1. | [optional] [readonly] **openTime** | **Long** | First Open Time | [optional] +**riskLimitTable** | **String** | Risk limit table ID | [optional] [readonly] +**averageMaintenanceRate** | **String** | Average maintenance margin rate | [optional] [readonly] ## Enum: ModeEnum diff --git a/docs/SpotApi.md b/docs/SpotApi.md index ffa4d8b..78517c5 100644 --- a/docs/SpotApi.md +++ b/docs/SpotApi.md @@ -365,7 +365,7 @@ No authorization required Retrieve order book -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 reversed are reversed ### Example @@ -462,7 +462,7 @@ 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 + String lastId = "12345"; // String | Specify the currency name to query in batches, and support up to 100 pass parameters at a time. 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 @@ -496,7 +496,7 @@ 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] + **lastId** | **String**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time. | [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] @@ -548,7 +548,7 @@ public class Example { 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. 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 + 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 String interval = "30m"; // String | Interval time between data points. Note that `30d` means 1 natual month, not 30 days try { List> result = apiInstance.listCandlesticks(currencyPair) @@ -578,7 +578,7 @@ 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] **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] + **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 | [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] ### Return type @@ -1313,7 +1313,7 @@ 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 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 { @@ -1338,7 +1338,7 @@ 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] + **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] @@ -1590,7 +1590,7 @@ Name | Type | Description | Notes 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, it supports modifying the price or quantity (choose one of two), and also supports modifying the price and quantity at the same time 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 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 operation. ### Example @@ -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 pending orders will be 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 @@ -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 diff --git a/docs/SpotPricePutOrder.md b/docs/SpotPricePutOrder.md index 62281ee..f3aee62 100644 --- a/docs/SpotPricePutOrder.md +++ b/docs/SpotPricePutOrder.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **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 | +**account** | [**AccountEnum**](#AccountEnum) | Trading account type. Portfolio margin account must set to `unified` -normal: spot trading - margin: margin trading - unified: unified trading | **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] diff --git a/docs/SpotPriceTrigger.md b/docs/SpotPriceTrigger.md index 2da8bfc..05dc2d4 100644 --- a/docs/SpotPriceTrigger.md +++ b/docs/SpotPriceTrigger.md @@ -6,7 +6,7 @@ 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 | +**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. | ## Enum: RuleEnum diff --git a/docs/SubAccountToSubAccount.md b/docs/SubAccountToSubAccount.md index 7c57b16..60cd8a2 100644 --- a/docs/SubAccountToSubAccount.md +++ b/docs/SubAccountToSubAccount.md @@ -10,6 +10,6 @@ Name | Type | Description | Notes **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. | **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** | Transferred 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 869042b..5000627 100644 --- a/docs/SubAccountTransfer.md +++ b/docs/SubAccountTransfer.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **subAccount** | **String** | Sub account user ID | -**subAccountType** | **String** | 操作的子账号交易账户， spot - 现货账户， futures - 永续合约账户， delivery - 交割合约账户, options - 期权账户 | [optional] +**subAccountType** | **String** | Target sub user's account. `spot` - spot account, `futures` - perpetual contract account, `delivery` - delivery 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 | diff --git a/docs/SubAccountTransferRecordItem.md b/docs/SubAccountTransferRecordItem.md index c42be4b..acce1ac 100644 --- a/docs/SubAccountTransferRecordItem.md +++ b/docs/SubAccountTransferRecordItem.md @@ -8,7 +8,7 @@ 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** | 操作的子账号交易账户， spot - 现货账户， futures - 永续合约账户， delivery - 交割合约账户, options - 期权账户 | [optional] +**subAccountType** | **String** | Target sub user's account. `spot` - spot account, `futures` - perpetual contract account, `delivery` - delivery 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 | diff --git a/docs/SwapCoinStruct.md b/docs/SwapCoinStruct.md new file mode 100644 index 0000000..e082449 --- /dev/null +++ b/docs/SwapCoinStruct.md @@ -0,0 +1,17 @@ + +# SwapCoinStruct + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **Integer** | Order ID | [optional] +**uid** | **Integer** | User ID | [optional] +**coin** | **String** | Currency | [optional] +**type** | **Integer** | Type: 0-Lock, 1-Certificate | [optional] +**amount** | **String** | Amount | [optional] +**exchangeRate** | **String** | Exchange Ratio | [optional] +**pid** | **Integer** | Plan ID | [optional] +**status** | **Integer** | status 1-success | [optional] +**createStamp** | **Integer** | Transaction timestamp | [optional] + diff --git a/docs/Trade.md b/docs/Trade.md index b421b47..5f0cc49 100644 --- a/docs/Trade.md +++ b/docs/Trade.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **createTime** | **String** | Trading time | [optional] **createTimeMs** | **String** | Trading time, with millisecond precision | [optional] **currencyPair** | **String** | Currency pair | [optional] -**side** | [**SideEnum**](#SideEnum) | Order side | [optional] +**side** | [**SideEnum**](#SideEnum) | Buy or sell order | [optional] **role** | [**RoleEnum**](#RoleEnum) | Trade role. No value in public endpoints | [optional] **amount** | **String** | Trade amount | [optional] **price** | **String** | Order price | [optional] diff --git a/docs/UniCurrencyInterest.md b/docs/UniCurrencyInterest.md index 5693395..d4f86c5 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 Interest reinvestment | [optional] [readonly] diff --git a/docs/UniInterestRecord.md b/docs/UniInterestRecord.md index 77d22bf..90703a1 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 Interest reinvestment | [optional] [readonly] **createTime** | **Long** | Created time | [optional] [readonly] diff --git a/docs/UniLend.md b/docs/UniLend.md index 51970dd..0f31ef0 100644 --- a/docs/UniLend.md +++ b/docs/UniLend.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes **lentAmount** | **String** | Lent amount | [optional] [readonly] **frozenAmount** | **String** | Frozen amount | [optional] [readonly] **minRate** | **String** | Minimum interest rate | [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 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] diff --git a/docs/UnifiedAccount.md b/docs/UnifiedAccount.md index a77dbee..bbc35b5 100644 --- a/docs/UnifiedAccount.md +++ b/docs/UnifiedAccount.md @@ -24,5 +24,5 @@ Name | Type | Description | Notes **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] -**isAllCollateral** | **Boolean** | 是否所有币种均作为保证金，true - 所有币种作为保证金，false - 否 | [optional] +**isAllCollateral** | **Boolean** | Whether all currencies are used as margin, true - All currencies are used as margin, false - No | [optional] diff --git a/docs/UnifiedApi.md b/docs/UnifiedApi.md index 52e97e1..4b862b6 100644 --- a/docs/UnifiedApi.md +++ b/docs/UnifiedApi.md @@ -25,7 +25,7 @@ Method | HTTP request | Description [**setUserLeverageCurrencySetting**](UnifiedApi.md#setUserLeverageCurrencySetting) | **POST** /unified/leverage/user_currency_setting | Set the 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 -[**setUnifiedCollateral**](UnifiedApi.md#setUnifiedCollateral) | **POST** /unified/collateral_currencies | 设置抵押币种 +[**setUnifiedCollateral**](UnifiedApi.md#setUnifiedCollateral) | **POST** /unified/collateral_currencies | Set Collateral Currency @@ -826,7 +826,7 @@ This endpoint does not need any parameter. Set mode of the unified account -每种账户模式的切换只需要传对应账户模式的参数，同时支持在切换账户模式时打开或关闭对应账户模式下的配置开关 - 开通经典账户模式时，mode=classic ``` PUT /unified/unified_mode { \"mode\": \"classic\" } ``` - 开通跨币种保证金模式，mode=multi_currency ``` PUT /unified/unified_mode { \"mode\": \"multi_currency\", \"settings\": { \"usdt_futures\": true } } ``` - 开通组合保证金模式时，mode=portfolio ``` PUT /unified/unified_mode { \"mode\": \"portfolio\", \"settings\": { \"spot_hedge\": true } } ``` - 开通单币种保证金模式时，mode=single_currency ``` PUT /unified/unified_mode { \"mode\": \"single_currency\" } ``` +Each account mode switch only requires passing the corresponding account mode parameter, and also supports turning on or off the configuration switches under the corresponding account mode during the switch. - When enabling the classic account mode, mode=classic ``` PUT /unified/unified_mode { \"mode\": \"classic\" } ``` - When enabling the cross-currency margin mode, mode=multi_currency ``` PUT /unified/unified_mode { \"mode\": \"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 @@ -1496,7 +1496,7 @@ No authorization required # **setUnifiedCollateral** > UnifiedCollateralRes setUnifiedCollateral(unifiedCollateralReq) -设置抵押币种 +Set Collateral Currency ### Example @@ -1558,5 +1558,5 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | 更新成功 | - | +**200** | UpdateSuccess | - | diff --git a/docs/UnifiedBalance.md b/docs/UnifiedBalance.md index b47aba2..0ff634a 100644 --- a/docs/UnifiedBalance.md +++ b/docs/UnifiedBalance.md @@ -24,5 +24,5 @@ Name | Type | Description | Notes **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] -**enabledCollateral** | **Boolean** | 币种开启作为保证金，true - 启用，false - 未启用 | [optional] +**enabledCollateral** | **Boolean** | Currency enabled as margin: true - Enabled, false - Disabled | [optional] diff --git a/docs/UnifiedCollateralReq.md b/docs/UnifiedCollateralReq.md index 1252a81..74b0d6e 100644 --- a/docs/UnifiedCollateralReq.md +++ b/docs/UnifiedCollateralReq.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**collateralType** | [**CollateralTypeEnum**](#CollateralTypeEnum) | 用户设置抵押物模式 0(all)-全部币种作为抵押物,1(custom)-自定义币种作为抵押物,collateral_type为0(all)时，enable_list与disable_list参数无效 | [optional] -**enableList** | **List<String>** | 币种列表，collateral_type=1(custom)表示追加的逻辑 | [optional] -**disableList** | **List<String>** | 取消列表，表示取消的逻辑 | [optional] +**collateralType** | [**CollateralTypeEnum**](#CollateralTypeEnum) | User-set collateral mode0(all)-All currencies used as collateral, 1(custom)-Custom currencies used as collateral; when collateral_type is 0(all), the enable_list and disable_list parameters are invalid | [optional] +**enableList** | **List<String>** | Currency list, where collateral_type=1(custom) indicates the logic of addition | [optional] +**disableList** | **List<String>** | Cancellation list, indicating the logic of cancellation | [optional] ## Enum: CollateralTypeEnum diff --git a/docs/UnifiedCollateralRes.md b/docs/UnifiedCollateralRes.md index e36c9d1..5254657 100644 --- a/docs/UnifiedCollateralRes.md +++ b/docs/UnifiedCollateralRes.md @@ -1,11 +1,11 @@ # UnifiedCollateralRes -统一账户抵押模式设置返回 +Return of unified account collateral mode settings ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**isSuccess** | **Boolean** | 是否设置成功 | [optional] +**isSuccess** | **Boolean** | Whether the setting was successful | [optional] diff --git a/docs/UnifiedLoanRecord.md b/docs/UnifiedLoanRecord.md index 712c062..384ee70 100644 --- a/docs/UnifiedLoanRecord.md +++ b/docs/UnifiedLoanRecord.md @@ -7,7 +7,7 @@ Loan records Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Long** | id | [optional] [readonly] +**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] diff --git a/docs/WalletApi.md b/docs/WalletApi.md index 0182015..bf90110 100644 --- a/docs/WalletApi.md +++ b/docs/WalletApi.md @@ -412,7 +412,7 @@ Name | Type | Description | Notes 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 +Record time range cannot exceed 30 days > Note: only records after 20-04-10can be retrieved ### Example diff --git a/docs/WithdrawalRecord.md b/docs/WithdrawalRecord.md index 54c9f53..db7a2a9 100644 --- a/docs/WithdrawalRecord.md +++ b/docs/WithdrawalRecord.md @@ -7,7 +7,7 @@ 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 | diff --git a/pom.xml b/pom.xml index e0fe6f7..03fbc9e 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ gate-api jar gate-api - 6.100.2 + 6.102.0 https://github.com/gateio/gateapi-java.git Java client for gateapi @@ -27,7 +27,7 @@ Gate support@mail.gate.com Gate - https://www.gate.io + https://www.gate.com diff --git a/src/main/java/io/gate/gateapi/ApiCallback.java b/src/main/java/io/gate/gateapi/ApiCallback.java index 4953a2c..ef483bf 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 0edaca8..aba0da8 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.100.2/java"); + setUserAgent("OpenAPI-Generator/6.102.0/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 86ac20b..e93f79b 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 e3cbfa9..b9a5356 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 db95190..fe9166e 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 59f0a3e..4ebfb51 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 a16cdcd..0fdcebb 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 b9f5633..d0fb65f 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 f3bcfae..b3db2b8 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 22a92c7..015d21e 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 5d828da..b0d2a64 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 8e8aa4c..d58c1d9 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 @@ -552,7 +552,7 @@ 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 + * Only the main account that created this STP group can query the account * @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 @@ -569,7 +569,7 @@ 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 + * Only the main account that created this STP group can query the account * @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 @@ -587,7 +587,7 @@ 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 + * Only the main account that created this STP group can query the account * @param stpId STP Group ID (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 97106bb..726261a 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 @@ -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 The parameter loan_currency is used to specify the borrowing currency. If loan_currency is not provided, the API will return all supported borrowing currencies. (optional) * @return APIlistCollateralCurrenciesRequest */ public APIlistCollateralCurrenciesRequest loanCurrency(String loanCurrency) { diff --git a/src/main/java/io/gate/gateapi/api/DeliveryApi.java b/src/main/java/io/gate/gateapi/api/DeliveryApi.java index 9e38f40..6ce0d04 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 @@ -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. (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 { @@ -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) { @@ -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 以上个列表的最后一条记录的 ID 作为下个列表的起点。 该字段不再继续支持，新的请求请使用 `from` 和 `to` 字段来限定时间范围 (optional) * @return APIlistDeliveryTradesRequest */ public APIlistDeliveryTradesRequest lastId(String lastId) { @@ -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 (optional) * @return APIlistDeliveryCandlesticksRequest */ public APIlistDeliveryCandlesticksRequest to(Long to) { @@ -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 timeweek (optional, default to 5m) * @return APIlistDeliveryCandlesticksRequest */ public APIlistDeliveryCandlesticksRequest interval(String interval) { @@ -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) { @@ -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 (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 (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 (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 (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 @@ -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 Specify the currency name to query in batches, and support up to 100 pass parameters at a time. (optional) * @return APIlistDeliveryOrdersRequest */ public APIlistDeliveryOrdersRequest lastId(String lastId) { @@ -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 Specify the currency name to query in batches, and support up to 100 pass parameters at a time. (optional) * @return APIgetMyDeliveryTradesRequest */ public APIgetMyDeliveryTradesRequest lastId(String lastId) { diff --git a/src/main/java/io/gate/gateapi/api/EarnApi.java b/src/main/java/io/gate/gateapi/api/EarnApi.java index d88f0ef..fb20471 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 @@ -30,6 +30,7 @@ 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; @@ -773,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) { @@ -864,7 +865,7 @@ public okhttp3.Call executeAsync(final ApiCallback @@ -952,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) { @@ -962,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) { @@ -1220,7 +1221,7 @@ private okhttp3.Call findCoinValidateBeforeCall(FindCoin findCoin, final ApiCall } /** - * 链上赚币币种 + * Staking Coins * * @param findCoin (required) * @return List<String> @@ -1237,7 +1238,7 @@ public List findCoin(FindCoin findCoin) throws ApiException { } /** - * 链上赚币币种 + * Staking Coins * * @param findCoin (required) * @return ApiResponse<List<String>> @@ -1255,7 +1256,7 @@ public ApiResponse> findCoinWithHttpInfo(FindCoin findCoin) throws } /** - * 链上赚币币种 (asynchronously) + * Staking Coins (asynchronously) * * @param findCoin (required) * @param _callback The callback to be executed when the API call finishes @@ -1298,7 +1299,7 @@ public okhttp3.Call swapStakingCoinCall(SwapCoin swapCoin, final ApiCallback _ca Map localVarCookieParams = new HashMap(); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - + "application/json" }; final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) { @@ -1330,6 +1331,7 @@ private okhttp3.Call swapStakingCoinValidateBeforeCall(SwapCoin swapCoin, final * 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 @@ -1337,15 +1339,16 @@ private okhttp3.Call swapStakingCoinValidateBeforeCall(SwapCoin swapCoin, final
200 swap success -
*/ - public void swapStakingCoin(SwapCoin swapCoin) throws ApiException { - swapStakingCoinWithHttpInfo(swapCoin); + 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<Void> + * @return ApiResponse<SwapCoinStruct> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1353,9 +1356,10 @@ public void swapStakingCoin(SwapCoin swapCoin) throws ApiException {
200 swap success -
*/ - public ApiResponse swapStakingCoinWithHttpInfo(SwapCoin swapCoin) throws ApiException { + public ApiResponse swapStakingCoinWithHttpInfo(SwapCoin swapCoin) throws ApiException { okhttp3.Call localVarCall = swapStakingCoinValidateBeforeCall(swapCoin, null); - return localVarApiClient.execute(localVarCall); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); } /** @@ -1371,9 +1375,10 @@ public ApiResponse swapStakingCoinWithHttpInfo(SwapCoin swapCoin) throws A 200 swap success - */ - public okhttp3.Call swapStakingCoinAsync(SwapCoin swapCoin, final ApiCallback _callback) throws ApiException { + public okhttp3.Call swapStakingCoinAsync(SwapCoin swapCoin, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = swapStakingCoinValidateBeforeCall(swapCoin, _callback); - localVarApiClient.executeAsync(localVarCall, _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 ce75cc6..c158c77 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 @@ -489,7 +489,7 @@ 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. + * 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 determination, no interest will be earned 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 @@ -504,7 +504,7 @@ 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. + * 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 determination, no interest will be earned 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 @@ -521,7 +521,7 @@ 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. + * 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 determination, no interest will be earned 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 @@ -757,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) { @@ -767,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) { @@ -1078,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) { @@ -1088,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) { @@ -1289,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-07-02 10:50+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-15 06:10+0000 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 { @@ -1356,7 +1356,7 @@ 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-07-02 10:50+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-15 06:10+0000 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, unit s, maximum span of 30 days (required) * @param to End timestamp, unit s, maximum span of 30 days (required) * @param asset Currency name (required) @@ -1365,7 +1365,7 @@ private okhttp3.Call listUniChartValidateBeforeCall(Long from, Long to, String a * @http.response.details - +
Status Code Description Response Headers
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-02 10:50+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-15 06:10+0000 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 { @@ -1375,7 +1375,7 @@ 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-07-02 10:50+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-15 06:10+0000 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, unit s, maximum span of 30 days (required) * @param to End timestamp, unit s, maximum span of 30 days (required) * @param asset Currency name (required) @@ -1384,7 +1384,7 @@ public List listUniChart(Long from, Long to, String asset) th * @http.response.details - +
Status Code Description Response Headers
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-02 10:50+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-15 06:10+0000 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 { @@ -1395,7 +1395,7 @@ 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-07-02 10:50+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-15 06:10+0000 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, unit s, maximum span of 30 days (required) * @param to End timestamp, unit s, maximum span of 30 days (required) * @param asset Currency name (required) @@ -1405,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-07-02 10:50+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-15 06:10+0000 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 { @@ -1423,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-07-02 10:50+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-15 06:10+0000 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 { @@ -1463,13 +1463,13 @@ 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-07-02 10:50+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-15 06:10+0000 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-07-02 10:50+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-15 06:10+0000 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 { @@ -1479,13 +1479,13 @@ 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-07-02 10:50+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-15 06:10+0000 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-07-02 10:50+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-15 06:10+0000 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 { @@ -1496,14 +1496,14 @@ 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-07-02 10:50+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-15 06:10+0000 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-07-02 10:50+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-15 06:10+0000 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 7b5363e..14e4473 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 diff --git a/src/main/java/io/gate/gateapi/api/FuturesApi.java b/src/main/java/io/gate/gateapi/api/FuturesApi.java index f4a5b31..2771b5a 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 @@ -42,6 +42,7 @@ 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.InsuranceRecord; @@ -472,7 +473,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. (optional, default to false) * @return APIlistFuturesOrderBookRequest */ public APIlistFuturesOrderBookRequest withId(Boolean withId) { @@ -488,7 +489,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 +503,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 +518,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 +533,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 { @@ -549,7 +550,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) { @@ -885,7 +886,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 (optional) * @return APIlistFuturesCandlesticksRequest */ public APIlistFuturesCandlesticksRequest to(Long to) { @@ -1094,7 +1095,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 (optional) * @return APIlistFuturesPremiumIndexRequest */ public APIlistFuturesPremiumIndexRequest to(Long to) { @@ -1450,7 +1451,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 +1461,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) { @@ -2102,7 +2103,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 +2113,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) { @@ -2192,7 +2193,7 @@ 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. + * The maximum time interval between `from` and `to` is **3600 seconds**. Certain private fields will **not be returned** in public endpoints; refer to individual field descriptions for details. * @param settle Settle currency (required) * @return APIlistLiquidatedOrdersRequest * @http.response.details @@ -2619,7 +2620,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 +2630,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) { @@ -2709,7 +2710,7 @@ 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. + * If the contract field is passed, only records containing this field after 2023-10-30 can be filtered。 2023-10-30 can be filtered。 2023-10-30 can be filtered。 * @param settle Settle currency (required) * @return APIlistFuturesAccountBookRequest * @http.response.details @@ -3054,7 +3055,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 (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -3125,7 +3126,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 (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 +3145,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 (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 +3165,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 (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 @@ -3633,7 +3634,7 @@ 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 + * The prerequisite for changing mode is that all positions have no holdings * @param settle Settle currency (required) * @param dualMode Whether to enable dual mode (required) * @return FuturesAccount @@ -3651,7 +3652,7 @@ 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 + * The prerequisite for changing mode is that all positions have no holdings * @param settle Settle currency (required) * @param dualMode Whether to enable dual mode (required) * @return ApiResponse<FuturesAccount> @@ -3670,7 +3671,7 @@ 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 + * The prerequisite for changing mode is that all positions have no holdings * @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 @@ -3839,7 +3840,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 (required) * @param dualSide Long or short position (required) * @param _callback Callback for upload/download progress * @return Call to execute @@ -3920,7 +3921,7 @@ 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 (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 @@ -3940,7 +3941,7 @@ 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 (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 @@ -3961,7 +3962,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 (required) * @param dualSide Long or short position (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -4374,7 +4375,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 Specify the currency name to query in batches, and support up to 100 pass parameters at a time. (optional) * @return APIlistFuturesOrdersRequest */ public APIlistFuturesOrdersRequest lastId(String lastId) { @@ -4588,7 +4589,7 @@ 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 ordersspecified. Set to bid to cancel all buy orders, set to ask to cancel all (optional) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -4662,7 +4663,7 @@ private okhttp3.Call cancelFuturesOrdersValidateBeforeCall(String settle, String * @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 ordersspecified. Set to bid to cancel all buy orders, set to ask to cancel all (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 @@ -4682,7 +4683,7 @@ public List cancelFuturesOrders(String settle, String contract, St * @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 ordersspecified. Set to bid to cancel all buy orders, set to ask to cancel all (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 @@ -4703,7 +4704,7 @@ public ApiResponse> cancelFuturesOrdersWithHttpInfo(String se * @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 ordersspecified. Set to bid to cancel all buy orders, set to ask to cancel all (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 @@ -4819,7 +4820,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 +4830,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) { @@ -5752,7 +5753,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 +5763,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) { @@ -6004,7 +6005,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 +6015,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) { @@ -6542,7 +6543,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 set a new countdown 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 @@ -6560,7 +6561,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 set a new countdown 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> @@ -6579,7 +6580,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 set a new countdown 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 @@ -6816,7 +6817,7 @@ 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. + * Multiple different order IDs can be specified. A maximum of 20 records * @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) @@ -6835,7 +6836,7 @@ 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. + * Multiple different order IDs can be specified. A maximum of 20 records * @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) @@ -6855,7 +6856,7 @@ 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. + * Multiple different order IDs can be specified. A maximum of 20 records * @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) @@ -6941,7 +6942,7 @@ 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. + * Multiple different order IDs can be specified. A maximum of 10 orders can * @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) @@ -6960,7 +6961,7 @@ public List amendBatchFutureOrders(String settle, List> 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. + * Multiple different order IDs can be specified. A maximum of 10 orders can * @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) @@ -7000,6 +7001,127 @@ public okhttp3.Call amendBatchFutureOrdersAsync(String settle, List + Status Code Description Response Headers + 200 Successfully retrieved - + + */ + 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 Successfully retrieved -
+ */ + 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 Successfully retrieved -
+ */ + 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 Successfully retrieved -
+ */ + 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; diff --git a/src/main/java/io/gate/gateapi/api/MarginApi.java b/src/main/java/io/gate/gateapi/api/MarginApi.java index 0ee8d51..3f6a795 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 diff --git a/src/main/java/io/gate/gateapi/api/MarginUniApi.java b/src/main/java/io/gate/gateapi/api/MarginUniApi.java index 9b36535..bda12f4 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 @@ -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) { diff --git a/src/main/java/io/gate/gateapi/api/MultiCollateralLoanApi.java b/src/main/java/io/gate/gateapi/api/MultiCollateralLoanApi.java index 72b6fc0..941eea6 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 @@ -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 Query the current interest rate of the currency in the previous hour (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) { @@ -1097,8 +1097,8 @@ 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 (required) + * @param currency When it is a collateral currency, multiple currencies can be passed separated by commas;when it is a borrowing currency, only one currenc (required) * @param _callback Callback for upload/download progress * @return Call to execute * @throws ApiException If fail to serialize the request body object @@ -1164,8 +1164,8 @@ private okhttp3.Call listUserCurrencyQuotaValidateBeforeCall(String type, String /** * List User Currency Quota * - * @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 (required) + * @param currency When it is a collateral currency, multiple currencies can be passed separated by commas;when it is a borrowing currency, only one currenc (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 @@ -1182,8 +1182,8 @@ public List listUserCurrencyQuota(String type, String currency) t /** * List User Currency Quota * - * @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 (required) + * @param currency When it is a collateral currency, multiple currencies can be passed separated by commas;when it is a borrowing currency, only one currenc (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 @@ -1201,8 +1201,8 @@ public ApiResponse> listUserCurrencyQuotaWithHttpInfo(String /** * List User Currency Quota (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 (required) + * @param currency When it is a collateral currency, multiple currencies can be passed separated by commas;when it is a borrowing currency, only one currenc (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 @@ -1655,8 +1655,8 @@ 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 the current interest rate of the currency in the previous hour. + * @param currencies Specify currency name query array, separated by commas, maximum 100items. (required) * @return APIgetMultiCollateralCurrentRateRequest * @http.response.details diff --git a/src/main/java/io/gate/gateapi/api/OptionsApi.java b/src/main/java/io/gate/gateapi/api/OptionsApi.java index 6a67e6e..8609883 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 @@ -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) { @@ -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) { @@ -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. (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 { @@ -1265,7 +1265,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 APIlistOptionsOrderBookRequest listOptionsOrderBook(String contract) { @@ -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) { @@ -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) { @@ -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) { @@ -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) { @@ -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) { @@ -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) { diff --git a/src/main/java/io/gate/gateapi/api/RebateApi.java b/src/main/java/io/gate/gateapi/api/RebateApi.java index f42cdbf..e4b826a 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 diff --git a/src/main/java/io/gate/gateapi/api/SpotApi.java b/src/main/java/io/gate/gateapi/api/SpotApi.java index 36ac7e9..ff1d2f2 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 @@ -811,7 +811,7 @@ 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 + * Market depth buy orders are sorted by price from high to low, sell orders are reversed are reversed * @param currencyPair Currency pair (required) * @return APIlistOrderBookRequest * @http.response.details @@ -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 Specify the currency name to query in batches, and support up to 100 pass parameters at a time. (optional) * @return APIlistTradesRequest */ public APIlistTradesRequest lastId(String lastId) { @@ -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 (optional) * @return APIlistCandlesticksRequest */ public APIlistCandlesticksRequest to(Long to) { @@ -2651,7 +2651,7 @@ 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 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 @@ -2723,7 +2723,7 @@ private okhttp3.Call cancelOrdersValidateBeforeCall(String currencyPair, String * 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 * @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 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> @@ -2744,7 +2744,7 @@ public List cancelOrders(String currencyPair, String side, String a * 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 * @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 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>> @@ -2766,7 +2766,7 @@ public ApiResponse> cancelOrdersWithHttpInfo(String currencyPa * 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 * @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 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 @@ -3250,7 +3250,7 @@ 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, it supports modifying the price or quantity (choose one of two), and also supports modifying the price and quantity at the same time 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 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 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) @@ -3271,7 +3271,7 @@ 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, it supports modifying the price or quantity (choose one of two), and also supports modifying the price and quantity at the same time 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 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 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) @@ -3293,7 +3293,7 @@ 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, it supports modifying the price or quantity (choose one of two), and also supports modifying the price and quantity at the same time 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 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 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) @@ -3700,7 +3700,7 @@ 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 pending orders will be 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 @@ -3717,7 +3717,7 @@ 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 pending orders will be 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 @@ -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 pending orders will be 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 @@ -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 setUnifiedModeWithHttpInfo(UnifiedModeSet unifiedModeSe /** * Set mode of the unified account (asynchronously) - * 每种账户模式的切换只需要传对应账户模式的参数，同时支持在切换账户模式时打开或关闭对应账户模式下的配置开关 - 开通经典账户模式时，mode=classic ``` PUT /unified/unified_mode { \"mode\": \"classic\" } ``` - 开通跨币种保证金模式，mode=multi_currency ``` PUT /unified/unified_mode { \"mode\": \"multi_currency\", \"settings\": { \"usdt_futures\": true } } ``` - 开通组合保证金模式时，mode=portfolio ``` PUT /unified/unified_mode { \"mode\": \"portfolio\", \"settings\": { \"spot_hedge\": true } } ``` - 开通单币种保证金模式时，mode=single_currency ``` PUT /unified/unified_mode { \"mode\": \"single_currency\" } ``` + * Each account mode switch only requires passing the corresponding account mode parameter, and also supports turning on or off the configuration switches under the corresponding account mode during the switch. - When enabling the classic account mode, mode=classic ``` PUT /unified/unified_mode { \"mode\": \"classic\" } ``` - When enabling the cross-currency margin mode, mode=multi_currency ``` PUT /unified/unified_mode { \"mode\": \"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 @@ -2778,7 +2778,7 @@ public APIgetHistoryLoanRateRequest getHistoryLoanRate(String currency) { * @http.response.details - +
Status Code Description Response Headers
200 更新成功 -
200 UpdateSuccess -
*/ public okhttp3.Call setUnifiedCollateralCall(UnifiedCollateralReq unifiedCollateralReq, final ApiCallback _callback) throws ApiException { @@ -2822,7 +2822,7 @@ private okhttp3.Call setUnifiedCollateralValidateBeforeCall(UnifiedCollateralReq } /** - * 设置抵押币种 + * Set Collateral Currency * * @param unifiedCollateralReq (required) * @return UnifiedCollateralRes @@ -2830,7 +2830,7 @@ private okhttp3.Call setUnifiedCollateralValidateBeforeCall(UnifiedCollateralReq * @http.response.details - +
Status Code Description Response Headers
200 更新成功 -
200 UpdateSuccess -
*/ public UnifiedCollateralRes setUnifiedCollateral(UnifiedCollateralReq unifiedCollateralReq) throws ApiException { @@ -2839,7 +2839,7 @@ public UnifiedCollateralRes setUnifiedCollateral(UnifiedCollateralReq unifiedCol } /** - * 设置抵押币种 + * Set Collateral Currency * * @param unifiedCollateralReq (required) * @return ApiResponse<UnifiedCollateralRes> @@ -2847,7 +2847,7 @@ public UnifiedCollateralRes setUnifiedCollateral(UnifiedCollateralReq unifiedCol * @http.response.details - +
Status Code Description Response Headers
200 更新成功 -
200 UpdateSuccess -
*/ public ApiResponse setUnifiedCollateralWithHttpInfo(UnifiedCollateralReq unifiedCollateralReq) throws ApiException { @@ -2857,7 +2857,7 @@ public ApiResponse setUnifiedCollateralWithHttpInfo(Unifie } /** - * 设置抵押币种 (asynchronously) + * Set Collateral Currency (asynchronously) * * @param unifiedCollateralReq (required) * @param _callback The callback to be executed when the API call finishes @@ -2866,7 +2866,7 @@ public ApiResponse setUnifiedCollateralWithHttpInfo(Unifie * @http.response.details - +
Status Code Description Response Headers
200 更新成功 -
200 UpdateSuccess -
*/ public okhttp3.Call setUnifiedCollateralAsync(UnifiedCollateralReq unifiedCollateralReq, final ApiCallback _callback) throws ApiException { diff --git a/src/main/java/io/gate/gateapi/api/WalletApi.java b/src/main/java/io/gate/gateapi/api/WalletApi.java index 881db12..2ffe939 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 @@ -1039,7 +1039,7 @@ public okhttp3.Call executeAsync(final ApiCallback diff --git a/src/main/java/io/gate/gateapi/api/WithdrawalApi.java b/src/main/java/io/gate/gateapi/api/WithdrawalApi.java index fa3953c..a2cd529 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 diff --git a/src/main/java/io/gate/gateapi/auth/ApiKeyAuth.java b/src/main/java/io/gate/gateapi/auth/ApiKeyAuth.java index 37cf408..fe23ce7 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 390efb7..2ae13a2 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 99d20e0..0a02da4 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 297bfe4..5e4f019 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 2be20ae..2dc1180 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 b2d95a7..0f91b26 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 diff --git a/src/main/java/io/gate/gateapi/models/AccountDetail.java b/src/main/java/io/gate/gateapi/models/AccountDetail.java index 647b86c..91022fc 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 @@ -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 - Copy trading 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 a8053e5..4c72e55 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 diff --git a/src/main/java/io/gate/gateapi/models/AccountRateLimit.java b/src/main/java/io/gate/gateapi/models/AccountRateLimit.java index 5c2f684..dfd34b0 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 diff --git a/src/main/java/io/gate/gateapi/models/AgencyCommission.java b/src/main/java/io/gate/gateapi/models/AgencyCommission.java index 8171852..c6094a7 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 diff --git a/src/main/java/io/gate/gateapi/models/AgencyCommissionHistory.java b/src/main/java/io/gate/gateapi/models/AgencyCommissionHistory.java index 5fbdc17..15d9482 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 diff --git a/src/main/java/io/gate/gateapi/models/AgencyTransaction.java b/src/main/java/io/gate/gateapi/models/AgencyTransaction.java index 6628f54..f1e1888 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 diff --git a/src/main/java/io/gate/gateapi/models/AgencyTransactionHistory.java b/src/main/java/io/gate/gateapi/models/AgencyTransactionHistory.java index 510d774..bee288f 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 ddbee40..cfd3c18 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 diff --git a/src/main/java/io/gate/gateapi/models/BatchAmendItem.java b/src/main/java/io/gate/gateapi/models/BatchAmendItem.java index 3aeb958..ca04bf5 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 @@ -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 amountor pricecan 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 amountor pricecan be specified. * @return price **/ @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 57fc9cb..d81e470 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 diff --git a/src/main/java/io/gate/gateapi/models/BatchFuturesOrder.java b/src/main/java/io/gate/gateapi/models/BatchFuturesOrder.java index 182e716..4b829f1 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 diff --git a/src/main/java/io/gate/gateapi/models/BatchOrder.java b/src/main/java/io/gate/gateapi/models/BatchOrder.java index ec901d1..2024a74 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 { @@ -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 diff --git a/src/main/java/io/gate/gateapi/models/BorrowCurrencyInfo.java b/src/main/java/io/gate/gateapi/models/BorrowCurrencyInfo.java index 524d80b..fb0666b 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 diff --git a/src/main/java/io/gate/gateapi/models/BrokerCommission.java b/src/main/java/io/gate/gateapi/models/BrokerCommission.java index adbfdec..df596e3 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 diff --git a/src/main/java/io/gate/gateapi/models/BrokerCommission1.java b/src/main/java/io/gate/gateapi/models/BrokerCommission1.java index 479fe34..bb61773 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 diff --git a/src/main/java/io/gate/gateapi/models/BrokerCommissionSubBrokerInfo.java b/src/main/java/io/gate/gateapi/models/BrokerCommissionSubBrokerInfo.java index 4f5a83a..aa2068f 100644 --- a/src/main/java/io/gate/gateapi/models/BrokerCommissionSubBrokerInfo.java +++ b/src/main/java/io/gate/gateapi/models/BrokerCommissionSubBrokerInfo.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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/BrokerTransaction.java b/src/main/java/io/gate/gateapi/models/BrokerTransaction.java index 62c9606..3832d56 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 36b5444..130e5d5 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 diff --git a/src/main/java/io/gate/gateapi/models/CancelBatchOrder.java b/src/main/java/io/gate/gateapi/models/CancelBatchOrder.java index e2e79a3..9b5249a 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 5464847..4d5c1cf 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 diff --git a/src/main/java/io/gate/gateapi/models/CollateralAdjust.java b/src/main/java/io/gate/gateapi/models/CollateralAdjust.java index fa20e51..0379a7b 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 diff --git a/src/main/java/io/gate/gateapi/models/CollateralAdjustRes.java b/src/main/java/io/gate/gateapi/models/CollateralAdjustRes.java index 0a93ae6..66e547f 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 diff --git a/src/main/java/io/gate/gateapi/models/CollateralAlign.java b/src/main/java/io/gate/gateapi/models/CollateralAlign.java index 99db007..dd45664 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 diff --git a/src/main/java/io/gate/gateapi/models/CollateralCurrency.java b/src/main/java/io/gate/gateapi/models/CollateralCurrency.java index 67fc4dd..b5cacc9 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 ff7646e..8665cee 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 diff --git a/src/main/java/io/gate/gateapi/models/CollateralCurrencyRes.java b/src/main/java/io/gate/gateapi/models/CollateralCurrencyRes.java index 144f3ca..3bf4a34 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 diff --git a/src/main/java/io/gate/gateapi/models/CollateralCurrentRate.java b/src/main/java/io/gate/gateapi/models/CollateralCurrentRate.java index ede877e..99356fb 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 diff --git a/src/main/java/io/gate/gateapi/models/CollateralFixRate.java b/src/main/java/io/gate/gateapi/models/CollateralFixRate.java index 9361585..e0f725f 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 diff --git a/src/main/java/io/gate/gateapi/models/CollateralLoanCurrency.java b/src/main/java/io/gate/gateapi/models/CollateralLoanCurrency.java index 46b0271..487c8f4 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 1cf5fb9..13ff25d 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 diff --git a/src/main/java/io/gate/gateapi/models/CollateralOrder.java b/src/main/java/io/gate/gateapi/models/CollateralOrder.java index a1a3b02..53b4e56 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 diff --git a/src/main/java/io/gate/gateapi/models/CollateralRecord.java b/src/main/java/io/gate/gateapi/models/CollateralRecord.java index 0a7181e..ac67415 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 diff --git a/src/main/java/io/gate/gateapi/models/Contract.java b/src/main/java/io/gate/gateapi/models/Contract.java index adc06f9..6471f20 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 @@ -717,7 +717,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 + * 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 * @return orderPriceDeviate **/ @javax.annotation.Nullable @@ -1017,7 +1017,7 @@ public Contract launchTime(Long launchTime) { } /** - * 合约开盘时间 + * Contract expiry timestamp * @return launchTime **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/ContractStat.java b/src/main/java/io/gate/gateapi/models/ContractStat.java index b020622..ee443b6 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 diff --git a/src/main/java/io/gate/gateapi/models/ConvertSmallBalance.java b/src/main/java/io/gate/gateapi/models/ConvertSmallBalance.java index c7c919b..92e6720 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 diff --git a/src/main/java/io/gate/gateapi/models/CountdownCancelAllFuturesTask.java b/src/main/java/io/gate/gateapi/models/CountdownCancelAllFuturesTask.java index 53ff573..3076a62 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 @@ -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 a5e3b8f..9dfc6d1 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 @@ -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 2e54918..a0fe012 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 @@ -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 864428d..0a18a59 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 diff --git a/src/main/java/io/gate/gateapi/models/CreateMultiCollateralOrder.java b/src/main/java/io/gate/gateapi/models/CreateMultiCollateralOrder.java index 698b5c4..af99902 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 diff --git a/src/main/java/io/gate/gateapi/models/CreateUniLend.java b/src/main/java/io/gate/gateapi/models/CreateUniLend.java index 47b1a12..d726278 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 diff --git a/src/main/java/io/gate/gateapi/models/CreateUniLoan.java b/src/main/java/io/gate/gateapi/models/CreateUniLoan.java index 19d79e9..26ddd1d 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 diff --git a/src/main/java/io/gate/gateapi/models/CrossMarginBalance.java b/src/main/java/io/gate/gateapi/models/CrossMarginBalance.java index 06fd6d8..6c928d1 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 diff --git a/src/main/java/io/gate/gateapi/models/CrossMarginLoan.java b/src/main/java/io/gate/gateapi/models/CrossMarginLoan.java index 57695df..1fee149 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 diff --git a/src/main/java/io/gate/gateapi/models/CrossMarginRepayment.java b/src/main/java/io/gate/gateapi/models/CrossMarginRepayment.java index 88576ac..26e19e0 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 diff --git a/src/main/java/io/gate/gateapi/models/Currency.java b/src/main/java/io/gate/gateapi/models/Currency.java index 1a2f624..b154495 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 1fd6c0e..5c948f2 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 diff --git a/src/main/java/io/gate/gateapi/models/CurrencyPair.java b/src/main/java/io/gate/gateapi/models/CurrencyPair.java index ab044b2..9520175 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 @@ -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) { @@ -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 e61e9e7..a5557ee 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 diff --git a/src/main/java/io/gate/gateapi/models/DebitFee.java b/src/main/java/io/gate/gateapi/models/DebitFee.java index 35294ab..0dc55bd 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 diff --git a/src/main/java/io/gate/gateapi/models/DeliveryCandlestick.java b/src/main/java/io/gate/gateapi/models/DeliveryCandlestick.java index 512824e..9427705 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 3f6d16f..8602204 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 @@ -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 + * 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 * @return orderPriceDeviate **/ @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 bccfec1..767816d 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 4a7f00c..b876fb8 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 diff --git a/src/main/java/io/gate/gateapi/models/DepositAddress.java b/src/main/java/io/gate/gateapi/models/DepositAddress.java index 3c530b8..25040ef 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 e18d2c5..1bfb60e 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 diff --git a/src/main/java/io/gate/gateapi/models/DualGetOrders.java b/src/main/java/io/gate/gateapi/models/DualGetOrders.java index ab408e7..67c2b85 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 diff --git a/src/main/java/io/gate/gateapi/models/DualGetPlans.java b/src/main/java/io/gate/gateapi/models/DualGetPlans.java index ba618a5..9616642 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 diff --git a/src/main/java/io/gate/gateapi/models/Eth2RateList.java b/src/main/java/io/gate/gateapi/models/Eth2RateList.java index 743a92a..81ee348 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 diff --git a/src/main/java/io/gate/gateapi/models/Eth2Swap.java b/src/main/java/io/gate/gateapi/models/Eth2Swap.java index e84219c..2c9829a 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 diff --git a/src/main/java/io/gate/gateapi/models/FindCoin.java b/src/main/java/io/gate/gateapi/models/FindCoin.java index 8553441..71f57e5 100644 --- a/src/main/java/io/gate/gateapi/models/FindCoin.java +++ b/src/main/java/io/gate/gateapi/models/FindCoin.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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/FlashSwapCurrencyPair.java b/src/main/java/io/gate/gateapi/models/FlashSwapCurrencyPair.java index 8e5942a..97e2d62 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 diff --git a/src/main/java/io/gate/gateapi/models/FlashSwapOrder.java b/src/main/java/io/gate/gateapi/models/FlashSwapOrder.java index abe691a..58d6fb8 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 7d1971d..f583d01 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 @@ -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 716e539..b11b809 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 a34faea..e7f9fcd 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 diff --git a/src/main/java/io/gate/gateapi/models/FundingAccount.java b/src/main/java/io/gate/gateapi/models/FundingAccount.java index 80aac52..54d7cae 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 86c1347..efcfbce 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 428404a..c8a86b6 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesAccount.java b/src/main/java/io/gate/gateapi/models/FuturesAccount.java index 706a36e..ea4a6c2 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 @@ -120,6 +120,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; @@ -605,6 +609,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; @@ -657,12 +681,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, enableCredit, positionInitialMargin, maintenanceMargin, bonus, enableEvolvedClassic, crossOrderMargin, crossInitialMargin, crossMaintenanceMargin, crossUnrealisedPnl, crossAvailable, crossMarginBalance, crossMmr, crossImr, isolatedPositionMargin, enableNewDualMode, marginMode, enableTieredMm, history); } @@ -694,6 +719,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 eb7457f..df14ba7 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 @@ -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 b566a33..77d2d4b 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 2b468fa..e3686f8 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesBatchAmendOrderRequest.java b/src/main/java/io/gate/gateapi/models/FuturesBatchAmendOrderRequest.java index 8a61a42..2e6420d 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesCandlestick.java b/src/main/java/io/gate/gateapi/models/FuturesCandlestick.java index f719f92..7be10dd 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 d9d333b..07db3cf 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesIndexConstituents.java b/src/main/java/io/gate/gateapi/models/FuturesIndexConstituents.java index aacccfb..807a889 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 5459792..e98cabb 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesLimitRiskTiers.java b/src/main/java/io/gate/gateapi/models/FuturesLimitRiskTiers.java index adb1647..93d15c8 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 @@ -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) { @@ -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 + * @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 4273d26..f88d3f6 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 60518eb..bb32e8a 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesOrder.java b/src/main/java/io/gate/gateapi/models/FuturesOrder.java index f334ab4..1bea1e3 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesOrderAmendment.java b/src/main/java/io/gate/gateapi/models/FuturesOrderAmendment.java index 1f785b7..f95efa8 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesOrderBook.java b/src/main/java/io/gate/gateapi/models/FuturesOrderBook.java index 4434339..9cf150d 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesOrderBookItem.java b/src/main/java/io/gate/gateapi/models/FuturesOrderBookItem.java index 638d744..fcd05e0 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 index 29e5d24..317af9d 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesPositionCrossMode.java +++ b/src/main/java/io/gate/gateapi/models/FuturesPositionCrossMode.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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/FuturesPremiumIndex.java b/src/main/java/io/gate/gateapi/models/FuturesPremiumIndex.java index 3ff242e..caa4419 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesPriceTrigger.java b/src/main/java/io/gate/gateapi/models/FuturesPriceTrigger.java index fae9a01..fb02e7d 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesPriceTriggeredOrder.java b/src/main/java/io/gate/gateapi/models/FuturesPriceTriggeredOrder.java index e74c0d8..a179ecd 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 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..112578b --- /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 risk limit ladder + */ +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 + * @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 6bfc231..6861704 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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesTrade.java b/src/main/java/io/gate/gateapi/models/FuturesTrade.java index 7bf108c..dc55f5c 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 diff --git a/src/main/java/io/gate/gateapi/models/IndexConstituent.java b/src/main/java/io/gate/gateapi/models/IndexConstituent.java index c593830..ab72f27 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/InlineResponse200.java b/src/main/java/io/gate/gateapi/models/InlineResponse200.java index 353f45a..f534026 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 d5dfb8a..769a1fa 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 51e5f12..279f215 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 a826352..95231e0 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 diff --git a/src/main/java/io/gate/gateapi/models/LiquidateOrder.java b/src/main/java/io/gate/gateapi/models/LiquidateOrder.java index 8b51faf..d0d5e12 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 diff --git a/src/main/java/io/gate/gateapi/models/MarginAccount.java b/src/main/java/io/gate/gateapi/models/MarginAccount.java index e2f6402..a5b953d 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 diff --git a/src/main/java/io/gate/gateapi/models/MarginAccountBook.java b/src/main/java/io/gate/gateapi/models/MarginAccountBook.java index 5a928e6..34179b4 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 diff --git a/src/main/java/io/gate/gateapi/models/MarginAccountCurrency.java b/src/main/java/io/gate/gateapi/models/MarginAccountCurrency.java index 3869319..b51cd76 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 diff --git a/src/main/java/io/gate/gateapi/models/MarginLeverageTier.java b/src/main/java/io/gate/gateapi/models/MarginLeverageTier.java index d7e23d9..116356d 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 6ee72d3..74cdb60 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 diff --git a/src/main/java/io/gate/gateapi/models/MarginTiers.java b/src/main/java/io/gate/gateapi/models/MarginTiers.java index 9516b9a..590adca 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 71844ac..821da0a 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 3dc755e..76a1cc4 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 31a4683..ce7be6a 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 diff --git a/src/main/java/io/gate/gateapi/models/MockFuturesPosition.java b/src/main/java/io/gate/gateapi/models/MockFuturesPosition.java index 9523a50..83eae2a 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 diff --git a/src/main/java/io/gate/gateapi/models/MockMarginResult.java b/src/main/java/io/gate/gateapi/models/MockMarginResult.java index d4e1cc6..c21fb61 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 diff --git a/src/main/java/io/gate/gateapi/models/MockOptionsOrder.java b/src/main/java/io/gate/gateapi/models/MockOptionsOrder.java index 74f1623..e5b3bee 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 diff --git a/src/main/java/io/gate/gateapi/models/MockOptionsPosition.java b/src/main/java/io/gate/gateapi/models/MockOptionsPosition.java index 41aeac6..4492d43 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 diff --git a/src/main/java/io/gate/gateapi/models/MockRiskUnit.java b/src/main/java/io/gate/gateapi/models/MockRiskUnit.java index 956264f..ca19c36 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 diff --git a/src/main/java/io/gate/gateapi/models/MockSpotBalance.java b/src/main/java/io/gate/gateapi/models/MockSpotBalance.java index eee56f8..f4cb635 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 diff --git a/src/main/java/io/gate/gateapi/models/MockSpotOrder.java b/src/main/java/io/gate/gateapi/models/MockSpotOrder.java index cccb76e..5e73f3b 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 diff --git a/src/main/java/io/gate/gateapi/models/MultiChainAddressItem.java b/src/main/java/io/gate/gateapi/models/MultiChainAddressItem.java index 4f62b77..4f35aa0 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 02bb1f4..92c07ec 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 diff --git a/src/main/java/io/gate/gateapi/models/MultiCollateralItem.java b/src/main/java/io/gate/gateapi/models/MultiCollateralItem.java index 9d15c20..455aca4 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 b68861f..23eabae 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 diff --git a/src/main/java/io/gate/gateapi/models/MultiCollateralRecord.java b/src/main/java/io/gate/gateapi/models/MultiCollateralRecord.java index fc0af56..e7d78c4 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 diff --git a/src/main/java/io/gate/gateapi/models/MultiCollateralRecordCurrency.java b/src/main/java/io/gate/gateapi/models/MultiCollateralRecordCurrency.java index fb062b4..d447698 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 diff --git a/src/main/java/io/gate/gateapi/models/MultiLoanItem.java b/src/main/java/io/gate/gateapi/models/MultiLoanItem.java index 91e2be9..7e00610 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 85ae87c..1bdb0d2 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 diff --git a/src/main/java/io/gate/gateapi/models/MultiRepayRecord.java b/src/main/java/io/gate/gateapi/models/MultiRepayRecord.java index 3325aad..b84d275 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 diff --git a/src/main/java/io/gate/gateapi/models/MultiRepayResp.java b/src/main/java/io/gate/gateapi/models/MultiRepayResp.java index 7d85509..b7652ba 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 diff --git a/src/main/java/io/gate/gateapi/models/MyFuturesTrade.java b/src/main/java/io/gate/gateapi/models/MyFuturesTrade.java index cd14480..ec8d73a 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 diff --git a/src/main/java/io/gate/gateapi/models/MyFuturesTradeTimeRange.java b/src/main/java/io/gate/gateapi/models/MyFuturesTradeTimeRange.java index d8128f8..d337129 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 diff --git a/src/main/java/io/gate/gateapi/models/OpenOrders.java b/src/main/java/io/gate/gateapi/models/OpenOrders.java index c14cf56..c37978c 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsAccount.java b/src/main/java/io/gate/gateapi/models/OptionsAccount.java index cc6f73c..de1f983 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsAccountBook.java b/src/main/java/io/gate/gateapi/models/OptionsAccountBook.java index 3490ae4..9d9e226 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsCandlestick.java b/src/main/java/io/gate/gateapi/models/OptionsCandlestick.java index 331e1f1..179b6cd 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 dba3df5..8a893a7 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsMMP.java b/src/main/java/io/gate/gateapi/models/OptionsMMP.java index 60701dc..3419fa1 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsMMPReset.java b/src/main/java/io/gate/gateapi/models/OptionsMMPReset.java index 65e9c37..ca4a6d9 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsMySettlements.java b/src/main/java/io/gate/gateapi/models/OptionsMySettlements.java index e6ed7c5..cb9ac29 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsMyTrade.java b/src/main/java/io/gate/gateapi/models/OptionsMyTrade.java index 2929920..a98b4a8 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsOrder.java b/src/main/java/io/gate/gateapi/models/OptionsOrder.java index fe13a00..853f5ab 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsPosition.java b/src/main/java/io/gate/gateapi/models/OptionsPosition.java index e7e756a..fcb2059 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsPositionClose.java b/src/main/java/io/gate/gateapi/models/OptionsPositionClose.java index 6130434..1c8490c 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsPositionCloseOrder.java b/src/main/java/io/gate/gateapi/models/OptionsPositionCloseOrder.java index 18f2577..654a850 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsSettlement.java b/src/main/java/io/gate/gateapi/models/OptionsSettlement.java index 0ab9f9f..f430a10 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsTicker.java b/src/main/java/io/gate/gateapi/models/OptionsTicker.java index 9777d52..0244623 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 diff --git a/src/main/java/io/gate/gateapi/models/OptionsUnderlying.java b/src/main/java/io/gate/gateapi/models/OptionsUnderlying.java index 7bc1fc1..2da3a34 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 af846c1..868d17c 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 e71ae8a..08b9eec 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 { @@ -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() { diff --git a/src/main/java/io/gate/gateapi/models/OrderBook.java b/src/main/java/io/gate/gateapi/models/OrderBook.java index 2318d53..be0900d 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 diff --git a/src/main/java/io/gate/gateapi/models/OrderCancel.java b/src/main/java/io/gate/gateapi/models/OrderCancel.java index 9831954..221f113 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 { @@ -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() { diff --git a/src/main/java/io/gate/gateapi/models/OrderPatch.java b/src/main/java/io/gate/gateapi/models/OrderPatch.java index d0f1df0..65e8e59 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 @@ -95,7 +95,7 @@ public OrderPatch amount(String amount) { } /** - * New order amount. `amount` and `price` must specify one of them + * Trading Quantity. Either amountor pricemust 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 amountor pricemust be specified * @return price **/ @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 d6963e6..ae07031 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 9ace806..c245306 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 diff --git a/src/main/java/io/gate/gateapi/models/PartnerSub.java b/src/main/java/io/gate/gateapi/models/PartnerSub.java index c8d8cb6..7eb90eb 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 diff --git a/src/main/java/io/gate/gateapi/models/PartnerSubList.java b/src/main/java/io/gate/gateapi/models/PartnerSubList.java index a978ffa..7685254 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 e745b60..fa25c06 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 192d92c..41ab038 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 e7d4ab3..a3a9863 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 diff --git a/src/main/java/io/gate/gateapi/models/Position.java b/src/main/java/io/gate/gateapi/models/Position.java index 0c23eae..2125e5e 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 @@ -197,6 +197,14 @@ 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; + /** * User ID @@ -577,6 +585,26 @@ 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; + } + @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -616,12 +644,14 @@ 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); } @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); } @@ -660,6 +690,8 @@ 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("}"); 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 014bcbd..503fa77 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 diff --git a/src/main/java/io/gate/gateapi/models/PositionCloseOrder.java b/src/main/java/io/gate/gateapi/models/PositionCloseOrder.java index bb36d41..9c90a8e 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 diff --git a/src/main/java/io/gate/gateapi/models/ProfitLossRange.java b/src/main/java/io/gate/gateapi/models/ProfitLossRange.java index 1f73a8a..a18746d 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 diff --git a/src/main/java/io/gate/gateapi/models/RebateUserInfo.java b/src/main/java/io/gate/gateapi/models/RebateUserInfo.java index df358c5..0c91b5f 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 213e833..4d14d77 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 diff --git a/src/main/java/io/gate/gateapi/models/RepayLoan.java b/src/main/java/io/gate/gateapi/models/RepayLoan.java index 351d6c1..ed676a4 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 diff --git a/src/main/java/io/gate/gateapi/models/RepayMultiLoan.java b/src/main/java/io/gate/gateapi/models/RepayMultiLoan.java index 1207c76..c0b3133 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 diff --git a/src/main/java/io/gate/gateapi/models/RepayRecord.java b/src/main/java/io/gate/gateapi/models/RepayRecord.java index f122899..072e49e 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 diff --git a/src/main/java/io/gate/gateapi/models/RepayRecordCurrency.java b/src/main/java/io/gate/gateapi/models/RepayRecordCurrency.java index d4a2dde..6d09a2a 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 diff --git a/src/main/java/io/gate/gateapi/models/RepayRecordLeftInterest.java b/src/main/java/io/gate/gateapi/models/RepayRecordLeftInterest.java index 86f9235..9d8e4ae 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 9d90d87..a82df33 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 diff --git a/src/main/java/io/gate/gateapi/models/RepayRecordTotalInterest.java b/src/main/java/io/gate/gateapi/models/RepayRecordTotalInterest.java index 0fd40d6..4ff0f10 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 3d28af0..863ae74 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 36e53aa..a2a1b1f 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 diff --git a/src/main/java/io/gate/gateapi/models/SavedAddress.java b/src/main/java/io/gate/gateapi/models/SavedAddress.java index c36db4f..494efd2 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 1b7e13d..343a114 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 diff --git a/src/main/java/io/gate/gateapi/models/SmallBalanceHistory.java b/src/main/java/io/gate/gateapi/models/SmallBalanceHistory.java index 33d0681..c1f8392 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 diff --git a/src/main/java/io/gate/gateapi/models/SpotAccount.java b/src/main/java/io/gate/gateapi/models/SpotAccount.java index 27e0b92..67c67b3 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 03b6e22..db932e6 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 diff --git a/src/main/java/io/gate/gateapi/models/SpotCurrencyChain.java b/src/main/java/io/gate/gateapi/models/SpotCurrencyChain.java index 0c6ade0..e0f6c2c 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 diff --git a/src/main/java/io/gate/gateapi/models/SpotFee.java b/src/main/java/io/gate/gateapi/models/SpotFee.java index 1ee5406..c919c84 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 diff --git a/src/main/java/io/gate/gateapi/models/SpotInsuranceHistory.java b/src/main/java/io/gate/gateapi/models/SpotInsuranceHistory.java index 90764c1..f4fd1cd 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 diff --git a/src/main/java/io/gate/gateapi/models/SpotPricePutOrder.java b/src/main/java/io/gate/gateapi/models/SpotPricePutOrder.java index 9c8b45a..b6109c5 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. Portfolio margin account must set to `unified` -normal: spot trading - margin: margin trading - unified: unified trading */ @JsonAdapter(AccountEnum.Adapter.class) public enum AccountEnum { @@ -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. Portfolio margin account must set to `unified` -normal: spot trading - margin: margin trading - unified: unified trading * @return account **/ public AccountEnum getAccount() { diff --git a/src/main/java/io/gate/gateapi/models/SpotPriceTrigger.java b/src/main/java/io/gate/gateapi/models/SpotPriceTrigger.java index e1f6ccd..3efb211 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 larger than or equal to `price` field - `<=`: triggered when market price less than or equal to `price` field */ @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 larger than or equal to `price` field - `<=`: triggered when market price less than or equal to `price` field * @return rule **/ public RuleEnum getRule() { diff --git a/src/main/java/io/gate/gateapi/models/SpotPriceTriggeredOrder.java b/src/main/java/io/gate/gateapi/models/SpotPriceTriggeredOrder.java index 5f47309..3b8c726 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 diff --git a/src/main/java/io/gate/gateapi/models/StpGroup.java b/src/main/java/io/gate/gateapi/models/StpGroup.java index fc0bb30..a3ea160 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 diff --git a/src/main/java/io/gate/gateapi/models/StpGroupUser.java b/src/main/java/io/gate/gateapi/models/StpGroupUser.java index bb95acb..37e72f6 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 diff --git a/src/main/java/io/gate/gateapi/models/StructuredBuy.java b/src/main/java/io/gate/gateapi/models/StructuredBuy.java index f73f553..805e515 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 diff --git a/src/main/java/io/gate/gateapi/models/StructuredGetProjectList.java b/src/main/java/io/gate/gateapi/models/StructuredGetProjectList.java index c528ccf..54dbf73 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 diff --git a/src/main/java/io/gate/gateapi/models/StructuredOrderList.java b/src/main/java/io/gate/gateapi/models/StructuredOrderList.java index f8080e8..a1d15a1 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 diff --git a/src/main/java/io/gate/gateapi/models/SubAccount.java b/src/main/java/io/gate/gateapi/models/SubAccount.java index ca93612..5e9be9d 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 diff --git a/src/main/java/io/gate/gateapi/models/SubAccountBalance.java b/src/main/java/io/gate/gateapi/models/SubAccountBalance.java index bde6280..772ef07 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 7b75403..bf2e802 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 55ecc8c..5734972 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 40293ab..06c494c 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 diff --git a/src/main/java/io/gate/gateapi/models/SubAccountKeyPerms.java b/src/main/java/io/gate/gateapi/models/SubAccountKeyPerms.java index 37c942b..f223648 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 diff --git a/src/main/java/io/gate/gateapi/models/SubAccountMarginBalance.java b/src/main/java/io/gate/gateapi/models/SubAccountMarginBalance.java index 0d93608..d524570 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 5487c2b..c95e985 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 @@ -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 + * Transferred 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 21c9149..a2b3a66 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 @@ -74,7 +74,7 @@ public SubAccountTransfer subAccountType(String subAccountType) { } /** - * 操作的子账号交易账户， spot - 现货账户， futures - 永续合约账户， delivery - 交割合约账户, options - 期权账户 + * Target sub user's account. `spot` - spot account, `futures` - perpetual contract account, `delivery` - delivery account * @return subAccountType **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SubAccountTransferRecordItem.java b/src/main/java/io/gate/gateapi/models/SubAccountTransferRecordItem.java index 29c838d..c5f3cd5 100644 --- a/src/main/java/io/gate/gateapi/models/SubAccountTransferRecordItem.java +++ b/src/main/java/io/gate/gateapi/models/SubAccountTransferRecordItem.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 @@ public SubAccountTransferRecordItem subAccountType(String subAccountType) { } /** - * 操作的子账号交易账户， spot - 现货账户， futures - 永续合约账户， delivery - 交割合约账户, options - 期权账户 + * Target sub user's account. `spot` - spot account, `futures` - perpetual contract account, `delivery` - delivery account * @return subAccountType **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SubCrossMarginAccount.java b/src/main/java/io/gate/gateapi/models/SubCrossMarginAccount.java index b45231e..0d1fae3 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 diff --git a/src/main/java/io/gate/gateapi/models/SubUserMode.java b/src/main/java/io/gate/gateapi/models/SubUserMode.java index ab1fa47..e061467 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 diff --git a/src/main/java/io/gate/gateapi/models/SwapCoin.java b/src/main/java/io/gate/gateapi/models/SwapCoin.java index e537e69..4cfa8c2 100644 --- a/src/main/java/io/gate/gateapi/models/SwapCoin.java +++ b/src/main/java/io/gate/gateapi/models/SwapCoin.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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/SwapCoinStruct.java b/src/main/java/io/gate/gateapi/models/SwapCoinStruct.java new file mode 100644 index 0000000..7846671 --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/SwapCoinStruct.java @@ -0,0 +1,297 @@ +/* + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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_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_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_PID = "pid"; + @SerializedName(SERIALIZED_NAME_PID) + private Integer pid; + + public static final String SERIALIZED_NAME_STATUS = "status"; + @SerializedName(SERIALIZED_NAME_STATUS) + private Integer status; + + public static final String SERIALIZED_NAME_CREATE_STAMP = "createStamp"; + @SerializedName(SERIALIZED_NAME_CREATE_STAMP) + private Integer createStamp; + + + 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 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-Lock, 1-Certificate + * @return type + **/ + @javax.annotation.Nullable + public Integer getType() { + return type; + } + + + public void setType(Integer type) { + this.type = type; + } + + 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 pid(Integer pid) { + + this.pid = pid; + return this; + } + + /** + * Plan ID + * @return pid + **/ + @javax.annotation.Nullable + public Integer getPid() { + return pid; + } + + + public void setPid(Integer pid) { + this.pid = pid; + } + + 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 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; + } + @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.uid, swapCoinStruct.uid) && + Objects.equals(this.coin, swapCoinStruct.coin) && + Objects.equals(this.type, swapCoinStruct.type) && + Objects.equals(this.amount, swapCoinStruct.amount) && + Objects.equals(this.exchangeRate, swapCoinStruct.exchangeRate) && + Objects.equals(this.pid, swapCoinStruct.pid) && + Objects.equals(this.status, swapCoinStruct.status) && + Objects.equals(this.createStamp, swapCoinStruct.createStamp); + } + + @Override + public int hashCode() { + return Objects.hash(id, uid, coin, type, amount, exchangeRate, pid, status, createStamp); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SwapCoinStruct {\n"); + sb.append(" id: ").append(toIndentedString(id)).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(" amount: ").append(toIndentedString(amount)).append("\n"); + sb.append(" exchangeRate: ").append(toIndentedString(exchangeRate)).append("\n"); + sb.append(" pid: ").append(toIndentedString(pid)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).append("\n"); + sb.append(" createStamp: ").append(toIndentedString(createStamp)).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 26fafce..5f8207e 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 f012674..a8165c3 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 diff --git a/src/main/java/io/gate/gateapi/models/TotalBalance.java b/src/main/java/io/gate/gateapi/models/TotalBalance.java index 40e3883..cd59862 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 diff --git a/src/main/java/io/gate/gateapi/models/Trade.java b/src/main/java/io/gate/gateapi/models/Trade.java index b7c012a..569b919 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 { @@ -269,7 +269,7 @@ public Trade side(SideEnum side) { } /** - * Order side + * Buy or sell order * @return side **/ @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 be4429a..a1e8fa4 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 diff --git a/src/main/java/io/gate/gateapi/models/TransactionID.java b/src/main/java/io/gate/gateapi/models/TransactionID.java index 874664f..5ad4564 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 diff --git a/src/main/java/io/gate/gateapi/models/Transfer.java b/src/main/java/io/gate/gateapi/models/Transfer.java index 99b0e1b..9582794 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 diff --git a/src/main/java/io/gate/gateapi/models/TransferOrderStatus.java b/src/main/java/io/gate/gateapi/models/TransferOrderStatus.java index 7e5f475..9d9680d 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 diff --git a/src/main/java/io/gate/gateapi/models/TransferablesResult.java b/src/main/java/io/gate/gateapi/models/TransferablesResult.java index dffcea6..84f7207 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 diff --git a/src/main/java/io/gate/gateapi/models/TriggerOrderResponse.java b/src/main/java/io/gate/gateapi/models/TriggerOrderResponse.java index 28fa91f..a0934e0 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 22f34f5..b625684 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 diff --git a/src/main/java/io/gate/gateapi/models/UidPushOrder.java b/src/main/java/io/gate/gateapi/models/UidPushOrder.java index 907e68a..058a437 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 diff --git a/src/main/java/io/gate/gateapi/models/UidPushWithdrawal.java b/src/main/java/io/gate/gateapi/models/UidPushWithdrawal.java index ea92c87..b1544ab 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 cd4272a..6e94cde 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 8335fdc..15aa39f 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 diff --git a/src/main/java/io/gate/gateapi/models/UniCurrencyInterest.java b/src/main/java/io/gate/gateapi/models/UniCurrencyInterest.java index 78d7a2f..ef03eca 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 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 883646c..bf3dd9b 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/UniInterestRecord.java b/src/main/java/io/gate/gateapi/models/UniInterestRecord.java index 93895e2..d064144 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 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 dd52d07..48fb708 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 @@ -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 Interest reinvestment * @return interestStatus **/ @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 5f46761..e9fdcdf 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 diff --git a/src/main/java/io/gate/gateapi/models/UniLendRecord.java b/src/main/java/io/gate/gateapi/models/UniLendRecord.java index 6dedfc6..d82035f 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 diff --git a/src/main/java/io/gate/gateapi/models/UniLoan.java b/src/main/java/io/gate/gateapi/models/UniLoan.java index 8a3673b..6890f3b 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 diff --git a/src/main/java/io/gate/gateapi/models/UniLoanInterestRecord.java b/src/main/java/io/gate/gateapi/models/UniLoanInterestRecord.java index cf867aa..e3c7e33 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 diff --git a/src/main/java/io/gate/gateapi/models/UniLoanRecord.java b/src/main/java/io/gate/gateapi/models/UniLoanRecord.java index 723fcc4..453053e 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedAccount.java b/src/main/java/io/gate/gateapi/models/UnifiedAccount.java index 3c1bb9b..e7732b8 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 @@ -493,7 +493,7 @@ public UnifiedAccount isAllCollateral(Boolean isAllCollateral) { } /** - * 是否所有币种均作为保证金，true - 所有币种作为保证金，false - 否 + * Whether all currencies are used as margin, true - All currencies are used as margin, false - No * @return isAllCollateral **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedBalance.java b/src/main/java/io/gate/gateapi/models/UnifiedBalance.java index 7648e43..a50a929 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 @@ -491,7 +491,7 @@ public UnifiedBalance enabledCollateral(Boolean enabledCollateral) { } /** - * 币种开启作为保证金，true - 启用，false - 未启用 + * Currency enabled as margin: true - Enabled, false - Disabled * @return enabledCollateral **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedBorrowable.java b/src/main/java/io/gate/gateapi/models/UnifiedBorrowable.java index ff44ea0..d70976a 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 d0c64a5..0b7fa8b 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedCollateralReq.java b/src/main/java/io/gate/gateapi/models/UnifiedCollateralReq.java index 034928e..1afdae5 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedCollateralReq.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedCollateralReq.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 @@ */ public class UnifiedCollateralReq { /** - * 用户设置抵押物模式 0(all)-全部币种作为抵押物,1(custom)-自定义币种作为抵押物,collateral_type为0(all)时，enable_list与disable_list参数无效 + * User-set collateral mode0(all)-All currencies used as collateral, 1(custom)-Custom currencies used as collateral; when collateral_type is 0(all), the enable_list and disable_list parameters are invalid */ @JsonAdapter(CollateralTypeEnum.Adapter.class) public enum CollateralTypeEnum { @@ -92,7 +92,7 @@ public UnifiedCollateralReq collateralType(CollateralTypeEnum collateralType) { } /** - * 用户设置抵押物模式 0(all)-全部币种作为抵押物,1(custom)-自定义币种作为抵押物,collateral_type为0(all)时，enable_list与disable_list参数无效 + * User-set collateral mode0(all)-All currencies used as collateral, 1(custom)-Custom currencies used as collateral; when collateral_type is 0(all), the enable_list and disable_list parameters are invalid * @return collateralType **/ @javax.annotation.Nullable @@ -120,7 +120,7 @@ public UnifiedCollateralReq addEnableListItem(String enableListItem) { } /** - * 币种列表，collateral_type=1(custom)表示追加的逻辑 + * Currency list, where collateral_type=1(custom) indicates the logic of addition * @return enableList **/ @javax.annotation.Nullable @@ -148,7 +148,7 @@ public UnifiedCollateralReq addDisableListItem(String disableListItem) { } /** - * 取消列表，表示取消的逻辑 + * Cancellation list, indicating the logic of cancellation * @return disableList **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedCollateralRes.java b/src/main/java/io/gate/gateapi/models/UnifiedCollateralRes.java index e6c809e..d7c0434 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedCollateralRes.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedCollateralRes.java @@ -1,6 +1,6 @@ /* - * Gate API v4 - * Welcome to Gate API APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf. + * Gate API + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * 统一账户抵押模式设置返回 + * Return of unified account collateral mode settings */ public class UnifiedCollateralRes { public static final String SERIALIZED_NAME_IS_SUCCESS = "is_success"; @@ -35,7 +35,7 @@ public UnifiedCollateralRes isSuccess(Boolean isSuccess) { } /** - * 是否设置成功 + * Whether the setting was successful * @return isSuccess **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedCurrency.java b/src/main/java/io/gate/gateapi/models/UnifiedCurrency.java index 1c9fcda..7317c5e 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedDiscount.java b/src/main/java/io/gate/gateapi/models/UnifiedDiscount.java index 660c902..a0281af 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedDiscountTiers.java b/src/main/java/io/gate/gateapi/models/UnifiedDiscountTiers.java index b8ca30c..09c7e04 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedHistoryLoanRate.java b/src/main/java/io/gate/gateapi/models/UnifiedHistoryLoanRate.java index 712da6f..a59956a 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedHistoryLoanRateRates.java b/src/main/java/io/gate/gateapi/models/UnifiedHistoryLoanRateRates.java index a976886..28dbb42 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedLeverageConfig.java b/src/main/java/io/gate/gateapi/models/UnifiedLeverageConfig.java index 74304f8..38d4150 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedLeverageSetting.java b/src/main/java/io/gate/gateapi/models/UnifiedLeverageSetting.java index 846dbbe..f4b5817 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedLoan.java b/src/main/java/io/gate/gateapi/models/UnifiedLoan.java index c579627..1f28921 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedLoanRecord.java b/src/main/java/io/gate/gateapi/models/UnifiedLoanRecord.java index d1d8266..2f97a11 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 @@ -57,7 +57,7 @@ public class UnifiedLoanRecord { /** - * id + * ID * @return id **/ @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 0159733..ed25f06 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedMarginTiers.java b/src/main/java/io/gate/gateapi/models/UnifiedMarginTiers.java index 8370cae..015d27f 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedModeSet.java b/src/main/java/io/gate/gateapi/models/UnifiedModeSet.java index 9c97c9b..f489dc5 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedPortfolioInput.java b/src/main/java/io/gate/gateapi/models/UnifiedPortfolioInput.java index 5bcbc05..66559e0 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedPortfolioOutput.java b/src/main/java/io/gate/gateapi/models/UnifiedPortfolioOutput.java index c87da6c..97ef36c 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedRiskUnits.java b/src/main/java/io/gate/gateapi/models/UnifiedRiskUnits.java index 3ad309c..21e504e 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedSettings.java b/src/main/java/io/gate/gateapi/models/UnifiedSettings.java index 6f0859e..af82037 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 diff --git a/src/main/java/io/gate/gateapi/models/UnifiedTransferable.java b/src/main/java/io/gate/gateapi/models/UnifiedTransferable.java index 7a88c6e..54bf80c 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 diff --git a/src/main/java/io/gate/gateapi/models/UserLtvInfo.java b/src/main/java/io/gate/gateapi/models/UserLtvInfo.java index e0751ba..b198af4 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 diff --git a/src/main/java/io/gate/gateapi/models/UserSub.java b/src/main/java/io/gate/gateapi/models/UserSub.java index c08f3b4..0a204ec 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 diff --git a/src/main/java/io/gate/gateapi/models/UserSubRelation.java b/src/main/java/io/gate/gateapi/models/UserSubRelation.java index 2e9314f..0207b90 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 3a68b81..68944ff 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 diff --git a/src/main/java/io/gate/gateapi/models/WithdrawStatus.java b/src/main/java/io/gate/gateapi/models/WithdrawStatus.java index e8ba68f..1a60abf 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 diff --git a/src/main/java/io/gate/gateapi/models/WithdrawalRecord.java b/src/main/java/io/gate/gateapi/models/WithdrawalRecord.java index eaac616..37b843d 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 From 274620802c082fc516fe60241ed5ef1ec2c085ad Mon Sep 17 00:00:00 2001 From: gateio Date: Tue, 15 Jul 2025 06:20:29 +0000 Subject: [PATCH 07/14] update to v2.102.0 --- docs/EarnUniApi.md | 8 +++--- .../java/io/gate/gateapi/api/EarnUniApi.java | 28 +++++++++---------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/EarnUniApi.md b/docs/EarnUniApi.md index 964cfa0..fefd18b 100644 --- a/docs/EarnUniApi.md +++ b/docs/EarnUniApi.md @@ -664,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-07-15 06:10+0000 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 +Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:20+0000 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 @@ -730,7 +730,7 @@ 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-07-15 06:10+0000 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 | - | +**200** | Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:20+0000 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** @@ -738,7 +738,7 @@ Name | Type | Description | Notes Currency estimate annualized interest rate -Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:10+0000 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 +Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:20+0000 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 @@ -796,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-07-15 06:10+0000 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 | - | +**200** | Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:20+0000 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/src/main/java/io/gate/gateapi/api/EarnUniApi.java b/src/main/java/io/gate/gateapi/api/EarnUniApi.java index c158c77..b1ac890 100644 --- a/src/main/java/io/gate/gateapi/api/EarnUniApi.java +++ b/src/main/java/io/gate/gateapi/api/EarnUniApi.java @@ -1289,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-07-15 06:10+0000 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 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:20+0000 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 { @@ -1356,7 +1356,7 @@ 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-07-15 06:10+0000 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 + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:20+0000 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, unit s, maximum span of 30 days (required) * @param to End timestamp, unit s, maximum span of 30 days (required) * @param asset Currency name (required) @@ -1365,7 +1365,7 @@ private okhttp3.Call listUniChartValidateBeforeCall(Long from, Long to, String a * @http.response.details - +
Status Code Description Response Headers
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:10+0000 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 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:20+0000 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 { @@ -1375,7 +1375,7 @@ 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-07-15 06:10+0000 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 + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:20+0000 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, unit s, maximum span of 30 days (required) * @param to End timestamp, unit s, maximum span of 30 days (required) * @param asset Currency name (required) @@ -1384,7 +1384,7 @@ public List listUniChart(Long from, Long to, String asset) th * @http.response.details - +
Status Code Description Response Headers
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:10+0000 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 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:20+0000 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 { @@ -1395,7 +1395,7 @@ 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-07-15 06:10+0000 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 + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:20+0000 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, unit s, maximum span of 30 days (required) * @param to End timestamp, unit s, maximum span of 30 days (required) * @param asset Currency name (required) @@ -1405,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-07-15 06:10+0000 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 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:20+0000 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 { @@ -1423,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-07-15 06:10+0000 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 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:20+0000 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 { @@ -1463,13 +1463,13 @@ 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-07-15 06:10+0000 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 + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:20+0000 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-07-15 06:10+0000 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 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:20+0000 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 { @@ -1479,13 +1479,13 @@ 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-07-15 06:10+0000 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 + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:20+0000 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-07-15 06:10+0000 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 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:20+0000 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 { @@ -1496,14 +1496,14 @@ 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-07-15 06:10+0000 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 + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:20+0000 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-07-15 06:10+0000 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 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:20+0000 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 { From 873c6b440370e6e8d30f142ab3304b125a02cb86 Mon Sep 17 00:00:00 2001 From: gateio Date: Tue, 15 Jul 2025 06:29:13 +0000 Subject: [PATCH 08/14] update to v6.102.0 --- docs/EarnUniApi.md | 8 +++--- .../java/io/gate/gateapi/api/EarnUniApi.java | 28 +++++++++---------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/EarnUniApi.md b/docs/EarnUniApi.md index fefd18b..38370c5 100644 --- a/docs/EarnUniApi.md +++ b/docs/EarnUniApi.md @@ -664,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-07-15 06:20+0000 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 +Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:28+0000 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 @@ -730,7 +730,7 @@ 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-07-15 06:20+0000 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 | - | +**200** | Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:28+0000 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** @@ -738,7 +738,7 @@ Name | Type | Description | Notes Currency estimate annualized interest rate -Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:20+0000 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 +Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:28+0000 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 @@ -796,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-07-15 06:20+0000 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 | - | +**200** | Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:28+0000 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/src/main/java/io/gate/gateapi/api/EarnUniApi.java b/src/main/java/io/gate/gateapi/api/EarnUniApi.java index b1ac890..9df0619 100644 --- a/src/main/java/io/gate/gateapi/api/EarnUniApi.java +++ b/src/main/java/io/gate/gateapi/api/EarnUniApi.java @@ -1289,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-07-15 06:20+0000 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 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:28+0000 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 { @@ -1356,7 +1356,7 @@ 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-07-15 06:20+0000 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 + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:28+0000 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, unit s, maximum span of 30 days (required) * @param to End timestamp, unit s, maximum span of 30 days (required) * @param asset Currency name (required) @@ -1365,7 +1365,7 @@ private okhttp3.Call listUniChartValidateBeforeCall(Long from, Long to, String a * @http.response.details - +
Status Code Description Response Headers
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:20+0000 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 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:28+0000 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 { @@ -1375,7 +1375,7 @@ 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-07-15 06:20+0000 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 + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:28+0000 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, unit s, maximum span of 30 days (required) * @param to End timestamp, unit s, maximum span of 30 days (required) * @param asset Currency name (required) @@ -1384,7 +1384,7 @@ public List listUniChart(Long from, Long to, String asset) th * @http.response.details - +
Status Code Description Response Headers
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:20+0000 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 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:28+0000 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 { @@ -1395,7 +1395,7 @@ 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-07-15 06:20+0000 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 + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:28+0000 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, unit s, maximum span of 30 days (required) * @param to End timestamp, unit s, maximum span of 30 days (required) * @param asset Currency name (required) @@ -1405,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-07-15 06:20+0000 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 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:28+0000 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 { @@ -1423,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-07-15 06:20+0000 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 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:28+0000 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 { @@ -1463,13 +1463,13 @@ 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-07-15 06:20+0000 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 + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:28+0000 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-07-15 06:20+0000 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 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:28+0000 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 { @@ -1479,13 +1479,13 @@ 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-07-15 06:20+0000 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 + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:28+0000 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-07-15 06:20+0000 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 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:28+0000 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 { @@ -1496,14 +1496,14 @@ 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-07-15 06:20+0000 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 + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:28+0000 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-07-15 06:20+0000 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 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:28+0000 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 { From a601a30f82db25fe5c3b6c9a96bfea1d469f9175 Mon Sep 17 00:00:00 2001 From: gateio Date: Tue, 15 Jul 2025 06:49:14 +0000 Subject: [PATCH 09/14] update to v6.102.1 --- README.md | 10 +++---- build.gradle | 2 +- build.sbt | 2 +- docs/EarnUniApi.md | 8 +++--- pom.xml | 2 +- src/main/java/io/gate/gateapi/ApiClient.java | 2 +- .../java/io/gate/gateapi/api/EarnUniApi.java | 28 +++++++++---------- 7 files changed, 27 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index dcbeb61..f517770 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ Gate API -- API version: v4.102.0 -- SDK version: 6.102.0 +- API version: v4.102.1 +- SDK version: 6.102.1 Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces @@ -53,7 +53,7 @@ Add this dependency to your project's POM: io.gate gate-api - 6.102.0 + 6.102.1 compile ``` @@ -63,7 +63,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.102.0" +compile "io.gate:gate-api:6.102.1" ``` ### Others @@ -76,7 +76,7 @@ mvn clean package Then manually install the following JARs: -* `target/gate-api-6.102.0.jar` +* `target/gate-api-6.102.1.jar` * `target/lib/*.jar` To install the API client library to your local Maven repository, simply execute: diff --git a/build.gradle b/build.gradle index 56c2a5a..35dcca4 100644 --- a/build.gradle +++ b/build.gradle @@ -3,7 +3,7 @@ apply plugin: 'eclipse' apply plugin: 'java' group = 'io.gate' -version = '6.102.0' +version = '6.102.1' buildscript { repositories { diff --git a/build.sbt b/build.sbt index ec2355f..93d796d 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.102.0", + version := "6.102.1", scalaVersion := "2.11.4", scalacOptions ++= Seq("-feature"), javacOptions in compile ++= Seq("-Xlint:deprecation"), diff --git a/docs/EarnUniApi.md b/docs/EarnUniApi.md index 38370c5..f7ec8af 100644 --- a/docs/EarnUniApi.md +++ b/docs/EarnUniApi.md @@ -664,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-07-15 06:28+0000 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 +Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:48+0000 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 @@ -730,7 +730,7 @@ 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-07-15 06:28+0000 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 | - | +**200** | Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:48+0000 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** @@ -738,7 +738,7 @@ Name | Type | Description | Notes Currency estimate annualized interest rate -Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:28+0000 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 +Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:48+0000 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 @@ -796,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-07-15 06:28+0000 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 | - | +**200** | Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:48+0000 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/pom.xml b/pom.xml index 03fbc9e..5321e32 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ gate-api jar gate-api - 6.102.0 + 6.102.1 https://github.com/gateio/gateapi-java.git Java client for gateapi diff --git a/src/main/java/io/gate/gateapi/ApiClient.java b/src/main/java/io/gate/gateapi/ApiClient.java index aba0da8..cced6ac 100644 --- a/src/main/java/io/gate/gateapi/ApiClient.java +++ b/src/main/java/io/gate/gateapi/ApiClient.java @@ -113,7 +113,7 @@ private void init() { json = new JSON(); // Set default User-Agent. - setUserAgent("OpenAPI-Generator/6.102.0/java"); + setUserAgent("OpenAPI-Generator/6.102.1/java"); authentications = new HashMap(); } diff --git a/src/main/java/io/gate/gateapi/api/EarnUniApi.java b/src/main/java/io/gate/gateapi/api/EarnUniApi.java index 9df0619..989782c 100644 --- a/src/main/java/io/gate/gateapi/api/EarnUniApi.java +++ b/src/main/java/io/gate/gateapi/api/EarnUniApi.java @@ -1289,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-07-15 06:28+0000 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 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:48+0000 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 { @@ -1356,7 +1356,7 @@ 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-07-15 06:28+0000 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 + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:48+0000 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, unit s, maximum span of 30 days (required) * @param to End timestamp, unit s, maximum span of 30 days (required) * @param asset Currency name (required) @@ -1365,7 +1365,7 @@ private okhttp3.Call listUniChartValidateBeforeCall(Long from, Long to, String a * @http.response.details - +
Status Code Description Response Headers
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:28+0000 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 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:48+0000 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 { @@ -1375,7 +1375,7 @@ 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-07-15 06:28+0000 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 + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:48+0000 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, unit s, maximum span of 30 days (required) * @param to End timestamp, unit s, maximum span of 30 days (required) * @param asset Currency name (required) @@ -1384,7 +1384,7 @@ public List listUniChart(Long from, Long to, String asset) th * @http.response.details - +
Status Code Description Response Headers
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:28+0000 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 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:48+0000 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 { @@ -1395,7 +1395,7 @@ 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-07-15 06:28+0000 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 + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:48+0000 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, unit s, maximum span of 30 days (required) * @param to End timestamp, unit s, maximum span of 30 days (required) * @param asset Currency name (required) @@ -1405,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-07-15 06:28+0000 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 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:48+0000 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 { @@ -1423,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-07-15 06:28+0000 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 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:48+0000 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 { @@ -1463,13 +1463,13 @@ 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-07-15 06:28+0000 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 + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:48+0000 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-07-15 06:28+0000 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 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:48+0000 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 { @@ -1479,13 +1479,13 @@ 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-07-15 06:28+0000 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 + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:48+0000 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-07-15 06:28+0000 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 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:48+0000 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 { @@ -1496,14 +1496,14 @@ 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-07-15 06:28+0000 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 + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:48+0000 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-07-15 06:28+0000 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 -
200 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:48+0000 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 { From 7578f609975806e36eab175fb53fa956a1751435 Mon Sep 17 00:00:00 2001 From: gateio Date: Tue, 22 Jul 2025 02:05:41 +0000 Subject: [PATCH 10/14] update to v6.102.6 --- README.md | 562 ++++---- build.gradle | 2 +- build.sbt | 2 +- docs/AccountApi.md | 74 +- docs/AccountBalance.md | 8 +- docs/AccountDetail.md | 12 +- docs/AccountDetailKey.md | 4 +- docs/AccountRateLimit.md | 6 +- docs/AgencyCommission.md | 12 +- docs/AgencyCommissionHistory.md | 6 +- docs/AgencyTransaction.md | 18 +- docs/AgencyTransactionHistory.md | 6 +- docs/AutoRepaySetting.md | 2 +- docs/BatchAmendItem.md | 6 +- docs/BatchAmendOrderReq.md | 10 +- docs/BatchFuturesOrder.md | 42 +- docs/BatchOrder.md | 58 +- docs/BorrowCurrencyInfo.md | 10 +- docs/BrokerCommission.md | 4 +- docs/BrokerCommission1.md | 19 +- docs/BrokerCommissionSubBrokerInfo.md | 10 +- docs/BrokerTransaction.md | 4 +- docs/BrokerTransaction1.md | 17 +- docs/CancelBatchOrder.md | 4 +- docs/CancelOrderResult.md | 16 +- docs/CollateralAdjust.md | 4 +- docs/CollateralAdjustRes.md | 6 +- docs/CollateralAlign.md | 6 +- docs/CollateralCurrency.md | 4 +- docs/CollateralCurrencyInfo.md | 8 +- docs/CollateralCurrencyRes.md | 4 +- docs/CollateralCurrentRate.md | 6 +- docs/CollateralFixRate.md | 10 +- docs/CollateralLoanApi.md | 140 +- docs/CollateralLoanCurrency.md | 6 +- docs/CollateralLtv.md | 8 +- docs/CollateralOrder.md | 30 +- docs/CollateralRecord.md | 22 +- docs/Contract.md | 72 +- docs/ContractStat.md | 26 +- docs/ConvertSmallBalance.md | 6 +- docs/CountdownCancelAllFuturesTask.md | 4 +- docs/CountdownCancelAllOptionsTask.md | 6 +- docs/CountdownCancelAllSpotTask.md | 4 +- docs/CreateCollateralOrder.md | 8 +- docs/CreateMultiCollateralOrder.md | 16 +- docs/CreateUniLend.md | 8 +- docs/CreateUniLoan.md | 12 +- docs/CrossMarginBalance.md | 8 +- docs/CrossMarginLoan.md | 18 +- docs/CrossMarginRepayment.md | 14 +- docs/Currency.md | 18 +- docs/CurrencyChain.md | 14 +- docs/CurrencyPair.md | 40 +- docs/CurrencyQuota.md | 12 +- docs/DebitFee.md | 2 +- docs/DeliveryApi.md | 514 +++---- docs/DeliveryCandlestick.md | 14 +- docs/DeliveryContract.md | 76 +- docs/DeliverySettlement.md | 18 +- docs/DeliveryTicker.md | 38 +- docs/DepositAddress.md | 4 +- docs/DepositRecord.md | 16 +- docs/DualGetOrders.md | 32 +- docs/DualGetPlans.md | 24 +- docs/EarnApi.md | 98 +- docs/EarnUniApi.md | 138 +- docs/Eth2RateList.md | 6 +- docs/Eth2Swap.md | 6 +- docs/FindCoin.md | 4 +- docs/FlashSwapApi.md | 58 +- docs/FlashSwapCurrencyPair.md | 14 +- docs/FlashSwapOrder.md | 18 +- docs/FlashSwapOrderPreview.md | 10 +- docs/FlashSwapOrderRequest.md | 8 +- docs/FlashSwapPreviewRequest.md | 2 +- docs/FundingAccount.md | 10 +- docs/FundingRateRecord.md | 4 +- docs/FutureCancelOrderResult.md | 10 +- docs/FuturesAccount.md | 30 +- docs/FuturesAccountBook.md | 14 +- docs/FuturesAccountHistory.md | 22 +- docs/FuturesApi.md | 874 +++++------ docs/FuturesAutoDeleverage.md | 20 +- docs/FuturesBatchAmendOrderRequest.md | 10 +- docs/FuturesCandlestick.md | 16 +- docs/FuturesFee.md | 6 +- docs/FuturesIndexConstituents.md | 4 +- docs/FuturesInitialOrder.md | 10 +- docs/FuturesLimitRiskTiers.md | 14 +- docs/FuturesLiqOrder.md | 14 +- docs/FuturesLiquidate.md | 12 +- docs/FuturesOrder.md | 43 +- docs/FuturesOrderAmendment.md | 4 +- docs/FuturesOrderBook.md | 8 +- docs/FuturesOrderBookItem.md | 4 +- docs/FuturesPositionCrossMode.md | 4 +- docs/FuturesPremiumIndex.md | 12 +- docs/FuturesPriceTrigger.md | 6 +- docs/FuturesPriceTriggeredOrder.md | 20 +- docs/FuturesRiskLimitTier.md | 14 +- docs/FuturesTicker.md | 34 +- docs/FuturesTrade.md | 12 +- docs/IndexConstituent.md | 4 +- docs/InlineResponse2001.md | 2 +- docs/InsuranceRecord.md | 4 +- docs/LedgerRecord.md | 16 +- docs/LiquidateOrder.md | 8 +- docs/MarginAccount.md | 10 +- docs/MarginAccountBook.md | 16 +- docs/MarginAccountCurrency.md | 10 +- docs/MarginApi.md | 144 +- docs/MarginLeverageTier.md | 8 +- docs/MarginMarketLeverage.md | 6 +- docs/MarginTiers.md | 10 +- docs/MarginTransferable.md | 6 +- docs/MarginUniApi.md | 116 +- docs/MaxUniBorrowable.md | 6 +- docs/MockFuturesOrder.md | 4 +- docs/MockFuturesPosition.md | 2 +- docs/MockMarginResult.md | 14 +- docs/MockOptionsOrder.md | 6 +- docs/MockOptionsPosition.md | 2 +- docs/MockRiskUnit.md | 20 +- docs/MockSpotBalance.md | 4 +- docs/MockSpotOrder.md | 6 +- docs/MultiChainAddressItem.md | 8 +- docs/MultiCollateralCurrency.md | 4 +- docs/MultiCollateralItem.md | 6 +- docs/MultiCollateralLoanApi.md | 144 +- docs/MultiCollateralOrder.md | 24 +- docs/MultiCollateralRecord.md | 12 +- docs/MultiCollateralRecordCurrency.md | 6 +- docs/MultiLoanItem.md | 4 +- docs/MultiLoanRepayItem.md | 4 +- docs/MultiRepayRecord.md | 22 +- docs/MultiRepayResp.md | 6 +- docs/MyFuturesTrade.md | 22 +- docs/MyFuturesTradeTimeRange.md | 22 +- docs/OpenOrders.md | 2 +- docs/OptionsAccount.md | 32 +- docs/OptionsAccountBook.md | 10 +- docs/OptionsApi.md | 348 ++--- docs/OptionsCandlestick.md | 12 +- docs/OptionsContract.md | 52 +- docs/OptionsMMP.md | 10 +- docs/OptionsMMPReset.md | 10 +- docs/OptionsMySettlements.md | 16 +- docs/OptionsMyTrade.md | 16 +- docs/OptionsOrder.md | 40 +- docs/OptionsPosition.md | 32 +- docs/OptionsPositionClose.md | 12 +- docs/OptionsPositionCloseOrder.md | 8 +- docs/OptionsSettlement.md | 12 +- docs/OptionsTicker.md | 38 +- docs/OptionsUnderlying.md | 4 +- docs/OptionsUnderlyingTicker.md | 8 +- docs/Order.md | 56 +- docs/OrderBook.md | 8 +- docs/OrderCancel.md | 60 +- docs/OrderPatch.md | 10 +- docs/OrderResp.md | 2 +- docs/PartnerCommissionHistory.md | 4 +- docs/PartnerSub.md | 6 +- docs/PartnerSubList.md | 4 +- docs/PartnerTransactionHistory.md | 4 +- docs/PatchUniLend.md | 4 +- docs/PlaceDualInvestmentOrder.md | 6 +- docs/Position.md | 56 +- docs/PositionClose.md | 26 +- docs/PositionCloseOrder.md | 8 +- docs/ProfitLossRange.md | 8 +- docs/RebateApi.md | 214 +-- docs/RebateUserInfo.md | 4 +- docs/RepayCurrencyRes.md | 8 +- docs/RepayLoan.md | 8 +- docs/RepayMultiLoan.md | 6 +- docs/RepayRecord.md | 28 +- docs/RepayRecordCurrency.md | 6 +- docs/RepayRecordLeftInterest.md | 12 +- docs/RepayRecordRepaidCurrency.md | 12 +- docs/RepayRecordTotalInterest.md | 8 +- docs/RepayResp.md | 6 +- docs/RiskUnits.md | 16 +- docs/SavedAddress.md | 12 +- docs/SmallBalance.md | 10 +- docs/SmallBalanceHistory.md | 12 +- docs/SpotAccount.md | 8 +- docs/SpotAccountBook.md | 16 +- docs/SpotApi.md | 420 +++--- docs/SpotCurrencyChain.md | 10 +- docs/SpotFee.md | 14 +- docs/SpotInsuranceHistory.md | 6 +- docs/SpotPricePutOrder.md | 8 +- docs/SpotPriceTrigger.md | 4 +- docs/SpotPriceTriggeredOrder.md | 16 +- docs/StpGroup.md | 8 +- docs/StpGroupUser.md | 6 +- docs/StructuredBuy.md | 6 +- docs/StructuredGetProjectList.md | 22 +- docs/StructuredOrderList.md | 14 +- docs/SubAccount.md | 12 +- docs/SubAccountApi.md | 110 +- docs/SubAccountBalance.md | 4 +- docs/SubAccountCrossMarginBalance.md | 2 +- docs/SubAccountFuturesBalance.md | 4 +- docs/SubAccountKey.md | 18 +- docs/SubAccountKeyPerms.md | 2 +- docs/SubAccountMarginBalance.md | 4 +- docs/SubAccountToSubAccount.md | 8 +- docs/SubAccountTransfer.md | 6 +- docs/SubAccountTransferRecordItem.md | 14 +- docs/SubCrossMarginAccount.md | 20 +- docs/SubUserMode.md | 4 +- docs/SwapCoin.md | 10 +- docs/SwapCoinStruct.md | 24 +- docs/SystemTime.md | 2 +- docs/Ticker.md | 30 +- docs/TotalBalance.md | 2 +- docs/Trade.md | 30 +- docs/TradeFee.md | 20 +- docs/TransactionID.md | 2 +- docs/Transfer.md | 8 +- docs/TransferOrderStatus.md | 2 +- docs/TransferablesResult.md | 6 +- docs/TriggerOrderResponse.md | 2 +- docs/TriggerTime.md | 2 +- docs/UidPushOrder.md | 16 +- docs/UidPushWithdrawal.md | 6 +- docs/UidPushWithdrawalResp.md | 2 +- docs/UniCurrency.md | 10 +- docs/UniCurrencyInterest.md | 4 +- docs/UniCurrencyPair.md | 10 +- docs/UniInterestRecord.md | 14 +- docs/UniLend.md | 22 +- docs/UniLendInterest.md | 4 +- docs/UniLendRecord.md | 16 +- docs/UniLoan.md | 14 +- docs/UniLoanInterestRecord.md | 16 +- docs/UniLoanRecord.md | 12 +- docs/UnifiedAccount.md | 12 +- docs/UnifiedApi.md | 232 +-- docs/UnifiedBalance.md | 8 +- docs/UnifiedBorrowable.md | 4 +- docs/UnifiedBorrowable1.md | 6 +- docs/UnifiedCollateralReq.md | 4 +- docs/UnifiedCollateralRes.md | 4 +- docs/UnifiedCurrency.md | 10 +- docs/UnifiedDiscount.md | 6 +- docs/UnifiedDiscountTiers.md | 10 +- docs/UnifiedHistoryLoanRate.md | 6 +- docs/UnifiedHistoryLoanRateRates.md | 4 +- docs/UnifiedLeverageConfig.md | 14 +- docs/UnifiedLeverageSetting.md | 6 +- docs/UnifiedLoan.md | 10 +- docs/UnifiedLoanRecord.md | 16 +- docs/UnifiedLoanResult.md | 4 +- docs/UnifiedMarginTiers.md | 6 +- docs/UnifiedPortfolioInput.md | 12 +- docs/UnifiedPortfolioOutput.md | 6 +- docs/UnifiedRiskUnits.md | 4 +- docs/UnifiedSettings.md | 2 +- docs/UnifiedTransferable.md | 4 +- docs/UserLtvInfo.md | 16 +- docs/UserSub.md | 6 +- docs/UserSubRelation.md | 2 +- docs/UserTotalAmount.md | 6 +- docs/WalletApi.md | 244 ++-- docs/WithdrawStatus.md | 24 +- docs/WithdrawalApi.md | 16 +- docs/WithdrawalRecord.md | 22 +- pom.xml | 2 +- src/main/java/io/gate/gateapi/ApiClient.java | 2 +- .../java/io/gate/gateapi/api/AccountApi.java | 158 +- .../gate/gateapi/api/CollateralLoanApi.java | 190 +-- .../java/io/gate/gateapi/api/DeliveryApi.java | 754 +++++----- .../java/io/gate/gateapi/api/EarnApi.java | 156 +- .../java/io/gate/gateapi/api/EarnUniApi.java | 240 ++-- .../io/gate/gateapi/api/FlashSwapApi.java | 86 +- .../java/io/gate/gateapi/api/FuturesApi.java | 1274 ++++++++--------- .../java/io/gate/gateapi/api/MarginApi.java | 208 +-- .../io/gate/gateapi/api/MarginUniApi.java | 164 +-- .../gateapi/api/MultiCollateralLoanApi.java | 214 +-- .../java/io/gate/gateapi/api/OptionsApi.java | 508 +++---- .../java/io/gate/gateapi/api/RebateApi.java | 210 +-- .../java/io/gate/gateapi/api/SpotApi.java | 634 ++++---- .../io/gate/gateapi/api/SubAccountApi.java | 240 ++-- .../java/io/gate/gateapi/api/UnifiedApi.java | 378 ++--- .../java/io/gate/gateapi/api/WalletApi.java | 350 ++--- .../io/gate/gateapi/api/WithdrawalApi.java | 34 +- .../gate/gateapi/models/AccountBalance.java | 10 +- .../io/gate/gateapi/models/AccountDetail.java | 12 +- .../gate/gateapi/models/AccountDetailKey.java | 4 +- .../gate/gateapi/models/AccountRateLimit.java | 6 +- .../gate/gateapi/models/AgencyCommission.java | 12 +- .../models/AgencyCommissionHistory.java | 6 +- .../gateapi/models/AgencyTransaction.java | 18 +- .../models/AgencyTransactionHistory.java | 6 +- .../gate/gateapi/models/AutoRepaySetting.java | 4 +- .../gate/gateapi/models/BatchAmendItem.java | 6 +- .../gateapi/models/BatchAmendOrderReq.java | 10 +- .../gateapi/models/BatchFuturesOrder.java | 46 +- .../io/gate/gateapi/models/BatchOrder.java | 62 +- .../gateapi/models/BorrowCurrencyInfo.java | 10 +- .../gate/gateapi/models/BrokerCommission.java | 4 +- .../gateapi/models/BrokerCommission1.java | 48 +- .../models/BrokerCommissionSubBrokerInfo.java | 10 +- .../gateapi/models/BrokerTransaction.java | 4 +- .../gateapi/models/BrokerTransaction1.java | 46 +- .../gate/gateapi/models/CancelBatchOrder.java | 4 +- .../gateapi/models/CancelOrderResult.java | 16 +- .../gate/gateapi/models/CollateralAdjust.java | 4 +- .../gateapi/models/CollateralAdjustRes.java | 6 +- .../gate/gateapi/models/CollateralAlign.java | 6 +- .../gateapi/models/CollateralCurrency.java | 4 +- .../models/CollateralCurrencyInfo.java | 8 +- .../gateapi/models/CollateralCurrencyRes.java | 4 +- .../gateapi/models/CollateralCurrentRate.java | 6 +- .../gateapi/models/CollateralFixRate.java | 10 +- .../models/CollateralLoanCurrency.java | 6 +- .../io/gate/gateapi/models/CollateralLtv.java | 8 +- .../gate/gateapi/models/CollateralOrder.java | 30 +- .../gate/gateapi/models/CollateralRecord.java | 22 +- .../java/io/gate/gateapi/models/Contract.java | 76 +- .../io/gate/gateapi/models/ContractStat.java | 26 +- .../gateapi/models/ConvertSmallBalance.java | 6 +- .../models/CountdownCancelAllFuturesTask.java | 4 +- .../models/CountdownCancelAllOptionsTask.java | 6 +- .../models/CountdownCancelAllSpotTask.java | 4 +- .../gateapi/models/CreateCollateralOrder.java | 8 +- .../models/CreateMultiCollateralOrder.java | 16 +- .../io/gate/gateapi/models/CreateUniLend.java | 10 +- .../io/gate/gateapi/models/CreateUniLoan.java | 14 +- .../gateapi/models/CrossMarginBalance.java | 8 +- .../gate/gateapi/models/CrossMarginLoan.java | 18 +- .../gateapi/models/CrossMarginRepayment.java | 14 +- .../java/io/gate/gateapi/models/Currency.java | 18 +- .../io/gate/gateapi/models/CurrencyChain.java | 14 +- .../io/gate/gateapi/models/CurrencyPair.java | 42 +- .../io/gate/gateapi/models/CurrencyQuota.java | 12 +- .../java/io/gate/gateapi/models/DebitFee.java | 2 +- .../gateapi/models/DeliveryCandlestick.java | 14 +- .../gate/gateapi/models/DeliveryContract.java | 82 +- .../gateapi/models/DeliverySettlement.java | 18 +- .../gate/gateapi/models/DeliveryTicker.java | 38 +- .../gate/gateapi/models/DepositAddress.java | 4 +- .../io/gate/gateapi/models/DepositRecord.java | 16 +- .../io/gate/gateapi/models/DualGetOrders.java | 32 +- .../io/gate/gateapi/models/DualGetPlans.java | 24 +- .../io/gate/gateapi/models/Eth2RateList.java | 6 +- .../java/io/gate/gateapi/models/Eth2Swap.java | 6 +- .../java/io/gate/gateapi/models/FindCoin.java | 4 +- .../gateapi/models/FlashSwapCurrencyPair.java | 14 +- .../gate/gateapi/models/FlashSwapOrder.java | 18 +- .../gateapi/models/FlashSwapOrderPreview.java | 10 +- .../gateapi/models/FlashSwapOrderRequest.java | 8 +- .../models/FlashSwapPreviewRequest.java | 2 +- .../gate/gateapi/models/FundingAccount.java | 10 +- .../gateapi/models/FundingRateRecord.java | 4 +- .../models/FutureCancelOrderResult.java | 10 +- .../gate/gateapi/models/FuturesAccount.java | 30 +- .../gateapi/models/FuturesAccountBook.java | 16 +- .../gateapi/models/FuturesAccountHistory.java | 22 +- .../gateapi/models/FuturesAutoDeleverage.java | 20 +- .../models/FuturesBatchAmendOrderRequest.java | 10 +- .../gateapi/models/FuturesCandlestick.java | 16 +- .../io/gate/gateapi/models/FuturesFee.java | 6 +- .../models/FuturesIndexConstituents.java | 4 +- .../gateapi/models/FuturesInitialOrder.java | 12 +- .../gateapi/models/FuturesLimitRiskTiers.java | 14 +- .../gate/gateapi/models/FuturesLiqOrder.java | 14 +- .../gate/gateapi/models/FuturesLiquidate.java | 12 +- .../io/gate/gateapi/models/FuturesOrder.java | 66 +- .../gateapi/models/FuturesOrderAmendment.java | 58 +- .../gate/gateapi/models/FuturesOrderBook.java | 8 +- .../gateapi/models/FuturesOrderBookItem.java | 4 +- .../models/FuturesPositionCrossMode.java | 4 +- .../gateapi/models/FuturesPremiumIndex.java | 12 +- .../gateapi/models/FuturesPriceTrigger.java | 10 +- .../models/FuturesPriceTriggeredOrder.java | 24 +- .../gateapi/models/FuturesRiskLimitTier.java | 14 +- .../io/gate/gateapi/models/FuturesTicker.java | 34 +- .../io/gate/gateapi/models/FuturesTrade.java | 12 +- .../gate/gateapi/models/IndexConstituent.java | 4 +- .../gateapi/models/InlineResponse2001.java | 2 +- .../gate/gateapi/models/InsuranceRecord.java | 4 +- .../io/gate/gateapi/models/LedgerRecord.java | 16 +- .../gate/gateapi/models/LiquidateOrder.java | 8 +- .../io/gate/gateapi/models/MarginAccount.java | 10 +- .../gateapi/models/MarginAccountBook.java | 16 +- .../gateapi/models/MarginAccountCurrency.java | 10 +- .../gateapi/models/MarginLeverageTier.java | 8 +- .../gateapi/models/MarginMarketLeverage.java | 6 +- .../io/gate/gateapi/models/MarginTiers.java | 10 +- .../gateapi/models/MarginTransferable.java | 6 +- .../gate/gateapi/models/MaxUniBorrowable.java | 6 +- .../gate/gateapi/models/MockFuturesOrder.java | 4 +- .../gateapi/models/MockFuturesPosition.java | 2 +- .../gate/gateapi/models/MockMarginResult.java | 14 +- .../gate/gateapi/models/MockOptionsOrder.java | 6 +- .../gateapi/models/MockOptionsPosition.java | 2 +- .../io/gate/gateapi/models/MockRiskUnit.java | 20 +- .../gate/gateapi/models/MockSpotBalance.java | 4 +- .../io/gate/gateapi/models/MockSpotOrder.java | 6 +- .../gateapi/models/MultiChainAddressItem.java | 8 +- .../models/MultiCollateralCurrency.java | 4 +- .../gateapi/models/MultiCollateralItem.java | 6 +- .../gateapi/models/MultiCollateralOrder.java | 24 +- .../gateapi/models/MultiCollateralRecord.java | 12 +- .../models/MultiCollateralRecordCurrency.java | 6 +- .../io/gate/gateapi/models/MultiLoanItem.java | 4 +- .../gateapi/models/MultiLoanRepayItem.java | 4 +- .../gate/gateapi/models/MultiRepayRecord.java | 22 +- .../gate/gateapi/models/MultiRepayResp.java | 6 +- .../gate/gateapi/models/MyFuturesTrade.java | 24 +- .../models/MyFuturesTradeTimeRange.java | 24 +- .../io/gate/gateapi/models/OpenOrders.java | 2 +- .../gate/gateapi/models/OptionsAccount.java | 32 +- .../gateapi/models/OptionsAccountBook.java | 10 +- .../gateapi/models/OptionsCandlestick.java | 12 +- .../gate/gateapi/models/OptionsContract.java | 52 +- .../io/gate/gateapi/models/OptionsMMP.java | 10 +- .../gate/gateapi/models/OptionsMMPReset.java | 10 +- .../gateapi/models/OptionsMySettlements.java | 16 +- .../gate/gateapi/models/OptionsMyTrade.java | 18 +- .../io/gate/gateapi/models/OptionsOrder.java | 42 +- .../gate/gateapi/models/OptionsPosition.java | 32 +- .../gateapi/models/OptionsPositionClose.java | 14 +- .../models/OptionsPositionCloseOrder.java | 8 +- .../gateapi/models/OptionsSettlement.java | 12 +- .../io/gate/gateapi/models/OptionsTicker.java | 38 +- .../gateapi/models/OptionsUnderlying.java | 4 +- .../models/OptionsUnderlyingTicker.java | 8 +- .../java/io/gate/gateapi/models/Order.java | 62 +- .../io/gate/gateapi/models/OrderBook.java | 8 +- .../io/gate/gateapi/models/OrderCancel.java | 64 +- .../io/gate/gateapi/models/OrderPatch.java | 10 +- .../io/gate/gateapi/models/OrderResp.java | 2 +- .../models/PartnerCommissionHistory.java | 4 +- .../io/gate/gateapi/models/PartnerSub.java | 6 +- .../gate/gateapi/models/PartnerSubList.java | 4 +- .../models/PartnerTransactionHistory.java | 4 +- .../io/gate/gateapi/models/PatchUniLend.java | 4 +- .../models/PlaceDualInvestmentOrder.java | 6 +- .../java/io/gate/gateapi/models/Position.java | 58 +- .../io/gate/gateapi/models/PositionClose.java | 28 +- .../gateapi/models/PositionCloseOrder.java | 8 +- .../gate/gateapi/models/ProfitLossRange.java | 8 +- .../gate/gateapi/models/RebateUserInfo.java | 4 +- .../gate/gateapi/models/RepayCurrencyRes.java | 8 +- .../io/gate/gateapi/models/RepayLoan.java | 8 +- .../gate/gateapi/models/RepayMultiLoan.java | 6 +- .../io/gate/gateapi/models/RepayRecord.java | 28 +- .../gateapi/models/RepayRecordCurrency.java | 6 +- .../models/RepayRecordLeftInterest.java | 12 +- .../models/RepayRecordRepaidCurrency.java | 12 +- .../models/RepayRecordTotalInterest.java | 8 +- .../io/gate/gateapi/models/RepayResp.java | 6 +- .../io/gate/gateapi/models/RiskUnits.java | 16 +- .../io/gate/gateapi/models/SavedAddress.java | 12 +- .../io/gate/gateapi/models/SmallBalance.java | 10 +- .../gateapi/models/SmallBalanceHistory.java | 12 +- .../io/gate/gateapi/models/SpotAccount.java | 8 +- .../gate/gateapi/models/SpotAccountBook.java | 16 +- .../gateapi/models/SpotCurrencyChain.java | 10 +- .../java/io/gate/gateapi/models/SpotFee.java | 14 +- .../gateapi/models/SpotInsuranceHistory.java | 6 +- .../gateapi/models/SpotPricePutOrder.java | 8 +- .../gate/gateapi/models/SpotPriceTrigger.java | 6 +- .../models/SpotPriceTriggeredOrder.java | 16 +- .../java/io/gate/gateapi/models/StpGroup.java | 8 +- .../io/gate/gateapi/models/StpGroupUser.java | 6 +- .../io/gate/gateapi/models/StructuredBuy.java | 6 +- .../models/StructuredGetProjectList.java | 22 +- .../gateapi/models/StructuredOrderList.java | 14 +- .../io/gate/gateapi/models/SubAccount.java | 12 +- .../gateapi/models/SubAccountBalance.java | 4 +- .../models/SubAccountCrossMarginBalance.java | 2 +- .../models/SubAccountFuturesBalance.java | 4 +- .../io/gate/gateapi/models/SubAccountKey.java | 18 +- .../gateapi/models/SubAccountKeyPerms.java | 2 +- .../models/SubAccountMarginBalance.java | 4 +- .../models/SubAccountToSubAccount.java | 8 +- .../gateapi/models/SubAccountTransfer.java | 6 +- .../models/SubAccountTransferRecordItem.java | 14 +- .../gateapi/models/SubCrossMarginAccount.java | 20 +- .../io/gate/gateapi/models/SubUserMode.java | 4 +- .../java/io/gate/gateapi/models/SwapCoin.java | 10 +- .../gate/gateapi/models/SwapCoinStruct.java | 224 ++- .../io/gate/gateapi/models/SystemTime.java | 2 +- .../java/io/gate/gateapi/models/Ticker.java | 30 +- .../io/gate/gateapi/models/TotalBalance.java | 2 +- .../java/io/gate/gateapi/models/Trade.java | 34 +- .../java/io/gate/gateapi/models/TradeFee.java | 20 +- .../io/gate/gateapi/models/TransactionID.java | 2 +- .../java/io/gate/gateapi/models/Transfer.java | 12 +- .../gateapi/models/TransferOrderStatus.java | 2 +- .../gateapi/models/TransferablesResult.java | 6 +- .../gateapi/models/TriggerOrderResponse.java | 2 +- .../io/gate/gateapi/models/TriggerTime.java | 2 +- .../io/gate/gateapi/models/UidPushOrder.java | 16 +- .../gateapi/models/UidPushWithdrawal.java | 6 +- .../gateapi/models/UidPushWithdrawalResp.java | 2 +- .../io/gate/gateapi/models/UniCurrency.java | 10 +- .../gateapi/models/UniCurrencyInterest.java | 4 +- .../gate/gateapi/models/UniCurrencyPair.java | 10 +- .../gateapi/models/UniInterestRecord.java | 14 +- .../java/io/gate/gateapi/models/UniLend.java | 22 +- .../gate/gateapi/models/UniLendInterest.java | 4 +- .../io/gate/gateapi/models/UniLendRecord.java | 16 +- .../java/io/gate/gateapi/models/UniLoan.java | 14 +- .../gateapi/models/UniLoanInterestRecord.java | 16 +- .../io/gate/gateapi/models/UniLoanRecord.java | 12 +- .../gate/gateapi/models/UnifiedAccount.java | 12 +- .../gate/gateapi/models/UnifiedBalance.java | 8 +- .../gateapi/models/UnifiedBorrowable.java | 4 +- .../gateapi/models/UnifiedBorrowable1.java | 6 +- .../gateapi/models/UnifiedCollateralReq.java | 6 +- .../gateapi/models/UnifiedCollateralRes.java | 4 +- .../gate/gateapi/models/UnifiedCurrency.java | 10 +- .../gate/gateapi/models/UnifiedDiscount.java | 6 +- .../gateapi/models/UnifiedDiscountTiers.java | 10 +- .../models/UnifiedHistoryLoanRate.java | 6 +- .../models/UnifiedHistoryLoanRateRates.java | 4 +- .../gateapi/models/UnifiedLeverageConfig.java | 14 +- .../models/UnifiedLeverageSetting.java | 6 +- .../io/gate/gateapi/models/UnifiedLoan.java | 12 +- .../gateapi/models/UnifiedLoanRecord.java | 16 +- .../gateapi/models/UnifiedLoanResult.java | 4 +- .../gateapi/models/UnifiedMarginTiers.java | 6 +- .../gateapi/models/UnifiedPortfolioInput.java | 12 +- .../models/UnifiedPortfolioOutput.java | 6 +- .../gate/gateapi/models/UnifiedRiskUnits.java | 4 +- .../gate/gateapi/models/UnifiedSettings.java | 2 +- .../gateapi/models/UnifiedTransferable.java | 4 +- .../io/gate/gateapi/models/UserLtvInfo.java | 16 +- .../java/io/gate/gateapi/models/UserSub.java | 6 +- .../gate/gateapi/models/UserSubRelation.java | 2 +- .../gate/gateapi/models/UserTotalAmount.java | 6 +- .../gate/gateapi/models/WithdrawStatus.java | 24 +- .../gate/gateapi/models/WithdrawalRecord.java | 22 +- 541 files changed, 8512 insertions(+), 8367 deletions(-) diff --git a/README.md b/README.md index f517770..b4f2253 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ Gate API -- API version: v4.102.1 -- SDK version: 6.102.1 +- API version: v4.102.6 +- SDK version: 6.102.6 Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces @@ -53,7 +53,7 @@ Add this dependency to your project's POM: io.gate gate-api - 6.102.1 + 6.102.6 compile ``` @@ -63,7 +63,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.102.1" +compile "io.gate:gate-api:6.102.6" ``` ### Others @@ -76,7 +76,7 @@ mvn clean package Then manually install the following JARs: -* `target/gate-api-6.102.1.jar` +* `target/gate-api-6.102.6.jar` * `target/lib/*.jar` To install the API client library to your local Maven repository, simply execute: @@ -141,287 +141,287 @@ 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* | [**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* | [**getAccountDetail**](docs/AccountApi.md#getAccountDetail) | **GET** /account/detail | Get account detail. +*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 -*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* | [**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* | [**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 -*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* | [**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 -*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 | 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* | [**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 -*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* | [**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 -*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* | [**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* | [**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* | [**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* | [**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 | 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 -*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* | [**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* | [**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 -*MarginApi* | [**listCrossMarginLoans**](docs/MarginApi.md#listCrossMarginLoans) | **GET** /margin/cross/loans | List cross margin borrow history. (deprecated) -*MarginApi* | [**listCrossMarginRepayments**](docs/MarginApi.md#listCrossMarginRepayments) | **GET** /margin/cross/repayments | Retrieve cross margin repayments. (deprecated) -*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* | [**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 -*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 -*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* | [**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* | [**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 +*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. +*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* | [**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* | [**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. +*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* | [**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. +*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 | 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* | [**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. +*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* | [**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. +*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* | [**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* | [**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* | [**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* | [**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 | 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. +*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* | [**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* | [**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. +*MarginApi* | [**listCrossMarginLoans**](docs/MarginApi.md#listCrossMarginLoans) | **GET** /margin/cross/loans | List cross margin borrow history. (deprecated). +*MarginApi* | [**listCrossMarginRepayments**](docs/MarginApi.md#listCrossMarginRepayments) | **GET** /margin/cross/repayments | Retrieve cross margin repayments. (deprecated). +*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* | [**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. +*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. +*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* | [**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* | [**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* | [**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* | [**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 -*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* | [**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* | [**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 -*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* | [**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 +*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* | [**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. +*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* | [**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* | [**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. +*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* | [**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* | [**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* | [**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* | [**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* | [**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 -*UnifiedApi* | [**setUnifiedCollateral**](docs/UnifiedApi.md#setUnifiedCollateral) | **POST** /unified/collateral_currencies | Set Collateral Currency -*WalletApi* | [**listCurrencyChains**](docs/WalletApi.md#listCurrencyChains) | **GET** /wallet/currency_chains | List 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* | [**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* | [**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* | [**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 -*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 +*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* | [**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* | [**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* | [**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* | [**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. +*UnifiedApi* | [**setUnifiedCollateral**](docs/UnifiedApi.md#setUnifiedCollateral) | **POST** /unified/collateral_currencies | Set Collateral Currency. +*WalletApi* | [**listCurrencyChains**](docs/WalletApi.md#listCurrencyChains) | **GET** /wallet/currency_chains | List 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* | [**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* | [**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* | [**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. +*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. ## Documentation for Models diff --git a/build.gradle b/build.gradle index 35dcca4..8def177 100644 --- a/build.gradle +++ b/build.gradle @@ -3,7 +3,7 @@ apply plugin: 'eclipse' apply plugin: 'java' group = 'io.gate' -version = '6.102.1' +version = '6.102.6' buildscript { repositories { diff --git a/build.sbt b/build.sbt index 93d796d..bca1e62 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.102.1", + version := "6.102.6", scalaVersion := "2.11.4", scalacOptions ++= Seq("-feature"), javacOptions in compile ++= Seq("-Xlint:deprecation"), diff --git a/docs/AccountApi.md b/docs/AccountApi.md index 5941052..5b6be5b 100644 --- a/docs/AccountApi.md +++ b/docs/AccountApi.md @@ -4,13 +4,13 @@ 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 -[**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 +[**getAccountDetail**](AccountApi.md#getAccountDetail) | **GET** /account/detail | Get account detail. +[**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. @@ -19,7 +19,7 @@ Method | HTTP request | Description # **getAccountDetail** > AccountDetail getAccountDetail() -Get account detail +Get account detail. ### Example @@ -77,13 +77,13 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful | - | +**200** | Successful. | - | # **getAccountRateLimit** > List<AccountRateLimit> getAccountRateLimit() -Get user transaction rate limit information +Get user transaction rate limit information. ### Example @@ -141,15 +141,15 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful | - | +**200** | Successful. | - | # **listSTPGroups** > List<StpGroup> listSTPGroups().name(name).execute(); -List STP Groups +List STP Groups. -Retrieve the list of STP groups created by the main account user only +Retrieve the list of STP groups created by the main account user only. ### 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 | Perform a fuzzy search based on the 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**| Perform a fuzzy search based on the name. | [optional] ### Return type @@ -213,15 +213,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **createSTPGroup** > StpGroup createSTPGroup(stpGroup) -Create STP Group +Create STP Group. -Only the main account is allowed to create a new STP user group +Only the main account is allowed to create a new STP user group. ### Example @@ -289,9 +289,9 @@ Name | Type | Description | Notes # **listSTPGroupsUsers** > List<StpGroupUser> listSTPGroupsUsers(stpId) -List users of the STP group +List users of the STP group. -Only the main account that created this STP group can query the account +Only the main account that created this STP group can query the account. ### Example @@ -314,7 +314,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); AccountApi apiInstance = new AccountApi(defaultClient); - Long stpId = 1L; // Long | STP Group ID + Long stpId = 1L; // Long | STP Group ID. try { List result = apiInstance.listSTPGroupsUsers(stpId); System.out.println(result); @@ -335,7 +335,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **stpId** | **Long**| STP Group ID | + **stpId** | **Long**| STP Group ID. | ### Return type @@ -353,15 +353,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **addSTPGroupUsers** > List<StpGroupUser> addSTPGroupUsers(stpId, requestBody) -Add users to the STP group +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 +- Only the master account that created the STP user group is allowed to add users group.- Only accounts under the main account are allowed to be added. Cross-account is not permitted ### Example @@ -384,8 +384,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); AccountApi apiInstance = new AccountApi(defaultClient); - Long stpId = 1L; // Long | STP Group ID - List requestBody = Arrays.asList(); // List | User ID + Long stpId = 1L; // Long | STP Group ID. + List requestBody = Arrays.asList(); // List | User ID. try { List result = apiInstance.addSTPGroupUsers(stpId, requestBody); System.out.println(result); @@ -406,8 +406,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **stpId** | **Long**| STP Group ID | - **requestBody** | [**List<Long>**](Long.md)| User ID | + **stpId** | **Long**| STP Group ID. | + **requestBody** | [**List<Long>**](Long.md)| User ID. | ### Return type @@ -431,7 +431,7 @@ Name | Type | Description | Notes # **deleteSTPGroupUsers** > List<StpGroupUser> deleteSTPGroupUsers(stpId, userId) -Delete the user in the STP group +Delete the user in the STP 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 @@ -456,8 +456,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 stpId = 1L; // Long | STP Group ID. + Long userId = 1L; // Long | STP user ID, multiple can be separated by commas. try { List result = apiInstance.deleteSTPGroupUsers(stpId, userId); System.out.println(result); @@ -478,8 +478,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **stpId** | **Long**| STP Group ID | - **userId** | **Long**| STP user ID, multiple can be separated by commas | + **stpId** | **Long**| STP Group ID. | + **userId** | **Long**| STP user ID, multiple can be separated by commas. | ### Return type @@ -497,7 +497,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | Success. | - | # **getDebitFee** @@ -563,7 +563,7 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | Success. | - | # **setDebitFee** @@ -632,5 +632,5 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | Success. | - | diff --git a/docs/AccountBalance.md b/docs/AccountBalance.md index 82aa609..c9462db 100644 --- a/docs/AccountBalance.md +++ b/docs/AccountBalance.md @@ -1,16 +1,16 @@ # AccountBalance -Total balances calculated with specified currency unit +Total balances calculated with specified currency unit. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**amount** | **String** | Account total balance amount | [optional] -**currency** | [**CurrencyEnum**](#CurrencyEnum) | Currency | [optional] +**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** | Borrowed，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 e23a262..70e557e 100644 --- a/docs/AccountDetail.md +++ b/docs/AccountDetail.md @@ -1,16 +1,16 @@ # AccountDetail -Account detail +Account detail. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ipWhitelist** | **List<String>** | IP whitelist | [optional] -**currencyPairs** | **List<String>** | CurrencyPair whitelisting | [optional] -**userId** | **Long** | User ID | [optional] -**tier** | **Long** | User VIP level | [optional] +**ipWhitelist** | **List<String>** | IP whitelist. | [optional] +**currencyPairs** | **List<String>** | CurrencyPair whitelisting. | [optional] +**userId** | **Long** | User ID. | [optional] +**tier** | **Long** | User VIP level. | [optional] **key** | [**AccountDetailKey**](AccountDetailKey.md) | | [optional] -**copyTradingRole** | **Integer** | User role: 0 - Normal user 1 - Copy trading leader 2 - Copy trading follower 3 - Both leader and follower | [optional] +**copyTradingRole** | **Integer** | User role: 0 - Normal user, 1 - Copy trading leader, follower, 3 - Both leader and follower | [optional] diff --git a/docs/AccountDetailKey.md b/docs/AccountDetailKey.md index 801792f..96dce1d 100644 --- a/docs/AccountDetailKey.md +++ b/docs/AccountDetailKey.md @@ -1,11 +1,11 @@ # AccountDetailKey -API Key detail +API Key detail. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**mode** | **Integer** | mode: 1 - classic account 2 - portfolio margin account | [optional] +**mode** | **Integer** | mode: 1 - classic account 2 - portfolio margin account. | [optional] diff --git a/docs/AccountRateLimit.md b/docs/AccountRateLimit.md index b84a8d8..cd486c8 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] -**updatedAt** | **String** | Update time | [optional] +**ratio** | **String** | Transaction rate. | [optional] +**mainRatio** | **String** | Total transaction ratio of main account. | [optional] +**updatedAt** | **String** | Update time. | [optional] diff --git a/docs/AgencyCommission.md b/docs/AgencyCommission.md index 1162280..249ec82 100644 --- a/docs/AgencyCommission.md +++ b/docs/AgencyCommission.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**commissionTime** | **Long** | Commission Time. (unix timestamp) | [optional] -**userId** | **Long** | User ID | [optional] -**groupName** | **String** | Group name | [optional] -**commissionAmount** | **String** | Commission Amount | [optional] -**commissionAsset** | **String** | Commission Asset | [optional] -**source** | **String** | Source. SPOT - SPOT Rebate, FUTURES - Futures Rebate | [optional] +**commissionTime** | **Long** | Commission Time. (unix timestamp). | [optional] +**userId** | **Long** | User ID. | [optional] +**groupName** | **String** | Group name. | [optional] +**commissionAmount** | **String** | Commission Amount. | [optional] +**commissionAsset** | **String** | Commission Asset. | [optional] +**source** | **String** | Source. SPOT - SPOT Rebate, FUTURES - Futures Rebate. | [optional] diff --git a/docs/AgencyCommissionHistory.md b/docs/AgencyCommissionHistory.md index 9a5b4c1..a89026e 100644 --- a/docs/AgencyCommissionHistory.md +++ b/docs/AgencyCommissionHistory.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currencyPair** | **String** | Currency pair | [optional] -**total** | **Long** | Total | [optional] -**list** | [**List<AgencyCommission>**](AgencyCommission.md) | List of comission history | [optional] +**currencyPair** | **String** | Currency pair. | [optional] +**total** | **Long** | Total. | [optional] +**list** | [**List<AgencyCommission>**](AgencyCommission.md) | List of comission history. | [optional] diff --git a/docs/AgencyTransaction.md b/docs/AgencyTransaction.md index 81a851b..08e607d 100644 --- a/docs/AgencyTransaction.md +++ b/docs/AgencyTransaction.md @@ -5,13 +5,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**transactionTime** | **Long** | Transaction Time. (unix timestamp) | [optional] -**userId** | **Long** | User ID | [optional] -**groupName** | **String** | Group name | [optional] -**fee** | **String** | Fee | [optional] -**feeAsset** | **String** | Fee currency | [optional] -**currencyPair** | **String** | Currency pair | [optional] -**amount** | **String** | Commission Amount | [optional] -**amountAsset** | **String** | Commission Asset | [optional] -**source** | **String** | Source. SPOT - SPOT Rebate, FUTURES - Futures Rebate | [optional] +**transactionTime** | **Long** | Transaction Time. (unix timestamp). | [optional] +**userId** | **Long** | User ID. | [optional] +**groupName** | **String** | Group name. | [optional] +**fee** | **String** | Fee. | [optional] +**feeAsset** | **String** | Fee currency. | [optional] +**currencyPair** | **String** | Currency pair. | [optional] +**amount** | **String** | Commission Amount. | [optional] +**amountAsset** | **String** | Commission Asset. | [optional] +**source** | **String** | Source. SPOT - SPOT Rebate, FUTURES - Futures Rebate. | [optional] diff --git a/docs/AgencyTransactionHistory.md b/docs/AgencyTransactionHistory.md index 2a78460..b10a6c3 100644 --- a/docs/AgencyTransactionHistory.md +++ b/docs/AgencyTransactionHistory.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currencyPair** | **String** | Currency pair | [optional] -**total** | **Long** | Total | [optional] -**list** | [**List<AgencyTransaction>**](AgencyTransaction.md) | List of transaction history | [optional] +**currencyPair** | **String** | Currency pair. | [optional] +**total** | **Long** | Total. | [optional] +**list** | [**List<AgencyTransaction>**](AgencyTransaction.md) | List of transaction history. | [optional] diff --git a/docs/AutoRepaySetting.md b/docs/AutoRepaySetting.md index 176b917..ddc3a88 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 9c0f769..d068ae6 100644 --- a/docs/BatchAmendItem.md +++ b/docs/BatchAmendItem.md @@ -1,17 +1,17 @@ # BatchAmendItem -Order information that needs to be modified +Order information that needs to be modified. ## Properties 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). | -**currencyPair** | **String** | Currency pair | +**currencyPair** | **String** | Currency pair. | **account** | **String** | Default spot, unified account and warehouse-by-store leverage account. | [optional] **amount** | **String** | Trading Quantity. Only one of amountor pricecan be specified. | [optional] **price** | **String** | Trading Price. Only one of amountor pricecan be specified. | [optional] -**amendText** | **String** | Custom info during amending order | [optional] +**amendText** | **String** | Custom info during amending order. | [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..935312f 100644 --- a/docs/BatchAmendOrderReq.md +++ b/docs/BatchAmendOrderReq.md @@ -1,15 +1,15 @@ # BatchAmendOrderReq -Modify contract order parameters +Modify contract order parameters. ## Properties 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] +**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, 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] +**amendText** | **String** | Custom info during amending order. | [optional] diff --git a/docs/BatchFuturesOrder.md b/docs/BatchFuturesOrder.md index 70afffc..e8aa664 100644 --- a/docs/BatchFuturesOrder.md +++ b/docs/BatchFuturesOrder.md @@ -1,39 +1,39 @@ # BatchFuturesOrder -Futures order details +Futures order details. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**succeeded** | **Boolean** | Whether the batch of orders succeeded | [optional] -**label** | **String** | Error label, only exists if execution fails | [optional] +**succeeded** | **Boolean** | Whether the batch of orders succeeded. | [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] +**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 - 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] -**contract** | **String** | Futures contract | [optional] +**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] -**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] +**price** | **String** | Order price. 0 for market order with `tif` set as `ioc`. | [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** | Size left to be traded. | [optional] [readonly] +**fillPrice** | **String** | Fill price of the order. | [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] +**tkfr** | **String** | Taker fee. | [optional] [readonly] +**mkfr** | **String** | Maker fee. | [optional] [readonly] +**refu** | **Integer** | Reference 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 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] **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 df65c20..1225438 100644 --- a/docs/BatchOrder.md +++ b/docs/BatchOrder.md @@ -1,48 +1,48 @@ # BatchOrder -Batch order details +Batch order details. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**orderId** | **String** | Order ID | [optional] -**amendText** | **String** | The custom data that the user remarked when amending the order | [optional] +**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] -**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] -**createTime** | **String** | Creation time of order | [optional] [readonly] -**updateTime** | **String** | Last modification time of order | [optional] [readonly] -**createTimeMs** | **Long** | Creation time of order (in milliseconds) | [optional] [readonly] -**updateTimeMs** | **Long** | Last modification time of order (in milliseconds) | [optional] [readonly] +**succeeded** | **Boolean** | Whether the batch of orders succeeded. | [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] +**createTime** | **String** | Creation time of order. | [optional] [readonly] +**updateTime** | **String** | Last modification time of order. | [optional] [readonly] +**createTimeMs** | **Long** | Creation time of order (in milliseconds). | [optional] [readonly] +**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] +**currencyPair** | **String** | Currency pair. | [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) | Buy or sell order | [optional] -**amount** | **String** | Trade amount | [optional] -**price** | **String** | Order price | [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] +**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] -**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] -**fee** | **String** | Fee deducted | [optional] [readonly] -**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] -**rebatedFee** | **String** | Rebated fee | [optional] [readonly] -**rebatedFeeCurrency** | **String** | Rebated fee currency unit | [optional] [readonly] +**left** | **String** | Amount left to fill. | [optional] [readonly] +**filledAmount** | **String** | Amount traded to fill. | [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] +**fee** | **String** | Fee deducted. | [optional] [readonly] +**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] +**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..3ff744b 100644 --- a/docs/BorrowCurrencyInfo.md +++ b/docs/BorrowCurrencyInfo.md @@ -5,9 +5,9 @@ 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] +**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] diff --git a/docs/BrokerCommission.md b/docs/BrokerCommission.md index f648e03..314c1b9 100644 --- a/docs/BrokerCommission.md +++ b/docs/BrokerCommission.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**total** | **Long** | Total | [optional] -**list** | [**List<BrokerCommission1>**](BrokerCommission1.md) | List of comission history | [optional] +**total** | **Long** | Total. | [optional] +**list** | [**List<BrokerCommission1>**](BrokerCommission1.md) | List of comission history. | [optional] diff --git a/docs/BrokerCommission1.md b/docs/BrokerCommission1.md index bba07b4..a27f115 100644 --- a/docs/BrokerCommission1.md +++ b/docs/BrokerCommission1.md @@ -5,14 +5,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**commissionTime** | **Long** | Commission Time. (unix timestamp) | [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] -**currencyPair** | **String** | Currency pair | [optional] +**commissionTime** | **Long** | Commission Time. (unix timestamp). | [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.、Alpha | [optional] +**currencyPair** | **String** | Currency pair. | [optional] **subBrokerInfo** | [**BrokerCommissionSubBrokerInfo**](BrokerCommissionSubBrokerInfo.md) | | [optional] +**alphaContractAddr** | **String** | Alpha token address | [optional] diff --git a/docs/BrokerCommissionSubBrokerInfo.md b/docs/BrokerCommissionSubBrokerInfo.md index a61d20b..235c831 100644 --- a/docs/BrokerCommissionSubBrokerInfo.md +++ b/docs/BrokerCommissionSubBrokerInfo.md @@ -1,14 +1,14 @@ # BrokerCommissionSubBrokerInfo -The sub broker info +The sub broker info. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Long** | The sub broker user ID | [optional] -**originalCommissionRate** | **String** | The sub broker original commission rate | [optional] -**relativeCommissionRate** | **String** | The sub broker relative commission rate | [optional] -**commissionRate** | **String** | The sub broker actual commission rate | [optional] +**userId** | **Long** | The sub broker user ID. | [optional] +**originalCommissionRate** | **String** | The sub broker original commission rate. | [optional] +**relativeCommissionRate** | **String** | The sub broker relative commission rate. | [optional] +**commissionRate** | **String** | The sub broker actual commission rate. | [optional] diff --git a/docs/BrokerTransaction.md b/docs/BrokerTransaction.md index 3dafae9..26381e8 100644 --- a/docs/BrokerTransaction.md +++ b/docs/BrokerTransaction.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**total** | **Long** | Total | [optional] -**list** | [**List<BrokerTransaction1>**](BrokerTransaction1.md) | List of transaction history | [optional] +**total** | **Long** | Total. | [optional] +**list** | [**List<BrokerTransaction1>**](BrokerTransaction1.md) | List of transaction history. | [optional] diff --git a/docs/BrokerTransaction1.md b/docs/BrokerTransaction1.md index da7b51c..099aa77 100644 --- a/docs/BrokerTransaction1.md +++ b/docs/BrokerTransaction1.md @@ -5,13 +5,14 @@ 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] -**currencyPair** | **String** | Currency pair | [optional] -**amount** | **String** | Commission Amount | [optional] -**feeAsset** | **String** | Fee currency | [optional] -**source** | **String** | Rebate Type: Spot、Futures、Options | [optional] +**transactionTime** | **Long** | Transaction Time. (unix timestamp). | [optional] +**userId** | **Long** | User ID. | [optional] +**groupName** | **String** | Group name. | [optional] +**fee** | **String** | fee (usdt). | [optional] +**currencyPair** | **String** | Currency pair. | [optional] +**amount** | **String** | Commission Amount. | [optional] +**feeAsset** | **String** | Fee currency. | [optional] +**source** | **String** | Rebate Type: Spot、Futures、Options.、Alpha | [optional] **subBrokerInfo** | [**BrokerCommissionSubBrokerInfo**](BrokerCommissionSubBrokerInfo.md) | | [optional] +**alphaContractAddr** | **String** | Alpha token address | [optional] diff --git a/docs/CancelBatchOrder.md b/docs/CancelBatchOrder.md index be6fb13..67e55df 100644 --- a/docs/CancelBatchOrder.md +++ b/docs/CancelBatchOrder.md @@ -1,13 +1,13 @@ # CancelBatchOrder -Info of order to be cancelled +Info of order to be cancelled. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currencyPair** | **String** | Order currency pair | +**currencyPair** | **String** | Order currency pair. | **id** | **String** | Order ID or user custom ID. Custom ID are accepted only within 30 minutes after order creation | **account** | **String** | If the canceled order is a unified account apikey, this field must be specified and set to `unified` | [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/CancelOrderResult.md b/docs/CancelOrderResult.md index 34066c2..8c07a8c 100644 --- a/docs/CancelOrderResult.md +++ b/docs/CancelOrderResult.md @@ -1,17 +1,17 @@ # CancelOrderResult -Order cancellation result +Order cancellation result. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currencyPair** | **String** | Order currency pair | [optional] -**id** | **String** | Order ID | [optional] -**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] -**account** | **String** | Default is empty (deprecated) | [optional] +**currencyPair** | **String** | Order currency pair. | [optional] +**id** | **String** | Order ID. | [optional] +**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] +**account** | **String** | Default is empty (deprecated). | [optional] diff --git a/docs/CollateralAdjust.md b/docs/CollateralAdjust.md index e3413db..af3862c 100644 --- a/docs/CollateralAdjust.md +++ b/docs/CollateralAdjust.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**orderId** | **Long** | Order ID | +**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] +**collaterals** | [**List<CollateralCurrency>**](CollateralCurrency.md) | Collateral Currency List. | [optional] diff --git a/docs/CollateralAdjustRes.md b/docs/CollateralAdjustRes.md index bcce281..ccc05b6 100644 --- a/docs/CollateralAdjustRes.md +++ b/docs/CollateralAdjustRes.md @@ -1,12 +1,12 @@ # CollateralAdjustRes -Result of multi-collateral adjustment +Result of multi-collateral adjustment. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**orderId** | **Long** | Order ID | [optional] -**collateralCurrencies** | [**List<CollateralCurrencyRes>**](CollateralCurrencyRes.md) | Collateral Currency Information | [optional] +**orderId** | **Long** | Order ID. | [optional] +**collateralCurrencies** | [**List<CollateralCurrencyRes>**](CollateralCurrencyRes.md) | Collateral Currency Information. | [optional] diff --git a/docs/CollateralAlign.md b/docs/CollateralAlign.md index 7aae66a..5f5cf12 100644 --- a/docs/CollateralAlign.md +++ b/docs/CollateralAlign.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**orderId** | **Long** | Order ID | -**collateralCurrency** | **String** | Collateral | -**collateralAmount** | **String** | Collateral amount | +**orderId** | **Long** | Order ID. | +**collateralCurrency** | **String** | Collateral. | +**collateralAmount** | **String** | Collateral amount. | **type** | **String** | Operation types: append - for adding collateral, redeem - for withdrawing collateral | diff --git a/docs/CollateralCurrency.md b/docs/CollateralCurrency.md index a05a724..f9c833b 100644 --- a/docs/CollateralCurrency.md +++ b/docs/CollateralCurrency.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency | [optional] -**amount** | **String** | Size | [optional] +**currency** | **String** | Currency. | [optional] +**amount** | **String** | Size. | [optional] diff --git a/docs/CollateralCurrencyInfo.md b/docs/CollateralCurrencyInfo.md index 38b55f9..fd98fc3 100644 --- a/docs/CollateralCurrencyInfo.md +++ b/docs/CollateralCurrencyInfo.md @@ -5,8 +5,8 @@ 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] +**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] diff --git a/docs/CollateralCurrencyRes.md b/docs/CollateralCurrencyRes.md index 22659bc..82c0505 100644 --- a/docs/CollateralCurrencyRes.md +++ b/docs/CollateralCurrencyRes.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**succeeded** | **Boolean** | Update success status | [optional] +**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] -**currency** | **String** | Currency | [optional] +**currency** | **String** | Currency. | [optional] **amount** | **String** | Quantity of successful collateral operation; 0 if the operation fails. | [optional] diff --git a/docs/CollateralCurrentRate.md b/docs/CollateralCurrentRate.md index 85ff1c8..0c4d9ad 100644 --- a/docs/CollateralCurrentRate.md +++ b/docs/CollateralCurrentRate.md @@ -1,12 +1,12 @@ # CollateralCurrentRate -Multi-currency pledge current interest rate +Multi-currency pledge current interest rate. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency | [optional] -**currentRate** | **String** | Currency current interest rate | [optional] +**currency** | **String** | Currency. | [optional] +**currentRate** | **String** | Currency current interest rate. | [optional] diff --git a/docs/CollateralFixRate.md b/docs/CollateralFixRate.md index 459d30b..dde7626 100644 --- a/docs/CollateralFixRate.md +++ b/docs/CollateralFixRate.md @@ -1,14 +1,14 @@ # CollateralFixRate -Multi-collateral fixed interest rate +Multi-collateral fixed interest rate. ## Properties 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] +**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] diff --git a/docs/CollateralLoanApi.md b/docs/CollateralLoanApi.md index 73fef6a..d7e468e 100644 --- a/docs/CollateralLoanApi.md +++ b/docs/CollateralLoanApi.md @@ -4,23 +4,23 @@ 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 -[**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 -[**listCollateralCurrencies**](CollateralLoanApi.md#listCollateralCurrencies) | **GET** /loan/collateral/currencies | Query supported borrowing and collateral currencies +[**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. +[**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. +[**listCollateralCurrencies**](CollateralLoanApi.md#listCollateralCurrencies) | **GET** /loan/collateral/currencies | Query supported borrowing and collateral currencies. # **listCollateralLoanOrders** > List<CollateralOrder> listCollateralLoanOrders().page(page).limit(limit).collateralCurrency(collateralCurrency).borrowCurrency(borrowCurrency).execute(); -List Orders +List Orders. ### Example @@ -43,10 +43,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 - String borrowCurrency = "USDT"; // String | Borrowed currency + 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. + String borrowCurrency = "USDT"; // String | Borrowed currency. try { List result = apiInstance.listCollateralLoanOrders() .page(page) @@ -72,10 +72,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 100] - **collateralCurrency** | **String**| Collateral | [optional] - **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 100] + **collateralCurrency** | **String**| Collateral. | [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. | - | # **createCollateralLoan** > OrderResp createCollateralLoan(createCollateralOrder) -Place order +Place order. ### Example @@ -161,13 +161,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | Success. | - | # **getCollateralLoanOrderDetail** > CollateralOrder getCollateralLoanOrderDetail(orderId) -Get a single order +Get a single order. ### 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 on successful order creation. 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 on successful order creation. | ### Return type @@ -229,13 +229,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | Success. | - | # **repayCollateralLoan** > RepayResp repayCollateralLoan(repayLoan) -Repayment +Repayment. ### Example @@ -297,13 +297,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Operated successfully | - | +**200** | Operated successfully. | - | # **listRepayRecords** > List<RepayRecord> listRepayRecords(source).borrowCurrency(borrowCurrency).collateralCurrency(collateralCurrency).page(page).limit(limit).from(from).to(to).execute(); -Repayment history +Repayment history. ### Example @@ -326,13 +326,13 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 - 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 + String source = "repay"; // String | Operation type: repay - Regular repayment, liquidate - Liquidation. + String borrowCurrency = "USDT"; // String | Borrowed currency. + String collateralCurrency = "BTC"; // String | Collateral. + 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. try { List result = apiInstance.listRepayRecords(source) .borrowCurrency(borrowCurrency) @@ -360,13 +360,13 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **source** | **String**| Operation type: repay - Regular repayment, liquidate - Liquidation | - **borrowCurrency** | **String**| Borrowed currency | [optional] - **collateralCurrency** | **String**| Collateral | [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] + **source** | **String**| Operation type: repay - Regular repayment, liquidate - Liquidation. | + **borrowCurrency** | **String**| Borrowed currency. | [optional] + **collateralCurrency** | **String**| Collateral. | [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] ### Return type @@ -384,13 +384,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listCollateralRecords** > List<CollateralRecord> listCollateralRecords().page(page).limit(limit).from(from).to(to).borrowCurrency(borrowCurrency).collateralCurrency(collateralCurrency).execute(); -Query collateral adjustment records +Query collateral adjustment records. ### Example @@ -413,12 +413,12 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 - String borrowCurrency = "USDT"; // String | Borrowed currency - String collateralCurrency = "BTC"; // String | Collateral + 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. + String borrowCurrency = "USDT"; // String | Borrowed currency. + String collateralCurrency = "BTC"; // String | Collateral. try { List result = apiInstance.listCollateralRecords() .page(page) @@ -446,12 +446,12 @@ 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] - **borrowCurrency** | **String**| Borrowed currency | [optional] - **collateralCurrency** | **String**| Collateral | [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] + **borrowCurrency** | **String**| Borrowed currency. | [optional] + **collateralCurrency** | **String**| Collateral. | [optional] ### Return type @@ -469,13 +469,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **operateCollateral** > operateCollateral(collateralAlign) -Increase or redeem collateral +Increase or redeem collateral. ### Example @@ -536,13 +536,13 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Operated successfully | - | +**204** | Operated successfully. | - | # **getUserTotalAmount** > UserTotalAmount getUserTotalAmount() -Query the total borrowing and collateral amount for the user +Query the total borrowing and collateral amount for the user. ### Example @@ -600,13 +600,13 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **getUserLtvInfo** > UserLtvInfo getUserLtvInfo(collateralCurrency, borrowCurrency) -Query user's collateralization ratio +Query user's collateralization ratio. ### Example @@ -629,8 +629,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); CollateralLoanApi apiInstance = new CollateralLoanApi(defaultClient); - String collateralCurrency = "BTC"; // String | Collateral - String borrowCurrency = "USDT"; // String | Borrowed currency + String collateralCurrency = "BTC"; // String | Collateral. + String borrowCurrency = "USDT"; // String | Borrowed currency. try { UserLtvInfo result = apiInstance.getUserLtvInfo(collateralCurrency, borrowCurrency); System.out.println(result); @@ -651,8 +651,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **collateralCurrency** | **String**| Collateral | - **borrowCurrency** | **String**| Borrowed currency | + **collateralCurrency** | **String**| Collateral. | + **borrowCurrency** | **String**| Borrowed currency. | ### Return type @@ -670,13 +670,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listCollateralCurrencies** > List<CollateralLoanCurrency> listCollateralCurrencies().loanCurrency(loanCurrency).execute(); -Query supported borrowing and collateral currencies +Query supported borrowing and collateral currencies. ### Example @@ -736,5 +736,5 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | diff --git a/docs/CollateralLoanCurrency.md b/docs/CollateralLoanCurrency.md index 92bdf8a..e0da6d6 100644 --- a/docs/CollateralLoanCurrency.md +++ b/docs/CollateralLoanCurrency.md @@ -1,12 +1,12 @@ # CollateralLoanCurrency -Supported borrowing and collateral currencies +Supported borrowing and collateral currencies. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**loanCurrency** | **String** | Borrowed currency | [optional] -**collateralCurrency** | **List<String>** | List of supported collateral currencies | [optional] +**loanCurrency** | **String** | Borrowed currency. | [optional] +**collateralCurrency** | **List<String>** | List of supported collateral currencies. | [optional] diff --git a/docs/CollateralLtv.md b/docs/CollateralLtv.md index 9812ae4..66d3322 100644 --- a/docs/CollateralLtv.md +++ b/docs/CollateralLtv.md @@ -1,13 +1,13 @@ # CollateralLtv -Collateral Ratio +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** | The initial collateralization rate. | [optional] +**alertLtv** | **String** | Warning collateralization ratio. | [optional] +**liquidateLtv** | **String** | The liquidation collateralization rate. | [optional] diff --git a/docs/CollateralOrder.md b/docs/CollateralOrder.md index bae42ce..b6be0de 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] -**collateralAmount** | **String** | Collateral amount | [optional] -**borrowCurrency** | **String** | Borrowed currency | [optional] -**borrowAmount** | **String** | Borrowing 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] +**orderId** | **Long** | Order ID. | [optional] +**collateralCurrency** | **String** | Collateral. | [optional] +**collateralAmount** | **String** | Collateral amount. | [optional] +**borrowCurrency** | **String** | Borrowed currency. | [optional] +**borrowAmount** | **String** | Borrowing 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] **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] +**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..8e45007 100644 --- a/docs/CollateralRecord.md +++ b/docs/CollateralRecord.md @@ -1,20 +1,20 @@ # CollateralRecord -Collateral record +Collateral record. ## Properties 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] +**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] diff --git a/docs/Contract.md b/docs/Contract.md index 14046b7..abb37af 100644 --- a/docs/Contract.md +++ b/docs/Contract.md @@ -1,50 +1,50 @@ # Contract -Futures contract details +Futures contract details. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | Futures contract | [optional] -**type** | [**TypeEnum**](#TypeEnum) | Futures contract type | [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] -**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] -**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] +**name** | **String** | Futures contract. | [optional] +**type** | [**TypeEnum**](#TypeEnum) | Futures contract type. | [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, 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] +**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] +**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] -**tradeId** | **Long** | Current trade ID | [optional] -**tradeSize** | **Long** | Historical accumulated trade size | [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] -**enableCredit** | **Boolean** | Whether portfolio margin account is enabled | [optional] -**createTime** | **Double** | Created time of the contract | [optional] +**refDiscountRate** | **String** | Referral fee rate discount. | [optional] +**refRebateRate** | **String** | Referrer commission rate. | [optional] +**orderbookId** | **Long** | Current orderbook ID. | [optional] +**tradeId** | **Long** | Current trade ID. | [optional] +**tradeSize** | **Long** | Historical accumulated trade size. | [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` contract is offline | [optional] +**ordersLimit** | **Integer** | Maximum number of open orders. | [optional] +**enableBonus** | **Boolean** | Whether bouns 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, trading, delisting, delisted | [optional] -**launchTime** | **Long** | Contract expiry timestamp | [optional] +**status** | **String** | Contract Status Types include: prelaunch, trading, delisting, delisted. | [optional] +**launchTime** | **Long** | Contract expiry timestamp. | [optional] ## Enum: TypeEnum diff --git a/docs/ContractStat.md b/docs/ContractStat.md index d8552a1..6952af2 100644 --- a/docs/ContractStat.md +++ b/docs/ContractStat.md @@ -5,17 +5,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] -**topLsrAccount** | **Double** | Top trader long/short account ratio | [optional] -**topLsrSize** | **Double** | Top trader long/short position ratio | [optional] +**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] +**topLsrAccount** | **Double** | Top trader long/short account ratio. | [optional] +**topLsrSize** | **Double** | Top trader long/short position ratio. | [optional] diff --git a/docs/ConvertSmallBalance.md b/docs/ConvertSmallBalance.md index b178eae..d130582 100644 --- a/docs/ConvertSmallBalance.md +++ b/docs/ConvertSmallBalance.md @@ -1,12 +1,12 @@ # ConvertSmallBalance -Convert Small Balance +Convert Small Balance. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **List<String>** | Currency | [optional] -**isAll** | **Boolean** | Whether to exchange all | [optional] +**currency** | **List<String>** | Currency. | [optional] +**isAll** | **Boolean** | Whether to exchange all. | [optional] diff --git a/docs/CountdownCancelAllFuturesTask.md b/docs/CountdownCancelAllFuturesTask.md index b7a1523..79c0ca2 100644 --- a/docs/CountdownCancelAllFuturesTask.md +++ b/docs/CountdownCancelAllFuturesTask.md @@ -1,12 +1,12 @@ # CountdownCancelAllFuturesTask -Countdown cancel task detail +Countdown cancel task detail. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **timeout** | **Integer** | Countdown time in seconds At least 5 seconds, 0 means cancel countdown | -**contract** | **String** | Futures contract | [optional] +**contract** | **String** | Futures contract. | [optional] diff --git a/docs/CountdownCancelAllOptionsTask.md b/docs/CountdownCancelAllOptionsTask.md index fc87f87..08de556 100644 --- a/docs/CountdownCancelAllOptionsTask.md +++ b/docs/CountdownCancelAllOptionsTask.md @@ -1,13 +1,13 @@ # CountdownCancelAllOptionsTask -Countdown cancel task detail +Countdown cancel task detail. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **timeout** | **Integer** | Countdown time in seconds At least 5 seconds, 0 means cancel countdown | -**contract** | **String** | Options contract name | [optional] -**underlying** | **String** | Underlying | [optional] +**contract** | **String** | Options contract name. | [optional] +**underlying** | **String** | Underlying. | [optional] diff --git a/docs/CountdownCancelAllSpotTask.md b/docs/CountdownCancelAllSpotTask.md index 27388e9..f31548a 100644 --- a/docs/CountdownCancelAllSpotTask.md +++ b/docs/CountdownCancelAllSpotTask.md @@ -1,12 +1,12 @@ # CountdownCancelAllSpotTask -Countdown cancel task detail +Countdown cancel task detail. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **timeout** | **Integer** | Countdown time in seconds At least 5 seconds, 0 means cancel countdown | -**currencyPair** | **String** | Currency pair | [optional] +**currencyPair** | **String** | Currency pair. | [optional] diff --git a/docs/CreateCollateralOrder.md b/docs/CreateCollateralOrder.md index f8aebc7..47391bb 100644 --- a/docs/CreateCollateralOrder.md +++ b/docs/CreateCollateralOrder.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**collateralAmount** | **String** | Collateral amount | -**collateralCurrency** | **String** | Collateral | -**borrowAmount** | **String** | Borrowing amount | -**borrowCurrency** | **String** | Borrowed currency | +**collateralAmount** | **String** | Collateral amount. | +**collateralCurrency** | **String** | Collateral. | +**borrowAmount** | **String** | Borrowing amount. | +**borrowCurrency** | **String** | Borrowed currency. | diff --git a/docs/CreateMultiCollateralOrder.md b/docs/CreateMultiCollateralOrder.md index 73064fe..913c262 100644 --- a/docs/CreateMultiCollateralOrder.md +++ b/docs/CreateMultiCollateralOrder.md @@ -5,13 +5,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**orderId** | **String** | Order ID | [optional] -**orderType** | **String** | current - current, fixed - fixed, if not specified, default to current | [optional] +**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] -**borrowCurrency** | **String** | Borrowed currency | -**borrowAmount** | **String** | Borrowing amount | -**collateralCurrencies** | [**List<CollateralCurrency>**](CollateralCurrency.md) | Collateral currency and amount | [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] +**borrowCurrency** | **String** | Borrowed currency. | +**borrowAmount** | **String** | Borrowing amount. | +**collateralCurrencies** | [**List<CollateralCurrency>**](CollateralCurrency.md) | Collateral currency and amount. | [optional] diff --git a/docs/CreateUniLend.md b/docs/CreateUniLend.md index f280986..5cf797c 100644 --- a/docs/CreateUniLend.md +++ b/docs/CreateUniLend.md @@ -1,15 +1,15 @@ # CreateUniLend -Lend or redeem +Lend or redeem. ## 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 | +**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] ## Enum: TypeEnum diff --git a/docs/CreateUniLoan.md b/docs/CreateUniLoan.md index 990887e..ea33789 100644 --- a/docs/CreateUniLoan.md +++ b/docs/CreateUniLoan.md @@ -1,17 +1,17 @@ # CreateUniLoan -Borrow or repay +Borrow or repay. ## Properties 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] -**currencyPair** | **String** | Currency pair | +**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 repaid in full. | [optional] +**currencyPair** | **String** | Currency pair. | ## Enum: TypeEnum diff --git a/docs/CrossMarginBalance.md b/docs/CrossMarginBalance.md index 806732e..76cd66b 100644 --- a/docs/CrossMarginBalance.md +++ b/docs/CrossMarginBalance.md @@ -5,8 +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] +**available** | **String** | Available amount. | [optional] +**freeze** | **String** | Locked amount. | [optional] +**borrowed** | **String** | Borrowed amount. | [optional] +**interest** | **String** | Unpaid interests. | [optional] diff --git a/docs/CrossMarginLoan.md b/docs/CrossMarginLoan.md index b9fe1d6..255d3ac 100644 --- a/docs/CrossMarginLoan.md +++ b/docs/CrossMarginLoan.md @@ -5,16 +5,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | Loan record ID | [optional] [readonly] -**createTime** | **Long** | Creation timestamp, in milliseconds | [optional] [readonly] -**updateTime** | **Long** | Update timestamp, in milliseconds | [optional] [readonly] -**currency** | **String** | Currency name | -**amount** | **String** | Borrowed amount | -**text** | **String** | User defined custom ID | [optional] +**id** | **String** | Loan record ID. | [optional] [readonly] +**createTime** | **Long** | Creation timestamp, in milliseconds. | [optional] [readonly] +**updateTime** | **Long** | Update timestamp, in milliseconds. | [optional] [readonly] +**currency** | **String** | Currency name. | +**amount** | **String** | Borrowed amount. | +**text** | **String** | User defined custom ID. | [optional] **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] +**repaid** | **String** | Repaid amount. | [optional] [readonly] +**repaidInterest** | **String** | Repaid interest. | [optional] [readonly] +**unpaidInterest** | **String** | Outstanding interest yet to be paid. | [optional] [readonly] ## Enum: StatusEnum diff --git a/docs/CrossMarginRepayment.md b/docs/CrossMarginRepayment.md index 5759bf6..f281bac 100644 --- a/docs/CrossMarginRepayment.md +++ b/docs/CrossMarginRepayment.md @@ -5,11 +5,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | Loan record ID | [optional] -**createTime** | **Long** | Repayment time | [optional] -**loanId** | **String** | Loan record ID | [optional] -**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] +**id** | **String** | Loan record ID. | [optional] +**createTime** | **Long** | Repayment time. | [optional] +**loanId** | **String** | Loan record ID. | [optional] +**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 after cancellation | [optional] [readonly] diff --git a/docs/Currency.md b/docs/Currency.md index 0f1d258..ca6a039 100644 --- a/docs/Currency.md +++ b/docs/Currency.md @@ -5,14 +5,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency symbol | [optional] -**name** | **String** | Currency name | [optional] -**delisted** | **Boolean** | Whether currency is de-listed | [optional] -**withdrawDisabled** | **Boolean** | Whether currency's withdrawal is disabled (deprecated) | [optional] -**withdrawDelayed** | **Boolean** | Whether currency's withdrawal is delayed (deprecated) | [optional] -**depositDisabled** | **Boolean** | Whether currency's deposit is disabled (deprecated) | [optional] -**tradeDisabled** | **Boolean** | Whether currency's trading is disabled | [optional] +**currency** | **String** | Currency symbol. | [optional] +**name** | **String** | Currency name. | [optional] +**delisted** | **Boolean** | Whether currency is de-listed. | [optional] +**withdrawDisabled** | **Boolean** | Whether currency's withdrawal is disabled (deprecated). | [optional] +**withdrawDelayed** | **Boolean** | Whether currency's withdrawal is delayed (deprecated). | [optional] +**depositDisabled** | **Boolean** | Whether currency's deposit is disabled (deprecated). | [optional] +**tradeDisabled** | **Boolean** | Whether currency's trading is disabled. | [optional] **fixedRate** | **String** | Fixed fee rate. Only for fixed rate currencies, not valid for normal currencies | [optional] -**chain** | **String** | The main chain corresponding to the coin | [optional] -**chains** | [**List<SpotCurrencyChain>**](SpotCurrencyChain.md) | All links corresponding to coins | [optional] +**chain** | **String** | The main chain corresponding to the coin. | [optional] +**chains** | [**List<SpotCurrencyChain>**](SpotCurrencyChain.md) | All links corresponding to coins. | [optional] diff --git a/docs/CurrencyChain.md b/docs/CurrencyChain.md index f5dde3b..95176ad 100644 --- a/docs/CurrencyChain.md +++ b/docs/CurrencyChain.md @@ -5,12 +5,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**chain** | **String** | Chain name | [optional] -**nameCn** | **String** | Chain name in Chinese | [optional] -**nameEn** | **String** | Chain name in English | [optional] +**chain** | **String** | Chain name. | [optional] +**nameCn** | **String** | Chain name in Chinese. | [optional] +**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] -**decimal** | **String** | Withdrawal precision | [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] +**decimal** | **String** | Withdrawal precision. | [optional] diff --git a/docs/CurrencyPair.md b/docs/CurrencyPair.md index 2fd80e0..a5a997c 100644 --- a/docs/CurrencyPair.md +++ b/docs/CurrencyPair.md @@ -1,31 +1,31 @@ # CurrencyPair -Spot currency pair +Spot currency pair. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | Currency pair | [optional] -**base** | **String** | Base currency | [optional] -**baseName** | **String** | Transaction currency name | [optional] -**quote** | **String** | Quote currency | [optional] -**quoteName** | **String** | Name of the denominated currency | [optional] -**fee** | **String** | Trading fee | [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] -**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] +**id** | **String** | Currency pair. | [optional] +**base** | **String** | Base currency. | [optional] +**baseName** | **String** | Transaction currency name. | [optional] +**quote** | **String** | Quote currency. | [optional] +**quoteName** | **String** | Name of the denominated currency. | [optional] +**fee** | **String** | Trading fee. | [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: 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..1b62ae2 100644 --- a/docs/CurrencyQuota.md +++ b/docs/CurrencyQuota.md @@ -1,15 +1,15 @@ # CurrencyQuota -Currency Quota +Currency Quota. ## Properties 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] -**leftQuoteUsdt** | **String** | Remaining currency limit converted to USDT | [optional] +**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] +**leftQuoteUsdt** | **String** | Remaining currency limit converted to USDT. | [optional] diff --git a/docs/DebitFee.md b/docs/DebitFee.md index e1c5c1e..cf372bf 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 discount is used. | diff --git a/docs/DeliveryApi.md b/docs/DeliveryApi.md index 4d55208..ac9234c 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 -[**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 +[**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. +[**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. # **listDeliveryContracts** > List<DeliveryContract> listDeliveryContracts(settle) -List all futures contracts +List all futures contracts. ### Example @@ -58,7 +58,7 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency + String settle = "usdt"; // String | Settle currency. try { List result = apiInstance.listDeliveryContracts(settle); System.out.println(result); @@ -79,7 +79,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: usdt] + **settle** | **String**| Settle currency. | [enum: usdt] ### Return type @@ -97,13 +97,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **getDeliveryContract** > DeliveryContract getDeliveryContract(settle, contract) -Get a single contract +Get a single contract. ### Example @@ -122,8 +122,8 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency - String contract = "BTC_USDT_20200814"; // String | Futures contract + String settle = "usdt"; // String | Settle currency. + String contract = "BTC_USDT_20200814"; // String | Futures contract. try { DeliveryContract result = apiInstance.getDeliveryContract(settle, contract); System.out.println(result); @@ -144,8 +144,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: usdt] - **contract** | **String**| Futures contract | + **settle** | **String**| Settle currency. | [enum: usdt] + **contract** | **String**| Futures contract. | ### Return type @@ -163,15 +163,15 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Contract information | - | +**200** | Contract information. | - | # **listDeliveryOrderBook** > FuturesOrderBook listDeliveryOrderBook(settle, contract).interval(interval).limit(limit).withId(withId).execute(); -Futures order book +Futures order book. -Bids will be sorted by price from high to low, while asks sorted reversely +Bids will be sorted by price from high to low, while asks sorted reversely. ### Example @@ -190,10 +190,10 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 + 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 to return depth update ID. This ID increments by 1 each time. try { FuturesOrderBook result = apiInstance.listDeliveryOrderBook(settle, contract) @@ -219,10 +219,10 @@ public class Example { 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] + **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 to return depth update ID. This ID increments by 1 each time. | [optional] [default to false] ### Return type @@ -241,13 +241,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Depth query successful | - | +**200** | Depth query successful. | - | # **listDeliveryTrades** > List<FuturesTrade> listDeliveryTrades(settle, contract).limit(limit).lastId(lastId).from(from).to(to).execute(); -Futures trading history +Futures trading history. ### Example @@ -266,12 +266,12 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 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 | 以上个列表的最后一条记录的 ID 作为下个列表的起点。 该字段不再继续支持，新的请求请使用 `from` 和 `to` 字段来限定时间范围 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) @@ -297,12 +297,12 @@ public class Example { 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] + **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**| 以上个列表的最后一条记录的 ID 作为下个列表的起点。 该字段不再继续支持，新的请求请使用 `from` 和 `to` 字段来限定时间范围 | [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. | - | # **listDeliveryCandlesticks** > List<DeliveryCandlestick> listDeliveryCandlesticks(settle, contract).from(from).to(to).limit(limit).interval(interval).execute(); -Get futures candlesticks +Get futures candlesticks. 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` @@ -347,12 +347,12 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency - String contract = "BTC_USDT_20200814"; // String | Futures contract + 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 | 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 + 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 specified 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 | Time interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial timeweek + String interval = "5m"; // String | Time interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial timeweek, 7d time is aligned with Unix initial time try { List result = apiInstance.listDeliveryCandlesticks(settle, contract) .from(from) @@ -378,12 +378,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: usdt] - **contract** | **String**| Futures contract | + **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**| 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 | [optional] + **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 specified | [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**| Time interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial timeweek | [optional] [default to 5m] [enum: 10s, 30s, 1m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 7d, 1w, 30d] + **interval** | **String**| Time interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial timeweek, 7d time is aligned with Unix initial time | [optional] [default to 5m] [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** | Successfully retrieved. | - | # **listDeliveryTickers** > List<DeliveryTicker> listDeliveryTickers(settle).contract(contract).execute(); -List futures tickers +List futures tickers. ### Example @@ -426,8 +426,8 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency - String contract = "BTC_USDT_20200814"; // String | Futures contract + String settle = "usdt"; // String | Settle currency. + String contract = "BTC_USDT_20200814"; // String | Futures contract. try { List result = apiInstance.listDeliveryTickers(settle) .contract(contract) @@ -450,8 +450,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: usdt] - **contract** | **String**| Futures contract | [optional] + **settle** | **String**| Settle currency. | [enum: usdt] + **contract** | **String**| Futures contract. | [optional] ### Return type @@ -469,13 +469,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listDeliveryInsuranceLedger** > List<InsuranceRecord> listDeliveryInsuranceLedger(settle).limit(limit).execute(); -Futures insurance balance history +Futures insurance balance history. ### Example @@ -494,8 +494,8 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 + String settle = "usdt"; // String | Settle currency. + Integer limit = 100; // Integer | Maximum number of records to be returned in a single list. try { List result = apiInstance.listDeliveryInsuranceLedger(settle) .limit(limit) @@ -518,8 +518,8 @@ 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] + **settle** | **String**| Settle currency. | [enum: usdt] + **limit** | **Integer**| Maximum number of records to be 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** | Successfully retrieved. | - | # **listDeliveryAccounts** > FuturesAccount listDeliveryAccounts(settle) -Query futures account +Query futures account. ### Example @@ -566,7 +566,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency + String settle = "usdt"; // String | Settle currency. try { FuturesAccount result = apiInstance.listDeliveryAccounts(settle); System.out.println(result); @@ -587,7 +587,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: usdt] + **settle** | **String**| Settle currency. | [enum: usdt] ### Return type @@ -605,13 +605,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **listDeliveryAccountBook** > List<FuturesAccountBook> listDeliveryAccountBook(settle).limit(limit).from(from).to(to).type(type).execute(); -Query account book +Query account book. ### Example @@ -634,11 +634,11 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 + 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 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 | 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 + 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_fee: POINT Trading fee - point_refr: POINT Referrer rebate try { List result = apiInstance.listDeliveryAccountBook(settle) .limit(limit) @@ -664,11 +664,11 @@ 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] + **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 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**| 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] + **type** | **String**| Changing Type: - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: point_fee: POINT Trading fee - point_refr: POINT Referrer rebate | [optional] [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. | - | # **listDeliveryPositions** > List<Position> listDeliveryPositions(settle) -List all positions of a user +List all positions of a user. ### Example @@ -715,7 +715,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency + String settle = "usdt"; // String | Settle currency. try { List result = apiInstance.listDeliveryPositions(settle); System.out.println(result); @@ -736,7 +736,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: usdt] + **settle** | **String**| Settle currency. | [enum: usdt] ### Return type @@ -754,13 +754,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **getDeliveryPosition** > Position getDeliveryPosition(settle, contract) -Get single position +Get single position. ### Example @@ -783,8 +783,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency - String contract = "BTC_USDT_20200814"; // String | Futures contract + String settle = "usdt"; // String | Settle currency. + String contract = "BTC_USDT_20200814"; // String | Futures contract. try { Position result = apiInstance.getDeliveryPosition(settle, contract); System.out.println(result); @@ -805,8 +805,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: usdt] - **contract** | **String**| Futures contract | + **settle** | **String**| Settle currency. | [enum: usdt] + **contract** | **String**| Futures contract. | ### Return type @@ -824,13 +824,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information | - | +**200** | Position information. | - | # **updateDeliveryPositionMargin** > Position updateDeliveryPositionMargin(settle, contract, change) -Update position margin +Update position margin. ### Example @@ -853,9 +853,9 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 amount, positive number increases, negative number + String settle = "usdt"; // String | Settle currency. + String contract = "BTC_USDT_20200814"; // String | Futures contract. + String change = "0.01"; // String | Margin change amount, positive number increases, negative number. try { Position result = apiInstance.updateDeliveryPositionMargin(settle, contract, change); System.out.println(result); @@ -876,9 +876,9 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: usdt] - **contract** | **String**| Futures contract | - **change** | **String**| Margin change amount, positive number increases, negative number | + **settle** | **String**| Settle currency. | [enum: usdt] + **contract** | **String**| Futures contract. | + **change** | **String**| Margin change amount, positive number increases, negative number. | ### Return type @@ -896,13 +896,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information | - | +**200** | Position information. | - | # **updateDeliveryPositionLeverage** > Position updateDeliveryPositionLeverage(settle, contract, leverage) -Update position leverage +Update position leverage. ### Example @@ -925,9 +925,9 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency - String contract = "BTC_USDT_20200814"; // String | Futures contract - String leverage = "10"; // String | New position leverage + String settle = "usdt"; // String | Settle currency. + String contract = "BTC_USDT_20200814"; // String | Futures contract. + String leverage = "10"; // String | New position leverage. try { Position result = apiInstance.updateDeliveryPositionLeverage(settle, contract, leverage); System.out.println(result); @@ -948,9 +948,9 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: usdt] - **contract** | **String**| Futures contract | - **leverage** | **String**| New position leverage | + **settle** | **String**| Settle currency. | [enum: usdt] + **contract** | **String**| Futures contract. | + **leverage** | **String**| New position leverage. | ### Return type @@ -968,13 +968,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information | - | +**200** | Position information. | - | # **updateDeliveryPositionRiskLimit** > Position updateDeliveryPositionRiskLimit(settle, contract, riskLimit) -Update position risk limit +Update position risk limit. ### Example @@ -997,9 +997,9 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency - String contract = "BTC_USDT_20200814"; // String | Futures contract - String riskLimit = "10"; // String | New position risk limit + String settle = "usdt"; // String | Settle currency. + String contract = "BTC_USDT_20200814"; // String | Futures contract. + String riskLimit = "10"; // String | New position risk limit. try { Position result = apiInstance.updateDeliveryPositionRiskLimit(settle, contract, riskLimit); System.out.println(result); @@ -1020,9 +1020,9 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: usdt] - **contract** | **String**| Futures contract | - **riskLimit** | **String**| New position risk limit | + **settle** | **String**| Settle currency. | [enum: usdt] + **contract** | **String**| Futures contract. | + **riskLimit** | **String**| New position risk limit. | ### Return type @@ -1040,15 +1040,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information | - | +**200** | Position information. | - | # **listDeliveryOrders** > List<FuturesOrder> listDeliveryOrders(settle, status).contract(contract).limit(limit).offset(offset).lastId(lastId).countTotal(countTotal).execute(); -List futures orders +List futures orders. -Zero-filled order cannot be retrieved 10 minutes after order cancellation +Zero-filled order cannot be retrieved 10 minutes after order cancellation. ### Example @@ -1071,13 +1071,13 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency - String status = "open"; // String | Only list the orders with this 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 offset = 0; // Integer | List offset, starting from 0 + String settle = "usdt"; // String | Settle currency. + String status = "open"; // String | Only list the orders with this 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 offset = 0; // Integer | List offset, starting from 0. String lastId = "12345"; // String | Specify the currency name to query in batches, and support up to 100 pass parameters at a time. - Integer countTotal = 0; // Integer | Whether to return total number matched. Default to 0(no return) + Integer countTotal = 0; // Integer | Whether to return total number matched. Default to 0(no return). try { List result = apiInstance.listDeliveryOrders(settle, status) .contract(contract) @@ -1104,13 +1104,13 @@ 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] - **contract** | **String**| Futures contract | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **settle** | **String**| Settle currency. | [enum: usdt] + **status** | **String**| Only list the orders with this 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] + **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] **lastId** | **String**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time. | [optional] - **countTotal** | **Integer**| Whether to return total number matched. Default to 0(no return) | [optional] [default to 0] [enum: 0, 1] + **countTotal** | **Integer**| Whether to return total number matched. Default 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. | * 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.
| # **createDeliveryOrder** > FuturesOrder createDeliveryOrder(settle, futuresOrder) -Create a futures order +Create a futures order. -Zero-filled order cannot be retrieved 10 minutes after order cancellation +Zero-filled order cannot be retrieved 10 minutes after order cancellation. ### Example @@ -1159,7 +1159,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency + String settle = "usdt"; // String | Settle currency. FuturesOrder futuresOrder = new FuturesOrder(); // FuturesOrder | try { FuturesOrder result = apiInstance.createDeliveryOrder(settle, futuresOrder); @@ -1181,7 +1181,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: usdt] + **settle** | **String**| Settle currency. | [enum: usdt] **futuresOrder** | [**FuturesOrder**](FuturesOrder.md)| | ### Return type @@ -1200,15 +1200,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Order details | - | +**201** | Order details. | - | # **cancelDeliveryOrders** > List<FuturesOrder> cancelDeliveryOrders(settle, contract, side) -Cancel all `open` orders matched +Cancel all `open` orders matched. -Zero-filled order cannot be retrieved 10 minutes after order cancellation +Zero-filled order cannot be retrieved 10 minutes after order cancellation. ### Example @@ -1231,9 +1231,9 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 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. try { List result = apiInstance.cancelDeliveryOrders(settle, contract, side); System.out.println(result); @@ -1254,9 +1254,9 @@ public class Example { 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] + **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] ### Return type @@ -1274,15 +1274,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | All orders matched cancelled | - | +**200** | All orders matched cancelled. | - | # **getDeliveryOrder** > FuturesOrder getDeliveryOrder(settle, orderId) -Get a single order +Get a single order. -Zero-filled order cannot be retrieved 10 minutes after order cancellation +Zero-filled order cannot be retrieved 10 minutes after order cancellation. ### Example @@ -1305,8 +1305,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 settle = "usdt"; // String | Settle currency. + String orderId = "12345"; // String | Retrieve the data of the order with the specified ID. try { FuturesOrder result = apiInstance.getDeliveryOrder(settle, orderId); System.out.println(result); @@ -1327,8 +1327,8 @@ 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 | + **settle** | **String**| Settle currency. | [enum: usdt] + **orderId** | **String**| Retrieve the data of the order with the specified ID. | ### Return type @@ -1346,13 +1346,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order details | - | +**200** | Order details. | - | # **cancelDeliveryOrder** > FuturesOrder cancelDeliveryOrder(settle, orderId) -Cancel a single order +Cancel a single order. ### Example @@ -1375,8 +1375,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 settle = "usdt"; // String | Settle currency. + String orderId = "12345"; // String | Retrieve the data of the order with the specified ID. try { FuturesOrder result = apiInstance.cancelDeliveryOrder(settle, orderId); System.out.println(result); @@ -1397,8 +1397,8 @@ 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 | + **settle** | **String**| Settle currency. | [enum: usdt] + **orderId** | **String**| Retrieve the data of the order with the specified ID. | ### Return type @@ -1416,13 +1416,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order details | - | +**200** | Order details. | - | # **getMyDeliveryTrades** > List<MyFuturesTrade> getMyDeliveryTrades(settle).contract(contract).order(order).limit(limit).offset(offset).lastId(lastId).countTotal(countTotal).execute(); -List personal trading history +List personal trading history. ### Example @@ -1445,13 +1445,13 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - 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 offset = 0; // Integer | List offset, starting from 0 + 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 offset = 0; // Integer | List offset, starting from 0. String lastId = "12345"; // String | Specify the currency name to query in batches, and support up to 100 pass parameters at a time. - Integer countTotal = 0; // Integer | Whether to return total number matched. Default to 0(no return) + Integer countTotal = 0; // Integer | Whether to return total number matched. Default to 0(no return). try { List result = apiInstance.getMyDeliveryTrades(settle) .contract(contract) @@ -1479,13 +1479,13 @@ public class Example { 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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **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] + **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] **lastId** | **String**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time. | [optional] - **countTotal** | **Integer**| Whether to return total number matched. Default to 0(no return) | [optional] [default to 0] [enum: 0, 1] + **countTotal** | **Integer**| Whether to return total number matched. Default 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. | * 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.
| # **listDeliveryPositionClose** > List<PositionClose> listDeliveryPositionClose(settle).contract(contract).limit(limit).execute(); -List position close history +List position close history. ### Example @@ -1532,9 +1532,9 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 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. try { List result = apiInstance.listDeliveryPositionClose(settle) .contract(contract) @@ -1558,9 +1558,9 @@ public class Example { 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] + **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] ### Return type @@ -1578,13 +1578,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **listDeliveryLiquidates** > List<FuturesLiquidate> listDeliveryLiquidates(settle).contract(contract).limit(limit).at(at).execute(); -List liquidation history +List liquidation history. ### Example @@ -1607,10 +1607,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 + 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. try { List result = apiInstance.listDeliveryLiquidates(settle) .contract(contract) @@ -1635,10 +1635,10 @@ public class Example { 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] + **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] ### Return type @@ -1656,13 +1656,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **listDeliverySettlements** > List<DeliverySettlement> listDeliverySettlements(settle).contract(contract).limit(limit).at(at).execute(); -List settlement history +List settlement history. ### Example @@ -1685,10 +1685,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 + 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. try { List result = apiInstance.listDeliverySettlements(settle) .contract(contract) @@ -1713,10 +1713,10 @@ public class Example { 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] + **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] ### Return type @@ -1734,15 +1734,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **listDeliveryRiskLimitTiers** > List<FuturesLimitRiskTiers> listDeliveryRiskLimitTiers(settle).contract(contract).limit(limit).offset(offset).execute(); -List risk limit tiers +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. +When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets.'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect empty. ### Example @@ -1761,10 +1761,10 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 offset = 0; // Integer | List offset, starting from 0 + 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 offset = 0; // Integer | List offset, starting from 0. try { List result = apiInstance.listDeliveryRiskLimitTiers(settle) .contract(contract) @@ -1789,10 +1789,10 @@ public class Example { 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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **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] + **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** | Successfully retrieved. | - | # **listPriceTriggeredDeliveryOrders** > List<FuturesPriceTriggeredOrder> listPriceTriggeredDeliveryOrders(settle, status).contract(contract).limit(limit).offset(offset).execute(); -List All Price-triggered Orders +List All Price-triggered Orders. ### Example @@ -1839,11 +1839,11 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency - String status = "status_example"; // String | Only list the orders with this 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 offset = 0; // Integer | List offset, starting from 0 + String settle = "usdt"; // String | Settle currency. + String status = "status_example"; // String | Only list the orders with this 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 offset = 0; // Integer | List offset, starting from 0. try { List result = apiInstance.listPriceTriggeredDeliveryOrders(settle, status) .contract(contract) @@ -1868,11 +1868,11 @@ 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] - **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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **settle** | **String**| Settle currency. | [enum: usdt] + **status** | **String**| Only list the orders with this 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] + **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. | - | # **createPriceTriggeredDeliveryOrder** > TriggerOrderResponse createPriceTriggeredDeliveryOrder(settle, futuresPriceTriggeredOrder) -Create a price-triggered order +Create a price-triggered order. ### Example @@ -1919,7 +1919,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency + String settle = "usdt"; // String | Settle currency. FuturesPriceTriggeredOrder futuresPriceTriggeredOrder = new FuturesPriceTriggeredOrder(); // FuturesPriceTriggeredOrder | try { TriggerOrderResponse result = apiInstance.createPriceTriggeredDeliveryOrder(settle, futuresPriceTriggeredOrder); @@ -1941,7 +1941,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: usdt] + **settle** | **String**| Settle currency. | [enum: usdt] **futuresPriceTriggeredOrder** | [**FuturesPriceTriggeredOrder**](FuturesPriceTriggeredOrder.md)| | ### Return type @@ -1960,13 +1960,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Order created | - | +**201** | Order created. | - | # **cancelPriceTriggeredDeliveryOrderList** > List<FuturesPriceTriggeredOrder> cancelPriceTriggeredDeliveryOrderList(settle, contract) -Cancel All Price-triggered Orders +Cancel All Price-triggered Orders. ### Example @@ -1989,8 +1989,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency - String contract = "BTC_USDT"; // String | Futures contract + String settle = "usdt"; // String | Settle currency. + String contract = "BTC_USDT"; // String | Futures contract. try { List result = apiInstance.cancelPriceTriggeredDeliveryOrderList(settle, contract); System.out.println(result); @@ -2011,8 +2011,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: usdt] - **contract** | **String**| Futures contract | + **settle** | **String**| Settle currency. | [enum: usdt] + **contract** | **String**| Futures contract. | ### Return type @@ -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. Query order status by listing orders. | - | # **getPriceTriggeredDeliveryOrder** > FuturesPriceTriggeredOrder getPriceTriggeredDeliveryOrder(settle, orderId) -Get a price-triggered order +Get a price-triggered order. ### Example @@ -2059,8 +2059,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 settle = "usdt"; // String | Settle currency. + String orderId = "orderId_example"; // String | Retrieve the data of the order with the specified ID. try { FuturesPriceTriggeredOrder result = apiInstance.getPriceTriggeredDeliveryOrder(settle, orderId); System.out.println(result); @@ -2081,8 +2081,8 @@ 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 | + **settle** | **String**| Settle currency. | [enum: usdt] + **orderId** | **String**| Retrieve the data of the order with the specified ID. | ### 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 detail. | - | # **cancelPriceTriggeredDeliveryOrder** > FuturesPriceTriggeredOrder cancelPriceTriggeredDeliveryOrder(settle, orderId) -cancel a price-triggered order +cancel a price-triggered order. ### Example @@ -2129,8 +2129,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 settle = "usdt"; // String | Settle currency. + String orderId = "orderId_example"; // String | Retrieve the data of the order with the specified ID. try { FuturesPriceTriggeredOrder result = apiInstance.cancelPriceTriggeredDeliveryOrder(settle, orderId); System.out.println(result); @@ -2151,8 +2151,8 @@ 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 | + **settle** | **String**| Settle currency. | [enum: usdt] + **orderId** | **String**| Retrieve the data of the order with the specified ID. | ### 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 detail. | - | diff --git a/docs/DeliveryCandlestick.md b/docs/DeliveryCandlestick.md index 9544efc..8fb3a69 100644 --- a/docs/DeliveryCandlestick.md +++ b/docs/DeliveryCandlestick.md @@ -1,16 +1,16 @@ # DeliveryCandlestick -data point in every timestamp +data point in every timestamp. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**t** | **Double** | Unix timestamp in seconds | [optional] -**v** | **Long** | size volume (contract size). Only returned if `contract` is not prefixed | [optional] -**c** | **String** | Close price (quote currency) | [optional] -**h** | **String** | Highest price (quote currency) | [optional] -**l** | **String** | Lowest price (quote currency) | [optional] -**o** | **String** | Open price (quote currency) | [optional] +**t** | **Double** | Unix timestamp in seconds. | [optional] +**v** | **Long** | size volume (contract size). Only returned if `contract` is not prefixed. | [optional] +**c** | **String** | Close price (quote currency). | [optional] +**h** | **String** | Highest price (quote currency). | [optional] +**l** | **String** | Lowest price (quote currency). | [optional] +**o** | **String** | Open price (quote currency). | [optional] diff --git a/docs/DeliveryContract.md b/docs/DeliveryContract.md index 0473943..b7e3262 100644 --- a/docs/DeliveryContract.md +++ b/docs/DeliveryContract.md @@ -1,50 +1,50 @@ # DeliveryContract -Futures contract details +Futures contract details. ## Properties 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] -**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] -**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] -**takerFeeRate** | **String** | Taker fee rate | [optional] -**orderPriceRound** | **String** | Minimum order price increment | [optional] -**markPriceRound** | **String** | Minimum mark price increment | [optional] -**basisRate** | **String** | Fair basis rate | [optional] -**basisValue** | **String** | Fair basis value | [optional] -**basisImpactValue** | **String** | Funding used for calculating impact bid, ask price | [optional] -**settlePrice** | **String** | Settle price | [optional] -**settlePriceInterval** | **Integer** | Settle price update interval | [optional] -**settlePriceDuration** | **Integer** | Settle price update duration in seconds | [optional] -**expireTime** | **Long** | Contract expiry timestamp | [optional] -**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] +**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] +**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, 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] +**takerFeeRate** | **String** | Taker fee rate. | [optional] +**orderPriceRound** | **String** | Minimum order price increment. | [optional] +**markPriceRound** | **String** | Minimum mark price increment. | [optional] +**basisRate** | **String** | Fair basis rate. | [optional] +**basisValue** | **String** | Fair basis value. | [optional] +**basisImpactValue** | **String** | Funding used for calculating impact bid, ask price. | [optional] +**settlePrice** | **String** | Settle price. | [optional] +**settlePriceInterval** | **Integer** | Settle price update interval. | [optional] +**settlePriceDuration** | **Integer** | Settle price update duration in seconds. | [optional] +**expireTime** | **Long** | Contract expiry timestamp. | [optional] +**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] -**tradeId** | **Long** | Current trade ID | [optional] -**tradeSize** | **Long** | Historical accumulated trade size | [optional] -**positionSize** | **Long** | Current total long position size | [optional] -**configChangeTime** | **Double** | Last changed time of configuration | [optional] -**inDelisting** | **Boolean** | Contract is delisting | [optional] -**ordersLimit** | **Integer** | Maximum number of open orders | [optional] +**refDiscountRate** | **String** | Referral fee rate discount. | [optional] +**refRebateRate** | **String** | Referrer commission rate. | [optional] +**orderbookId** | **Long** | Current orderbook ID. | [optional] +**tradeId** | **Long** | Current trade ID. | [optional] +**tradeSize** | **Long** | Historical accumulated trade size. | [optional] +**positionSize** | **Long** | Current total long position size. | [optional] +**configChangeTime** | **Double** | Last changed time of configuration. | [optional] +**inDelisting** | **Boolean** | Contract is delisting. | [optional] +**ordersLimit** | **Integer** | Maximum number of open orders. | [optional] ## Enum: CycleEnum diff --git a/docs/DeliverySettlement.md b/docs/DeliverySettlement.md index 68582cf..8dc451d 100644 --- a/docs/DeliverySettlement.md +++ b/docs/DeliverySettlement.md @@ -5,13 +5,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**time** | **Long** | Liquidation time | [optional] [readonly] -**contract** | **String** | Futures contract | [optional] [readonly] -**leverage** | **String** | Position leverage | [optional] [readonly] -**size** | **Long** | Position size | [optional] [readonly] -**margin** | **String** | Position margin | [optional] [readonly] -**entryPrice** | **String** | Average entry price | [optional] [readonly] -**settlePrice** | **String** | Settled price | [optional] [readonly] -**profit** | **String** | Profit | [optional] [readonly] -**fee** | **String** | Fee deducted | [optional] [readonly] +**time** | **Long** | Liquidation time. | [optional] [readonly] +**contract** | **String** | Futures contract. | [optional] [readonly] +**leverage** | **String** | Position leverage. | [optional] [readonly] +**size** | **Long** | Position size. | [optional] [readonly] +**margin** | **String** | Position margin. | [optional] [readonly] +**entryPrice** | **String** | Average entry price. | [optional] [readonly] +**settlePrice** | **String** | Settled price. | [optional] [readonly] +**profit** | **String** | Profit. | [optional] [readonly] +**fee** | **String** | Fee deducted. | [optional] [readonly] diff --git a/docs/DeliveryTicker.md b/docs/DeliveryTicker.md index 858013a..63c77e8 100644 --- a/docs/DeliveryTicker.md +++ b/docs/DeliveryTicker.md @@ -5,27 +5,27 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**contract** | **String** | Futures contract | [optional] -**last** | **String** | Last trading price | [optional] +**contract** | **String** | Futures contract. | [optional] +**last** | **String** | Last trading price. | [optional] **changePercentage** | **String** | Change percentage. | [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] +**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] -**markPrice** | **String** | Recent mark price | [optional] -**fundingRate** | **String** | Funding rate | [optional] -**fundingRateIndicative** | **String** | Indicative Funding rate in next period. (deprecated. use `funding_rate`) | [optional] -**indexPrice** | **String** | Index price | [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] +**markPrice** | **String** | Recent mark price. | [optional] +**fundingRate** | **String** | Funding rate. | [optional] +**fundingRateIndicative** | **String** | Indicative Funding rate in next period. (deprecated. use `funding_rate`). | [optional] +**indexPrice** | **String** | Index price. | [optional] **quantoBaseRate** | **String** | Exchange rate of base currency and settlement currency in Quanto contract. Does not exists in contracts of other types | [optional] -**basisRate** | **String** | Basis rate | [optional] -**basisValue** | **String** | Basis value | [optional] -**lowestAsk** | **String** | Recent lowest ask | [optional] -**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] +**basisRate** | **String** | Basis rate. | [optional] +**basisValue** | **String** | Basis value. | [optional] +**lowestAsk** | **String** | Recent lowest ask. | [optional] +**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] diff --git a/docs/DepositAddress.md b/docs/DepositAddress.md index 8ec52fa..9f9db10 100644 --- a/docs/DepositAddress.md +++ b/docs/DepositAddress.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency detail | -**address** | **String** | Deposit address | +**currency** | **String** | Currency detail. | +**address** | **String** | Deposit address. | **multichainAddresses** | [**List<MultiChainAddressItem>**](MultiChainAddressItem.md) | | [optional] diff --git a/docs/DepositRecord.md b/docs/DepositRecord.md index 826ff86..5b31601 100644 --- a/docs/DepositRecord.md +++ b/docs/DepositRecord.md @@ -5,14 +5,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | Record ID | [optional] [readonly] -**txid** | **String** | Hash record of the withdrawal | [optional] [readonly] +**id** | **String** | Record ID. | [optional] [readonly] +**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 | -**currency** | **String** | Currency name | -**address** | **String** | Withdrawal address. Required for withdrawals | [optional] -**memo** | **String** | Additional remarks with regards to the withdrawal | [optional] +**timestamp** | **String** | Operation time. | [optional] [readonly] +**amount** | **String** | Currency amount. | +**currency** | **String** | Currency name. | +**address** | **String** | Withdrawal address. Required for withdrawals. | [optional] +**memo** | **String** | Additional remarks with regards to the withdrawal. | [optional] **status** | **String** | Trading Status - REVIEW: Recharge review (compliance review) - PEND: Processing - DONE: Waiting for funds to be unlocked - INVALID: Invalid data - TRACK: Track the number of confirmations, waiting to add funds to the user (spot) - BLOCKED: Rejected Recharge - DEP_CREDITED: Recharge to account, withdrawal is not unlocked | [optional] [readonly] -**chain** | **String** | Name of the chain used in withdrawals | +**chain** | **String** | Name of the chain used in withdrawals. | diff --git a/docs/DualGetOrders.md b/docs/DualGetOrders.md index bcb0fe1..9a04532 100644 --- a/docs/DualGetOrders.md +++ b/docs/DualGetOrders.md @@ -5,21 +5,21 @@ 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] +**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] -**exercisePrice** | **String** | Strike price | [optional] -**settlementPrice** | **String** | settlement price | [optional] -**settlementCurrency** | **String** | Settle currency | [optional] -**apyDisplay** | **String** | APY | [optional] -**apySettlement** | **String** | Settlement APY | [optional] -**deliveryTime** | **Integer** | Settlement time | [optional] -**text** | **String** | Custom order information | [optional] +**investCurrency** | **String** | Investment Currency. | [optional] +**exerciseCurrency** | **String** | Strike Currency. | [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] +**deliveryTime** | **Integer** | Settlement time. | [optional] +**text** | **String** | Custom order information. | [optional] diff --git a/docs/DualGetPlans.md b/docs/DualGetPlans.md index a91215e..27fa3a3 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] -**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] +**id** | **Integer** | Plan ID. | [optional] +**instrumentName** | **String** | Instrument Name. | [optional] +**investCurrency** | **String** | Investment Currency. | [optional] +**exerciseCurrency** | **String** | Strike Currency. | [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] diff --git a/docs/EarnApi.md b/docs/EarnApi.md index 93bbb72..7b649a9 100644 --- a/docs/EarnApi.md +++ b/docs/EarnApi.md @@ -4,23 +4,23 @@ 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 -[**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 +[**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. +[**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. # **swapETH2** > swapETH2(eth2Swap) -ETH2 swap +ETH2 swap. ### Example @@ -81,15 +81,15 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | swap success | - | +**200** | swap success. | - | # **rateListETH2** > List<Eth2RateList> rateListETH2() -ETH2 historical rate of return query +ETH2 historical rate of return query. -Check the ETH earnings rate record for the last 31 days +Check the ETH earnings rate record for the last 31 days. ### Example @@ -147,13 +147,13 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful | - | +**200** | Successful. | - | # **listDualInvestmentPlans** > List<DualGetPlans> listDualInvestmentPlans().planId(planId).execute(); -Dual Investment product list +Dual Investment product list. ### Example @@ -172,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) @@ -195,7 +195,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **planId** | **Long**| Financial project id | [optional] + **planId** | **Long**| Financial project id. | [optional] ### Return type @@ -213,13 +213,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful | - | +**200** | Successful. | - | # **listDualOrders** > List<DualGetOrders> listDualOrders().from(from).to(to).page(page).limit(limit).execute(); -Dual Investment order list +Dual Investment order list. ### Example @@ -242,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 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 + Long from = 1740727000L; // Long | Start checkout 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. try { List result = apiInstance.listDualOrders() .from(from) @@ -271,10 +271,10 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **from** | **Long**| Start checkout 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] + **from** | **Long**| Start checkout 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] ### Return type @@ -292,13 +292,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful | - | +**200** | Successful. | - | # **placeDualOrder** > placeDualOrder(placeDualInvestmentOrder) -Place Dual Investment order +Place Dual Investment order. ### Example @@ -359,13 +359,13 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | Success. | - | # **listStructuredProducts** > List<StructuredGetProjectList> listStructuredProducts(status).type(type).page(page).limit(limit).execute(); -Structured Product List +Structured Product List. ### Example @@ -386,8 +386,8 @@ public class Example { EarnApi apiInstance = new EarnApi(defaultClient); 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 page = 1; // Integer | Page number. + Integer limit = 100; // Integer | Maximum number of records to be returned in a single list. try { List result = apiInstance.listStructuredProducts(status) .type(type) @@ -414,8 +414,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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] + **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] ### Return type @@ -433,13 +433,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful | - | +**200** | Successful. | - | # **listStructuredOrders** > List<StructuredOrderList> listStructuredOrders().from(from).to(to).page(page).limit(limit).execute(); -Structured Product Order List +Structured Product Order List. ### Example @@ -464,8 +464,8 @@ public class Example { EarnApi apiInstance = new EarnApi(defaultClient); 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 page = 1; // Integer | Page number. + Integer limit = 100; // Integer | Maximum number of records to be returned in a single list. try { List result = apiInstance.listStructuredOrders() .from(from) @@ -493,8 +493,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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] + **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] ### Return type @@ -512,13 +512,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful | - | +**200** | Successful. | - | # **placeStructuredOrder** > placeStructuredOrder(structuredBuy) -Place Structured Product Order +Place Structured Product Order. ### Example @@ -579,13 +579,13 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | Success. | - | # **findCoin** > List<String> findCoin(findCoin) -Staking Coins +Staking Coins. ### Example @@ -647,13 +647,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful | - | +**200** | Successful. | - | # **swapStakingCoin** > SwapCoinStruct swapStakingCoin(swapCoin) -On-chain Token Swap for Earned Coins +On-chain Token Swap for Earned Coins. ### Example @@ -715,5 +715,5 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | swap success | - | +**200** | swap success. | - | diff --git a/docs/EarnUniApi.md b/docs/EarnUniApi.md index f7ec8af..20852f1 100644 --- a/docs/EarnUniApi.md +++ b/docs/EarnUniApi.md @@ -4,24 +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 -[**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 +[**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. +[**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. # **listUniCurrencies** > List<UniCurrency> listUniCurrencies() -List currencies for lending +List currencies for lending. ### Example @@ -75,13 +75,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **getUniCurrency** > UniCurrency getUniCurrency(currency) -Get currency detail for lending +Get currency detail for lending. ### Example @@ -100,7 +100,7 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); EarnUniApi apiInstance = new EarnUniApi(defaultClient); - String currency = "btc"; // String | Currency + String currency = "btc"; // String | Currency. try { UniCurrency result = apiInstance.getUniCurrency(currency); System.out.println(result); @@ -121,7 +121,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Currency | + **currency** | **String**| Currency. | ### Return type @@ -139,13 +139,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listUserUniLends** > List<UniLend> listUserUniLends().currency(currency).page(page).limit(limit).execute(); -List user's lending orders +List user's lending orders. ### Example @@ -168,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 - Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 100 + 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. try { List result = apiInstance.listUserUniLends() .currency(currency) @@ -195,9 +195,9 @@ public class Example { 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] + **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] ### Return type @@ -215,15 +215,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **createUniLend** > createUniLend(createUniLend) -Lend or redeem +Lend or redeem. -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 determination, no interest will be earned 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. +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 @@ -284,15 +284,15 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Operated successfully | - | +**204** | Operated successfully. | - | # **changeUniLend** > changeUniLend(patchUniLend) -Amend lending order +Amend lending order. -Currently only supports amending the minimum interest rate (hour) +Currently only supports amending the minimum interest rate (hour). ### Example @@ -353,13 +353,13 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Updated | - | +**204** | Updated. | - | # **listUniLendRecords** > List<UniLendRecord> listUniLendRecords().currency(currency).page(page).limit(limit).from(from).to(to).type(type).execute(); -List records of lending +List records of lending. ### Example @@ -382,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 - Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 100 + 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 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 | type: lend - lend, redeem - redeem + String type = "lend"; // String | type: lend - lend, redeem - redeem. try { List result = apiInstance.listUniLendRecords() .currency(currency) @@ -415,12 +415,12 @@ public class Example { 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] + **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 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**| type: lend - lend, redeem - redeem | [optional] [enum: lend, redeem] + **type** | **String**| type: lend - lend, redeem - redeem. | [optional] [enum: lend, redeem] ### Return type @@ -438,13 +438,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **getUniInterest** > UniLendInterest getUniInterest(currency) -Get the user's total interest income of specified currency +Get the user's total interest income of specified currency. ### Example @@ -467,7 +467,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); EarnUniApi apiInstance = new EarnUniApi(defaultClient); - String currency = "btc"; // String | Currency + String currency = "btc"; // String | Currency. try { UniLendInterest result = apiInstance.getUniInterest(currency); System.out.println(result); @@ -488,7 +488,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Currency | + **currency** | **String**| Currency. | ### Return type @@ -506,13 +506,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listUniInterestRecords** > List<UniInterestRecord> listUniInterestRecords().currency(currency).page(page).limit(limit).from(from).to(to).execute(); -List interest records +List interest records. ### Example @@ -535,9 +535,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 - Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 100 + 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 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 { @@ -566,9 +566,9 @@ public class Example { 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] + **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 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] @@ -588,13 +588,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **getUniInterestStatus** > UniCurrencyInterest getUniInterestStatus(currency) -query currency interest compounding status +query currency interest compounding status. ### Example @@ -617,7 +617,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); EarnUniApi apiInstance = new EarnUniApi(defaultClient); - String currency = "btc"; // String | Currency + String currency = "btc"; // String | Currency. try { UniCurrencyInterest result = apiInstance.getUniInterestStatus(currency); System.out.println(result); @@ -638,7 +638,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Currency | + **currency** | **String**| Currency. | ### Return type @@ -656,15 +656,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listUniChart** > List<InlineResponse200> listUniChart(from, to, asset) -UniLoan currency annualized trend chart +UniLoan currency annualized trend chart. -Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:48+0000 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 +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 @@ -687,9 +687,9 @@ 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 - String asset = "BTC"; // String | Currency name + 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. + String asset = "BTC"; // String | Currency name. try { List result = apiInstance.listUniChart(from, to, asset); System.out.println(result); @@ -710,9 +710,9 @@ 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 | - **asset** | **String**| Currency name | + **from** | **Long**| Start timestamp, unit s, maximum span of 30 days. | + **to** | **Long**| End timestamp, unit s, maximum span of 30 days. | + **asset** | **String**| Currency name. | ### Return type @@ -730,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-07-15 06:48+0000 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 | - | +**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 estimate annualized interest rate. -Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:48+0000 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 +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 @@ -796,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-07-15 06:48+0000 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 | - | +**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..e601241 100644 --- a/docs/Eth2RateList.md +++ b/docs/Eth2RateList.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dateTime** | **Long** | Date and Time Stamp | [optional] -**date** | **String** | Date | [optional] -**rate** | **String** | percentage | [optional] +**dateTime** | **Long** | Date and Time Stamp. | [optional] +**date** | **String** | Date. | [optional] +**rate** | **String** | percentage. | [optional] diff --git a/docs/Eth2Swap.md b/docs/Eth2Swap.md index d6955d0..7df43aa 100644 --- a/docs/Eth2Swap.md +++ b/docs/Eth2Swap.md @@ -1,12 +1,12 @@ # Eth2Swap -ETH2 Staking +ETH2 Staking. ## 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** | amount. | diff --git a/docs/FindCoin.md b/docs/FindCoin.md index 34f4993..c8f3100 100644 --- a/docs/FindCoin.md +++ b/docs/FindCoin.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**coin** | **String** | Currency | [optional] -**cointype** | **String** | Coin Type swap-Voucher lock-Locked | [optional] +**coin** | **String** | Currency. | [optional] +**cointype** | **String** | Coin Type swap-Voucher lock-Locked. | [optional] diff --git a/docs/FlashSwapApi.md b/docs/FlashSwapApi.md index 4a03b41..b4cbebc 100644 --- a/docs/FlashSwapApi.md +++ b/docs/FlashSwapApi.md @@ -4,18 +4,18 @@ 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 -[**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 +[**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. +[**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. # **listFlashSwapCurrencyPair** > List<FlashSwapCurrencyPair> listFlashSwapCurrencyPair().currency(currency).page(page).limit(limit).execute(); -List All Supported Currency Pairs In Flash Swap +List All Supported Currency Pairs In Flash Swap. `BTC_GT` represents selling BTC and buying GT. The limits for each currency may vary across different currency pairs. It is not necessary that two currencies that can be swapped instantaneously can be exchanged with each other. For example, it is possible to sell BTC and buy GT, but it does not necessarily mean that GT can be sold to buy BTC. @@ -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 - Integer page = 1; // Integer | Page number - Integer limit = 1000; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 1000 + String currency = "BTC"; // String | Retrieve data of the specified currency. + Integer page = 1; // Integer | Page number. + Integer limit = 1000; // Integer | Maximum response items. Default: 100, 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] - **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum response items. Default: 100, minimum: 1, Maximum: 1000 | [optional] [default to 1000] + **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: 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** | Successfully retrieved. | - | # **listFlashSwapOrders** > List<FlashSwapOrder> listFlashSwapOrders().status(status).sellCurrency(sellCurrency).buyCurrency(buyCurrency).reverse(reverse).limit(limit).page(page).execute(); -List all flash swap orders +List all flash swap orders. ### Example @@ -115,9 +115,9 @@ public class Example { 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 page = 1; // Integer | Page number + 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) - ascending order(oldest first) + Integer limit = 100; // Integer | Maximum number of records to be returned in a single list. + Integer page = 1; // Integer | Page number. try { List result = apiInstance.listFlashSwapOrders() .status(status) @@ -148,9 +148,9 @@ 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] - **page** | **Integer**| Page number | [optional] [default to 1] + **reverse** | **Boolean**| If results are sorted by id in reverse order. Default to `true` - `true`: sort by id in descending order(recent first) - ascending order(oldest first) | [optional] + **limit** | **Integer**| Maximum number of records to be returned in a single list. | [optional] [default to 100] + **page** | **Integer**| Page number. | [optional] [default to 1] ### Return type @@ -168,13 +168,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **createFlashSwapOrder** > FlashSwapOrder createFlashSwapOrder(flashSwapOrderRequest) -Create a flash swap order +Create a flash swap order. Initiate a flash swap preview in advance because order creation requires a preview result @@ -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** | The flash swap order is created successfully. | - | # **getFlashSwapOrder** > FlashSwapOrder getFlashSwapOrder(orderId) -Get a single flash swap order's detail +Get a single flash swap order's detail. ### Example @@ -267,7 +267,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FlashSwapApi apiInstance = new FlashSwapApi(defaultClient); - Integer orderId = 1; // Integer | Flash swap order ID + Integer orderId = 1; // Integer | Flash swap order ID. try { FlashSwapOrder result = apiInstance.getFlashSwapOrder(orderId); System.out.println(result); @@ -288,7 +288,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **orderId** | **Integer**| Flash swap order ID | + **orderId** | **Integer**| Flash swap order ID. | ### Return type @@ -306,13 +306,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **previewFlashSwapOrder** > FlashSwapOrderPreview previewFlashSwapOrder(flashSwapPreviewRequest) -Initiate a flash swap order preview +Initiate a 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** | The flash swap order successfully previewed. | - | diff --git a/docs/FlashSwapCurrencyPair.md b/docs/FlashSwapCurrencyPair.md index 79406b1..aef9f84 100644 --- a/docs/FlashSwapCurrencyPair.md +++ b/docs/FlashSwapCurrencyPair.md @@ -1,17 +1,17 @@ # FlashSwapCurrencyPair -List all supported currencies in flash swap +List all supported currencies in flash swap. ## Properties 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] +**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] diff --git a/docs/FlashSwapOrder.md b/docs/FlashSwapOrder.md index fcf1cd3..3990d15 100644 --- a/docs/FlashSwapOrder.md +++ b/docs/FlashSwapOrder.md @@ -1,19 +1,19 @@ # FlashSwapOrder -Flash swap order +Flash swap order. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Long** | Flash swap order ID | [optional] [readonly] -**createTime** | **Long** | Creation time of order (in milliseconds) | [optional] [readonly] -**userId** | **Long** | User ID | [optional] [readonly] -**sellCurrency** | **String** | Currency to sell | [optional] [readonly] -**sellAmount** | **String** | Amount to sell | [optional] [readonly] -**buyCurrency** | **String** | Currency to buy | [optional] [readonly] -**buyAmount** | **String** | Amount to buy | [optional] [readonly] -**price** | **String** | Price | [optional] [readonly] +**id** | **Long** | Flash swap order ID. | [optional] [readonly] +**createTime** | **Long** | Creation time of order (in milliseconds). | [optional] [readonly] +**userId** | **Long** | User ID. | [optional] [readonly] +**sellCurrency** | **String** | Currency to sell. | [optional] [readonly] +**sellAmount** | **String** | Amount to sell. | [optional] [readonly] +**buyCurrency** | **String** | Currency to buy. | [optional] [readonly] +**buyAmount** | **String** | Amount to buy. | [optional] [readonly] +**price** | **String** | Price. | [optional] [readonly] **status** | **Integer** | Flash swap order status `1` - success `2` - failure | [optional] [readonly] diff --git a/docs/FlashSwapOrderPreview.md b/docs/FlashSwapOrderPreview.md index bf76ffe..7fa4fd8 100644 --- a/docs/FlashSwapOrderPreview.md +++ b/docs/FlashSwapOrderPreview.md @@ -1,16 +1,16 @@ # FlashSwapOrderPreview -Initiate a flash swap order preview +Initiate a flash swap order preview. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**previewId** | **String** | Preview result ID | [optional] +**previewId** | **String** | Preview result ID. | [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] +**sellAmount** | **String** | Amount to sell. | [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] +**buyAmount** | **String** | Amount to buy. | [optional] +**price** | **String** | Price. | [optional] diff --git a/docs/FlashSwapOrderRequest.md b/docs/FlashSwapOrderRequest.md index 100b504..9905c66 100644 --- a/docs/FlashSwapOrderRequest.md +++ b/docs/FlashSwapOrderRequest.md @@ -1,15 +1,15 @@ # FlashSwapOrderRequest -Parameters of flash swap order creation +Parameters of flash swap order creation. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**previewId** | **String** | Preview result ID | +**previewId** | **String** | Preview result ID. | **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) | +**sellAmount** | **String** | Amount to sell (based on the preview result). | **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) | +**buyAmount** | **String** | Amount to buy (based on the preview result). | diff --git a/docs/FlashSwapPreviewRequest.md b/docs/FlashSwapPreviewRequest.md index 1fec8a3..a8d64e7 100644 --- a/docs/FlashSwapPreviewRequest.md +++ b/docs/FlashSwapPreviewRequest.md @@ -1,7 +1,7 @@ # FlashSwapPreviewRequest -Parameters of flash swap order creation +Parameters of flash swap order creation. ## Properties diff --git a/docs/FundingAccount.md b/docs/FundingAccount.md index dfa4e8a..88d18f4 100644 --- a/docs/FundingAccount.md +++ b/docs/FundingAccount.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency name | [optional] -**available** | **String** | Available assets to lend, which is identical to spot account `available` | [optional] -**locked** | **String** | Locked amount. i.e. amount in `open` loans | [optional] -**lent** | **String** | Outstanding loan amount yet to be repaid | [optional] -**totalLent** | **String** | Amount used for lending. total_lent = lent + locked | [optional] +**currency** | **String** | Currency name. | [optional] +**available** | **String** | Available assets to lend, which is identical to spot account `available`. | [optional] +**locked** | **String** | Locked amount. i.e. amount in `open` loans. | [optional] +**lent** | **String** | Outstanding loan amount yet to be repaid. | [optional] +**totalLent** | **String** | Amount used for lending. total_lent = lent + locked. | [optional] diff --git a/docs/FundingRateRecord.md b/docs/FundingRateRecord.md index 07639ee..4aa8567 100644 --- a/docs/FundingRateRecord.md +++ b/docs/FundingRateRecord.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**t** | **Long** | Unix timestamp in seconds | [optional] -**r** | **String** | Funding rate | [optional] +**t** | **Long** | Unix timestamp in seconds. | [optional] +**r** | **String** | Funding rate. | [optional] diff --git a/docs/FutureCancelOrderResult.md b/docs/FutureCancelOrderResult.md index 7a7ebec..bf5e945 100644 --- a/docs/FutureCancelOrderResult.md +++ b/docs/FutureCancelOrderResult.md @@ -1,14 +1,14 @@ # FutureCancelOrderResult -Order cancellation result +Order cancellation result. ## Properties 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] +**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] diff --git a/docs/FuturesAccount.md b/docs/FuturesAccount.md index 4ede5c7..7e1a327 100644 --- a/docs/FuturesAccount.md +++ b/docs/FuturesAccount.md @@ -6,29 +6,29 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **total** | **String** | total is the balance after the user's accumulated deposit, withdraw, profit and loss (including realized profit and loss, fund, fee and referral rebate), excluding unrealized profit and loss. total = SUM(history_dnw, history_pnl, history_fee, history_refr, history_fund) | [optional] -**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] -**inDualMode** | **Boolean** | Whether dual mode is enabled | [optional] -**enableCredit** | **Boolean** | Whether portfolio margin account mode is enabled | [optional] -**positionInitialMargin** | **String** | Initial margin position, applicable to the portfolio margin account model | [optional] +**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 withdrawn. The transfer amount needs to deduct the bonus) | [optional] +**point** | **String** | POINT amount. | [optional] +**currency** | **String** | Settle currency. | [optional] +**inDualMode** | **Boolean** | Whether dual mode is enabled. | [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] -**enableEvolvedClassic** | **Boolean** | Classic account margin mode, true-new mode, false-old mode | [optional] +**bonus** | **String** | Perpetual Contract 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] +**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] -**enableNewDualMode** | **Boolean** | Whether to open a new two-way position mode | [optional] +**isolatedPositionMargin** | **String** | Ware -position margin, suitable for the new classic account margin model. | [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] +**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 7b87091..2ea8816 100644 --- a/docs/FuturesAccountBook.md +++ b/docs/FuturesAccountBook.md @@ -5,14 +5,14 @@ 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] -**text** | **String** | Comment | [optional] +**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_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction | [optional] +**text** | **String** | Comment. | [optional] **contract** | **String** | Futures contract, the field is only available for data after 2023-10-30. | [optional] -**tradeId** | **String** | trade id | [optional] -**id** | **String** | Account change record ID | [optional] +**tradeId** | **String** | trade id. | [optional] +**id** | **String** | Account change record ID. | [optional] ## Enum: TypeEnum diff --git a/docs/FuturesAccountHistory.md b/docs/FuturesAccountHistory.md index 67b7e58..2b30d5c 100644 --- a/docs/FuturesAccountHistory.md +++ b/docs/FuturesAccountHistory.md @@ -1,20 +1,20 @@ # FuturesAccountHistory -Statistical data +Statistical data. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dnw** | **String** | total amount of deposit and withdraw | [optional] -**pnl** | **String** | total amount of trading profit and loss | [optional] -**fee** | **String** | total amount of fee | [optional] -**refr** | **String** | total amount of referrer rebates | [optional] -**fund** | **String** | total amount of funding costs | [optional] -**pointDnw** | **String** | total amount of point deposit and withdraw | [optional] -**pointFee** | **String** | total amount of point fee | [optional] -**pointRefr** | **String** | total amount of referrer rebates of point fee | [optional] -**bonusDnw** | **String** | total amount of perpetual contract bonus transfer | [optional] -**bonusOffset** | **String** | total amount of perpetual contract bonus deduction | [optional] +**dnw** | **String** | total amount of deposit and withdraw. | [optional] +**pnl** | **String** | total amount of trading profit and loss. | [optional] +**fee** | **String** | total amount of fee. | [optional] +**refr** | **String** | total amount of referrer rebates. | [optional] +**fund** | **String** | total amount of funding costs. | [optional] +**pointDnw** | **String** | total amount of point deposit and withdraw. | [optional] +**pointFee** | **String** | total amount of point fee. | [optional] +**pointRefr** | **String** | total amount of referrer rebates of point fee. | [optional] +**bonusDnw** | **String** | total amount of perpetual contract bonus transfer. | [optional] +**bonusOffset** | **String** | total amount of perpetual contract bonus deduction. | [optional] diff --git a/docs/FuturesApi.md b/docs/FuturesApi.md index 4a6f999..2d80b58 100644 --- a/docs/FuturesApi.md +++ b/docs/FuturesApi.md @@ -4,62 +4,62 @@ 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 -[**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 -[**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 -[**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 -[**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 -[**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 | 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 +[**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. +[**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. +[**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. +[**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. +[**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. +[**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 | 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. # **listFuturesContracts** > List<Contract> listFuturesContracts(settle).limit(limit).offset(offset).execute(); -List all futures contracts +List all futures contracts. ### Example @@ -78,9 +78,9 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 offset = 0; // Integer | List offset, starting from 0 + String settle = "usdt"; // String | Settle currency. + Integer limit = 100; // Integer | Maximum number of records to be returned in a single list. + Integer offset = 0; // Integer | List offset, starting from 0. try { List result = apiInstance.listFuturesContracts(settle) .limit(limit) @@ -104,9 +104,9 @@ 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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **settle** | **String**| Settle currency. | [enum: btc, usdt] + **limit** | **Integer**| Maximum number of records to be returned in a single list. | [optional] [default to 100] + **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] ### Return type @@ -124,13 +124,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **getFuturesContract** > Contract getFuturesContract(settle, contract) -Get a single contract +Get a single contract. ### Example @@ -149,8 +149,8 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency - String contract = "BTC_USDT"; // String | Futures contract + String settle = "usdt"; // String | Settle currency. + String contract = "BTC_USDT"; // String | Futures contract. try { Contract result = apiInstance.getFuturesContract(settle, contract); System.out.println(result); @@ -171,8 +171,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] - **contract** | **String**| Futures contract | + **settle** | **String**| Settle currency. | [enum: btc, usdt] + **contract** | **String**| Futures contract. | ### Return type @@ -190,15 +190,15 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Contract information | - | +**200** | Contract information. | - | # **listFuturesOrderBook** > FuturesOrderBook listFuturesOrderBook(settle, contract).interval(interval).limit(limit).withId(withId).execute(); -Futures order book +Futures order book. -Bids will be sorted by price from high to low, while asks sorted reversely +Bids will be sorted by price from high to low, while asks sorted reversely. ### Example @@ -217,10 +217,10 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 + 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 to return depth update ID. This ID increments by 1 each time. try { FuturesOrderBook result = apiInstance.listFuturesOrderBook(settle, contract) @@ -246,10 +246,10 @@ public class Example { 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] + **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 to return depth update ID. This ID increments by 1 each time. | [optional] [default to false] ### Return type @@ -268,13 +268,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Depth query successful | - | +**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 trading history. ### Example @@ -293,13 +293,13 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 offset = 0; // Integer | List offset, starting from 0 + 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 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) @@ -326,13 +326,13 @@ public class Example { 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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **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] + **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 @@ -350,13 +350,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **listFuturesCandlesticks** > List<FuturesCandlestick> listFuturesCandlesticks(settle, contract).from(from).to(to).limit(limit).interval(interval).execute(); -Get futures candlesticks +Get futures candlesticks. 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` @@ -377,12 +377,12 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency - String contract = "BTC_USDT"; // String | Futures contract + 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 | 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 + 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 specified 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 + 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. 1 natual month, not 30 days try { List result = apiInstance.listFuturesCandlesticks(settle, contract) .from(from) @@ -408,12 +408,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] - **contract** | **String**| Futures contract | + **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**| 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 | [optional] + **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 specified | [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"] + **interval** | **String**| Interval time between data points. Note that `1w` means natual week(Mon-Sun), while `7d` means every 7d since unix 0. 1 natual month, not 30 days | [optional] [default to "5m"] ### Return type @@ -431,13 +431,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listFuturesPremiumIndex** > List<FuturesPremiumIndex> listFuturesPremiumIndex(settle, contract).from(from).to(to).limit(limit).interval(interval).execute(); -Premium Index K-Line +Premium Index K-Line. Maximum of 1000 points can be returned in a query. Be sure not to exceed the limit when specifying from, to and interval @@ -458,12 +458,12 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency - String contract = "BTC_USDT"; // String | Futures contract + 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 | 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 + 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 specified 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 + String interval = "\"5m\""; // String | Interval time between data points. try { List result = apiInstance.listFuturesPremiumIndex(settle, contract) .from(from) @@ -489,12 +489,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] - **contract** | **String**| Futures contract | + **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**| 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 | [optional] + **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 specified | [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"] + **interval** | **String**| Interval time between data points. | [optional] [default to "5m"] ### Return type @@ -512,13 +512,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listFuturesTickers** > List<FuturesTicker> listFuturesTickers(settle).contract(contract).execute(); -List futures tickers +List futures tickers. ### Example @@ -537,8 +537,8 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency - String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified + String settle = "usdt"; // String | Settle currency. + String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified. try { List result = apiInstance.listFuturesTickers(settle) .contract(contract) @@ -561,8 +561,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] - **contract** | **String**| Futures contract, return related data only if specified | [optional] + **settle** | **String**| Settle currency. | [enum: btc, usdt] + **contract** | **String**| Futures contract, return related data only if specified. | [optional] ### Return type @@ -580,13 +580,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listFuturesFundingRateHistory** > List<FundingRateRecord> listFuturesFundingRateHistory(settle, contract).limit(limit).from(from).to(to).execute(); -Funding rate history +Funding rate history. ### Example @@ -605,9 +605,9 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 + 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 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 { @@ -634,9 +634,9 @@ public class Example { 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] + **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 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] @@ -656,13 +656,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | History retrieved | - | +**200** | History retrieved. | - | # **listFuturesInsuranceLedger** > List<InsuranceRecord> listFuturesInsuranceLedger(settle).limit(limit).execute(); -Futures insurance balance history +Futures insurance balance history. ### Example @@ -681,8 +681,8 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 + String settle = "usdt"; // String | Settle currency. + Integer limit = 100; // Integer | Maximum number of records to be returned in a single list. try { List result = apiInstance.listFuturesInsuranceLedger(settle) .limit(limit) @@ -705,8 +705,8 @@ 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] + **settle** | **String**| Settle currency. | [enum: btc, usdt] + **limit** | **Integer**| Maximum number of records to be returned in a single list. | [optional] [default to 100] ### Return type @@ -724,13 +724,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listContractStats** > List<ContractStat> listContractStats(settle, contract).from(from).interval(interval).limit(limit).execute(); -Futures stats +Futures stats. ### Example @@ -749,9 +749,9 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency - String contract = "BTC_USDT"; // String | Futures contract - Long from = 1604561000L; // Long | Start timestamp + String settle = "usdt"; // String | Settle currency. + String contract = "BTC_USDT"; // String | Futures contract. + Long from = 1604561000L; // Long | Start timestamp. String interval = "\"5m\""; // String | Integer limit = 30; // Integer | try { @@ -778,9 +778,9 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] - **contract** | **String**| Futures contract | - **from** | **Long**| Start timestamp | [optional] + **settle** | **String**| Settle currency. | [enum: btc, usdt] + **contract** | **String**| Futures contract. | + **from** | **Long**| Start timestamp. | [optional] **interval** | **String**| | [optional] [default to "5m"] **limit** | **Integer**| | [optional] [default to 30] @@ -800,13 +800,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **getIndexConstituents** > FuturesIndexConstituents getIndexConstituents(settle, index) -Get index constituents +Get index constituents. ### Example @@ -825,8 +825,8 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency - String index = "BTC_USDT"; // String | Index name + String settle = "usdt"; // String | Settle currency. + String index = "BTC_USDT"; // String | Index name. try { FuturesIndexConstituents result = apiInstance.getIndexConstituents(settle, index); System.out.println(result); @@ -847,8 +847,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] - **index** | **String**| Index name | + **settle** | **String**| Settle currency. | [enum: btc, usdt] + **index** | **String**| Index name. | ### Return type @@ -866,15 +866,15 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listLiquidatedOrders** > List<FuturesLiqOrder> listLiquidatedOrders(settle).contract(contract).from(from).to(to).limit(limit).execute(); -Retrieve liquidation history +Retrieve liquidation history. -The maximum time interval between `from` and `to` is **3600 seconds**. Certain private fields will **not be returned** in public endpoints; refer to individual field descriptions for details. +The time interval between from and to is maximum 3600. Some private fields are not returned by public interfaces, refer to field descriptions for interfaces, refer to field descriptions for details ### Example @@ -893,11 +893,11 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency - String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified + 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 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 to be returned in a single list + Integer limit = 100; // Integer | Maximum number of records to be returned in a single list. try { List result = apiInstance.listLiquidatedOrders(settle) .contract(contract) @@ -923,11 +923,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] - **contract** | **String**| Futures contract, return related data only if specified | [optional] + **settle** | **String**| Settle currency. | [enum: btc, usdt] + **contract** | **String**| Futures contract, return related data only if specified. | [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] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] + **limit** | **Integer**| Maximum number of records to be returned in a single list. | [optional] [default to 100] ### Return type @@ -945,15 +945,15 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **listFuturesRiskLimitTiers** > List<FuturesLimitRiskTiers> listFuturesRiskLimitTiers(settle).contract(contract).limit(limit).offset(offset).execute(); -List risk limit tiers +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. +When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets.'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect empty. ### Example @@ -972,10 +972,10 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 offset = 0; // Integer | List offset, starting from 0 + 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 offset = 0; // Integer | List offset, starting from 0. try { List result = apiInstance.listFuturesRiskLimitTiers(settle) .contract(contract) @@ -1000,10 +1000,10 @@ public class Example { 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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **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] + **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] ### Return type @@ -1021,13 +1021,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listFuturesAccounts** > FuturesAccount listFuturesAccounts(settle) -Query futures account +Query futures account. ### Example @@ -1050,7 +1050,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency + String settle = "usdt"; // String | Settle currency. try { FuturesAccount result = apiInstance.listFuturesAccounts(settle); System.out.println(result); @@ -1071,7 +1071,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] + **settle** | **String**| Settle currency. | [enum: btc, usdt] ### Return type @@ -1089,15 +1089,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listFuturesAccountBook** > List<FuturesAccountBook> listFuturesAccountBook(settle).contract(contract).limit(limit).offset(offset).from(from).to(to).type(type).execute(); -Query account book +Query account book. -If the contract field is passed, only records containing this field after 2023-10-30 can be filtered。 2023-10-30 can be filtered。 2023-10-30 can be filtered。 +If the contract field is passed, only records containing this field after 2023-10-30 can be filtered。 2023-10-30 can be filtered. ### Example @@ -1120,13 +1120,13 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 offset = 0; // Integer | List offset, starting from 0 + 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 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 - 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 + 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_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction try { List result = apiInstance.listFuturesAccountBook(settle) .contract(contract) @@ -1154,13 +1154,13 @@ public class Example { 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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **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] + **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] - **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] + **type** | **String**| Changing Type： - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: point_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction | [optional] ### Return type @@ -1178,13 +1178,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **listPositions** > List<Position> listPositions(settle).holding(holding).limit(limit).offset(offset).execute(); -List all positions of a user +List all positions of a user. ### Example @@ -1207,10 +1207,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency + 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 - Integer offset = 0; // Integer | List offset, starting from 0 + Integer limit = 100; // Integer | Maximum number of records to be returned in a single list. + Integer offset = 0; // Integer | List offset, starting from 0. try { List result = apiInstance.listPositions(settle) .holding(holding) @@ -1235,10 +1235,10 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] + **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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **limit** | **Integer**| Maximum number of records to be returned in a single list. | [optional] [default to 100] + **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] ### Return type @@ -1256,13 +1256,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **getPosition** > Position getPosition(settle, contract).execute(); -Get single position +Get single position. ### Example @@ -1285,8 +1285,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency - String contract = "BTC_USDT"; // String | Futures contract + String settle = "usdt"; // String | Settle currency. + String contract = "BTC_USDT"; // String | Futures contract. try { Position result = apiInstance.getPosition(settle, contract) .execute(); @@ -1308,8 +1308,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] - **contract** | **String**| Futures contract | + **settle** | **String**| Settle currency. | [enum: btc, usdt] + **contract** | **String**| Futures contract. | ### Return type @@ -1327,13 +1327,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information | - | +**200** | Position information. | - | # **updatePositionMargin** > Position updatePositionMargin(settle, contract, change) -Update position margin +Update position margin. ### Example @@ -1356,9 +1356,9 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 amount, positive number increases, negative number + String settle = "usdt"; // String | Settle currency. + String contract = "BTC_USDT"; // String | Futures contract. + String change = "0.01"; // String | Margin change amount, positive number increases, negative number. try { Position result = apiInstance.updatePositionMargin(settle, contract, change); System.out.println(result); @@ -1379,9 +1379,9 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] - **contract** | **String**| Futures contract | - **change** | **String**| Margin change amount, positive number increases, negative number | + **settle** | **String**| Settle currency. | [enum: btc, usdt] + **contract** | **String**| Futures contract. | + **change** | **String**| Margin change amount, positive number increases, negative number. | ### Return type @@ -1399,13 +1399,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information | - | +**200** | Position information. | - | # **updatePositionLeverage** > Position updatePositionLeverage(settle, contract, leverage, crossLeverageLimit) -Update position leverage +Update position leverage. ### Example @@ -1428,10 +1428,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - 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 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). try { Position result = apiInstance.updatePositionLeverage(settle, contract, leverage, crossLeverageLimit); System.out.println(result); @@ -1452,10 +1452,10 @@ public class Example { 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] + **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] ### Return type @@ -1473,13 +1473,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information | - | +**200** | Position information. | - | # **updatePositionCrossMode** > Position updatePositionCrossMode(settle, futuresPositionCrossMode) -Switch to the full position-by-store mode +Switch to the full position-by-store mode. ### Example @@ -1502,7 +1502,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency + String settle = "usdt"; // String | Settle currency. FuturesPositionCrossMode futuresPositionCrossMode = new FuturesPositionCrossMode(); // FuturesPositionCrossMode | try { Position result = apiInstance.updatePositionCrossMode(settle, futuresPositionCrossMode); @@ -1524,7 +1524,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] + **settle** | **String**| Settle currency. | [enum: btc, usdt] **futuresPositionCrossMode** | [**FuturesPositionCrossMode**](FuturesPositionCrossMode.md)| | ### Return type @@ -1543,13 +1543,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information | - | +**200** | Position information. | - | # **updatePositionRiskLimit** > Position updatePositionRiskLimit(settle, contract, riskLimit) -Update position risk limit +Update position risk limit. ### Example @@ -1572,9 +1572,9 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 settle = "usdt"; // String | Settle currency. + String contract = "BTC_USDT"; // String | Futures contract. + String riskLimit = "1000000"; // String | New Risk Limit Value. try { Position result = apiInstance.updatePositionRiskLimit(settle, contract, riskLimit); System.out.println(result); @@ -1595,9 +1595,9 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] - **contract** | **String**| Futures contract | - **riskLimit** | **String**| New Risk Limit Value | + **settle** | **String**| Settle currency. | [enum: btc, usdt] + **contract** | **String**| Futures contract. | + **riskLimit** | **String**| New Risk Limit Value. | ### Return type @@ -1615,15 +1615,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information | - | +**200** | Position information. | - | # **setDualMode** > FuturesAccount setDualMode(settle, dualMode) -Enable or disable dual mode +Enable or disable dual mode. -The prerequisite for changing mode is that all positions have no holdings +The prerequisite for changing mode is that all positions have no holdings. ### Example @@ -1646,8 +1646,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency - Boolean dualMode = true; // Boolean | Whether to enable dual mode + String settle = "usdt"; // String | Settle currency. + Boolean dualMode = true; // Boolean | Whether to enable dual mode. try { FuturesAccount result = apiInstance.setDualMode(settle, dualMode); System.out.println(result); @@ -1668,8 +1668,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] - **dualMode** | **Boolean**| Whether to enable dual mode | + **settle** | **String**| Settle currency. | [enum: btc, usdt] + **dualMode** | **Boolean**| Whether to enable dual mode. | ### Return type @@ -1687,13 +1687,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Updated | - | +**200** | Updated. | - | # **getDualModePosition** > List<Position> getDualModePosition(settle, contract).execute(); -Retrieve position detail in dual mode +Retrieve position detail in dual mode. ### Example @@ -1716,8 +1716,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency - String contract = "BTC_USDT"; // String | Futures contract + String settle = "usdt"; // String | Settle currency. + String contract = "BTC_USDT"; // String | Futures contract. try { List result = apiInstance.getDualModePosition(settle, contract) .execute(); @@ -1739,8 +1739,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] - **contract** | **String**| Futures contract | + **settle** | **String**| Settle currency. | [enum: btc, usdt] + **contract** | **String**| Futures contract. | ### Return type @@ -1758,13 +1758,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **updateDualModePositionMargin** > List<Position> updateDualModePositionMargin(settle, contract, change, dualSide) -Update position margin in dual mode +Update position margin in dual mode. ### Example @@ -1787,10 +1787,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 amount, positive number increases, negative number - String dualSide = "dual_long"; // String | Long or short position + String settle = "usdt"; // String | Settle currency. + String contract = "BTC_USDT"; // String | Futures contract. + String change = "0.01"; // String | Margin change amount, positive number increases, negative number. + String dualSide = "dual_long"; // String | Long or short position. try { List result = apiInstance.updateDualModePositionMargin(settle, contract, change, dualSide); System.out.println(result); @@ -1811,10 +1811,10 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] - **contract** | **String**| Futures contract | - **change** | **String**| Margin change amount, positive number increases, negative number | - **dualSide** | **String**| Long or short position | + **settle** | **String**| Settle currency. | [enum: btc, usdt] + **contract** | **String**| Futures contract. | + **change** | **String**| Margin change amount, positive number increases, negative number. | + **dualSide** | **String**| Long or short position. | ### Return type @@ -1832,13 +1832,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **updateDualModePositionLeverage** > List<Position> updateDualModePositionLeverage(settle, contract, leverage, crossLeverageLimit) -Update position leverage in dual mode +Update position leverage in dual mode. ### Example @@ -1861,10 +1861,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - 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 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). try { List result = apiInstance.updateDualModePositionLeverage(settle, contract, leverage, crossLeverageLimit); System.out.println(result); @@ -1885,10 +1885,10 @@ public class Example { 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] + **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] ### Return type @@ -1906,13 +1906,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **updateDualModePositionRiskLimit** > List<Position> updateDualModePositionRiskLimit(settle, contract, riskLimit) -Update position risk limit in dual mode +Update position risk limit in dual mode. ### Example @@ -1935,9 +1935,9 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 settle = "usdt"; // String | Settle currency. + String contract = "BTC_USDT"; // String | Futures contract. + String riskLimit = "1000000"; // String | New Risk Limit Value. try { List result = apiInstance.updateDualModePositionRiskLimit(settle, contract, riskLimit); System.out.println(result); @@ -1958,9 +1958,9 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] - **contract** | **String**| Futures contract | - **riskLimit** | **String**| New Risk Limit Value | + **settle** | **String**| Settle currency. | [enum: btc, usdt] + **contract** | **String**| Futures contract. | + **riskLimit** | **String**| New Risk Limit Value. | ### Return type @@ -1978,13 +1978,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listFuturesOrders** > List<FuturesOrder> listFuturesOrders(settle, status).contract(contract).limit(limit).offset(offset).lastId(lastId).execute(); -List futures orders +List futures orders. - 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 +2009,11 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency - String status = "open"; // String | Only list the orders with this 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 offset = 0; // Integer | List offset, starting from 0 + String settle = "usdt"; // String | Settle currency. + String status = "open"; // String | Only list the orders with this 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 offset = 0; // Integer | List offset, starting from 0. String lastId = "12345"; // String | Specify the currency name to query in batches, and support up to 100 pass parameters at a time. try { List result = apiInstance.listFuturesOrders(settle, status) @@ -2040,11 +2040,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] - **status** | **String**| Only list the orders with this 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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **settle** | **String**| Settle currency. | [enum: btc, usdt] + **status** | **String**| Only list the orders with this 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] + **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] **lastId** | **String**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time. | [optional] ### Return type @@ -2063,15 +2063,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. | * X-Pagination-Limit - Request limit specified.
* X-Pagination-Offset - Request offset specified.
| # **createFuturesOrder** > FuturesOrder createFuturesOrder(settle, futuresOrder, xGateExptime) -Create a futures order +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` +- 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 @@ -2094,7 +2094,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency + String settle = "usdt"; // String | Settle currency. FuturesOrder futuresOrder = new FuturesOrder(); // FuturesOrder | 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 { @@ -2117,7 +2117,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] + **settle** | **String**| Settle currency. | [enum: btc, usdt] **futuresOrder** | [**FuturesOrder**](FuturesOrder.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] @@ -2137,15 +2137,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Order details | - | +**201** | Order details. | - | # **cancelFuturesOrders** > List<FuturesOrder> cancelFuturesOrders(settle, contract, xGateExptime, side) -Cancel all `open` orders matched +Cancel all `open` orders matched. -Zero-filled order cannot be retrieved 10 minutes after order cancellation +Zero-filled order cannot be retrieved 10 minutes after order cancellation. ### Example @@ -2168,10 +2168,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency - String contract = "BTC_USDT"; // String | Futures contract + 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, both are included if not specified. Set to bid to cancel all buy orders, set to ask to cancel all sell ordersspecified. Set to bid to cancel all buy orders, set to ask to cancel all + String side = "ask"; // String | Specify all buy orders or all sell orders, both are included if not specified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell orders try { List result = apiInstance.cancelFuturesOrders(settle, contract, xGateExptime, side); System.out.println(result); @@ -2192,10 +2192,10 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] - **contract** | **String**| Futures contract | + **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, both are included if not specified. Set to bid to cancel all buy orders, set to ask to cancel all sell ordersspecified. Set to bid to cancel all buy orders, set to ask to cancel all | [optional] + **side** | **String**| Specify all buy orders or all sell orders, both are included if not specified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell orders | [optional] ### Return type @@ -2213,13 +2213,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | All orders matched cancelled | - | +**200** | All orders matched cancelled. | - | # **getOrdersWithTimeRange** > List<FuturesOrder> getOrdersWithTimeRange(settle).contract(contract).from(from).to(to).limit(limit).offset(offset).execute(); -List Futures Orders By Time Range +List Futures Orders By Time Range. ### Example @@ -2242,12 +2242,12 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency - String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified + 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 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 to be returned in a single list - Integer offset = 0; // Integer | List offset, starting from 0 + Integer limit = 100; // Integer | Maximum number of records to be returned in a single list. + Integer offset = 0; // Integer | List offset, starting from 0. try { List result = apiInstance.getOrdersWithTimeRange(settle) .contract(contract) @@ -2274,12 +2274,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] - **contract** | **String**| Futures contract, return related data only if specified | [optional] + **settle** | **String**| Settle currency. | [enum: btc, usdt] + **contract** | **String**| Futures contract, return related data only if specified. | [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] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **limit** | **Integer**| Maximum number of records to be returned in a single list. | [optional] [default to 100] + **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] ### Return type @@ -2297,13 +2297,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. | * X-Pagination-Limit - Request limit specified.
* X-Pagination-Offset - Request offset specified.
| # **createBatchFuturesOrder** > List<BatchFuturesOrder> createBatchFuturesOrder(settle, futuresOrder, xGateExptime) -Create a batch of futures orders +Create a batch of 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 @@ -2328,7 +2328,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency + String settle = "usdt"; // String | Settle currency. List futuresOrder = Arrays.asList(); // List | 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 { @@ -2351,7 +2351,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] + **settle** | **String**| Settle currency. | [enum: btc, usdt] **futuresOrder** | [**List<FuturesOrder>**](FuturesOrder.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] @@ -2371,13 +2371,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Request is completed | - | +**200** | Request is completed. | - | # **getFuturesOrder** > FuturesOrder getFuturesOrder(settle, orderId) -Get a single order +Get a single order. - 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,8 +2402,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 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. 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,8 +2424,8 @@ 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. | + **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. finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. | ### Return type @@ -2443,13 +2443,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order details | - | +**200** | Order details. | - | # **amendFuturesOrder** > FuturesOrder amendFuturesOrder(settle, orderId, futuresOrderAmendment, xGateExptime) -Amend an order +Amend an order. ### Example @@ -2472,8 +2472,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 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. 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,8 +2496,8 @@ 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. | + **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. 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] @@ -2517,13 +2517,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order details | - | +**200** | Order details. | - | # **cancelFuturesOrder** > FuturesOrder cancelFuturesOrder(settle, orderId, xGateExptime) -Cancel a single order +Cancel a single order. ### Example @@ -2546,8 +2546,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 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. 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,8 +2569,8 @@ 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. | + **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. 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 @@ -2589,13 +2589,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order details | - | +**200** | Order details. | - | # **getMyTrades** > List<MyFuturesTrade> getMyTrades(settle).contract(contract).order(order).limit(limit).offset(offset).lastId(lastId).execute(); -List personal trading history +List personal trading history. 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`. @@ -2620,11 +2620,11 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 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 offset = 0; // Integer | List offset, starting from 0 + 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 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 { List result = apiInstance.getMyTrades(settle) @@ -2652,11 +2652,11 @@ public class Example { 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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **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] + **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] ### Return type @@ -2675,13 +2675,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. | * X-Pagination-Limit - Request limit specified.
* X-Pagination-Offset - Request offset specified.
| # **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 +List personal trading history by time range. ### Example @@ -2704,12 +2704,12 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency - String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified + 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 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 to be returned in a single list - Integer offset = 0; // Integer | List offset, starting from 0 + Integer limit = 100; // Integer | Maximum number of records to be returned in a single list. + Integer offset = 0; // Integer | List offset, starting from 0. String role = "maker"; // String | Query role, maker or taker. try { List result = apiInstance.getMyTradesWithTimeRange(settle) @@ -2738,12 +2738,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] - **contract** | **String**| Futures contract, return related data only if specified | [optional] + **settle** | **String**| Settle currency. | [enum: btc, usdt] + **contract** | **String**| Futures contract, return related data only if specified. | [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] - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **limit** | **Integer**| Maximum number of records to be 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] ### Return type @@ -2762,13 +2762,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. | * X-Pagination-Limit - Request limit specified.
* X-Pagination-Offset - Request offset specified.
| # **listPositionClose** > List<PositionClose> listPositionClose(settle).contract(contract).limit(limit).offset(offset).from(from).to(to).side(side).pnl(pnl).execute(); -List position close history +List position close history. ### Example @@ -2791,14 +2791,14 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 offset = 0; // Integer | List offset, starting from 0 + 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 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 - String side = "short"; // String | Query side. long or shot - String pnl = "profit"; // String | Query profit or loss + String side = "short"; // String | Query side. long or shot. + String pnl = "profit"; // String | Query profit or loss. try { List result = apiInstance.listPositionClose(settle) .contract(contract) @@ -2827,14 +2827,14 @@ public class Example { 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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **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] + **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] - **side** | **String**| Query side. long or shot | [optional] - **pnl** | **String**| Query profit or loss | [optional] + **side** | **String**| Query side. long or shot. | [optional] + **pnl** | **String**| Query profit or loss. | [optional] ### Return type @@ -2852,13 +2852,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **listLiquidates** > List<FuturesLiquidate> listLiquidates(settle).contract(contract).limit(limit).at(at).execute(); -List liquidation history +List liquidation history. ### Example @@ -2881,10 +2881,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 + 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. try { List result = apiInstance.listLiquidates(settle) .contract(contract) @@ -2909,10 +2909,10 @@ public class Example { 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] + **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] ### Return type @@ -2930,13 +2930,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **listAutoDeleverages** > List<FuturesAutoDeleverage> listAutoDeleverages(settle).contract(contract).limit(limit).at(at).execute(); -List Auto-Deleveraging History +List Auto-Deleveraging History. ### Example @@ -2959,10 +2959,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 + 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. try { List result = apiInstance.listAutoDeleverages(settle) .contract(contract) @@ -2987,10 +2987,10 @@ public class Example { 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] + **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] ### Return type @@ -3008,15 +3008,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **countdownCancelAllFutures** > TriggerTime countdownCancelAllFutures(settle, countdownCancelAllFuturesTask) -Countdown cancel orders +Countdown cancel orders. -Heartbeat detection for contract orders: When the user-set `timeout` time is reached, if neither the existing countdown is canceled nor a new countdown is set, the relevant contract orders will be automatically canceled. This API can be called repeatedly to set a new countdown 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. +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 @@ -3039,7 +3039,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency + String settle = "usdt"; // String | Settle currency. CountdownCancelAllFuturesTask countdownCancelAllFuturesTask = new CountdownCancelAllFuturesTask(); // CountdownCancelAllFuturesTask | try { TriggerTime result = apiInstance.countdownCancelAllFutures(settle, countdownCancelAllFuturesTask); @@ -3061,7 +3061,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] + **settle** | **String**| Settle currency. | [enum: btc, usdt] **countdownCancelAllFuturesTask** | [**CountdownCancelAllFuturesTask**](CountdownCancelAllFuturesTask.md)| | ### Return type @@ -3080,13 +3080,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Set countdown successfully | - | +**200** | Set countdown successfully. | - | # **getFuturesFee** > Map<String, FuturesFee> getFuturesFee(settle).contract(contract).execute(); -Query user trading fee rates +Query user trading fee rates. ### Example @@ -3109,8 +3109,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency - String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified + String settle = "usdt"; // String | Settle currency. + String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified. try { Map result = apiInstance.getFuturesFee(settle) .contract(contract) @@ -3133,8 +3133,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] - **contract** | **String**| Futures contract, return related data only if specified | [optional] + **settle** | **String**| Settle currency. | [enum: btc, usdt] + **contract** | **String**| Futures contract, return related data only if specified. | [optional] ### Return type @@ -3152,15 +3152,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **cancelBatchFutureOrders** > List<FutureCancelOrderResult> cancelBatchFutureOrders(settle, requestBody, xGateExptime) -Cancel a batch of orders with an ID list +Cancel a batch of orders with an ID list. -Multiple different order IDs can be specified. A maximum of 20 records +Multiple different order IDs can be specified. A maximum of 20 records. ### Example @@ -3183,7 +3183,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency + String settle = "usdt"; // String | Settle currency. List requestBody = Arrays.asList(); // List | 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 { @@ -3206,7 +3206,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] + **settle** | **String**| Settle currency. | [enum: btc, usdt] **requestBody** | [**List<String>**](String.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] @@ -3226,15 +3226,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order cancellation operation completed | - | +**200** | Order cancellation operation completed. | - | # **amendBatchFutureOrders** > List<BatchFuturesOrder> amendBatchFutureOrders(settle, batchAmendOrderReq, xGateExptime) -Batch modify orders with specified IDs +Batch modify orders with specified IDs. -Multiple different order IDs can be specified. A maximum of 10 orders can +Multiple different order IDs can be specified. A maximum of 10 orders can. ### Example @@ -3257,7 +3257,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency + String settle = "usdt"; // String | Settle currency. List batchAmendOrderReq = Arrays.asList(); // List | 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 { @@ -3280,7 +3280,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] + **settle** | **String**| Settle currency. | [enum: btc, usdt] **batchAmendOrderReq** | [**List<BatchAmendOrderReq>**](BatchAmendOrderReq.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] @@ -3300,13 +3300,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Request is completed | - | +**200** | Request is completed. | - | # **getFuturesRiskLimitTable** > List<FuturesRiskLimitTier> getFuturesRiskLimitTable(settle, tableId) -Query risk limit table by table_id +Query risk limit table by table_id. Just pass table_id. @@ -3327,8 +3327,8 @@ public class Example { 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 + 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); @@ -3349,8 +3349,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] - **tableId** | **String**| Risk limit table ID | + **settle** | **String**| Settle currency. | [enum: btc, usdt] + **tableId** | **String**| Risk limit table ID. | ### Return type @@ -3368,13 +3368,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listPriceTriggeredOrders** > List<FuturesPriceTriggeredOrder> listPriceTriggeredOrders(settle, status).contract(contract).limit(limit).offset(offset).execute(); -List All Price-triggered Orders +List All Price-triggered Orders. ### Example @@ -3397,11 +3397,11 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency - String status = "status_example"; // String | Only list the orders with this 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 offset = 0; // Integer | List offset, starting from 0 + String settle = "usdt"; // String | Settle currency. + String status = "status_example"; // String | Only list the orders with this 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 offset = 0; // Integer | List offset, starting from 0. try { List result = apiInstance.listPriceTriggeredOrders(settle, status) .contract(contract) @@ -3426,11 +3426,11 @@ 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] - **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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **settle** | **String**| Settle currency. | [enum: btc, usdt] + **status** | **String**| Only list the orders with this 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] + **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] ### Return type @@ -3448,13 +3448,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **createPriceTriggeredOrder** > TriggerOrderResponse createPriceTriggeredOrder(settle, futuresPriceTriggeredOrder) -Create a price-triggered order +Create a price-triggered order. ### Example @@ -3477,7 +3477,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency + String settle = "usdt"; // String | Settle currency. FuturesPriceTriggeredOrder futuresPriceTriggeredOrder = new FuturesPriceTriggeredOrder(); // FuturesPriceTriggeredOrder | try { TriggerOrderResponse result = apiInstance.createPriceTriggeredOrder(settle, futuresPriceTriggeredOrder); @@ -3499,7 +3499,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] + **settle** | **String**| Settle currency. | [enum: btc, usdt] **futuresPriceTriggeredOrder** | [**FuturesPriceTriggeredOrder**](FuturesPriceTriggeredOrder.md)| | ### Return type @@ -3518,13 +3518,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Order created | - | +**201** | Order created. | - | # **cancelPriceTriggeredOrderList** > List<FuturesPriceTriggeredOrder> cancelPriceTriggeredOrderList(settle, contract) -Cancel All Price-triggered Orders +Cancel All Price-triggered Orders. ### Example @@ -3547,8 +3547,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency - String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified + String settle = "usdt"; // String | Settle currency. + String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified. try { List result = apiInstance.cancelPriceTriggeredOrderList(settle, contract); System.out.println(result); @@ -3569,8 +3569,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency | [enum: btc, usdt] - **contract** | **String**| Futures contract, return related data only if specified | [optional] + **settle** | **String**| Settle currency. | [enum: btc, usdt] + **contract** | **String**| Futures contract, return related data only if specified. | [optional] ### Return type @@ -3588,13 +3588,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. Query order status by listing orders. | - | # **getPriceTriggeredOrder** > FuturesPriceTriggeredOrder getPriceTriggeredOrder(settle, orderId) -Get a price-triggered order +Get a price-triggered order. ### Example @@ -3617,8 +3617,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 settle = "usdt"; // String | Settle currency. + String orderId = "orderId_example"; // String | Retrieve the data of the order with the specified ID. try { FuturesPriceTriggeredOrder result = apiInstance.getPriceTriggeredOrder(settle, orderId); System.out.println(result); @@ -3639,8 +3639,8 @@ 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 | + **settle** | **String**| Settle currency. | [enum: btc, usdt] + **orderId** | **String**| Retrieve the data of the order with the specified ID. | ### Return type @@ -3658,13 +3658,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Auto order detail | - | +**200** | Auto order detail. | - | # **cancelPriceTriggeredOrder** > FuturesPriceTriggeredOrder cancelPriceTriggeredOrder(settle, orderId) -cancel a price-triggered order +cancel a price-triggered order. ### Example @@ -3687,8 +3687,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 settle = "usdt"; // String | Settle currency. + String orderId = "orderId_example"; // String | Retrieve the data of the order with the specified ID. try { FuturesPriceTriggeredOrder result = apiInstance.cancelPriceTriggeredOrder(settle, orderId); System.out.println(result); @@ -3709,8 +3709,8 @@ 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 | + **settle** | **String**| Settle currency. | [enum: btc, usdt] + **orderId** | **String**| Retrieve the data of the order with the specified ID. | ### Return type @@ -3728,5 +3728,5 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Auto order detail | - | +**200** | Auto order detail. | - | diff --git a/docs/FuturesAutoDeleverage.md b/docs/FuturesAutoDeleverage.md index a094eef..8449e4e 100644 --- a/docs/FuturesAutoDeleverage.md +++ b/docs/FuturesAutoDeleverage.md @@ -5,14 +5,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**time** | **Long** | Automatic deleveraging time | [optional] [readonly] -**user** | **Long** | User ID | [optional] [readonly] -**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] -**entryPrice** | **String** | Average entry price | [optional] [readonly] -**fillPrice** | **String** | Average fill price | [optional] [readonly] -**tradeSize** | **Long** | Trading size | [optional] [readonly] -**positionSize** | **Long** | Positions after auto-deleveraging | [optional] [readonly] +**time** | **Long** | Automatic deleveraging time. | [optional] [readonly] +**user** | **Long** | User ID. | [optional] [readonly] +**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] +**entryPrice** | **String** | Average entry price. | [optional] [readonly] +**fillPrice** | **String** | Average fill price. | [optional] [readonly] +**tradeSize** | **Long** | Trading size. | [optional] [readonly] +**positionSize** | **Long** | Positions after auto-deleveraging. | [optional] [readonly] diff --git a/docs/FuturesBatchAmendOrderRequest.md b/docs/FuturesBatchAmendOrderRequest.md index 8f6d76d..ce50d49 100644 --- a/docs/FuturesBatchAmendOrderRequest.md +++ b/docs/FuturesBatchAmendOrderRequest.md @@ -1,15 +1,15 @@ # FuturesBatchAmendOrderRequest -Modify contract order parameters +Modify contract order parameters. ## Properties 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] +**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, 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] +**amendText** | **String** | Custom info during amending order. | [optional] diff --git a/docs/FuturesCandlestick.md b/docs/FuturesCandlestick.md index 11ce407..6172dd9 100644 --- a/docs/FuturesCandlestick.md +++ b/docs/FuturesCandlestick.md @@ -1,17 +1,17 @@ # FuturesCandlestick -data point in every timestamp +data point in every timestamp. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**t** | **Double** | Unix timestamp in seconds | [optional] -**v** | **Long** | size volume (contract size). Only returned if `contract` is not prefixed | [optional] -**c** | **String** | Close price (quote currency) | [optional] -**h** | **String** | Highest price (quote currency) | [optional] -**l** | **String** | Lowest price (quote currency) | [optional] -**o** | **String** | Open price (quote currency) | [optional] -**sum** | **String** | Trading volume (unit: Quote currency) | [optional] +**t** | **Double** | Unix timestamp in seconds. | [optional] +**v** | **Long** | size volume (contract size). Only returned if `contract` is not prefixed. | [optional] +**c** | **String** | Close price (quote currency). | [optional] +**h** | **String** | Highest price (quote currency). | [optional] +**l** | **String** | Lowest price (quote currency). | [optional] +**o** | **String** | Open price (quote currency). | [optional] +**sum** | **String** | Trading volume (unit: Quote currency). | [optional] diff --git a/docs/FuturesFee.md b/docs/FuturesFee.md index a6756bf..7f83c14 100644 --- a/docs/FuturesFee.md +++ b/docs/FuturesFee.md @@ -1,12 +1,12 @@ # FuturesFee -The returned result is a map type, where the key represents the market and the value represents the taker and maker fee rates. +The returned result is a map type, where the key represents the market and taker and maker fee rates. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**takerFee** | **String** | Taker fee | [optional] [readonly] -**makerFee** | **String** | maker fee | [optional] [readonly] +**takerFee** | **String** | Taker fee. | [optional] [readonly] +**makerFee** | **String** | maker fee. | [optional] [readonly] diff --git a/docs/FuturesIndexConstituents.md b/docs/FuturesIndexConstituents.md index 506c53c..248c190 100644 --- a/docs/FuturesIndexConstituents.md +++ b/docs/FuturesIndexConstituents.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**index** | **String** | Index name | [optional] [readonly] -**constituents** | [**List<IndexConstituent>**](IndexConstituent.md) | Constituents | [optional] [readonly] +**index** | **String** | Index name. | [optional] [readonly] +**constituents** | [**List<IndexConstituent>**](IndexConstituent.md) | Constituents. | [optional] [readonly] diff --git a/docs/FuturesInitialOrder.md b/docs/FuturesInitialOrder.md index bf2dda0..2ca6112 100644 --- a/docs/FuturesInitialOrder.md +++ b/docs/FuturesInitialOrder.md @@ -5,16 +5,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**contract** | **String** | Futures contract | +**contract** | **String** | Futures contract. | **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 | +**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] +**tif** | [**TifEnum**](#TifEnum) | Time in force strategy, default is gtc, market order currently only supports ioc mode mode - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled | [optional] **text** | **String** | The source of the order, including: - web: web - api: api - app: 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] -**isReduceOnly** | **Boolean** | Is the order reduce-only | [optional] [readonly] -**isClose** | **Boolean** | Is the order to close position | [optional] [readonly] +**isReduceOnly** | **Boolean** | Is the order reduce-only. | [optional] [readonly] +**isClose** | **Boolean** | Is the order to close position. | [optional] [readonly] ## Enum: TifEnum diff --git a/docs/FuturesLimitRiskTiers.md b/docs/FuturesLimitRiskTiers.md index 3772c40..d47013b 100644 --- a/docs/FuturesLimitRiskTiers.md +++ b/docs/FuturesLimitRiskTiers.md @@ -7,11 +7,11 @@ Retrieve risk limit configurations for different tiers under a specified contrac 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] -**contract** | **String** | Markets, visible only during market pagination requests | [optional] -**deduction** | **String** | Maintenance margin quick calculation deduction | [optional] +**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] +**contract** | **String** | Markets, visible only during market pagination requests. | [optional] +**deduction** | **String** | Maintenance margin quick calculation deduction. | [optional] diff --git a/docs/FuturesLiqOrder.md b/docs/FuturesLiqOrder.md index 5b681bd..4e49f10 100644 --- a/docs/FuturesLiqOrder.md +++ b/docs/FuturesLiqOrder.md @@ -5,11 +5,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**time** | **Long** | Liquidation time | [optional] [readonly] -**contract** | **String** | Futures contract | [optional] [readonly] -**size** | **Long** | User position size | [optional] [readonly] -**orderSize** | **Long** | Number of forced liquidation orders | [optional] [readonly] -**orderPrice** | **String** | Liquidation order price | [optional] [readonly] -**fillPrice** | **String** | Liquidation order average taker price | [optional] [readonly] -**left** | **Long** | System liquidation order maker size | [optional] [readonly] +**time** | **Long** | Liquidation time. | [optional] [readonly] +**contract** | **String** | Futures contract. | [optional] [readonly] +**size** | **Long** | User position size. | [optional] [readonly] +**orderSize** | **Long** | Number of forced liquidation orders. | [optional] [readonly] +**orderPrice** | **String** | Liquidation order price. | [optional] [readonly] +**fillPrice** | **String** | Liquidation order average taker price. | [optional] [readonly] +**left** | **Long** | System liquidation order maker size. | [optional] [readonly] diff --git a/docs/FuturesLiquidate.md b/docs/FuturesLiquidate.md index 4f6d8f0..3057a00 100644 --- a/docs/FuturesLiquidate.md +++ b/docs/FuturesLiquidate.md @@ -5,16 +5,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**time** | **Long** | Liquidation time | [optional] [readonly] -**contract** | **String** | Futures contract | [optional] [readonly] +**time** | **Long** | Liquidation time. | [optional] [readonly] +**contract** | **String** | Futures contract. | [optional] [readonly] **leverage** | **String** | Position leverage. Not returned in public endpoints. | [optional] [readonly] -**size** | **Long** | Position size | [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] -**orderPrice** | **String** | Liquidation order price | [optional] [readonly] -**fillPrice** | **String** | Liquidation order average taker price | [optional] [readonly] -**left** | **Long** | Liquidation order maker size | [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..1d57ee1 100644 --- a/docs/FuturesOrder.md +++ b/docs/FuturesOrder.md @@ -1,39 +1,38 @@ # FuturesOrder -Futures order details +Futures order details. ## Properties 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] -**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] +**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 - 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] -**contract** | **String** | Futures contract | +**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] -**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] +**price** | **String** | Order price. 0 for market order with `tif` set as `ioc`. | [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] -**tkfr** | **String** | Taker fee | [optional] [readonly] -**mkfr** | **String** | Maker fee | [optional] [readonly] -**refu** | **Integer** | Reference user ID | [optional] [readonly] +**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-x: new liquidation mode (isolated, cross margin one-way mode, non-hedging part of cross margin hedge mode) b. Liquidation under isolated margin in unified account single currency margin mode - hedge-liq-x: Liquidation under the new liquidation mode of the classic account hedge mode, the cross margin hedged part undergoes liquidation, meaning both long and short positions are liquidated simultaneously. - pm_liquidate: Unified account multi-currency margin mode liquidation - comb_margin_liquidate: Unified account portfolio margin mode liquidation - scm_liquidate: Unified account single currency margin mode liquidation - insurance: insurance | [optional] +**tkfr** | **String** | Taker fee. | [optional] [readonly] +**mkfr** | **String** | Maker fee. | [optional] [readonly] +**refu** | **Integer** | Reference 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] -**amendText** | **String** | The custom data that the user remarked when amending the order | [optional] [readonly] -**bizInfo** | **String** | Additional information | [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, 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] ## Enum: FinishAsEnum diff --git a/docs/FuturesOrderAmendment.md b/docs/FuturesOrderAmendment.md index 4c499dc..7f095f0 100644 --- a/docs/FuturesOrderAmendment.md +++ b/docs/FuturesOrderAmendment.md @@ -7,7 +7,5 @@ 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] +**amendText** | **String** | Custom info during amending order. | [optional] diff --git a/docs/FuturesOrderBook.md b/docs/FuturesOrderBook.md index 448950b..80b77b9 100644 --- a/docs/FuturesOrderBook.md +++ b/docs/FuturesOrderBook.md @@ -6,8 +6,8 @@ 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 | +**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. | diff --git a/docs/FuturesOrderBookItem.md b/docs/FuturesOrderBookItem.md index 564bf77..453ef2c 100644 --- a/docs/FuturesOrderBookItem.md +++ b/docs/FuturesOrderBookItem.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**p** | **String** | Price (quote currency) | [optional] -**s** | **Long** | Size | [optional] +**p** | **String** | Price (quote currency). | [optional] +**s** | **Long** | Size. | [optional] diff --git a/docs/FuturesPositionCrossMode.md b/docs/FuturesPositionCrossMode.md index e4be434..7dafd13 100644 --- a/docs/FuturesPositionCrossMode.md +++ b/docs/FuturesPositionCrossMode.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** | Full position-by-position model, ISOLATED-by-position, CROSS-full position. | +**contract** | **String** | Contract Market. | diff --git a/docs/FuturesPremiumIndex.md b/docs/FuturesPremiumIndex.md index 759ceb9..c3929ec 100644 --- a/docs/FuturesPremiumIndex.md +++ b/docs/FuturesPremiumIndex.md @@ -1,15 +1,15 @@ # FuturesPremiumIndex -data point in every timestamp +data point in every timestamp. ## Properties 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] -**o** | **String** | Open price | [optional] +**t** | **Double** | Unix timestamp in seconds. | [optional] +**c** | **String** | Close price. | [optional] +**h** | **String** | Highest price. | [optional] +**l** | **String** | Lowest price`. | [optional] +**o** | **String** | Open price. | [optional] diff --git a/docs/FuturesPriceTrigger.md b/docs/FuturesPriceTrigger.md index 0b7d8cb..11160a8 100644 --- a/docs/FuturesPriceTrigger.md +++ b/docs/FuturesPriceTrigger.md @@ -6,9 +6,9 @@ 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] +**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 - 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] ## Enum: StrategyTypeEnum diff --git a/docs/FuturesPriceTriggeredOrder.md b/docs/FuturesPriceTriggeredOrder.md index 498d04d..8b70553 100644 --- a/docs/FuturesPriceTriggeredOrder.md +++ b/docs/FuturesPriceTriggeredOrder.md @@ -1,7 +1,7 @@ # FuturesPriceTriggeredOrder -Futures order details +Futures order details. ## Properties @@ -9,15 +9,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **initial** | [**FuturesInitialOrder**](FuturesInitialOrder.md) | | **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] +**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 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`: 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] ## Enum: StatusEnum diff --git a/docs/FuturesRiskLimitTier.md b/docs/FuturesRiskLimitTier.md index 6a8a60a..941d348 100644 --- a/docs/FuturesRiskLimitTier.md +++ b/docs/FuturesRiskLimitTier.md @@ -1,16 +1,16 @@ # FuturesRiskLimitTier -Information for each tier of the risk limit ladder +Information for each tier of the risk limit ladder. ## 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 | [optional] +**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. | [optional] diff --git a/docs/FuturesTicker.md b/docs/FuturesTicker.md index b035bee..5075cc1 100644 --- a/docs/FuturesTicker.md +++ b/docs/FuturesTicker.md @@ -5,25 +5,25 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**contract** | **String** | Futures contract | [optional] -**last** | **String** | Last trading price | [optional] +**contract** | **String** | Futures contract. | [optional] +**last** | **String** | Last trading price. | [optional] **changePercentage** | **String** | Change percentage. | [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] +**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] -**markPrice** | **String** | Recent mark price | [optional] -**fundingRate** | **String** | Funding rate | [optional] -**fundingRateIndicative** | **String** | Indicative Funding rate in next period. (deprecated. use `funding_rate`) | [optional] -**indexPrice** | **String** | Index price | [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] +**markPrice** | **String** | Recent mark price. | [optional] +**fundingRate** | **String** | Funding rate. | [optional] +**fundingRateIndicative** | **String** | Indicative Funding rate in next period. (deprecated. use `funding_rate`). | [optional] +**indexPrice** | **String** | Index price. | [optional] **quantoBaseRate** | **String** | Exchange rate of base currency and settlement currency in Quanto contract. Does not exists in contracts of other types | [optional] -**lowestAsk** | **String** | Recent lowest ask | [optional] -**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] +**lowestAsk** | **String** | Recent lowest ask. | [optional] +**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] diff --git a/docs/FuturesTrade.md b/docs/FuturesTrade.md index 94b908d..81e8ebe 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] +**id** | **Long** | Trade ID. | [optional] +**createTime** | **Double** | Trading time. | [optional] **createTimeMs** | **Double** | Trading time, with milliseconds set 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] +**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. an internal trade, this field will not be returned. | [optional] diff --git a/docs/IndexConstituent.md b/docs/IndexConstituent.md index 0fb0098..0233c7e 100644 --- a/docs/IndexConstituent.md +++ b/docs/IndexConstituent.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**exchange** | **String** | Exchange | [optional] -**symbols** | **List<String>** | Symbol list | [optional] +**exchange** | **String** | Exchange. | [optional] +**symbols** | **List<String>** | Symbol list. | [optional] diff --git a/docs/InlineResponse2001.md b/docs/InlineResponse2001.md index 8c8b01e..87c312f 100644 --- a/docs/InlineResponse2001.md +++ b/docs/InlineResponse2001.md @@ -6,5 +6,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | | [optional] -**estRate** | **String** | Unconverted percentage | [optional] +**estRate** | **String** | Unconverted percentage. | [optional] diff --git a/docs/InsuranceRecord.md b/docs/InsuranceRecord.md index 334a689..11f95ce 100644 --- a/docs/InsuranceRecord.md +++ b/docs/InsuranceRecord.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**t** | **Long** | Unix timestamp in seconds | [optional] -**b** | **String** | Insurance balance | [optional] +**t** | **Long** | Unix timestamp in seconds. | [optional] +**b** | **String** | Insurance balance. | [optional] diff --git a/docs/LedgerRecord.md b/docs/LedgerRecord.md index 13a44df..6edf612 100644 --- a/docs/LedgerRecord.md +++ b/docs/LedgerRecord.md @@ -5,16 +5,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | Record ID | [optional] [readonly] -**txid** | **String** | Hash record of the withdrawal | [optional] [readonly] +**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] -**timestamp** | **String** | Operation time | [optional] [readonly] -**amount** | **String** | Currency amount | -**currency** | **String** | Currency name | -**address** | **String** | Withdrawal address. Required for withdrawals | [optional] -**memo** | **String** | Additional remarks with regards to the withdrawal | [optional] +**timestamp** | **String** | Operation time. | [optional] [readonly] +**amount** | **String** | Currency 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] -**chain** | **String** | Name of the chain used in withdrawals | +**chain** | **String** | Name of the chain used in withdrawals. | diff --git a/docs/LiquidateOrder.md b/docs/LiquidateOrder.md index 2f7b46a..9afd7ee 100644 --- a/docs/LiquidateOrder.md +++ b/docs/LiquidateOrder.md @@ -1,15 +1,15 @@ # LiquidateOrder -Liquidate Order detail +Liquidate Order detail. ## 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] -**currencyPair** | **String** | Currency pair | -**amount** | **String** | Trade amount | -**price** | **String** | Order price | +**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] diff --git a/docs/MarginAccount.md b/docs/MarginAccount.md index b55facc..1660a92 100644 --- a/docs/MarginAccount.md +++ b/docs/MarginAccount.md @@ -7,12 +7,12 @@ Margin account detail. `base` refers to base currency, while `quotes to quote cu 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] +**currencyPair** | **String** | Currency pair. | [optional] +**accountType** | **String** | Account type, risk - risk rate account, mmr - maintenance margin 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] +**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..68b03b4 100644 --- a/docs/MarginAccountBook.md +++ b/docs/MarginAccountBook.md @@ -5,12 +5,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | Balance change record ID | [optional] -**time** | **String** | Balance changed timestamp | [optional] -**timeMs** | **Long** | The timestamp of the change (in milliseconds) | [optional] -**currency** | **String** | Currency changed | [optional] -**currencyPair** | **String** | Account currency 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] +**id** | **String** | Balance change record ID. | [optional] +**time** | **String** | Balance changed timestamp. | [optional] +**timeMs** | **Long** | The timestamp of the change (in milliseconds). | [optional] +**currency** | **String** | Currency changed. | [optional] +**currencyPair** | **String** | Account currency 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] diff --git a/docs/MarginAccountCurrency.md b/docs/MarginAccountCurrency.md index 266de33..9566b30 100644 --- a/docs/MarginAccountCurrency.md +++ b/docs/MarginAccountCurrency.md @@ -1,15 +1,15 @@ # MarginAccountCurrency -Account currency details +Account currency details. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency name | [optional] +**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] +**locked** | **String** | Locked amount, used in margin trading. | [optional] +**borrowed** | **String** | Borrowed amount. | [optional] +**interest** | **String** | Unpaid interests. | [optional] diff --git a/docs/MarginApi.md b/docs/MarginApi.md index 68ae168..dcb4aa2 100644 --- a/docs/MarginApi.md +++ b/docs/MarginApi.md @@ -4,25 +4,25 @@ 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 -[**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 -[**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 -[**listCrossMarginLoans**](MarginApi.md#listCrossMarginLoans) | **GET** /margin/cross/loans | List cross margin borrow history. (deprecated) -[**listCrossMarginRepayments**](MarginApi.md#listCrossMarginRepayments) | **GET** /margin/cross/repayments | Retrieve cross margin repayments. (deprecated) +[**listMarginAccounts**](MarginApi.md#listMarginAccounts) | **GET** /margin/accounts | Margin account list. +[**listMarginAccountBook**](MarginApi.md#listMarginAccountBook) | **GET** /margin/account_book | List 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. +[**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. +[**listCrossMarginLoans**](MarginApi.md#listCrossMarginLoans) | **GET** /margin/cross/loans | List cross margin borrow history. (deprecated). +[**listCrossMarginRepayments**](MarginApi.md#listCrossMarginRepayments) | **GET** /margin/cross/repayments | Retrieve cross margin repayments. (deprecated). # **listMarginAccounts** > List<MarginAccount> listMarginAccounts().currencyPair(currencyPair).execute(); -Margin account list +Margin account list. ### Example @@ -45,7 +45,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginApi apiInstance = new MarginApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Currency pair + String currencyPair = "BTC_USDT"; // String | Currency pair. try { List result = apiInstance.listMarginAccounts() .currencyPair(currencyPair) @@ -68,7 +68,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair | [optional] + **currencyPair** | **String**| Currency pair. | [optional] ### Return type @@ -86,13 +86,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **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 +List margin account balance change history. Only transferals from and to margin account are provided for now. Time range allows 30 days at most @@ -120,10 +120,10 @@ public class Example { 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 - Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + 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. try { List result = apiInstance.listMarginAccountBook() .currency(currency) @@ -155,10 +155,10 @@ 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] - **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] + **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] ### Return type @@ -176,13 +176,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **listFundingAccounts** > List<FundingAccount> listFundingAccounts().currency(currency).execute(); -Funding account list +Funding account list. ### Example @@ -205,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 | Retrieve data of the specified currency. try { List result = apiInstance.listFundingAccounts() .currency(currency) @@ -228,7 +228,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | [optional] + **currency** | **String**| Retrieve data of the specified currency. | [optional] ### Return type @@ -246,13 +246,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **getAutoRepayStatus** > AutoRepaySetting getAutoRepayStatus() -Retrieve user auto repayment setting +Retrieve user auto repayment setting. ### Example @@ -310,13 +310,13 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Current auto repayment setting | - | +**200** | Current auto repayment setting. | - | # **setAutoRepay** > AutoRepaySetting setAutoRepay(status) -Update user's auto repayment setting +Update user's auto repayment setting. ### Example @@ -339,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 | New auto repayment status. `on` - enabled, `off` - disabled. try { AutoRepaySetting result = apiInstance.setAutoRepay(status); System.out.println(result); @@ -360,7 +360,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **status** | **String**| New auto repayment status. `on` - enabled, `off` - disabled | + **status** | **String**| New auto repayment status. `on` - enabled, `off` - disabled. | ### Return type @@ -378,13 +378,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Current auto repayment setting | - | +**200** | Current auto repayment setting. | - | # **getMarginTransferable** > MarginTransferable getMarginTransferable(currency).currencyPair(currencyPair).execute(); -Get the max transferable amount for a specific margin currency +Get the max transferable amount for a specific margin currency. ### Example @@ -407,8 +407,8 @@ 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 currencyPair = "BTC_USDT"; // String | Currency pair + String currency = "BTC"; // String | Retrieve data of the specified currency. + String currencyPair = "BTC_USDT"; // String | Currency pair. try { MarginTransferable result = apiInstance.getMarginTransferable(currency) .currencyPair(currencyPair) @@ -431,8 +431,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | - **currencyPair** | **String**| Currency pair | [optional] + **currency** | **String**| Retrieve data of the specified currency. | + **currencyPair** | **String**| Currency pair. | [optional] ### Return type @@ -450,13 +450,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **getUserMarginTier** > List<MarginLeverageTier> getUserMarginTier(currencyPair) -Check the user's own leverage lending gradient in the current market +Check the user's own leverage lending gradient in the current market. ### Example @@ -479,7 +479,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginApi apiInstance = new MarginApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Currency pair + String currencyPair = "BTC_USDT"; // String | Currency pair. try { List result = apiInstance.getUserMarginTier(currencyPair); System.out.println(result); @@ -500,7 +500,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair | + **currencyPair** | **String**| Currency pair. | ### Return type @@ -518,13 +518,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **getMarketMarginTier** > List<MarginLeverageTier> getMarketMarginTier(currencyPair) -Query the current market leverage lending gradient +Query the current market leverage lending gradient. ### Example @@ -543,7 +543,7 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); MarginApi apiInstance = new MarginApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Currency pair + String currencyPair = "BTC_USDT"; // String | Currency pair. try { List result = apiInstance.getMarketMarginTier(currencyPair); System.out.println(result); @@ -564,7 +564,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair | + **currencyPair** | **String**| Currency pair. | ### Return type @@ -582,13 +582,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **setUserMarketLeverage** > setUserMarketLeverage(marginMarketLeverage) -Set the user market leverage multiple +Set the user market leverage multiple. ### Example @@ -649,13 +649,13 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Success | - | +**204** | Success. | - | # **listMarginUserAccount** > List<MarginAccount> listMarginUserAccount().currencyPair(currencyPair).execute(); -Query the user's leverage account list +Query the user's leverage account list. Support querying risk rate per position account and margin rate per position account @@ -680,7 +680,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginApi apiInstance = new MarginApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Currency pair + String currencyPair = "BTC_USDT"; // String | Currency pair. try { List result = apiInstance.listMarginUserAccount() .currencyPair(currencyPair) @@ -703,7 +703,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair | [optional] + **currencyPair** | **String**| Currency pair. | [optional] ### Return type @@ -721,13 +721,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **listCrossMarginLoans** > List<CrossMarginLoan> listCrossMarginLoans(status).currency(currency).limit(limit).offset(offset).reverse(reverse).execute(); -List cross margin borrow history. (deprecated) +List cross margin borrow history. (deprecated). Sort by creation time in descending order by default. Set `reverse=false` to return ascending results. @@ -752,10 +752,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 - Integer offset = 0; // Integer | List offset, starting from 0 + 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. + 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 { List result = apiInstance.listCrossMarginLoans(status) @@ -782,10 +782,10 @@ 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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **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] + **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] ### Return type @@ -804,13 +804,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listCrossMarginRepayments** > List<CrossMarginRepayment> listCrossMarginRepayments().currency(currency).loanId(loanId).limit(limit).offset(offset).reverse(reverse).execute(); -Retrieve cross margin repayments. (deprecated) +Retrieve cross margin repayments. (deprecated). Sort by creation time in descending order by default. Set `reverse=false` to return ascending results. @@ -837,8 +837,8 @@ 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 offset = 0; // Integer | List offset, starting from 0 + Integer limit = 100; // Integer | Maximum number of records to be 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 { List result = apiInstance.listCrossMarginRepayments() @@ -868,8 +868,8 @@ 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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **limit** | **Integer**| Maximum number of records to be 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] ### Return type @@ -888,5 +888,5 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | diff --git a/docs/MarginLeverageTier.md b/docs/MarginLeverageTier.md index c8fa212..59a94c2 100644 --- a/docs/MarginLeverageTier.md +++ b/docs/MarginLeverageTier.md @@ -1,13 +1,13 @@ # MarginLeverageTier -Market gradient information +Market gradient information. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**upperLimit** | **String** | Maximum loan limit | [optional] -**mmr** | **String** | Maintenance margin rate | [optional] -**leverage** | **String** | Maximum leverage multiple | [optional] +**upperLimit** | **String** | Maximum loan limit. | [optional] +**mmr** | **String** | Maintenance margin rate. | [optional] +**leverage** | **String** | Maximum leverage multiple. | [optional] diff --git a/docs/MarginMarketLeverage.md b/docs/MarginMarketLeverage.md index 38af405..bf4ecdc 100644 --- a/docs/MarginMarketLeverage.md +++ b/docs/MarginMarketLeverage.md @@ -1,12 +1,12 @@ # MarginMarketLeverage -Market leverage settings +Market leverage settings. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currencyPair** | **String** | Currency pair | [optional] -**leverage** | **String** | Position leverage | +**currencyPair** | **String** | Currency pair. | [optional] +**leverage** | **String** | Position leverage. | diff --git a/docs/MarginTiers.md b/docs/MarginTiers.md index 53d86e2..e175b36 100644 --- a/docs/MarginTiers.md +++ b/docs/MarginTiers.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**tier** | **String** | Tier | [optional] -**marginRate** | **String** | Discount | [optional] -**lowerLimit** | **String** | Lower limit | [optional] -**upperLimit** | **String** | Upper limit, \"\" indicates greater than (the last tier) | [optional] -**leverage** | **String** | Position leverage | [optional] +**tier** | **String** | Tier. | [optional] +**marginRate** | **String** | Discount. | [optional] +**lowerLimit** | **String** | Lower limit. | [optional] +**upperLimit** | **String** | Upper limit, \"\" indicates greater than (the last tier). | [optional] +**leverage** | **String** | Position leverage. | [optional] diff --git a/docs/MarginTransferable.md b/docs/MarginTransferable.md index 3f983d7..b7685ff 100644 --- a/docs/MarginTransferable.md +++ b/docs/MarginTransferable.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency detail | [optional] -**currencyPair** | **String** | Currency pair | [optional] -**amount** | **String** | Max transferable amount | [optional] +**currency** | **String** | Currency detail. | [optional] +**currencyPair** | **String** | Currency pair. | [optional] +**amount** | **String** | Max transferable amount. | [optional] diff --git a/docs/MarginUniApi.md b/docs/MarginUniApi.md index 913debc..5c2e750 100644 --- a/docs/MarginUniApi.md +++ b/docs/MarginUniApi.md @@ -4,21 +4,21 @@ 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 -[**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 +[**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. +[**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. # **listUniCurrencyPairs** > List<UniCurrencyPair> listUniCurrencyPairs() -List lending markets +List lending markets. ### Example @@ -72,13 +72,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **getUniCurrencyPair** > UniCurrencyPair getUniCurrencyPair(currencyPair) -Get detail of lending market +Get detail of lending market. ### Example @@ -97,7 +97,7 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); MarginUniApi apiInstance = new MarginUniApi(defaultClient); - String currencyPair = "AE_USDT"; // String | Currency pair + String currencyPair = "AE_USDT"; // String | Currency pair. try { UniCurrencyPair result = apiInstance.getUniCurrencyPair(currencyPair); System.out.println(result); @@ -118,7 +118,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair | + **currencyPair** | **String**| Currency pair. | ### Return type @@ -136,13 +136,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **getMarginUniEstimateRate** > Map<String, String> getMarginUniEstimateRate(currencies) -Estimate interest Rate +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. @@ -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 | An array of up to 10 specifying the currency name. 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)| An array of up to 10 specifying the currency name. | ### Return type @@ -206,13 +206,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listUniLoans** > List<UniLoan> listUniLoans().currencyPair(currencyPair).currency(currency).page(page).limit(limit).execute(); -List loans +List loans. ### Example @@ -235,10 +235,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginUniApi apiInstance = new MarginUniApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Currency pair - 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 + String currencyPair = "BTC_USDT"; // String | Currency pair. + 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. try { List result = apiInstance.listUniLoans() .currencyPair(currencyPair) @@ -264,10 +264,10 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair | [optional] - **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] + **currencyPair** | **String**| Currency pair. | [optional] + **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] ### Return type @@ -285,13 +285,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **createUniLoan** > createUniLoan(createUniLoan) -Borrow or repay +Borrow or repay. ### Example @@ -352,13 +352,13 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Operated successfully | - | +**204** | Operated successfully. | - | # **listUniLoanRecords** > List<UniLoanRecord> listUniLoanRecords().type(type).currency(currency).currencyPair(currencyPair).page(page).limit(limit).execute(); -Get load records +Get load 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 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 + String type = "type_example"; // String | type: borrow - borrow, repay - repay. + String currency = "BTC"; // String | Retrieve data of the specified currency. + 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. 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] - **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] + **type** | **String**| type: borrow - borrow, repay - repay. | [optional] [enum: borrow, repay] + **currency** | **String**| Retrieve data of the specified currency. | [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] ### Return type @@ -434,13 +434,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listUniLoanInterestRecords** > List<UniLoanInterestRecord> listUniLoanInterestRecords().currencyPair(currencyPair).currency(currency).page(page).limit(limit).from(from).to(to).execute(); -List interest records +List interest records. ### Example @@ -463,10 +463,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginUniApi apiInstance = new MarginUniApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Currency pair - String currency = "BTC"; // String | Retrieve data of the specified currency - Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + String currencyPair = "BTC_USDT"; // String | Currency pair. + String currency = "BTC"; // String | Retrieve data of the specified currency. + 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 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 { @@ -496,10 +496,10 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair | [optional] - **currency** | **String**| Retrieve data of the specified 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] + **currencyPair** | **String**| Currency pair. | [optional] + **currency** | **String**| Retrieve data of the specified 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 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] @@ -519,13 +519,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **getUniBorrowable** > MaxUniBorrowable getUniBorrowable(currency, currencyPair) -Get maximum borrowable +Get maximum borrowable. ### Example @@ -548,8 +548,8 @@ 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 currencyPair = "BTC_USDT"; // String | Currency pair + String currency = "BTC"; // String | Retrieve data of the specified currency. + String currencyPair = "BTC_USDT"; // String | Currency pair. try { MaxUniBorrowable result = apiInstance.getUniBorrowable(currency, currencyPair); System.out.println(result); @@ -570,8 +570,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | - **currencyPair** | **String**| Currency pair | + **currency** | **String**| Retrieve data of the specified currency. | + **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** | Successfully retrieved. | - | diff --git a/docs/MaxUniBorrowable.md b/docs/MaxUniBorrowable.md index 22621c1..1fadabc 100644 --- a/docs/MaxUniBorrowable.md +++ b/docs/MaxUniBorrowable.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency | [readonly] -**currencyPair** | **String** | Currency pair | [optional] [readonly] -**borrowable** | **String** | Maximum borrowable | [readonly] +**currency** | **String** | Currency. | [readonly] +**currencyPair** | **String** | Currency pair. | [optional] [readonly] +**borrowable** | **String** | Maximum borrowable. | [readonly] diff --git a/docs/MockFuturesOrder.md b/docs/MockFuturesOrder.md index 983dd7f..35a86cd 100644 --- a/docs/MockFuturesOrder.md +++ b/docs/MockFuturesOrder.md @@ -1,7 +1,7 @@ # MockFuturesOrder -Futures order +Futures order. ## Properties @@ -9,5 +9,5 @@ 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. | -**left** | **String** | Unfilled contract quantity, involved in actual calculation | +**left** | **String** | Unfilled contract quantity, involved in actual calculation. | diff --git a/docs/MockFuturesPosition.md b/docs/MockFuturesPosition.md index d477aab..ec4b042 100644 --- a/docs/MockFuturesPosition.md +++ b/docs/MockFuturesPosition.md @@ -1,7 +1,7 @@ # MockFuturesPosition -Futures positions +Futures positions. ## Properties diff --git a/docs/MockMarginResult.md b/docs/MockMarginResult.md index d555dd7..a357697 100644 --- a/docs/MockMarginResult.md +++ b/docs/MockMarginResult.md @@ -1,17 +1,17 @@ # MockMarginResult -Margin result +Margin result. ## Properties 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] +**type** | **String** | Position combination type `original_position` - Original position `long_delta_original_position` - Positive delta + Original position `short_delta_original_position` position | [optional] +**profitLossRanges** | [**List<ProfitLossRange>**](ProfitLossRange.md) | The results of 3 pressure scenarios for MR1. | [optional] **maxLoss** | [**ProfitLossRange**](.md) | 最大损失 | [optional] -**mr1** | **String** | Stress testing | [optional] -**mr2** | **String** | Basis spread risk | [optional] -**mr3** | **String** | Volatility spread risk | [optional] -**mr4** | **String** | Option short risk | [optional] +**mr1** | **String** | Stress testing. | [optional] +**mr2** | **String** | Basis spread risk. | [optional] +**mr3** | **String** | Volatility spread risk. | [optional] +**mr4** | **String** | Option short risk. | [optional] diff --git a/docs/MockOptionsOrder.md b/docs/MockOptionsOrder.md index 1a48951..aa490fb 100644 --- a/docs/MockOptionsOrder.md +++ b/docs/MockOptionsOrder.md @@ -1,13 +1,13 @@ # MockOptionsOrder -Option orders +Option orders. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **optionsName** | **String** | Option name, currently only supports options for BTC and ETH with USDT. | -**size** | **String** | Initial order quantity, not involved in actual calculation | -**left** | **String** | Unfilled contract quantity, involved in actual calculation | +**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..5a25e38 100644 --- a/docs/MockOptionsPosition.md +++ b/docs/MockOptionsPosition.md @@ -1,7 +1,7 @@ # MockOptionsPosition -Options positions +Options positions. ## Properties diff --git a/docs/MockRiskUnit.md b/docs/MockRiskUnit.md index eb4ec63..882ef9f 100644 --- a/docs/MockRiskUnit.md +++ b/docs/MockRiskUnit.md @@ -1,19 +1,19 @@ # MockRiskUnit -Risk unit +Risk unit. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**symbol** | **String** | Risk unit name | [optional] -**spotInUse** | **String** | Spot usage | [optional] -**maintainMargin** | **String** | Maintenance margin | [optional] -**initialMargin** | **String** | Initial margin | [optional] -**marginResult** | [**List<MockMarginResult>**](MockMarginResult.md) | Margin result | [optional] -**delta** | **String** | Total Delta of risk unit | [optional] -**gamma** | **String** | Total Gamma of risk unit | [optional] -**theta** | **String** | Total Theta of risk unit | [optional] -**vega** | **String** | Total Vega of risk unit | [optional] +**symbol** | **String** | Risk unit name. | [optional] +**spotInUse** | **String** | Spot usage. | [optional] +**maintainMargin** | **String** | Maintenance margin. | [optional] +**initialMargin** | **String** | Initial margin. | [optional] +**marginResult** | [**List<MockMarginResult>**](MockMarginResult.md) | Margin result. | [optional] +**delta** | **String** | Total Delta of risk unit. | [optional] +**gamma** | **String** | Total Gamma of risk unit. | [optional] +**theta** | **String** | Total Theta of risk unit. | [optional] +**vega** | **String** | Total Vega of risk unit. | [optional] diff --git a/docs/MockSpotBalance.md b/docs/MockSpotBalance.md index ab2cdf4..2899e5e 100644 --- a/docs/MockSpotBalance.md +++ b/docs/MockSpotBalance.md @@ -1,12 +1,12 @@ # MockSpotBalance -Spot +Spot. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency name | +**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. | diff --git a/docs/MockSpotOrder.md b/docs/MockSpotOrder.md index 7874584..b6ea3f4 100644 --- a/docs/MockSpotOrder.md +++ b/docs/MockSpotOrder.md @@ -1,14 +1,14 @@ # MockSpotOrder -Spot orders +Spot orders. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currencyPairs** | **String** | Currency pair | -**orderPrice** | **String** | Price | +**currencyPairs** | **String** | Currency pair. | +**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. | diff --git a/docs/MultiChainAddressItem.md b/docs/MultiChainAddressItem.md index 64ff9cd..d5e3f03 100644 --- a/docs/MultiChainAddressItem.md +++ b/docs/MultiChainAddressItem.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**chain** | **String** | Name of the chain | [optional] -**address** | **String** | Deposit address | [optional] -**paymentId** | **String** | Notes that some currencies required(e.g., Tag, Memo) when depositing | [optional] -**paymentName** | **String** | Note type, `Tag` or `Memo` | [optional] +**chain** | **String** | Name of the chain. | [optional] +**address** | **String** | Deposit address. | [optional] +**paymentId** | **String** | Notes that some currencies required(e.g., Tag, Memo) when depositing. | [optional] +**paymentName** | **String** | Note type, `Tag` or `Memo`. | [optional] **obtainFailed** | **Integer** | The obtain failed status- 0: address successfully obtained- 1: failed to obtain address | [optional] diff --git a/docs/MultiCollateralCurrency.md b/docs/MultiCollateralCurrency.md index 06d701a..6fcb5f8 100644 --- a/docs/MultiCollateralCurrency.md +++ b/docs/MultiCollateralCurrency.md @@ -7,6 +7,6 @@ Borrowing and collateral currencies supported for Multi-Collateral. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**loanCurrencies** | [**List<MultiLoanItem>**](MultiLoanItem.md) | List of supported borrowing currencies | [optional] -**collateralCurrencies** | [**List<MultiCollateralItem>**](MultiCollateralItem.md) | List of supported collateral currencies | [optional] +**loanCurrencies** | [**List<MultiLoanItem>**](MultiLoanItem.md) | List of supported borrowing currencies. | [optional] +**collateralCurrencies** | [**List<MultiCollateralItem>**](MultiCollateralItem.md) | List of supported collateral currencies. | [optional] diff --git a/docs/MultiCollateralItem.md b/docs/MultiCollateralItem.md index 9bf8bf4..27524de 100644 --- a/docs/MultiCollateralItem.md +++ b/docs/MultiCollateralItem.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency | [optional] -**indexPrice** | **String** | Currency Index Price | [optional] -**discount** | **String** | Discount | [optional] +**currency** | **String** | Currency. | [optional] +**indexPrice** | **String** | Currency Index Price. | [optional] +**discount** | **String** | Discount. | [optional] diff --git a/docs/MultiCollateralLoanApi.md b/docs/MultiCollateralLoanApi.md index 88527e5..e33bb8f 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 -[**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 +[**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. +[**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. # **listMultiCollateralOrders** > List<MultiCollateralOrder> listMultiCollateralOrders().page(page).limit(limit).sort(sort).orderType(orderType).execute(); -List Multi-Collateral Orders +List Multi-Collateral Orders. ### Example @@ -45,9 +45,9 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 | Query the current interest rate of the currency in the previous hour + 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 | Query the current interest rate of the currency in the previous hour. 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() @@ -74,9 +74,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**| Query the current interest rate of the currency in the previous hour | [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] + **sort** | **String**| Query the current interest rate of the currency in the previous hour. | [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. | - | # **createMultiCollateral** > OrderResp createMultiCollateral(createMultiCollateralOrder) -Create Multi-Collateral Order +Create Multi-Collateral Order. ### Example @@ -163,13 +163,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | Success. | - | # **getMultiCollateralOrderDetail** > MultiCollateralOrder getMultiCollateralOrderDetail(orderId) -Get Multi-Collateral Order Detail +Get Multi-Collateral Order Detail. ### 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 on successful order creation. 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 on successful order creation. | ### Return type @@ -231,13 +231,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | Success. | - | # **listMultiRepayRecords** > List<MultiRepayRecord> listMultiRepayRecords(type).borrowCurrency(borrowCurrency).page(page).limit(limit).from(from).to(to).execute(); -List Multi-Collateral Repay Records +List Multi-Collateral Repay Records. ### Example @@ -260,12 +260,12 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MultiCollateralLoanApi apiInstance = new MultiCollateralLoanApi(defaultClient); - 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 + 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. try { List result = apiInstance.listMultiRepayRecords(type) .borrowCurrency(borrowCurrency) @@ -292,12 +292,12 @@ public class Example { 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] + **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] ### Return type @@ -315,13 +315,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **repayMultiCollateralLoan** > MultiRepayResp repayMultiCollateralLoan(repayMultiLoan) -Repay Multi-Collateral Loan +Repay Multi-Collateral Loan. ### Example @@ -383,13 +383,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Operated successfully | - | +**200** | Operated successfully. | - | # **listMultiCollateralRecords** > List<MultiCollateralRecord> listMultiCollateralRecords().page(page).limit(limit).from(from).to(to).collateralCurrency(collateralCurrency).execute(); -Query collateral adjustment records +Query collateral adjustment records. ### Example @@ -412,11 +412,11 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 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. try { List result = apiInstance.listMultiCollateralRecords() .page(page) @@ -443,11 +443,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 10] - **from** | **Long**| Start timestamp of the query | [optional] - **to** | **Long**| Time range ending, default to current time | [optional] - **collateralCurrency** | **String**| Collateral | [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] + **collateralCurrency** | **String**| Collateral. | [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. | - | # **operateMultiCollateral** > CollateralAdjustRes operateMultiCollateral(collateralAdjust) -Operate Multi-Collateral +Operate Multi-Collateral. ### Example @@ -533,13 +533,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Operated successfully | - | +**200** | Operated successfully. | - | # **listUserCurrencyQuota** > List<CurrencyQuota> listUserCurrencyQuota(type, currency) -List User Currency Quota +List User Currency Quota. ### 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 type: collateral - Collateral currency, borrow - Borrowing - String currency = "BTC"; // String | When it is a collateral currency, multiple currencies can be passed separated by commas;when it is a borrowing currency, only one currenc + String type = "collateral"; // String | Currency type: collateral - Collateral currency, borrow - Borrowing. + String currency = "BTC"; // String | When it is a collateral currency, multiple currencies can be passed separated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one commas; when it is a borrowing currency, only one currency can be passed 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 type: collateral - Collateral currency, borrow - Borrowing | - **currency** | **String**| When it is a collateral currency, multiple currencies can be passed separated by commas;when it is a borrowing currency, only one currenc | + **type** | **String**| Currency type: collateral - Collateral currency, borrow - Borrowing. | + **currency** | **String**| When it is a collateral currency, multiple currencies can be passed separated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one commas; when it is a borrowing currency, only one currency can be passed | ### Return type @@ -603,13 +603,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listMultiCollateralCurrencies** > MultiCollateralCurrency listMultiCollateralCurrencies() -Query supported borrowing and collateral currencies in Multi-Collateral +Query supported borrowing and collateral currencies in Multi-Collateral. ### Example @@ -663,13 +663,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **getMultiCollateralLtv** > CollateralLtv getMultiCollateralLtv() -Get Multi-Collateral ratio +Get Multi-Collateral ratio. The Multi-Collateral ratio is fixed, irrespective of the currency. @@ -725,13 +725,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **getMultiCollateralFixRate** > List<CollateralFixRate> getMultiCollateralFixRate() -Query fixed interest rates for the currency for 7 days and 30 days +Query fixed interest rates for the currency for 7 days and 30 days. ### Example @@ -785,13 +785,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **getMultiCollateralCurrentRate** > List<CollateralCurrentRate> getMultiCollateralCurrentRate(currencies).vipLevel(vipLevel).execute(); -Query the current interest rate of the currency +Query the current interest rate of the currency. Query the current interest rate of the currency in the previous hour. @@ -813,7 +813,7 @@ public class Example { MultiCollateralLoanApi apiInstance = new MultiCollateralLoanApi(defaultClient); List currencies = Arrays.asList(); // List | Specify currency name query array, separated by commas, maximum 100items. - String vipLevel = "\"0\""; // String | VIP level, defaults to 0 if not transferred + String vipLevel = "\"0\""; // String | VIP level, defaults to 0 if not transferred. try { List result = apiInstance.getMultiCollateralCurrentRate(currencies) .vipLevel(vipLevel) @@ -837,7 +837,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **currencies** | [**List<String>**](String.md)| Specify currency name query array, separated by commas, maximum 100items. | - **vipLevel** | **String**| VIP level, defaults to 0 if not transferred | [optional] [default to "0"] + **vipLevel** | **String**| VIP level, defaults to 0 if not transferred. | [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** | Successfully retrieved. | - | diff --git a/docs/MultiCollateralOrder.md b/docs/MultiCollateralOrder.md index c93c5e5..b4b1af1 100644 --- a/docs/MultiCollateralOrder.md +++ b/docs/MultiCollateralOrder.md @@ -1,24 +1,24 @@ # MultiCollateralOrder -Multi-Collateral Order +Multi-Collateral Order. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**orderId** | **String** | Order ID | [optional] -**orderType** | **String** | current - current, fixed - fixed | [optional] +**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] -**fixedRate** | **String** | Fixed interest rate | [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] +**autoRenew** | **Boolean** | Fixed interest rate, automatic renewal. | [optional] +**autoRepay** | **Boolean** | Fixed interest rate, automatic repayment. | [optional] +**currentLtv** | **String** | The 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] -**borrowCurrencies** | [**List<BorrowCurrencyInfo>**](BorrowCurrencyInfo.md) | Borrowing Currency List | [optional] -**collateralCurrencies** | [**List<CollateralCurrencyInfo>**](CollateralCurrencyInfo.md) | Collateral Currency List | [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] +**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..d21664c 100644 --- a/docs/MultiCollateralRecord.md +++ b/docs/MultiCollateralRecord.md @@ -7,11 +7,11 @@ Multi-Collateral adjustment record. 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] +**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] -**borrowCurrencies** | [**List<MultiCollateralRecordCurrency>**](MultiCollateralRecordCurrency.md) | Borrowing Currency List | [optional] -**collateralCurrencies** | [**List<MultiCollateralRecordCurrency>**](MultiCollateralRecordCurrency.md) | Collateral Currency List | [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..994e784 100644 --- a/docs/MultiCollateralRecordCurrency.md +++ b/docs/MultiCollateralRecordCurrency.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency | [optional] -**indexPrice** | **String** | Currency Index Price | [optional] -**beforeAmount** | **String** | Amount before the operation | [optional] +**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] diff --git a/docs/MultiLoanItem.md b/docs/MultiLoanItem.md index ce949d7..2f7939a 100644 --- a/docs/MultiLoanItem.md +++ b/docs/MultiLoanItem.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency | [optional] -**price** | **String** | Latest price of the currency | [optional] +**currency** | **String** | Currency. | [optional] +**price** | **String** | Latest price of the currency. | [optional] diff --git a/docs/MultiLoanRepayItem.md b/docs/MultiLoanRepayItem.md index 17a3604..b7d31d5 100644 --- a/docs/MultiLoanRepayItem.md +++ b/docs/MultiLoanRepayItem.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Repayment currency | [optional] -**amount** | **String** | Size | [optional] +**currency** | **String** | Repayment currency. | [optional] +**amount** | **String** | Size. | [optional] **repaidAll** | **Boolean** | Repayment method, set to true for full repayment, false for partial repayment. | [optional] diff --git a/docs/MultiRepayRecord.md b/docs/MultiRepayRecord.md index 398f4c0..c7e2d12 100644 --- a/docs/MultiRepayRecord.md +++ b/docs/MultiRepayRecord.md @@ -1,22 +1,22 @@ # MultiRepayRecord -Mult Repay Record +Mult Repay Record. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**orderId** | **Long** | Order ID | [optional] -**recordId** | **Long** | Repayment record ID | [optional] -**initLtv** | **String** | The initial collateralization rate | [optional] -**beforeLtv** | **String** | Ltv before the operation | [optional] -**afterLtv** | **String** | Ltv after the operation | [optional] +**orderId** | **Long** | Order ID. | [optional] +**recordId** | **Long** | Repayment record ID. | [optional] +**initLtv** | **String** | The 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] -**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] +**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] diff --git a/docs/MultiRepayResp.md b/docs/MultiRepayResp.md index 757393f..77f5be6 100644 --- a/docs/MultiRepayResp.md +++ b/docs/MultiRepayResp.md @@ -1,12 +1,12 @@ # MultiRepayResp -Repay Multi-Collateral Loan +Repay Multi-Collateral Loan. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**orderId** | **Long** | Order ID | [optional] -**repaidCurrencies** | [**List<RepayCurrencyRes>**](RepayCurrencyRes.md) | Repay Currency List | [optional] +**orderId** | **Long** | Order ID. | [optional] +**repaidCurrencies** | [**List<RepayCurrencyRes>**](RepayCurrencyRes.md) | Repay Currency List. | [optional] diff --git a/docs/MyFuturesTrade.md b/docs/MyFuturesTrade.md index 8b9750a..3139059 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] -**contract** | **String** | Futures contract | [optional] -**orderId** | **String** | Order ID related | [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] +**id** | **Long** | Trade ID. | [optional] +**createTime** | **Double** | Trading time. | [optional] +**contract** | **String** | Futures contract. | [optional] +**orderId** | **String** | Order ID related. | [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 > 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] ## Enum: RoleEnum diff --git a/docs/MyFuturesTradeTimeRange.md b/docs/MyFuturesTradeTimeRange.md index b6eda6a..e0b4bf8 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] -**contract** | **String** | Futures contract | [optional] -**orderId** | **String** | Order ID related | [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] +**tradeId** | **String** | Trade ID. | [optional] +**createTime** | **Double** | Trading time. | [optional] +**contract** | **String** | Futures contract. | [optional] +**orderId** | **String** | Order ID related. | [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 > 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] ## Enum: RoleEnum diff --git a/docs/OpenOrders.md b/docs/OpenOrders.md index 9607bc9..ccf9f7d 100644 --- a/docs/OpenOrders.md +++ b/docs/OpenOrders.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currencyPair** | **String** | Currency pair | [optional] +**currencyPair** | **String** | Currency pair. | [optional] **total** | **Integer** | The total number of pending 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..0335ebc 100644 --- a/docs/OptionsAccount.md +++ b/docs/OptionsAccount.md @@ -5,24 +5,24 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**user** | **Long** | User ID | [optional] -**total** | **String** | Account balance | [optional] +**user** | **Long** | User ID. | [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] -**mmpEnabled** | **Boolean** | Whether to enable MMP | [optional] -**liqTriggered** | **Boolean** | Whether to trigger position liquidation | [optional] +**equity** | **String** | Account equity, the sum of account balance and position value. | [optional] +**shortEnabled** | **Boolean** | If the account is allowed to short. | [optional] +**mmpEnabled** | **Boolean** | Whether to enable MMP. | [optional] +**liqTriggered** | **Boolean** | Whether to trigger position liquidation. | [optional] **marginMode** | [**MarginModeEnum**](#MarginModeEnum) | ｜ 保证金模式： - 0：经典现货保证金模式 - 1：跨币种保证金模式 - 2：组合保证金模式 | [optional] -**unrealisedPnl** | **String** | Unrealized PNL | [optional] -**initMargin** | **String** | Initial position margin | [optional] -**maintMargin** | **String** | Position maintenance margin | [optional] -**orderMargin** | **String** | Order margin of unfinished orders | [optional] -**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] -**ordersLimit** | **Integer** | Maximum number of outstanding orders | [optional] +**unrealisedPnl** | **String** | Unrealized PNL. | [optional] +**initMargin** | **String** | Initial position margin. | [optional] +**maintMargin** | **String** | Position maintenance margin. | [optional] +**orderMargin** | **String** | Order margin of unfinished orders. | [optional] +**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] +**ordersLimit** | **Integer** | Maximum number of outstanding orders. | [optional] **positionNotionalLimit** | **Long** | Notional value upper limit, including the nominal value of positions and outstanding orders | [optional] ## Enum: MarginModeEnum diff --git a/docs/OptionsAccountBook.md b/docs/OptionsAccountBook.md index 4525438..58826d5 100644 --- a/docs/OptionsAccountBook.md +++ b/docs/OptionsAccountBook.md @@ -5,9 +5,9 @@ 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] +**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_fee: POINT Trading fee - point_refr: POINT Referrer rebate | [optional] +**text** | **String** | custom text. | [optional] diff --git a/docs/OptionsApi.md b/docs/OptionsApi.md index 7666997..bf208a4 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 -[**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 -[**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 -[**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 +[**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. +[**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. +[**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. +[**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. [**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 underlyings. ### Example @@ -92,13 +92,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **listOptionsExpirations** > List<Long> listOptionsExpirations(underlying) -List all expiration times +List all expiration times. ### Example @@ -117,7 +117,7 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); OptionsApi apiInstance = new OptionsApi(defaultClient); - String underlying = "BTC_USDT"; // String | Underlying (Obtained by listing underlying endpoint) + String underlying = "BTC_USDT"; // String | Underlying (Obtained by listing underlying endpoint). try { List result = apiInstance.listOptionsExpirations(underlying); System.out.println(result); @@ -138,7 +138,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **underlying** | **String**| Underlying (Obtained by listing underlying endpoint) | + **underlying** | **String**| Underlying (Obtained by listing underlying endpoint). | ### Return type @@ -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 times of specified underlying. | - | # **listOptionsContracts** > List<OptionsContract> listOptionsContracts(underlying).expiration(expiration).execute(); -List all the contracts with specified underlying and expiration time +List all the contracts with specified underlying and expiration time. ### Example @@ -181,8 +181,8 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 + String underlying = "BTC_USDT"; // String | Underlying (Obtained by listing underlying endpoint). + Long expiration = 1636588800L; // Long | Unix timestamp of the expiration time. try { List result = apiInstance.listOptionsContracts(underlying) .expiration(expiration) @@ -205,8 +205,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **underlying** | **String**| Underlying (Obtained by listing underlying endpoint) | - **expiration** | **Long**| Unix timestamp of the expiration time | [optional] + **underlying** | **String**| Underlying (Obtained by listing underlying endpoint). | + **expiration** | **Long**| Unix timestamp of the expiration time. | [optional] ### Return type @@ -224,13 +224,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **getOptionsContract** > OptionsContract getOptionsContract(contract) -Query specified contract detail +Query specified contract detail. ### Example @@ -288,13 +288,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listOptionsSettlements** > List<OptionsSettlement> listOptionsSettlements(underlying).limit(limit).offset(offset).from(from).to(to).execute(); -List settlement history +List settlement history. ### Example @@ -313,9 +313,9 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 offset = 0; // Integer | List offset, starting from 0 + 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 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 try { @@ -343,9 +343,9 @@ 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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **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] + **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] @@ -365,13 +365,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **getOptionsSettlement** > OptionsSettlement getOptionsSettlement(contract, underlying, at) -Get specified contract's settlement +Get specified contract's settlement. ### Example @@ -391,7 +391,7 @@ public class Example { OptionsApi apiInstance = new OptionsApi(defaultClient); String contract = "BTC_USDT-20211130-65000-C"; // String | - String underlying = "BTC_USDT"; // String | Underlying (Obtained by listing underlying endpoint) + String underlying = "BTC_USDT"; // String | Underlying (Obtained by listing underlying endpoint). Long at = 56L; // Long | try { OptionsSettlement result = apiInstance.getOptionsSettlement(contract, underlying, at); @@ -414,7 +414,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **contract** | **String**| | - **underlying** | **String**| Underlying (Obtained by listing underlying endpoint) | + **underlying** | **String**| Underlying (Obtained by listing underlying endpoint). | **at** | **Long**| | ### Return type @@ -433,13 +433,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listMyOptionsSettlements** > List<OptionsMySettlements> listMyOptionsSettlements(underlying).contract(contract).limit(limit).offset(offset).from(from).to(to).execute(); -List my options settlements +List my options settlements. ### Example @@ -462,10 +462,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 offset = 0; // Integer | List offset, starting from 0 + 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 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 try { @@ -494,10 +494,10 @@ public class Example { 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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **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] + **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] @@ -517,15 +517,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **listOptionsOrderBook** > FuturesOrderBook listOptionsOrderBook(contract).interval(interval).limit(limit).withId(withId).execute(); -Options order book +Options order book. -Bids will be sorted by price from high to low, while asks sorted reversely +Bids will be sorted by price from high to low, while asks sorted reversely. ### Example @@ -544,9 +544,9 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 + 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 to return depth update ID. This ID increments by 1 each time. try { FuturesOrderBook result = apiInstance.listOptionsOrderBook(contract) @@ -572,9 +572,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] + **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 to return depth update ID. This ID increments by 1 each time. | [optional] [default to false] ### Return type @@ -593,13 +593,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Depth query successful | - | +**200** | Depth query successful. | - | # **listOptionsTickers** > List<OptionsTicker> listOptionsTickers(underlying) -List tickers of options contracts +List tickers of options contracts. ### Example @@ -618,7 +618,7 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); OptionsApi apiInstance = new OptionsApi(defaultClient); - String underlying = "BTC_USDT"; // String | Underlying (Obtained by listing underlying endpoint) + String underlying = "BTC_USDT"; // String | Underlying (Obtained by listing underlying endpoint). try { List result = apiInstance.listOptionsTickers(underlying); System.out.println(result); @@ -639,7 +639,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **underlying** | **String**| Underlying (Obtained by listing underlying endpoint) | + **underlying** | **String**| Underlying (Obtained by listing underlying endpoint). | ### Return type @@ -657,13 +657,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listOptionsUnderlyingTickers** > OptionsUnderlyingTicker listOptionsUnderlyingTickers(underlying) -Get underlying ticker +Get underlying ticker. ### Example @@ -682,7 +682,7 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); OptionsApi apiInstance = new OptionsApi(defaultClient); - String underlying = "BTC_USDT"; // String | Underlying + String underlying = "BTC_USDT"; // String | Underlying. try { OptionsUnderlyingTicker result = apiInstance.listOptionsUnderlyingTickers(underlying); System.out.println(result); @@ -703,7 +703,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **underlying** | **String**| Underlying | + **underlying** | **String**| Underlying. | ### Return type @@ -721,13 +721,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listOptionsCandlesticks** > List<OptionsCandlestick> listOptionsCandlesticks(contract).limit(limit).from(from).to(to).interval(interval).execute(); -Get options candlesticks +Get options candlesticks. ### Example @@ -746,11 +746,11 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 + 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 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 | Interval time between data points + String interval = "5m"; // String | Interval time between data points. try { List result = apiInstance.listOptionsCandlesticks(contract) .limit(limit) @@ -776,11 +776,11 @@ 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] + **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 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**| Interval time between data points | [optional] [default to 5m] [enum: 1m, 5m, 15m, 30m, 1h] + **interval** | **String**| Interval time 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** | Successfully retrieved. | - | # **listOptionsUnderlyingCandlesticks** > List<FuturesCandlestick> listOptionsUnderlyingCandlesticks(underlying).limit(limit).from(from).to(to).interval(interval).execute(); -Mark price candlesticks of an underlying +Mark price candlesticks of an underlying. ### Example @@ -823,11 +823,11 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 + 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 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 | Interval time between data points + String interval = "5m"; // String | Interval time between data points. try { List result = apiInstance.listOptionsUnderlyingCandlesticks(underlying) .limit(limit) @@ -853,11 +853,11 @@ 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] + **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 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**| Interval time between data points | [optional] [default to 5m] [enum: 1m, 5m, 15m, 30m, 1h] + **interval** | **String**| Interval time 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** | Successfully retrieved. | - | # **listOptionsTrades** > List<FuturesTrade> listOptionsTrades().contract(contract).type(type).limit(limit).offset(offset).from(from).to(to).execute(); -Options trade history +Options trade history. ### Example @@ -900,10 +900,10 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 - Integer offset = 0; // Integer | List offset, starting from 0 + 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. + 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 try { @@ -933,10 +933,10 @@ 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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **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] + **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] @@ -956,13 +956,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **listOptionsAccount** > OptionsAccount listOptionsAccount() -List options account +List options account. ### Example @@ -1020,13 +1020,13 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listOptionsAccountBook** > List<OptionsAccountBook> listOptionsAccountBook().limit(limit).offset(offset).from(from).to(to).type(type).execute(); -List account changing history +List account changing history. ### Example @@ -1049,8 +1049,8 @@ 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 offset = 0; // Integer | List offset, starting from 0 + Integer limit = 100; // Integer | Maximum number of records to be 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 String type = "dnw"; // String | Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - set: settlement PNL @@ -1080,8 +1080,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **limit** | **Integer**| Maximum number of records to be returned in a single list | [optional] [default to 100] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **limit** | **Integer**| Maximum number of records to be 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] **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] @@ -1102,13 +1102,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **listOptionsPositions** > List<OptionsPosition> listOptionsPositions().underlying(underlying).execute(); -List user's positions of specified underlying +List user's positions of specified underlying. ### Example @@ -1131,7 +1131,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); OptionsApi apiInstance = new OptionsApi(defaultClient); - String underlying = "BTC_USDT"; // String | Underlying + String underlying = "BTC_USDT"; // String | Underlying. try { List result = apiInstance.listOptionsPositions() .underlying(underlying) @@ -1154,7 +1154,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **underlying** | **String**| Underlying | [optional] + **underlying** | **String**| Underlying. | [optional] ### Return type @@ -1172,13 +1172,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **getOptionsPosition** > OptionsPosition getOptionsPosition(contract) -Get specified contract position +Get specified contract position. ### Example @@ -1240,13 +1240,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listOptionsPositionClose** > List<OptionsPositionClose> listOptionsPositionClose(underlying).contract(contract).execute(); -List user's liquidation history of specified underlying +List user's liquidation history of specified underlying. ### Example @@ -1269,8 +1269,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 + String underlying = "BTC_USDT"; // String | Underlying (Obtained by listing underlying endpoint). + String contract = "BTC_USDT-20210916-5000-C"; // String | Options contract name. try { List result = apiInstance.listOptionsPositionClose(underlying) .contract(contract) @@ -1293,8 +1293,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **underlying** | **String**| Underlying (Obtained by listing underlying endpoint) | - **contract** | **String**| Options contract name | [optional] + **underlying** | **String**| Underlying (Obtained by listing underlying endpoint). | + **contract** | **String**| Options contract name. | [optional] ### Return type @@ -1312,13 +1312,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **listOptionsOrders** > List<OptionsOrder> listOptionsOrders(status).contract(contract).underlying(underlying).limit(limit).offset(offset).from(from).to(to).execute(); -List options orders +List options orders. ### Example @@ -1341,11 +1341,11 @@ 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 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 offset = 0; // Integer | List offset, starting from 0 + String status = "open"; // String | Only list the orders with this 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 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 try { @@ -1375,11 +1375,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **status** | **String**| Only list the orders with this 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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **status** | **String**| Only list the orders with this 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] + **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] @@ -1399,13 +1399,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **createOptionsOrder** > OptionsOrder createOptionsOrder(optionsOrder) -Create an options order +Create an options order. ### Example @@ -1467,13 +1467,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Order detail | - | +**201** | Order detail. | - | # **cancelOptionsOrders** > List<OptionsOrder> cancelOptionsOrders(contract, underlying, side) -Cancel all `open` orders matched +Cancel all `open` orders matched. ### Example @@ -1496,9 +1496,9 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 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. try { List result = apiInstance.cancelOptionsOrders(contract, underlying, side); System.out.println(result); @@ -1519,9 +1519,9 @@ public class Example { 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] + **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] ### Return type @@ -1539,13 +1539,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | All orders matched cancelled | - | +**200** | All orders matched cancelled. | - | # **getOptionsOrder** > OptionsOrder getOptionsOrder(orderId) -Get a single order +Get a single order. ### 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 on successful order creation. 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 on successful order creation. | ### Return type @@ -1607,13 +1607,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order detail | - | +**200** | Order detail. | - | # **cancelOptionsOrder** > OptionsOrder cancelOptionsOrder(orderId) -Cancel a single order +Cancel a 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 on successful order creation. 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 on successful order creation. | ### Return type @@ -1675,15 +1675,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order detail | - | +**200** | Order detail. | - | # **countdownCancelAllOptions** > TriggerTime countdownCancelAllOptions(countdownCancelAllOptionsTask) -Countdown cancel orders +Countdown cancel orders. -Option order heartbeat detection, when the `timeout` time set by the user is reached, if the existing countdown is not canceled or a new countdown is set, the related `option pending order` will be automatically canceled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at intervals of 30 seconds, with each countdown `timeout` set to 30 (seconds). If this interface is not called again within 30 seconds, all pending orders on the `underlying` `contract` you specified will be automatically cancelled. If `underlying` `contract` is not specified, 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** | Set countdown successfully. | - | # **listMyOptionsTrades** > List<OptionsMyTrade> listMyOptionsTrades(underlying).contract(contract).limit(limit).offset(offset).from(from).to(to).execute(); -List personal trading history +List personal trading history. ### Example @@ -1774,10 +1774,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 offset = 0; // Integer | List offset, starting from 0 + 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 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 try { @@ -1806,10 +1806,10 @@ public class Example { 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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **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] + **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] @@ -1829,13 +1829,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **getOptionsMMP** > List<OptionsMMP> getOptionsMMP().underlying(underlying).execute(); -MMP Query +MMP Query. ### Example @@ -1858,7 +1858,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); OptionsApi apiInstance = new OptionsApi(defaultClient); - String underlying = "BTC_USDT"; // String | Underlying + String underlying = "BTC_USDT"; // String | Underlying. try { List result = apiInstance.getOptionsMMP() .underlying(underlying) @@ -1881,7 +1881,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **underlying** | **String**| Underlying | [optional] + **underlying** | **String**| Underlying. | [optional] ### Return type @@ -1899,7 +1899,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **setOptionsMMP** @@ -1967,7 +1967,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | MMP Information | - | +**200** | MMP Information. | - | # **resetOptionsMMP** @@ -2035,5 +2035,5 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | MMP Information | - | +**200** | MMP Information. | - | diff --git a/docs/OptionsCandlestick.md b/docs/OptionsCandlestick.md index 1f6a717..6b1b8ce 100644 --- a/docs/OptionsCandlestick.md +++ b/docs/OptionsCandlestick.md @@ -1,16 +1,16 @@ # OptionsCandlestick -data point in every timestamp +data point in every timestamp. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**t** | **Double** | Unix timestamp in seconds | [optional] -**v** | **Long** | size volume (contract size). Only returned if `contract` is not prefixed | [optional] -**c** | **String** | Close price (quote currency, unit: underlying corresponding option price) | [optional] +**t** | **Double** | Unix timestamp in seconds. | [optional] +**v** | **Long** | size volume (contract size). Only returned if `contract` is not prefixed. | [optional] +**c** | **String** | Close price (quote currency, unit: underlying corresponding option price). | [optional] **h** | **String** | Highest price (quote currency, unit: underlying corresponding option price) | [optional] -**l** | **String** | Lowest price (quote currency, unit: underlying corresponding option price) | [optional] -**o** | **String** | Open price (quote currency, unit: underlying corresponding option price) | [optional] +**l** | **String** | Lowest price (quote currency, unit: underlying corresponding option price). | [optional] +**o** | **String** | Open price (quote currency, unit: underlying corresponding option price). | [optional] diff --git a/docs/OptionsContract.md b/docs/OptionsContract.md index 837e3f0..360f600 100644 --- a/docs/OptionsContract.md +++ b/docs/OptionsContract.md @@ -1,35 +1,35 @@ # OptionsContract -Options contract detail +Options contract detail. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | Options contract name | [optional] -**tag** | **String** | tag | [optional] -**createTime** | **Double** | Creation time | [optional] -**expirationTime** | **Double** | Expiration time | [optional] -**isCall** | **Boolean** | `true` means call options, while `false` is 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] -**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] -**tradeId** | **Long** | Current trade ID | [optional] -**tradeSize** | **Long** | Historical accumulated trade size | [optional] -**positionSize** | **Long** | Current total long position size | [optional] -**ordersLimit** | **Integer** | Maximum number of open orders | [optional] +**name** | **String** | Options contract name. | [optional] +**tag** | **String** | tag. | [optional] +**createTime** | **Double** | Creation time. | [optional] +**expirationTime** | **Double** | Expiration time. | [optional] +**isCall** | **Boolean** | `true` means call options, while `false` is 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] +**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 `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] +**tradeId** | **Long** | Current trade ID. | [optional] +**tradeSize** | **Long** | Historical accumulated trade size. | [optional] +**positionSize** | **Long** | Current total long position size. | [optional] +**ordersLimit** | **Integer** | Maximum number of open orders. | [optional] diff --git a/docs/OptionsMMP.md b/docs/OptionsMMP.md index 48c4d34..29b1f46 100644 --- a/docs/OptionsMMP.md +++ b/docs/OptionsMMP.md @@ -7,11 +7,11 @@ MMP Settings Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**underlying** | **String** | Underlying | -**window** | **Integer** | Time window (milliseconds), between 1-5000, 0 means disabling MMP | +**underlying** | **String** | Underlying. | +**window** | **Integer** | Time window (milliseconds), between 1-5000, 0 means disabling 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] +**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] diff --git a/docs/OptionsMMPReset.md b/docs/OptionsMMPReset.md index c79f10d..acb53cd 100644 --- a/docs/OptionsMMPReset.md +++ b/docs/OptionsMMPReset.md @@ -7,11 +7,11 @@ MMP Reset Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**underlying** | **String** | Underlying | -**window** | **Integer** | Time window (milliseconds), between 1-5000, 0 means disabling MMP | [optional] [readonly] +**underlying** | **String** | Underlying. | +**window** | **Integer** | Time window (milliseconds), between 1-5000, 0 means disabling 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] +**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] diff --git a/docs/OptionsMySettlements.md b/docs/OptionsMySettlements.md index 67cce53..44f76fb 100644 --- a/docs/OptionsMySettlements.md +++ b/docs/OptionsMySettlements.md @@ -5,13 +5,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**time** | **Double** | Settlement time | [optional] -**underlying** | **String** | Underlying | [optional] -**contract** | **String** | Options contract name | [optional] -**strikePrice** | **String** | Strike price (quote currency) | [optional] -**settlePrice** | **String** | Settlement price (quote currency) | [optional] -**size** | **Long** | Size | [optional] -**settleProfit** | **String** | Settlement profit (quote currency) | [optional] -**fee** | **String** | Fee (quote currency) | [optional] +**time** | **Double** | Settlement time. | [optional] +**underlying** | **String** | Underlying. | [optional] +**contract** | **String** | Options contract name. | [optional] +**strikePrice** | **String** | Strike price (quote currency). | [optional] +**settlePrice** | **String** | Settlement price (quote currency). | [optional] +**size** | **Long** | 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] diff --git a/docs/OptionsMyTrade.md b/docs/OptionsMyTrade.md index f4a6aa5..8e9cd59 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] -**contract** | **String** | Options contract name | [optional] -**orderId** | **Integer** | Order ID related | [optional] -**size** | **Long** | Trading size | [optional] -**price** | **String** | Trading price (quote currency) | [optional] -**underlyingPrice** | **String** | Underlying price (quote currency) | [optional] -**role** | [**RoleEnum**](#RoleEnum) | Trade role. Available values are `taker` and `maker` | [optional] +**id** | **Long** | Trade ID. | [optional] +**createTime** | **Double** | Trading time. | [optional] +**contract** | **String** | Options contract name. | [optional] +**orderId** | **Integer** | Order ID related. | [optional] +**size** | **Long** | Trading size. | [optional] +**price** | **String** | Trading price (quote currency). | [optional] +**underlyingPrice** | **String** | Underlying price (quote currency). | [optional] +**role** | [**RoleEnum**](#RoleEnum) | Trade role. Available values are `taker` and `maker`. | [optional] ## Enum: RoleEnum diff --git a/docs/OptionsOrder.md b/docs/OptionsOrder.md index 25405ed..0fd591a 100644 --- a/docs/OptionsOrder.md +++ b/docs/OptionsOrder.md @@ -1,37 +1,37 @@ # OptionsOrder -Options order detail +Options order detail. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Long** | Options 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) | 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] +**id** | **Long** | Options 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) | Ending method, including: - filled: fully completed - canceled: user canceled - liquidated: forced liquidation cancellation - ioc: Not fully filled immediately because tif is set to ioc - auto_deleveraged: automatic deleveraging cancel - reduce_only: Increased position is cancelled, or the position is closed - position_closed: Because the position was closed, the pending order was canceled - reduce_out: Only reduce the excluded pending orders that are not easy to be filled - mmp_cancelled: MMP canceled | [optional] [readonly] **status** | [**StatusEnum**](#StatusEnum) | Order status - `open`: waiting to be traded - `finished`: finished | [optional] [readonly] -**contract** | **String** | Contract name | +**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] -**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] +**price** | **String** | Order price. 0 for market order with `tif` set as `ioc` (USDT). | [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] +**left** | **Long** | Size left to be traded. | [optional] [readonly] +**fillPrice** | **String** | Fill price of the order. | [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] -**refr** | **String** | Referrer rebate | [optional] [readonly] +**tkfr** | **String** | Taker fee. | [optional] [readonly] +**mkfr** | **String** | Maker fee. | [optional] [readonly] +**refu** | **Integer** | Reference user ID. | [optional] [readonly] +**refr** | **String** | Referrer rebate. | [optional] [readonly] ## Enum: FinishAsEnum diff --git a/docs/OptionsPosition.md b/docs/OptionsPosition.md index 5488cc8..52929c7 100644 --- a/docs/OptionsPosition.md +++ b/docs/OptionsPosition.md @@ -1,26 +1,26 @@ # OptionsPosition -Options position information +Options position information. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**user** | **Integer** | User ID | [optional] [readonly] -**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] -**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] -**unrealisedPnl** | **String** | Unrealized PNL | [optional] [readonly] -**pendingOrders** | **Integer** | Current open orders | [optional] [readonly] +**user** | **Integer** | User ID. | [optional] [readonly] +**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] +**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] +**unrealisedPnl** | **String** | Unrealized PNL. | [optional] [readonly] +**pendingOrders** | **Integer** | Current open orders. | [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** | Delta. | [optional] [readonly] +**gamma** | **String** | Gamma. | [optional] [readonly] +**vega** | **String** | Vega. | [optional] [readonly] +**theta** | **String** | Theta. | [optional] [readonly] diff --git a/docs/OptionsPositionClose.md b/docs/OptionsPositionClose.md index 5cd293b..09cec44 100644 --- a/docs/OptionsPositionClose.md +++ b/docs/OptionsPositionClose.md @@ -5,12 +5,12 @@ 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] +**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] ## Enum: SideEnum diff --git a/docs/OptionsPositionCloseOrder.md b/docs/OptionsPositionCloseOrder.md index 720920b..9aac5c4 100644 --- a/docs/OptionsPositionCloseOrder.md +++ b/docs/OptionsPositionCloseOrder.md @@ -1,13 +1,13 @@ # OptionsPositionCloseOrder -Current close order if any, or `null` +Current close order if any, or `null`. ## 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** | Close order ID. | [optional] +**price** | **String** | Close order price （quote currency). | [optional] +**isLiq** | **Boolean** | Is the close order from liquidation. | [optional] diff --git a/docs/OptionsSettlement.md b/docs/OptionsSettlement.md index 7504cdc..53a9f8e 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] -**contract** | **String** | Options contract name | [optional] -**profit** | **String** | Settlement profit per size (quote currency) | [optional] -**fee** | **String** | Settlement fee per size (quote currency) | [optional] -**strikePrice** | **String** | Strike price (quote currency) | [optional] -**settlePrice** | **String** | Settlement price (quote currency) | [optional] +**time** | **Double** | Last changed time of configuration. | [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] +**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..0063138 100644 --- a/docs/OptionsTicker.md +++ b/docs/OptionsTicker.md @@ -1,28 +1,28 @@ # OptionsTicker -Options contract detail +Options contract detail. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | Options contract name | [optional] -**lastPrice** | **String** | Last trading 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] -**ask1Price** | **String** | Best ask price | [optional] -**bid1Size** | **Long** | Best bid size | [optional] -**bid1Price** | **String** | Best bid price | [optional] -**positionSize** | **Long** | Current total long position size | [optional] -**markIv** | **String** | Implied volatility | [optional] -**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] -**rho** | **String** | Rho | [optional] +**name** | **String** | Options contract name. | [optional] +**lastPrice** | **String** | Last trading 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] +**ask1Price** | **String** | Best ask price. | [optional] +**bid1Size** | **Long** | Best bid size. | [optional] +**bid1Price** | **String** | Best bid price. | [optional] +**positionSize** | **Long** | Current total long position size. | [optional] +**markIv** | **String** | Implied volatility. | [optional] +**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] +**rho** | **String** | Rho. | [optional] diff --git a/docs/OptionsUnderlying.md b/docs/OptionsUnderlying.md index 40e0148..06f9abf 100644 --- a/docs/OptionsUnderlying.md +++ b/docs/OptionsUnderlying.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | Underlying name | [optional] -**indexPrice** | **String** | Spot index price (quote currency) | [optional] +**name** | **String** | Underlying name. | [optional] +**indexPrice** | **String** | Spot index price (quote currency). | [optional] diff --git a/docs/OptionsUnderlyingTicker.md b/docs/OptionsUnderlyingTicker.md index 19d8af3..0f1a924 100644 --- a/docs/OptionsUnderlyingTicker.md +++ b/docs/OptionsUnderlyingTicker.md @@ -1,13 +1,13 @@ # OptionsUnderlyingTicker -Options underlying detail +Options underlying detail. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**tradePut** | **Long** | Total put options trades amount in last 24h | [optional] -**tradeCall** | **Long** | Total call options trades amount in last 24h | [optional] -**indexPrice** | **String** | Index price (quote currency) | [optional] +**tradePut** | **Long** | Total put options trades amount in last 24h. | [optional] +**tradeCall** | **Long** | Total call options trades amount in last 24h. | [optional] +**indexPrice** | **String** | Index price (quote currency). | [optional] diff --git a/docs/Order.md b/docs/Order.md index 5e94950..7ff21af 100644 --- a/docs/Order.md +++ b/docs/Order.md @@ -1,47 +1,47 @@ # Order -Spot order details +Spot order details. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | Order ID | [optional] [readonly] +**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] -**createTime** | **String** | Creation time of order | [optional] [readonly] -**updateTime** | **String** | Last modification time of order | [optional] [readonly] -**createTimeMs** | **Long** | Creation time of order (in milliseconds) | [optional] [readonly] -**updateTimeMs** | **Long** | Last modification time of order (in milliseconds) | [optional] [readonly] +**amendText** | **String** | The custom data that the user remarked when amending the order. | [optional] [readonly] +**createTime** | **String** | Creation time of order. | [optional] [readonly] +**updateTime** | **String** | Last modification time of order. | [optional] [readonly] +**createTimeMs** | **Long** | Creation time of order (in milliseconds). | [optional] [readonly] +**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 | +**currencyPair** | **String** | Currency pair. | **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) | Buy or sell order | -**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** | When `type` is limit, it refers to base currency. For instance, `BTC_USDT` means `BTC` When different currency according to `side` - `side` : `buy` means quote currency, `BTC_USDT` means `USDT` - `side` : `sell` means base currency，`BTC_USDT` means `BTC` | +**price** | **String** | Price can't be empty 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] +**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] -**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] -**fee** | **String** | Fee deducted | [optional] [readonly] -**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] -**rebatedFee** | **String** | Rebated fee | [optional] [readonly] -**rebatedFeeCurrency** | **String** | Rebated fee currency unit | [optional] [readonly] +**left** | **String** | Amount left to fill. | [optional] [readonly] +**filledAmount** | **String** | Amount traded to fill. | [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] +**fee** | **String** | Fee deducted. | [optional] [readonly] +**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] +**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 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) | 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..d8ab07d 100644 --- a/docs/OrderBook.md +++ b/docs/OrderBook.md @@ -6,8 +6,8 @@ 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 | +**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. | diff --git a/docs/OrderCancel.md b/docs/OrderCancel.md index 3b56848..b86c08a 100644 --- a/docs/OrderCancel.md +++ b/docs/OrderCancel.md @@ -1,49 +1,49 @@ # OrderCancel -Spot order details +Spot order details. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | Order ID | [optional] [readonly] +**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] -**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] -**updateTime** | **String** | Last modification time of order | [optional] [readonly] -**createTimeMs** | **Long** | Creation time of order (in milliseconds) | [optional] [readonly] -**updateTimeMs** | **Long** | Last modification time of order (in milliseconds) | [optional] [readonly] +**amendText** | **String** | The custom data that the user remarked when amending the order. | [optional] [readonly] +**succeeded** | **Boolean** | Whether the batch of orders succeeded. | [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] +**updateTime** | **String** | Last modification time of order. | [optional] [readonly] +**createTimeMs** | **Long** | Creation time of order (in milliseconds). | [optional] [readonly] +**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 | +**currencyPair** | **String** | Currency pair. | **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) | Buy or sell order | -**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** | When `type` is limit, it refers to base currency. For instance, `BTC_USDT` means `BTC` When different currency according to `side` - `side` : `buy` means quote currency, `BTC_USDT` means `USDT` - `side` : `sell` means base currency，`BTC_USDT` means `BTC` | +**price** | **String** | Price can't be empty 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] +**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] -**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] -**fee** | **String** | Fee deducted | [optional] [readonly] -**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] -**rebatedFee** | **String** | Rebated fee | [optional] [readonly] -**rebatedFeeCurrency** | **String** | Rebated fee currency unit | [optional] [readonly] +**left** | **String** | Amount left to fill. | [optional] [readonly] +**filledAmount** | **String** | Amount traded to fill. | [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] +**fee** | **String** | Fee deducted. | [optional] [readonly] +**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] +**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] **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 5fca380..53c81f3 100644 --- a/docs/OrderPatch.md +++ b/docs/OrderPatch.md @@ -1,16 +1,16 @@ # OrderPatch -Spot order details +Spot order details. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currencyPair** | **String** | Currency pair | [optional] +**currencyPair** | **String** | Currency pair. | [optional] **account** | **String** | Specify query account. | [optional] -**amount** | **String** | Trading Quantity. Either amountor pricemust be specified | [optional] -**price** | **String** | Trading Price. Either amountor pricemust be specified | [optional] -**amendText** | **String** | Custom info during amending order | [optional] +**amount** | **String** | Trading Quantity. Either amountor pricemust be specified. | [optional] +**price** | **String** | Trading Price. Either amountor pricemust be specified. | [optional] +**amendText** | **String** | Custom info during amending order. | [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/OrderResp.md b/docs/OrderResp.md index 2ae418f..4a85cc5 100644 --- a/docs/OrderResp.md +++ b/docs/OrderResp.md @@ -5,5 +5,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**orderId** | **Long** | Order ID | [optional] +**orderId** | **Long** | Order ID. | [optional] diff --git a/docs/PartnerCommissionHistory.md b/docs/PartnerCommissionHistory.md index 08991e5..55d167c 100644 --- a/docs/PartnerCommissionHistory.md +++ b/docs/PartnerCommissionHistory.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**total** | **Long** | Total | [optional] -**list** | [**List<AgencyCommission>**](AgencyCommission.md) | List of comission history | [optional] +**total** | **Long** | Total. | [optional] +**list** | [**List<AgencyCommission>**](AgencyCommission.md) | List of comission history. | [optional] diff --git a/docs/PartnerSub.md b/docs/PartnerSub.md index 6d73faf..8849575 100644 --- a/docs/PartnerSub.md +++ b/docs/PartnerSub.md @@ -5,7 +5,7 @@ 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] +**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] diff --git a/docs/PartnerSubList.md b/docs/PartnerSubList.md index 5b4073b..b447892 100644 --- a/docs/PartnerSubList.md +++ b/docs/PartnerSubList.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**total** | **Long** | Total | [optional] -**list** | [**List<PartnerSub>**](PartnerSub.md) | Subordinate list | [optional] +**total** | **Long** | Total. | [optional] +**list** | [**List<PartnerSub>**](PartnerSub.md) | Subordinate list. | [optional] diff --git a/docs/PartnerTransactionHistory.md b/docs/PartnerTransactionHistory.md index af44969..25b6a8a 100644 --- a/docs/PartnerTransactionHistory.md +++ b/docs/PartnerTransactionHistory.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**total** | **Long** | Total | [optional] -**list** | [**List<AgencyTransaction>**](AgencyTransaction.md) | List of transaction history | [optional] +**total** | **Long** | Total. | [optional] +**list** | [**List<AgencyTransaction>**](AgencyTransaction.md) | List of transaction history. | [optional] diff --git a/docs/PatchUniLend.md b/docs/PatchUniLend.md index 91ad469..1087b73 100644 --- a/docs/PatchUniLend.md +++ b/docs/PatchUniLend.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency name | [optional] -**minRate** | **String** | Minimum interest rate | [optional] +**currency** | **String** | Currency name. | [optional] +**minRate** | **String** | Minimum interest rate. | [optional] diff --git a/docs/PlaceDualInvestmentOrder.md b/docs/PlaceDualInvestmentOrder.md index d1e4985..564f2a2 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 | +**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] diff --git a/docs/Position.md b/docs/Position.md index 166fab9..c6f8309 100644 --- a/docs/Position.md +++ b/docs/Position.md @@ -1,45 +1,45 @@ # Position -Futures position details +Futures position details. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**user** | **Long** | User ID | [optional] [readonly] -**contract** | **String** | Futures contract | [optional] [readonly] -**size** | **Long** | Position size | [optional] [readonly] +**user** | **Long** | User ID. | [optional] [readonly] +**contract** | **String** | Futures contract. | [optional] [readonly] +**size** | **Long** | Position size. | [optional] [readonly] **leverage** | **String** | Position leverage. 0 means cross margin; positive number means isolated margin | [optional] -**riskLimit** | **String** | Position risk limit | [optional] -**leverageMax** | **String** | Maximum leverage under current risk limit | [optional] [readonly] -**maintenanceRate** | **String** | Maintenance rate under current risk limit | [optional] [readonly] -**value** | **String** | Position value calculated in settlement currency | [optional] [readonly] -**margin** | **String** | Position margin | [optional] -**entryPrice** | **String** | Entry price | [optional] [readonly] -**liqPrice** | **String** | Liquidation price | [optional] [readonly] -**markPrice** | **String** | Current mark price | [optional] [readonly] +**riskLimit** | **String** | Position risk limit. | [optional] +**leverageMax** | **String** | Maximum leverage under current risk limit. | [optional] [readonly] +**maintenanceRate** | **String** | Maintenance rate under current risk limit. | [optional] [readonly] +**value** | **String** | Position value calculated in settlement currency. | [optional] [readonly] +**margin** | **String** | Position margin. | [optional] +**entryPrice** | **String** | Entry price. | [optional] [readonly] +**liqPrice** | **String** | Liquidation price. | [optional] [readonly] +**markPrice** | **String** | Current mark price. | [optional] [readonly] **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] -**pnlPnl** | **String** | Realized PNL - Position P/L | [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] -**lastClosePnl** | **String** | PNL of last position close | [optional] [readonly] -**realisedPoint** | **String** | Realized POINT PNL | [optional] [readonly] -**historyPoint** | **String** | History realized POINT PNL | [optional] [readonly] +**unrealisedPnl** | **String** | Unrealized 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] +**pnlFee** | **String** | Realized PNL - Transaction Fees. | [optional] [readonly] +**historyPnl** | **String** | History realized PNL. | [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 open orders. | [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] -**updateTime** | **Long** | Last update time | [optional] [readonly] +**mode** | [**ModeEnum**](#ModeEnum) | Position mode, including: - `single`: dual mode is not enabled- `dual_long`: long position in dual mode- `dual_short`: 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] -**openTime** | **Long** | First Open Time | [optional] -**riskLimitTable** | **String** | Risk limit table ID | [optional] [readonly] -**averageMaintenanceRate** | **String** | Average maintenance margin rate | [optional] [readonly] +**openTime** | **Long** | First Open Time. | [optional] +**riskLimitTable** | **String** | Risk limit table ID. | [optional] [readonly] +**averageMaintenanceRate** | **String** | Average maintenance margin rate. | [optional] [readonly] ## Enum: ModeEnum diff --git a/docs/PositionClose.md b/docs/PositionClose.md index 9ed136a..a4b14f2 100644 --- a/docs/PositionClose.md +++ b/docs/PositionClose.md @@ -5,19 +5,19 @@ 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] -**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] -**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] +**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] +**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] +**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 closing average price. | [optional] [readonly] +**shortPrice** | **String** | When 'side' is 'long,' it indicates the opening average price; when closing average price | [optional] [readonly] ## Enum: SideEnum diff --git a/docs/PositionCloseOrder.md b/docs/PositionCloseOrder.md index 13c6ad6..cdf37a4 100644 --- a/docs/PositionCloseOrder.md +++ b/docs/PositionCloseOrder.md @@ -1,13 +1,13 @@ # PositionCloseOrder -Current close order if any, or `null` +Current close order if any, or `null`. ## 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** | Close order ID. | [optional] +**price** | **String** | Close order price. | [optional] +**isLiq** | **Boolean** | Is the close order from liquidation. | [optional] diff --git a/docs/ProfitLossRange.md b/docs/ProfitLossRange.md index 7eb15f6..517af59 100644 --- a/docs/ProfitLossRange.md +++ b/docs/ProfitLossRange.md @@ -1,13 +1,13 @@ # ProfitLossRange -Profit and loss range +Profit and loss range. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**pricePercentage** | **String** | Percentage change in price | [optional] -**impliedVolatilityPercentage** | **String** | Percentage change in implied volatility | [optional] -**profitLoss** | **String** | PNL | [optional] +**pricePercentage** | **String** | Percentage change in price. | [optional] +**impliedVolatilityPercentage** | **String** | Percentage change in implied volatility. | [optional] +**profitLoss** | **String** | PNL. | [optional] diff --git a/docs/RebateApi.md b/docs/RebateApi.md index b79996d..f8d15af 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 -[**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 +[**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. +[**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. # **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 +The agency obtains the transaction history of the recommended user. -Record time range cannot exceed 30 days +Record time range cannot exceed 30 days. ### Example @@ -44,12 +44,12 @@ 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 - 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 - Integer offset = 0; // Integer | List offset, starting from 0 + String currencyPair = "BTC_USDT"; // String | Specify the currency pair, if not specified, return all currency 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. + Integer offset = 0; // Integer | List offset, starting from 0. try { List result = apiInstance.agencyTransactionHistory() .currencyPair(currencyPair) @@ -77,12 +77,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Specify the currency pair, if not specified, return all currency 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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **currencyPair** | **String**| Specify the currency pair, if not specified, return all currency 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] + **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. | - | # **agencyCommissionsHistory** > List<AgencyCommissionHistory> agencyCommissionsHistory().currency(currency).userId(userId).from(from).to(to).limit(limit).offset(offset).execute(); -The agency obtains the commission history of the recommended user +The agency obtains the commission history of the recommended user. -Record time range cannot exceed 30 days +Record time range cannot exceed 30 days. ### Example @@ -131,12 +131,12 @@ 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 - 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 - Integer offset = 0; // Integer | List offset, starting from 0 + String currency = "BTC"; // String | Filter by currency. Return all currency records if not specified. + 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. + Integer offset = 0; // Integer | List offset, starting from 0. try { List result = apiInstance.agencyCommissionsHistory() .currency(currency) @@ -164,12 +164,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Filter by currency. Return all currency records if not specified | [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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **currency** | **String**| Filter by currency. Return all currency records if not specified. | [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] + **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] ### Return type @@ -187,15 +187,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **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 records of recommended users. -Record time range cannot exceed 30 days +Record time range cannot exceed 30 days. ### Example @@ -218,12 +218,12 @@ 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 - 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 - Integer offset = 0; // Integer | List offset, starting from 0 + String currencyPair = "BTC_USDT"; // String | Specify the currency pair, if not specified, return all currency 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. + Integer offset = 0; // Integer | List offset, starting from 0. try { PartnerTransactionHistory result = apiInstance.partnerTransactionHistory() .currencyPair(currencyPair) @@ -251,12 +251,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Specify the currency pair, if not specified, return all currency 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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **currencyPair** | **String**| Specify the currency pair, if not specified, return all currency 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] + **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] ### Return type @@ -274,15 +274,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **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 commission records of recommended users. -Record time range cannot exceed 30 days +Record time range cannot exceed 30 days. ### Example @@ -305,12 +305,12 @@ 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 - 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 - Integer offset = 0; // Integer | List offset, starting from 0 + String currency = "BTC"; // String | Filter by currency. Return all currency records if not specified. + 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. + Integer offset = 0; // Integer | List offset, starting from 0. try { PartnerCommissionHistory result = apiInstance.partnerCommissionsHistory() .currency(currency) @@ -338,12 +338,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Filter by currency. Return all currency records if not specified | [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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **currency** | **String**| Filter by currency. Return all currency records if not specified. | [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] + **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] ### Return type @@ -361,15 +361,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **partnerSubList** > PartnerSubList partnerSubList().userId(userId).limit(limit).offset(offset).execute(); -Partner subordinate list +Partner subordinate list. -Including sub-agents, direct customers, indirect customers +Including sub-agents, direct customers, indirect customers. ### Example @@ -392,9 +392,9 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 offset = 0; // Integer | List offset, starting from 0 + 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 offset = 0; // Integer | List offset, starting from 0. try { PartnerSubList result = apiInstance.partnerSubList() .userId(userId) @@ -419,9 +419,9 @@ 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] - **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] + **limit** | **Integer**| Maximum number of records to be returned in a single list. | [optional] [default to 100] + **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] ### Return type @@ -439,15 +439,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **rebateBrokerCommissionHistory** > List<BrokerCommission> rebateBrokerCommissionHistory().limit(limit).offset(offset).userId(userId).from(from).to(to).execute(); -The broker obtains the user's commission rebate records +The broker obtains the user's commission rebate records. -Record time range cannot exceed 30 days +Record time range cannot exceed 30 days. ### Example @@ -470,11 +470,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 offset = 0; // Integer | List offset, starting from 0 - 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 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 to = 1714521600L; // Long | Time range ending, default to current time. try { List result = apiInstance.rebateBrokerCommissionHistory() .limit(limit) @@ -501,11 +501,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] - **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] + **limit** | **Integer**| Maximum number of records to be 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] + **to** | **Long**| Time range ending, default to current time. | [optional] ### Return type @@ -523,15 +523,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **rebateBrokerTransactionHistory** > List<BrokerTransaction> rebateBrokerTransactionHistory().limit(limit).offset(offset).userId(userId).from(from).to(to).execute(); -The broker obtains the user's trading history +The broker obtains the user's trading history. -Record time range cannot exceed 30 days +Record time range cannot exceed 30 days. ### Example @@ -554,11 +554,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 offset = 0; // Integer | List offset, starting from 0 - 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 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 to = 1714521600L; // Long | Time range ending, default to current time. try { List result = apiInstance.rebateBrokerTransactionHistory() .limit(limit) @@ -585,11 +585,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] - **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] + **limit** | **Integer**| Maximum number of records to be 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] + **to** | **Long**| Time range ending, default to current time. | [optional] ### Return type @@ -607,13 +607,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **rebateUserInfo** > List<RebateUserInfo> rebateUserInfo() -User retrieves rebate information +User retrieves rebate information. ### Example @@ -671,15 +671,15 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **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 in the system. ### Example @@ -702,7 +702,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 the user's ID list, split by,, if there are more than 100, take 100. try { UserSubRelation result = apiInstance.userSubRelation(userIdList); System.out.println(result); @@ -723,7 +723,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 the user's ID list, split by,, if there are more than 100, take 100. | ### Return type @@ -741,5 +741,5 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | diff --git a/docs/RebateUserInfo.md b/docs/RebateUserInfo.md index b0e707d..757ecb7 100644 --- a/docs/RebateUserInfo.md +++ b/docs/RebateUserInfo.md @@ -1,11 +1,11 @@ # RebateUserInfo -Retrieve user rebate information +Retrieve user rebate information. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**inviteUid** | **Long** | My inviter's UID | [optional] +**inviteUid** | **Long** | My inviter's UID. | [optional] diff --git a/docs/RepayCurrencyRes.md b/docs/RepayCurrencyRes.md index 7dcc745..b6c5c4c 100644 --- a/docs/RepayCurrencyRes.md +++ b/docs/RepayCurrencyRes.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**succeeded** | **Boolean** | Has the repayment been successful | [optional] +**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] -**currency** | **String** | Repayment currency | [optional] -**repaidPrincipal** | **String** | Principal | [optional] -**repaidInterest** | **String** | Principal | [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..e159952 100644 --- a/docs/RepayLoan.md +++ b/docs/RepayLoan.md @@ -1,13 +1,13 @@ # RepayLoan -Repay +Repay. ## Properties 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. | +**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 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..d6f9b84 100644 --- a/docs/RepayMultiLoan.md +++ b/docs/RepayMultiLoan.md @@ -1,12 +1,12 @@ # RepayMultiLoan -Repay Multi-Collateral Loan +Repay Multi-Collateral Loan. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**orderId** | **Long** | Order ID | -**repayItems** | [**List<MultiLoanRepayItem>**](MultiLoanRepayItem.md) | Repay Currency Item | +**orderId** | **Long** | Order ID. | +**repayItems** | [**List<MultiLoanRepayItem>**](MultiLoanRepayItem.md) | Repay Currency Item. | diff --git a/docs/RepayRecord.md b/docs/RepayRecord.md index e291510..8e4b0cc 100644 --- a/docs/RepayRecord.md +++ b/docs/RepayRecord.md @@ -1,23 +1,23 @@ # RepayRecord -Repayment record +Repayment record. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**orderId** | **Long** | Order ID | [optional] -**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] -**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] +**orderId** | **Long** | Order ID. | [optional] +**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] +**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] diff --git a/docs/RepayRecordCurrency.md b/docs/RepayRecordCurrency.md index d1b9e46..15e763c 100644 --- a/docs/RepayRecordCurrency.md +++ b/docs/RepayRecordCurrency.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency | [optional] -**indexPrice** | **String** | Currency Index Price | [optional] -**beforeAmount** | **String** | Amount before the operation | [optional] +**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] diff --git a/docs/RepayRecordLeftInterest.md b/docs/RepayRecordLeftInterest.md index 1956af7..031e1be 100644 --- a/docs/RepayRecordLeftInterest.md +++ b/docs/RepayRecordLeftInterest.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency | [optional] -**indexPrice** | **String** | Currency Index Price | [optional] -**beforeAmount** | **String** | Interest amount before repayment | [optional] -**beforeAmountUsdt** | **String** | Converted value of interest before repayment in USDT | [optional] -**afterAmount** | **String** | Interest amount after repayment | [optional] -**afterAmountUsdt** | **String** | Converted value of interest after repayment in USDT | [optional] +**currency** | **String** | Currency. | [optional] +**indexPrice** | **String** | Currency Index Price. | [optional] +**beforeAmount** | **String** | Interest amount before repayment. | [optional] +**beforeAmountUsdt** | **String** | Converted value of interest before repayment in USDT. | [optional] +**afterAmount** | **String** | Interest amount after repayment. | [optional] +**afterAmountUsdt** | **String** | Converted value of interest after repayment in USDT. | [optional] diff --git a/docs/RepayRecordRepaidCurrency.md b/docs/RepayRecordRepaidCurrency.md index 346f893..edca262 100644 --- a/docs/RepayRecordRepaidCurrency.md +++ b/docs/RepayRecordRepaidCurrency.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Repayment currency | [optional] -**indexPrice** | **String** | Currency Index Price | [optional] -**repaidAmount** | **String** | Repayment amount | [optional] -**repaidPrincipal** | **String** | Principal | [optional] -**repaidInterest** | **String** | Interest | [optional] -**repaidAmountUsdt** | **String** | Value of the repayment amount in USDT | [optional] +**currency** | **String** | Repayment currency. | [optional] +**indexPrice** | **String** | Currency Index Price. | [optional] +**repaidAmount** | **String** | Repayment amount. | [optional] +**repaidPrincipal** | **String** | Principal. | [optional] +**repaidInterest** | **String** | Interest. | [optional] +**repaidAmountUsdt** | **String** | Value of the repayment amount in USDT. | [optional] diff --git a/docs/RepayRecordTotalInterest.md b/docs/RepayRecordTotalInterest.md index aa2b6a4..57f416a 100644 --- a/docs/RepayRecordTotalInterest.md +++ b/docs/RepayRecordTotalInterest.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency | [optional] -**indexPrice** | **String** | Currency Index Price | [optional] -**amount** | **String** | Interest Amount | [optional] -**amountUsdt** | **String** | Interest amount converted to USDT | [optional] +**currency** | **String** | Currency. | [optional] +**indexPrice** | **String** | Currency Index Price. | [optional] +**amount** | **String** | Interest Amount. | [optional] +**amountUsdt** | **String** | Interest amount converted to USDT. | [optional] diff --git a/docs/RepayResp.md b/docs/RepayResp.md index baaf387..e46515d 100644 --- a/docs/RepayResp.md +++ b/docs/RepayResp.md @@ -1,12 +1,12 @@ # RepayResp -Repay +Repay. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**repaidPrincipal** | **String** | Principal | [optional] -**repaidInterest** | **String** | Interest | [optional] +**repaidPrincipal** | **String** | Principal. | [optional] +**repaidInterest** | **String** | Interest. | [optional] diff --git a/docs/RiskUnits.md b/docs/RiskUnits.md index 1dc90c7..615ec0a 100644 --- a/docs/RiskUnits.md +++ b/docs/RiskUnits.md @@ -5,12 +5,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**symbol** | **String** | Risk unit flag | [optional] -**spotInUse** | **String** | Spot hedging utilization | [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] -**gamma** | **String** | Total Gamma of risk unit | [optional] -**theta** | **String** | Total Theta of risk unit | [optional] -**vega** | **String** | Total Vega of risk unit | [optional] +**symbol** | **String** | Risk unit flag. | [optional] +**spotInUse** | **String** | Spot hedging utilization. | [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] +**gamma** | **String** | Total Gamma of risk unit. | [optional] +**theta** | **String** | Total Theta of risk unit. | [optional] +**vega** | **String** | Total Vega of risk unit. | [optional] diff --git a/docs/SavedAddress.md b/docs/SavedAddress.md index 2fcd258..406aca3 100644 --- a/docs/SavedAddress.md +++ b/docs/SavedAddress.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency | [optional] -**chain** | **String** | Chain name | [optional] -**address** | **String** | Address | [optional] -**name** | **String** | Name | [optional] -**tag** | **String** | Tag | [optional] -**verified** | **String** | Whether to pass the verification 0-unverified, 1-verified | [optional] +**currency** | **String** | Currency. | [optional] +**chain** | **String** | Chain name. | [optional] +**address** | **String** | Address. | [optional] +**name** | **String** | Name. | [optional] +**tag** | **String** | Tag. | [optional] +**verified** | **String** | Whether to pass the verification 0-unverified, 1-verified. | [optional] diff --git a/docs/SmallBalance.md b/docs/SmallBalance.md index 6c9da17..b5a35f7 100644 --- a/docs/SmallBalance.md +++ b/docs/SmallBalance.md @@ -1,14 +1,14 @@ # SmallBalance -Convert Small Balance +Convert Small Balance. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency | [optional] -**availableBalance** | **String** | Available balance | [optional] -**estimatedAsBtc** | **String** | Estimated as BTC | [optional] -**convertibleToGt** | **String** | Estimated conversion to GT | [optional] +**currency** | **String** | Currency. | [optional] +**availableBalance** | **String** | Available balance. | [optional] +**estimatedAsBtc** | **String** | Estimated as BTC. | [optional] +**convertibleToGt** | **String** | Estimated conversion to GT. | [optional] diff --git a/docs/SmallBalanceHistory.md b/docs/SmallBalanceHistory.md index 7e07d95..4482b26 100644 --- a/docs/SmallBalanceHistory.md +++ b/docs/SmallBalanceHistory.md @@ -1,15 +1,15 @@ # SmallBalanceHistory -Convert Small Balance +Convert Small Balance. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | Order ID | [optional] [readonly] -**currency** | **String** | Currency | [optional] [readonly] -**amount** | **String** | amount | [optional] [readonly] -**gtAmount** | **String** | GT amount | [optional] [readonly] -**createTime** | **Long** | Exchange time (in seconds) | [optional] [readonly] +**id** | **String** | Order ID. | [optional] [readonly] +**currency** | **String** | Currency. | [optional] [readonly] +**amount** | **String** | amount. | [optional] [readonly] +**gtAmount** | **String** | GT amount. | [optional] [readonly] +**createTime** | **Long** | Exchange time (in seconds). | [optional] [readonly] diff --git a/docs/SpotAccount.md b/docs/SpotAccount.md index 167c46d..b856966 100644 --- a/docs/SpotAccount.md +++ b/docs/SpotAccount.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency detail | [optional] -**available** | **String** | Available amount | [optional] -**locked** | **String** | Locked amount, used in trading | [optional] -**updateId** | **Long** | Version number | [optional] +**currency** | **String** | Currency detail. | [optional] +**available** | **String** | Available amount. | [optional] +**locked** | **String** | Locked amount, used in trading. | [optional] +**updateId** | **Long** | Version number. | [optional] diff --git a/docs/SpotAccountBook.md b/docs/SpotAccountBook.md index 9052b55..aa3c920 100644 --- a/docs/SpotAccountBook.md +++ b/docs/SpotAccountBook.md @@ -5,12 +5,12 @@ 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] -**code** | **String** | Account change code, see [Asset Record Code] (Asset Record Code) | [optional] -**text** | **String** | Additional information | [optional] +**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] +**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 78517c5..2bdbaf3 100644 --- a/docs/SpotApi.md +++ b/docs/SpotApi.md @@ -4,45 +4,45 @@ 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 -[**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 -[**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 -[**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 +[**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. +[**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. +[**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. +[**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. # **listCurrencies** > List<Currency> listCurrencies() -List all currencies' details +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. @@ -98,13 +98,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **getCurrency** > Currency getCurrency(currency) -Get details of a specific currency +Get details of a specific currency. ### Example @@ -123,7 +123,7 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); SpotApi apiInstance = new SpotApi(defaultClient); - String currency = "GT"; // String | Currency name + String currency = "GT"; // String | Currency name. try { Currency result = apiInstance.getCurrency(currency); System.out.println(result); @@ -144,7 +144,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Currency name | + **currency** | **String**| Currency name. | ### Return type @@ -162,13 +162,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listCurrencyPairs** > List<CurrencyPair> listCurrencyPairs() -List all currency pairs supported +List all currency pairs supported. ### Example @@ -222,13 +222,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | All currency pairs retrieved | - | +**200** | All currency pairs retrieved. | - | # **getCurrencyPair** > CurrencyPair getCurrencyPair(currencyPair) -Get details of a specifc currency pair +Get details of a specifc currency pair. ### Example @@ -247,7 +247,7 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); SpotApi apiInstance = new SpotApi(defaultClient); - String currencyPair = "ETH_BTC"; // String | Currency pair + String currencyPair = "ETH_BTC"; // String | Currency pair. try { CurrencyPair result = apiInstance.getCurrencyPair(currencyPair); System.out.println(result); @@ -268,7 +268,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair | + **currencyPair** | **String**| Currency pair. | ### Return type @@ -286,13 +286,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listTickers** > List<Ticker> listTickers().currencyPair(currencyPair).timezone(timezone).execute(); -Retrieve ticker information +Retrieve ticker information. Return only related data if `currency_pair` is specified; otherwise return all of them @@ -313,8 +313,8 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); SpotApi apiInstance = new SpotApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Currency pair - String timezone = "utc0"; // String | Timezone + String currencyPair = "BTC_USDT"; // String | Currency pair. + String timezone = "utc0"; // String | Timezone. try { List result = apiInstance.listTickers() .currencyPair(currencyPair) @@ -338,8 +338,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair | [optional] - **timezone** | **String**| Timezone | [optional] [enum: utc0, utc8, all] + **currencyPair** | **String**| Currency pair. | [optional] + **timezone** | **String**| Timezone. | [optional] [enum: utc0, utc8, all] ### Return type @@ -357,15 +357,15 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listOrderBook** > OrderBook listOrderBook(currencyPair).interval(interval).limit(limit).withId(withId).execute(); -Retrieve order book +Retrieve order book. -Market depth buy orders are sorted by price from high to low, sell orders are reversed are reversed +Market depth buy orders are sorted by price from high to low, sell orders are reversed ### Example @@ -384,10 +384,10 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 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. try { OrderBook result = apiInstance.listOrderBook(currencyPair) .interval(interval) @@ -412,10 +412,10 @@ 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] + **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] ### Return type @@ -433,15 +433,15 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listTrades** > List<Trade> listTrades(currencyPair).limit(limit).lastId(lastId).reverse(reverse).from(from).to(to).page(page).execute(); -Retrieve market trades +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. +Supports `from` and `to` by time range query or page-turn query based on `last_id`. By default, is the last 30 days. The query method based on `last_id` page turn is no longer recommended. If `last_id` is specified, the time range query parameters will be ignored. The maximum number of pages when searching data using limit&page paging function is 100,0, that is, limit * (page - 1) <= 100,0. ### Example @@ -460,13 +460,13 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 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 the currency name to query in batches, and support up to 100 pass parameters at a time. 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 page = 1; // Integer | Page number + 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. try { List result = apiInstance.listTrades(currencyPair) .limit(limit) @@ -494,13 +494,13 @@ 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] + **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 the currency name to query in batches, and support up to 100 pass parameters at a time. | [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] - **page** | **Integer**| Page number | [optional] [default to 1] + **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] ### Return type @@ -518,13 +518,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **listCandlesticks** > List<List<String>> listCandlesticks(currencyPair).limit(limit).from(from).to(to).interval(interval).execute(); -Market candlesticks +Market candlesticks. Maximum of 1000 points can be returned in a query. Be sure not to exceed the limit when specifying from, to and interval @@ -545,10 +545,10 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); SpotApi apiInstance = new SpotApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Currency pair + 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. 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 | 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 + 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 specified String interval = "30m"; // String | Interval time between data points. Note that `30d` means 1 natual month, not 30 days try { List> result = apiInstance.listCandlesticks(currencyPair) @@ -575,10 +575,10 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair | + **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] **from** | **Long**| Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified | [optional] - **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 | [optional] + **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 specified | [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] ### Return type @@ -597,13 +597,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **getFee** > SpotFee getFee().currencyPair(currencyPair).execute(); -Query user trading fee rates +Query user trading fee rates. This API is deprecated in favour of new fee retrieving API `/wallet/fee`. @@ -669,13 +669,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **getBatchSpotFee** > Map<String, SpotFee> getBatchSpotFee(currencyPairs) -Query a batch of user trading fee rates +Query a batch of user trading 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 | A request can only query up to 50 currency pairs. 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**| A request can only query up to 50 currency pairs. | ### Return type @@ -737,13 +737,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listSpotAccounts** > List<SpotAccount> listSpotAccounts().currency(currency).execute(); -List spot accounts +List spot 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 | Retrieve data of the specified currency. 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**| Retrieve data of the specified currency. | [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. | - | # **listSpotAccountBook** > List<SpotAccountBook> listSpotAccountBook().currency(currency).from(from).to(to).page(page).limit(limit).type(type).code(code).execute(); -Query account book +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. +Record query time range is not allowed to exceed 30 days. The maximum number of pages when searching data using limit&page paging function is 100,0, that is, limit * (page - 1) <= 100,0. ### Example @@ -838,11 +838,11 @@ 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 - Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list + 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. + 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` try { @@ -873,11 +873,11 @@ 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] - **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] + **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] + **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] @@ -897,13 +897,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **createBatchOrders** > List<BatchOrder> createBatchOrders(order, xGateExptime) -Create a batch of orders +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 @@ -969,15 +969,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Request is completed | - | +**200** | Request is completed. | - | # **listAllOpenOrders** > List<OpenOrders> listAllOpenOrders().page(page).limit(limit).account(account).execute(); -List all open orders +List all open orders. -Query the current order list of all trading pairs. Please note that the paging parameter controls the number of pending orders in each trading pair. There is no paging control 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 @@ -1000,8 +1000,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 + 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. try { List result = apiInstance.listAllOpenOrders() @@ -1027,8 +1027,8 @@ public class Example { 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] + **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] ### Return type @@ -1047,13 +1047,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **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 @@ -1117,15 +1117,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | order created | - | +**201** | order created. | - | # **listOrders** > List<Order> listOrders(currencyPair, status).page(page).limit(limit).account(account).from(from).to(to).side(side).execute(); -List orders +List orders. -Note that the query results are spot order lists for spot, unified account and warehouse-by-site leverage accounts by default. `status` is set to `open`, that is, when querying the pending order list, only pagination control of `page` and `limit` is supported. `limit` Maximum setting is only allowed to 100 . The `side` and `from`, `to` parameters for time range query are not supported. `status` 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 the query results are spot order lists for spot, unified account and warehouse-by-site leverage accounts by default. `status` is set to `open`, that is, when querying the pending order list, only pagination control of `page` and `limit` is supported. `limit` Maximum setting is only allowed to 100 . The `side` and `from`, `to` parameters for time range query are not supported. `status` when querying historical delegations, in addition to pagination queries, `from` and `to` are also supported by time range queries. In addition, it supports setting the `side` parameter to filter one-side history. The parameters of the time range filtering are processed according to the order end time. ### Example @@ -1150,12 +1150,12 @@ public class Example { 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 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 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 + 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. try { List result = apiInstance.listOrders(currencyPair, status) .page(page) @@ -1185,12 +1185,12 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **currencyPair** | **String**| Retrieve results with specified currency pair. It is required for open orders, but optional for finished ones. | **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] + **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] + **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] ### Return type @@ -1208,15 +1208,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **createOrder** > Order createOrder(order, xGateExptime) -Create an order +Create an order. -Support spot, margin, leverage, and full-position leverage orders. Use different accounts through the `account` field, default is `spot`, that is, use the spot account to place an order if the user is `unified` account, default is to place an order with a unified account When using leveraged account trading, that is, when `account` is set to `margin`, you can set `auto_borrow` to `true`, In the case of insufficient account balance, the system will automatically execute the `POST /margin/uni/loans` to borrow the insufficient part. Whether the assets obtained after the leveraged order is automatically used to return the borrowing orders of the leveraged account in a position-by-store leverage account depends on the automatic repayment settings of the user's position-by-store leverage account**, The account automatic repayment settings can be queried and set through `/margin/auto_repay`. Use unified 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 +Support spot, margin, leverage, and full-position leverage orders. Use different accounts through the `account` field, default is `spot`, that is, use the spot account to place an order if the user is `unified` account, default is to place an order with a unified account When using leveraged account trading, that is, when `account` is set to `margin`, you can set `auto_borrow` to `true`, In the case of insufficient account balance, the system will automatically execute the `POST /margin/uni/loans` to borrow the insufficient part. Whether the assets obtained after the leveraged order is automatically used to return the borrowing orders of the leveraged account in a position-by-store leverage account depends on the automatic repayment settings of the user's position-by-store leverage account**, The account automatic repayment settings can be queried and set through `/margin/auto_repay`. Use unified is set to `unified`, `auto_borrow` \" can also be enableTo realize the insufficient part of automatic borrowing, but unlike the leverage account, whether the entrustment of a unified account is automatically repayable depends on the when placing an order`auto_repay` setting, this setting is only effective for the current entrustment, that is, only the assets obtained after the entrustment transaction will be used to repay the borrowing orders of the full-position leverage account. Unified account ordering currently supports `auto_borrow` and `auto_repay` at the same time. Auto repayment will be triggered at the end of the order, i.e. `status` is `cancelled` or `closed` . **Delegation Status** The entrustment status in the pending order is `open`, which remains at `open` until all the quantity is traded. If it is eaten, the order ends and the status becomes `closed`. If the order is cancelled before all transactions are completed, regardless of whether there are partial transactions, the status will become `cancelled` **Iceberg Entrustment** `iceberg` is used to set the number of iceberg delegations displayed, and does not support complete hiding. Note that when hidden part of the transaction is charged according to the taker's handling rate. **Restrict user transactions** Set `stp_act` to decide to use strategies that limit user transactions ### Example @@ -1286,9 +1286,9 @@ Name | Type | Description | Notes # **cancelOrders** > List<OrderCancel> cancelOrders(currencyPair, side, account, actionMode, xGateExptime) -Cancel all `open` orders in specified currency pair +Cancel all `open` orders in specified currency pair. -When the `account` parameter is not specified, all pending orders including spot, unified account, and position-by-position leverage will be cancelled. When `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 position-by-position leverage will be cancelled. When transaction pairs are revoked You can specify a certain account separately to cancel all orders under the specified account ### Example @@ -1311,8 +1311,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 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: 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 @@ -1336,8 +1336,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair | [optional] - **side** | **String**| All bids or asks. Both included if not specified | [optional] + **currencyPair** | **String**| Currency pair. | [optional] + **side** | **String**| All bids or 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] @@ -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. Query order status by listing orders. | - | # **cancelBatchOrders** > List<CancelOrderResult> cancelBatchOrders(cancelBatchOrder, xGateExptime) -Cancel a batch of orders with an ID list +Cancel a batch of orders with an ID list. Multiple currency pairs can be specified, but maximum 20 orders are allowed per request @@ -1430,13 +1430,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Batch cancellation completed | - | +**200** | Batch cancellation completed. | - | # **getOrder** > Order getOrder(orderId, currencyPair, account) -Get a single order +Get a single order. By default, orders for spot, unified account and warehouse-by-site leverage account are checked. @@ -1462,7 +1462,7 @@ 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 currencyPair = "BTC_USDT"; // String | Specify the transaction pair to query. If you are querying pending order records, this field is traded records, this field can be left blank. String account = "spot"; // String | Specify query account. try { Order result = apiInstance.getOrder(orderId, currencyPair, account); @@ -1485,7 +1485,7 @@ 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. | + **currencyPair** | **String**| Specify the transaction pair to query. If you are querying pending order records, this field is traded records, this field can be left blank. | **account** | **String**| Specify query account. | [optional] ### Return type @@ -1504,13 +1504,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Detail retrieved | - | +**200** | Detail retrieved. | - | # **cancelOrder** > Order cancelOrder(orderId, currencyPair, account, actionMode, xGateExptime) -Cancel a single order +Cancel a single order. By default, orders for spot, unified accounts and leveraged accounts are revoked. @@ -1536,7 +1536,7 @@ 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 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 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 @@ -1561,7 +1561,7 @@ 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**| Currency pair | + **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] **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] @@ -1582,15 +1582,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order cancelled | - | +**200** | Order cancelled. | - | # **amendOrder** > Order amendOrder(orderId, orderPatch, currencyPair, account, xGateExptime) -Amend an order +Amend an 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 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 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 @@ -1615,7 +1615,7 @@ 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) OrderPatch orderPatch = new OrderPatch(); // OrderPatch | - String currencyPair = "BTC_USDT"; // String | Currency pair + String currencyPair = "BTC_USDT"; // String | Currency pair. 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 { @@ -1640,7 +1640,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] + **currencyPair** | **String**| Currency pair. | [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] @@ -1660,15 +1660,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Updated | - | +**200** | Updated. | - | # **listMyTrades** > List<Trade> listMyTrades().currencyPair(currencyPair).limit(limit).page(page).orderId(orderId).account(account).from(from).to(to).execute(); -List personal trading history +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. +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 @@ -1691,13 +1691,13 @@ 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 - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list. Default: 100, Minimum: 1, Maximum: 1000 - Integer page = 1; // Integer | Page number + 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 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 + Long from = 1627706330L; // Long | Start timestamp of the query. + Long to = 1635329650L; // Long | Time range ending, default to current time. try { List result = apiInstance.listMyTrades() .currencyPair(currencyPair) @@ -1726,13 +1726,13 @@ 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] - **page** | **Integer**| Page number | [optional] [default to 1] + **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] + **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] + **from** | **Long**| Start timestamp of the query. | [optional] + **to** | **Long**| Time range ending, default to current time. | [optional] ### Return type @@ -1750,13 +1750,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **getSystemTime** > SystemTime getSystemTime() -Get server current time +Get server current time. ### Example @@ -1810,15 +1810,15 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **countdownCancelAllSpot** > TriggerTime countdownCancelAllSpot(countdownCancelAllSpotTask) -Countdown cancel orders +Countdown cancel orders. -Spot order heartbeat detection. If there is no \"cancel existing countdown\" or \"set new countdown\" when the user-set `timeout` time is reached, the related `spot pending orders` will be automatically cancelled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at 30s intervals, setting the countdown `timeout` to `30 (seconds)` each time. If this interface is not called again within 30 seconds, all pending orders on the `market` you specified will be automatically cancelled. If no `market` is specified, all market pending orders will be 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. +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,15 +1880,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Set countdown successfully | - | +**200** | Set countdown successfully. | - | # **amendBatchOrders** > List<BatchOrder> amendBatchOrders(batchAmendItem, xGateExptime) -Batch modification of orders +Batch modification of orders. -Modify orders in spot, unified account and isolated margin account by default. Modify uncompleted orders, up to 5 orders can be modified at a time. Request parameters should be passed in array format. If there are order modification failures during the batch modification process, the modification of the next order will continue to be executed, and the execution will return with the corresponding order failure information. The call order of batch modification orders is consistent with the order list order. The return content order of batch modification orders is consistent with the order list order. +Modify orders in spot, unified account and isolated margin account by default. Modify uncompleted orders, up to 5 orders can be modified at a time. Request parameters should be passed in array format. If there are order modification failures during the batch modification process, the modification of the next order will continue to be executed, and the execution will return with the corresponding order failure information. The call order of batch modification orders is consistent with the order list order. The return is consistent with the order list order. ### Example @@ -1952,13 +1952,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order modification executed successfully | - | +**200** | Order modification executed successfully. | - | # **getSpotInsuranceHistory** > List<SpotInsuranceHistory> getSpotInsuranceHistory(business, currency, from, to).page(page).limit(limit).execute(); -Query spot insurance fund historical data +Query spot insurance fund historical data. ### Example @@ -1978,11 +1978,11 @@ 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 - Integer page = 1; // Integer | Page number - Integer limit = 30; // Integer | The maximum number of items returned in the list, the default value is 30 + String currency = "BTC"; // String | Currency. + Long from = 1547706332L; // Long | Start timestamp, 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 { List result = apiInstance.getSpotInsuranceHistory(business, currency, from, to) .page(page) @@ -2007,11 +2007,11 @@ public class Example { 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 | - **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] + **currency** | **String**| Currency. | + **from** | **Long**| Start timestamp, 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] ### Return type @@ -2029,13 +2029,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listSpotPriceTriggeredOrders** > List<SpotPriceTriggeredOrder> listSpotPriceTriggeredOrders(status).market(market).account(account).limit(limit).offset(offset).execute(); -Retrieve running auto order list +Retrieve running auto order list. ### Example @@ -2058,11 +2058,11 @@ 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 - Integer offset = 0; // Integer | List offset, starting from 0 + 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. + Integer offset = 0; // Integer | List offset, starting from 0. try { List result = apiInstance.listSpotPriceTriggeredOrders(status) .market(market) @@ -2088,11 +2088,11 @@ 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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **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] + **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. | - | # **createSpotPriceTriggeredOrder** > TriggerOrderResponse createSpotPriceTriggeredOrder(spotPriceTriggeredOrder) -Create a price-triggered order +Create a 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. | - | # **cancelSpotPriceTriggeredOrderList** > List<SpotPriceTriggeredOrder> cancelSpotPriceTriggeredOrderList(market, account) -Cancel All Price-triggered Orders +Cancel All Price-triggered 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 | Currency pair. + String account = "account_example"; // String | Trading account type. Portfolio margin account must 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**| Currency pair. | [optional] + **account** | **String**| Trading account type. Portfolio margin account must 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. Query order status by listing orders. | - | # **getSpotPriceTriggeredOrder** > SpotPriceTriggeredOrder getSpotPriceTriggeredOrder(orderId) -Get a price-triggered order +Get a price-triggered order. ### 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 | Retrieve the data of the order with the specified ID. 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**| Retrieve the data of the order with the specified ID. | ### 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 detail. | - | # **cancelSpotPriceTriggeredOrder** > SpotPriceTriggeredOrder cancelSpotPriceTriggeredOrder(orderId) -cancel a price-triggered order +cancel a price-triggered 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 | Retrieve the data of the order with the specified ID. 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**| Retrieve the data of the order with the specified ID. | ### 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 detail. | - | diff --git a/docs/SpotCurrencyChain.md b/docs/SpotCurrencyChain.md index d0bba74..5bb7d78 100644 --- a/docs/SpotCurrencyChain.md +++ b/docs/SpotCurrencyChain.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | Chain 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] -**depositDisabled** | **Boolean** | Whether currency's deposit is disabled | [optional] +**name** | **String** | Chain 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] +**depositDisabled** | **Boolean** | Whether currency's deposit is disabled. | [optional] diff --git a/docs/SpotFee.md b/docs/SpotFee.md index a979aae..cb214be 100644 --- a/docs/SpotFee.md +++ b/docs/SpotFee.md @@ -5,14 +5,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] +**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] **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] -**loanFee** | **String** | Loan fee rate of margin lending | [optional] -**pointType** | **String** | Point type. 0 - Initial version. 1 - new version since 202009 | [optional] -**currencyPair** | **String** | Currency pair | [optional] +**loanFee** | **String** | Loan fee rate of margin lending. | [optional] +**pointType** | **String** | Point type. 0 - Initial 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..b797b4c 100644 --- a/docs/SpotInsuranceHistory.md +++ b/docs/SpotInsuranceHistory.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency | [optional] -**balance** | **String** | balance | [optional] -**time** | **Long** | Creation time, timestamp, milliseconds | [optional] +**currency** | **String** | Currency. | [optional] +**balance** | **String** | balance. | [optional] +**time** | **Long** | Creation time, timestamp, milliseconds. | [optional] diff --git a/docs/SpotPricePutOrder.md b/docs/SpotPricePutOrder.md index f3aee62..8321296 100644 --- a/docs/SpotPricePutOrder.md +++ b/docs/SpotPricePutOrder.md @@ -7,12 +7,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` | +**price** | **String** | Order price. | +**amount** | **String** | When `type` is limit, it refers to base currency. For instance, `BTC_USDT` means `BTC` When different currency according to `side` - `side` : `buy` means quote currency, `BTC_USDT` means `USDT` - `side` : `sell` means base currency，`BTC_USDT` means `BTC` | **account** | [**AccountEnum**](#AccountEnum) | Trading account type. Portfolio margin account must set to `unified` -normal: spot trading - margin: margin trading - unified: unified trading | **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] +**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] ## Enum: TypeEnum diff --git a/docs/SpotPriceTrigger.md b/docs/SpotPriceTrigger.md index 05dc2d4..7a5c758 100644 --- a/docs/SpotPriceTrigger.md +++ b/docs/SpotPriceTrigger.md @@ -5,8 +5,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 | +**price** | **String** | Trigger price. | +**rule** | [**RuleEnum**](#RuleEnum) | Price trigger condition - `>=`: triggered when market price larger than or equal to `price` field - `<=`: or equal to `price` field | **expiration** | **Integer** | How long (in seconds) to wait for the condition to be triggered before cancelling the order. | ## Enum: RuleEnum diff --git a/docs/SpotPriceTriggeredOrder.md b/docs/SpotPriceTriggeredOrder.md index 818c34d..fe8bfd7 100644 --- a/docs/SpotPriceTriggeredOrder.md +++ b/docs/SpotPriceTriggeredOrder.md @@ -1,7 +1,7 @@ # SpotPriceTriggeredOrder -Spot order detail +Spot order detail. ## Properties @@ -9,12 +9,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **trigger** | [**SpotPriceTrigger**](SpotPriceTrigger.md) | | **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] +**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] +**reason** | **String** | Additional remarks on how the order was finished. | [optional] [readonly] diff --git a/docs/StpGroup.md b/docs/StpGroup.md index 42eaa7b..fa54513 100644 --- a/docs/StpGroup.md +++ b/docs/StpGroup.md @@ -5,8 +5,8 @@ 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] +**id** | **Long** | STP Group ID. | [optional] +**name** | **String** | STP Group name. | +**creatorId** | **Long** | Creator ID. | [optional] +**createTime** | **Long** | Creation time. | [optional] diff --git a/docs/StpGroupUser.md b/docs/StpGroupUser.md index fc9787d..3be334a 100644 --- a/docs/StpGroupUser.md +++ b/docs/StpGroupUser.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Long** | User ID | [optional] -**stpId** | **Long** | STP Group ID | [optional] -**createTime** | **Long** | Creation time | [optional] +**userId** | **Long** | User ID. | [optional] +**stpId** | **Long** | STP Group ID. | [optional] +**createTime** | **Long** | Creation time. | [optional] diff --git a/docs/StructuredBuy.md b/docs/StructuredBuy.md index a587bb8..f3deeab 100644 --- a/docs/StructuredBuy.md +++ b/docs/StructuredBuy.md @@ -1,12 +1,12 @@ # StructuredBuy -Dual Investment Purchase +Dual Investment Purchase. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**pid** | **String** | Plan ID | [optional] -**amount** | **String** | Purchase Amount | [optional] +**pid** | **String** | Plan ID. | [optional] +**amount** | **String** | Purchase Amount. | [optional] diff --git a/docs/StructuredGetProjectList.md b/docs/StructuredGetProjectList.md index d53b404..51d587f 100644 --- a/docs/StructuredGetProjectList.md +++ b/docs/StructuredGetProjectList.md @@ -1,22 +1,22 @@ # StructuredGetProjectList -Structured Products +Structured Products. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Integer** | Plan ID | [optional] +**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] +**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] **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..664b8a9 100644 --- a/docs/StructuredOrderList.md +++ b/docs/StructuredOrderList.md @@ -1,17 +1,17 @@ # StructuredOrderList -Structured order +Structured order. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Integer** | Order ID | [optional] -**pid** | **String** | Plan ID | [optional] -**lockCoin** | **String** | Locked coin | [optional] -**amount** | **String** | Locked amount | [optional] +**id** | **Integer** | Order ID. | [optional] +**pid** | **String** | Plan ID. | [optional] +**lockCoin** | **String** | Locked coin. | [optional] +**amount** | **String** | Locked amount. | [optional] **status** | **String** | Status: SUCCESS - SUCCESS FAILED - FAILED DONE - DONE | [optional] -**income** | **String** | Income | [optional] -**createTime** | **Integer** | Created time | [optional] +**income** | **String** | Income. | [optional] +**createTime** | **Integer** | Created time. | [optional] diff --git a/docs/SubAccount.md b/docs/SubAccount.md index b0ab679..07d87c7 100644 --- a/docs/SubAccount.md +++ b/docs/SubAccount.md @@ -5,12 +5,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**remark** | **String** | custom text | [optional] +**remark** | **String** | custom text. | [optional] **loginName** | **String** | Sub-account login name: Only letters, numbers and underscores are supported, and cannot contain other illegal characters | -**password** | **String** | The sub-account's password. (Default: the same as main account's password) | [optional] +**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] -**createTime** | **Long** | Created time | [optional] [readonly] +**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] +**createTime** | **Long** | Created time. | [optional] [readonly] diff --git a/docs/SubAccountApi.md b/docs/SubAccountApi.md index fc83e07..7d219e0 100644 --- a/docs/SubAccountApi.md +++ b/docs/SubAccountApi.md @@ -4,24 +4,24 @@ All URIs are relative to *https://api.gateio.ws/api/v4* 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 -[**listUnifiedMode**](SubAccountApi.md#listUnifiedMode) | **GET** /sub_accounts/unified_mode | Get sub-account mode +[**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. +[**listUnifiedMode**](SubAccountApi.md#listUnifiedMode) | **GET** /sub_accounts/unified_mode | Get sub-account mode. # **listSubAccounts** > List<SubAccount> listSubAccounts().type(type).execute(); -List sub-accounts +List sub-accounts. ### Example @@ -85,13 +85,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **createSubAccounts** > SubAccount createSubAccounts(subAccount) -Create a new sub-account +Create a new sub-account. ### Example @@ -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 the 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** | Successful. | - | # **listSubAccountKeys** > List<SubAccountKey> listSubAccountKeys(userId) -List all API Key of the sub-account +List all API Key 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. | - | # **createSubAccountKeys** > SubAccountKey createSubAccountKeys(userId, subAccountKey) -Create API Key of the sub-account +Create API Key of the sub-account. ### Example @@ -318,7 +318,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. SubAccountKey subAccountKey = new SubAccountKey(); // SubAccountKey | try { SubAccountKey result = apiInstance.createSubAccountKeys(userId, subAccountKey); @@ -340,7 +340,7 @@ 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 @@ -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 the API Key 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 | The API Key of the sub-account. 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**| The API Key of the sub-account. | ### Return type @@ -429,13 +429,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful | - | +**200** | Successful. | - | # **updateSubAccountKeys** > updateSubAccountKeys(userId, key, subAccountKey) -Update API key of the sub-account +Update API key of the sub-account. ### 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 | The API Key of the sub-account. 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**| The API Key of the sub-account. | **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. | - | # **deleteSubAccountKeys** > deleteSubAccountKeys(userId, key) -Delete API key of the sub-account +Delete API key of the sub-account. ### 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 | The API Key of the sub-account. 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**| The API Key of the sub-account. | ### Return type @@ -569,13 +569,13 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Delete successfully | - | +**204** | Delete successfully. | - | # **lockSubAccount** > lockSubAccount(userId) -Lock the sub-account +Lock the 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 | The user id of the sub-account. 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**| The user id of the sub-account. | ### Return type @@ -636,13 +636,13 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Lock successfully | - | +**204** | Lock successfully. | - | # **unlockSubAccount** > unlockSubAccount(userId) -Unlock the sub-account +Unlock the 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 | The user id of the sub-account. 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**| The user id of the sub-account. | ### Return type @@ -703,13 +703,13 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Unlock successfully | - | +**204** | Unlock successfully. | - | # **listUnifiedMode** > List<SubUserMode> listUnifiedMode() -Get sub-account mode +Get sub-account mode. Unified account mode： - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode @@ -769,5 +769,5 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | diff --git a/docs/SubAccountBalance.md b/docs/SubAccountBalance.md index 6e1ce23..6dcbeb8 100644 --- a/docs/SubAccountBalance.md +++ b/docs/SubAccountBalance.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**uid** | **String** | User ID | [optional] -**available** | **Map<String, String>** | Available balances of currencies | [optional] +**uid** | **String** | User ID. | [optional] +**available** | **Map<String, String>** | Available balances of currencies. | [optional] diff --git a/docs/SubAccountCrossMarginBalance.md b/docs/SubAccountCrossMarginBalance.md index c9de6fc..d685241 100644 --- a/docs/SubAccountCrossMarginBalance.md +++ b/docs/SubAccountCrossMarginBalance.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**uid** | **String** | User ID | [optional] +**uid** | **String** | User ID. | [optional] **available** | [**SubCrossMarginAccount**](.md) | 账户余额信息 | [optional] diff --git a/docs/SubAccountFuturesBalance.md b/docs/SubAccountFuturesBalance.md index c1ea4b0..d461dae 100644 --- a/docs/SubAccountFuturesBalance.md +++ b/docs/SubAccountFuturesBalance.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**uid** | **String** | User ID | [optional] -**available** | [**Map<String, FuturesAccount>**](FuturesAccount.md) | Futures account balances | [optional] +**uid** | **String** | User ID. | [optional] +**available** | [**Map<String, FuturesAccount>**](FuturesAccount.md) | Futures account balances. | [optional] diff --git a/docs/SubAccountKey.md b/docs/SubAccountKey.md index ac1ebca..a4b7c77 100644 --- a/docs/SubAccountKey.md +++ b/docs/SubAccountKey.md @@ -5,14 +5,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Long** | User ID | [optional] [readonly] -**mode** | **Integer** | Mode: 1 - classic 2 - portfolio account | [optional] -**name** | **String** | API key name | [optional] +**userId** | **Long** | User ID. | [optional] [readonly] +**mode** | **Integer** | Mode: 1 - classic 2 - portfolio account. | [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] -**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] +**ipWhitelist** | **List<String>** | ip white list (list will be removed 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] diff --git a/docs/SubAccountKeyPerms.md b/docs/SubAccountKeyPerms.md index dc7aad2..f063a88 100644 --- a/docs/SubAccountKeyPerms.md +++ b/docs/SubAccountKeyPerms.md @@ -6,5 +6,5 @@ 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] +**readOnly** | **Boolean** | read only. | [optional] diff --git a/docs/SubAccountMarginBalance.md b/docs/SubAccountMarginBalance.md index ab7ed81..5ad104e 100644 --- a/docs/SubAccountMarginBalance.md +++ b/docs/SubAccountMarginBalance.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**uid** | **String** | User ID | [optional] -**available** | [**List<MarginAccount>**](MarginAccount.md) | Margin account balances | [optional] +**uid** | **String** | User ID. | [optional] +**available** | [**List<MarginAccount>**](MarginAccount.md) | Margin account balances. | [optional] diff --git a/docs/SubAccountToSubAccount.md b/docs/SubAccountToSubAccount.md index 60cd8a2..5ef27b5 100644 --- a/docs/SubAccountToSubAccount.md +++ b/docs/SubAccountToSubAccount.md @@ -5,11 +5,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Transfer currency name | +**currency** | **String** | Transfer currency name. | **subAccountType** | **String** | Transfer from the account. (deprecate, use `sub_account_from_type` and `sub_account_to_type` instead) | [optional] -**subAccountFrom** | **String** | Transfer from the user id of the sub-account | +**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. | -**subAccountTo** | **String** | Transfer to the user id of the sub-account | +**subAccountTo** | **String** | Transfer to the user id of the sub-account. | **subAccountToType** | **String** | Transferred sub-account trading account: spot - spot account, futures - perpetual contract account, delivery - delivery contract account | -**amount** | **String** | Transfer amount | +**amount** | **String** | Transfer amount. | diff --git a/docs/SubAccountTransfer.md b/docs/SubAccountTransfer.md index 5000627..4391c0e 100644 --- a/docs/SubAccountTransfer.md +++ b/docs/SubAccountTransfer.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**subAccount** | **String** | Sub account user ID | +**subAccount** | **String** | Sub account user ID. | **subAccountType** | **String** | Target sub user's account. `spot` - spot account, `futures` - perpetual contract account, `delivery` - delivery account | [optional] -**currency** | **String** | Transfer currency name | -**amount** | **String** | Transfer amount | +**currency** | **String** | Transfer currency name. | +**amount** | **String** | Transfer amount. | **direction** | **String** | Transfer direction. to - transfer into sub account; from - transfer out from sub account | **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] diff --git a/docs/SubAccountTransferRecordItem.md b/docs/SubAccountTransferRecordItem.md index acce1ac..9fbc942 100644 --- a/docs/SubAccountTransferRecordItem.md +++ b/docs/SubAccountTransferRecordItem.md @@ -5,14 +5,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**timest** | **String** | Transfer timestamp | [optional] [readonly] -**uid** | **String** | Main account user ID | [optional] [readonly] -**subAccount** | **String** | Sub account user ID | +**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] -**currency** | **String** | Transfer currency name | -**amount** | **String** | Transfer amount | +**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] +**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] +**status** | **String** | Sub-account transfer record status, currently only success. | [optional] diff --git a/docs/SubCrossMarginAccount.md b/docs/SubCrossMarginAccount.md index c86187d..6aa518b 100644 --- a/docs/SubCrossMarginAccount.md +++ b/docs/SubCrossMarginAccount.md @@ -6,19 +6,19 @@ 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] +**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] -**borrowedNet** | **String** | Total borrowed value in USDT * borrowed factor | [optional] -**net** | **String** | Total net assets in USDT | [optional] -**leverage** | **String** | Position leverage | [optional] +**borrowedNet** | **String** | Total borrowed value in USDT * borrowed 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] -**totalInitialMargin** | **String** | Total initial margin | [optional] -**totalMarginBalance** | **String** | Total margin balance | [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] +**totalInitialMargin** | **String** | Total initial margin. | [optional] +**totalMarginBalance** | **String** | Total margin balance. | [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] diff --git a/docs/SubUserMode.md b/docs/SubUserMode.md index 3e49522..bee9dcd 100644 --- a/docs/SubUserMode.md +++ b/docs/SubUserMode.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Long** | User ID | [optional] -**isUnified** | **Boolean** | Is it a unified account? | [optional] +**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] diff --git a/docs/SwapCoin.md b/docs/SwapCoin.md index 0b524b3..8f1de15 100644 --- a/docs/SwapCoin.md +++ b/docs/SwapCoin.md @@ -1,14 +1,14 @@ # SwapCoin -Blockchain Mining +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] +**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 index e082449..57b8471 100644 --- a/docs/SwapCoinStruct.md +++ b/docs/SwapCoinStruct.md @@ -5,13 +5,19 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Integer** | Order ID | [optional] -**uid** | **Integer** | User ID | [optional] -**coin** | **String** | Currency | [optional] -**type** | **Integer** | Type: 0-Lock, 1-Certificate | [optional] -**amount** | **String** | Amount | [optional] -**exchangeRate** | **String** | Exchange Ratio | [optional] -**pid** | **Integer** | Plan ID | [optional] -**status** | **Integer** | status 1-success | [optional] -**createStamp** | **Integer** | Transaction timestamp | [optional] +**id** | **Integer** | Order ID. | [optional] +**pid** | **Integer** | Plan ID. | [optional] +**uid** | **Integer** | User ID. | [optional] +**coin** | **String** | Currency. | [optional] +**type** | **Integer** | 类型 0-质押 1-赎回 | [optional] +**subtype** | **String** | 子类型 | [optional] +**amount** | **String** | Amount. | [optional] +**exchangeRate** | **String** | Exchange Ratio. | [optional] +**exchangeAmount** | **String** | 兑换金额 | [optional] +**updateStamp** | **Integer** | 更新时间戳 | [optional] +**createStamp** | **Integer** | Transaction timestamp. | [optional] +**status** | **Integer** | status 1-success. | [optional] +**protocolType** | **Integer** | DEFI协议类型 | [optional] +**clientOrderId** | **String** | 参考ID | [optional] +**source** | **String** | Order source. | [optional] diff --git a/docs/SystemTime.md b/docs/SystemTime.md index ebc18b1..d0b9da9 100644 --- a/docs/SystemTime.md +++ b/docs/SystemTime.md @@ -5,5 +5,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**serverTime** | **Long** | Server current time(ms) | [optional] +**serverTime** | **Long** | Server current time(ms). | [optional] diff --git a/docs/Ticker.md b/docs/Ticker.md index da13bfd..54db8a5 100644 --- a/docs/Ticker.md +++ b/docs/Ticker.md @@ -5,21 +5,21 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currencyPair** | **String** | Currency pair | [optional] -**last** | **String** | Last trading price | [optional] -**lowestAsk** | **String** | Recent lowest ask | [optional] +**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] -**highestBid** | **String** | Recent highest bid | [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] -**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] -**etfLeverage** | **String** | ETF current leverage | [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] +**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] +**etfLeverage** | **String** | ETF current leverage. | [optional] diff --git a/docs/TotalBalance.md b/docs/TotalBalance.md index 5ed79f2..050abc7 100644 --- a/docs/TotalBalance.md +++ b/docs/TotalBalance.md @@ -1,7 +1,7 @@ # TotalBalance -User's balance in all accounts +User's balance in all accounts. ## Properties diff --git a/docs/Trade.md b/docs/Trade.md index 5f0cc49..4a0cb91 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] -**createTimeMs** | **String** | Trading time, with millisecond precision | [optional] -**currencyPair** | **String** | Currency pair | [optional] -**side** | [**SideEnum**](#SideEnum) | Buy or sell order | [optional] -**role** | [**RoleEnum**](#RoleEnum) | Trade role. No value 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] -**amendText** | **String** | The custom data that the user remarked when amending the order | [optional] +**id** | **String** | Trade ID. | [optional] +**createTime** | **String** | Trading time. | [optional] +**createTimeMs** | **String** | Trading time, with millisecond precision. | [optional] +**currencyPair** | **String** | Currency pair. | [optional] +**side** | [**SideEnum**](#SideEnum) | Buy or sell order. | [optional] +**role** | [**RoleEnum**](#RoleEnum) | Trade role. No value 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] +**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] +**text** | **String** | User defined information. No value in public endpoints. | [optional] ## Enum: SideEnum diff --git a/docs/TradeFee.md b/docs/TradeFee.md index 9b6ccb8..1c86874 100644 --- a/docs/TradeFee.md +++ b/docs/TradeFee.md @@ -5,17 +5,17 @@ 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] +**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] **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] -**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] +**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] **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..6b10285 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..e7eeed8 100644 --- a/docs/Transfer.md +++ b/docs/Transfer.md @@ -8,10 +8,10 @@ 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 | -**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] +**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] ## Enum: FromEnum diff --git a/docs/TransferOrderStatus.md b/docs/TransferOrderStatus.md index 6e9eda3..f727861 100644 --- a/docs/TransferOrderStatus.md +++ b/docs/TransferOrderStatus.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**txId** | **String** | Order id | [optional] +**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] diff --git a/docs/TransferablesResult.md b/docs/TransferablesResult.md index a013286..8393991 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 can be transferred up to a maximum of results. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency detail | [optional] -**amount** | **String** | The maximum amount that can be transferred out | [optional] +**currency** | **String** | Currency detail. | [optional] +**amount** | **String** | The maximum amount that can be transferred out. | [optional] diff --git a/docs/TriggerOrderResponse.md b/docs/TriggerOrderResponse.md index 23fc48c..85019c1 100644 --- a/docs/TriggerOrderResponse.md +++ b/docs/TriggerOrderResponse.md @@ -5,5 +5,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Long** | Auto order ID | [optional] +**id** | **Long** | Auto order ID. | [optional] diff --git a/docs/TriggerTime.md b/docs/TriggerTime.md index 1e8e196..2476867 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 of the end of the countdown, in milliseconds. | [optional] diff --git a/docs/UidPushOrder.md b/docs/UidPushOrder.md index 36a2b3d..7b1edae 100644 --- a/docs/UidPushOrder.md +++ b/docs/UidPushOrder.md @@ -5,13 +5,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Long** | Order ID | [optional] -**pushUid** | **Long** | Initiator User ID | [optional] -**receiveUid** | **Long** | Recipient User ID | [optional] -**currency** | **String** | Currency name | [optional] -**amount** | **String** | Transfer amount | [optional] -**createTime** | **Long** | Creation time | [optional] +**id** | **Long** | Order ID. | [optional] +**pushUid** | **Long** | Initiator User ID. | [optional] +**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] -**transactionType** | **String** | Order Type | [optional] +**message** | **String** | PENDING Reason Tips. | [optional] +**transactionType** | **String** | Order Type. | [optional] diff --git a/docs/UidPushWithdrawal.md b/docs/UidPushWithdrawal.md index 4fcd82e..afab0c6 100644 --- a/docs/UidPushWithdrawal.md +++ b/docs/UidPushWithdrawal.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**receiveUid** | **Long** | Recipient UID | -**currency** | **String** | Currency name | -**amount** | **String** | Transfer amount | +**receiveUid** | **Long** | Recipient UID. | +**currency** | **String** | Currency name. | +**amount** | **String** | Transfer amount. | diff --git a/docs/UidPushWithdrawalResp.md b/docs/UidPushWithdrawalResp.md index 5d7e783..5bf74f0 100644 --- a/docs/UidPushWithdrawalResp.md +++ b/docs/UidPushWithdrawalResp.md @@ -5,5 +5,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Long** | Order ID | [optional] +**id** | **Long** | Order ID. | [optional] diff --git a/docs/UniCurrency.md b/docs/UniCurrency.md index 09aac84..881614b 100644 --- a/docs/UniCurrency.md +++ b/docs/UniCurrency.md @@ -1,15 +1,15 @@ # UniCurrency -Currency detail +Currency detail. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency name | [optional] [readonly] +**currency** | **String** | Currency name. | [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] +**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 d4f86c5..cf8c91e 100644 --- a/docs/UniCurrencyInterest.md +++ b/docs/UniCurrencyInterest.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency | [optional] [readonly] -**interestStatus** | **String** | Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment Interest reinvestment | [optional] [readonly] +**currency** | **String** | Currency. | [optional] [readonly] +**interestStatus** | **String** | Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment | [optional] [readonly] diff --git a/docs/UniCurrencyPair.md b/docs/UniCurrencyPair.md index 2b09132..d4a6509 100644 --- a/docs/UniCurrencyPair.md +++ b/docs/UniCurrencyPair.md @@ -1,14 +1,14 @@ # UniCurrencyPair -Currency pair of the loan +Currency pair of the loan. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currencyPair** | **String** | Currency pair | [optional] [readonly] -**baseMinBorrowAmount** | **String** | Minimum borrow amount of base currency | [optional] [readonly] -**quoteMinBorrowAmount** | **String** | Minimum borrow amount of quote currency | [optional] [readonly] -**leverage** | **String** | Position leverage | [optional] [readonly] +**currencyPair** | **String** | Currency pair. | [optional] [readonly] +**baseMinBorrowAmount** | **String** | Minimum borrow amount of base currency. | [optional] [readonly] +**quoteMinBorrowAmount** | **String** | Minimum borrow amount of quote currency. | [optional] [readonly] +**leverage** | **String** | Position leverage. | [optional] [readonly] diff --git a/docs/UniInterestRecord.md b/docs/UniInterestRecord.md index 90703a1..10bdd82 100644 --- a/docs/UniInterestRecord.md +++ b/docs/UniInterestRecord.md @@ -1,16 +1,16 @@ # UniInterestRecord -Interest Record +Interest Record. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | **Integer** | Status: 0 - fail, 1 - success | [optional] [readonly] -**currency** | **String** | Currency | [optional] [readonly] -**actualRate** | **String** | Actual Rate | [optional] [readonly] -**interest** | **String** | Interest | [optional] [readonly] -**interestStatus** | **String** | Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment Interest reinvestment | [optional] [readonly] -**createTime** | **Long** | Created time | [optional] [readonly] +**status** | **Integer** | Status: 0 - fail, 1 - success. | [optional] [readonly] +**currency** | **String** | Currency. | [optional] [readonly] +**actualRate** | **String** | Actual Rate. | [optional] [readonly] +**interest** | **String** | Interest. | [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 0f31ef0..72561ae 100644 --- a/docs/UniLend.md +++ b/docs/UniLend.md @@ -1,20 +1,20 @@ # UniLend -Loan record +Loan record. ## Properties 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] -**minRate** | **String** | Minimum interest rate | [optional] [readonly] -**interestStatus** | **String** | Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment 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] +**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] +**minRate** | **String** | Minimum interest rate. | [optional] [readonly] +**interestStatus** | **String** | Interest status: interest_dividend - Normal 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] diff --git a/docs/UniLendInterest.md b/docs/UniLendInterest.md index 005a1d9..9131360 100644 --- a/docs/UniLendInterest.md +++ b/docs/UniLendInterest.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency | [optional] [readonly] -**interest** | **String** | Interest | [optional] [readonly] +**currency** | **String** | Currency. | [optional] [readonly] +**interest** | **String** | Interest. | [optional] [readonly] diff --git a/docs/UniLendRecord.md b/docs/UniLendRecord.md index 3f056c5..1419170 100644 --- a/docs/UniLendRecord.md +++ b/docs/UniLendRecord.md @@ -1,17 +1,17 @@ # UniLendRecord -Interest Record +Interest 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] -**createTime** | **Long** | Created time | [optional] [readonly] +**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] +**createTime** | **Long** | Created time. | [optional] [readonly] diff --git a/docs/UniLoan.md b/docs/UniLoan.md index 3584e7c..b40e6a1 100644 --- a/docs/UniLoan.md +++ b/docs/UniLoan.md @@ -1,16 +1,16 @@ # UniLoan -Loan +Loan. ## Properties 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] -**createTime** | **Long** | Created time | [optional] [readonly] -**updateTime** | **Long** | Updated time | [optional] [readonly] +**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] +**createTime** | **Long** | Created time. | [optional] [readonly] +**updateTime** | **Long** | Updated time. | [optional] [readonly] diff --git a/docs/UniLoanInterestRecord.md b/docs/UniLoanInterestRecord.md index 65d52f1..88c97f5 100644 --- a/docs/UniLoanInterestRecord.md +++ b/docs/UniLoanInterestRecord.md @@ -1,17 +1,17 @@ # UniLoanInterestRecord -Interest record +Interest record. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency name | [optional] [readonly] -**currencyPair** | **String** | Currency pair | [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] -**createTime** | **Long** | Created time | [optional] [readonly] +**currency** | **String** | Currency name. | [optional] [readonly] +**currencyPair** | **String** | Currency pair. | [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] +**createTime** | **Long** | Created time. | [optional] [readonly] diff --git a/docs/UniLoanRecord.md b/docs/UniLoanRecord.md index 2324db8..8cdf0f6 100644 --- a/docs/UniLoanRecord.md +++ b/docs/UniLoanRecord.md @@ -1,15 +1,15 @@ # UniLoanRecord -Loan records +Loan records. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**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] -**createTime** | **Long** | Created time | [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] +**createTime** | **Long** | Created time. | [optional] [readonly] diff --git a/docs/UnifiedAccount.md b/docs/UnifiedAccount.md index bbc35b5..d583dc0 100644 --- a/docs/UnifiedAccount.md +++ b/docs/UnifiedAccount.md @@ -5,11 +5,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Long** | User ID | [optional] -**refreshTime** | **Long** | Time of the most recent refresh | [optional] +**userId** | **Long** | User ID. | [optional] +**refreshTime** | **Long** | Time of the most recent refresh. | [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] +**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] **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] @@ -20,9 +20,9 @@ Name | Type | Description | Notes **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] +**leverage** | **String** | Actual leverage, 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] -**isAllCollateral** | **Boolean** | Whether all currencies are used as margin, true - All currencies are used as margin, false - No | [optional] +**useFunding** | **Boolean** | Whether to use funds as margin. | [optional] +**isAllCollateral** | **Boolean** | Whether all currencies are used as margin, true - false - No | [optional] diff --git a/docs/UnifiedApi.md b/docs/UnifiedApi.md index 4b862b6..6c5d1a8 100644 --- a/docs/UnifiedApi.md +++ b/docs/UnifiedApi.md @@ -4,35 +4,35 @@ 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 +[**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 -[**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 -[**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 -[**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 -[**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 -[**setUnifiedCollateral**](UnifiedApi.md#setUnifiedCollateral) | **POST** /unified/collateral_currencies | Set Collateral Currency +[**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. +[**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. +[**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. +[**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. +[**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. +[**setUnifiedCollateral**](UnifiedApi.md#setUnifiedCollateral) | **POST** /unified/collateral_currencies | Set Collateral Currency. # **listUnifiedAccounts** > UnifiedAccount listUnifiedAccounts().currency(currency).subUid(subUid).execute(); -Get unified account information +Get unified account information. The assets of each currency in the account will be adjusted according to their liquidity, defined by corresponding adjustment coefficients, and then uniformly converted to USD to calculate the total asset value and position value of the account. You can refer to the [Formula](#portfolio-account) in the documentation @@ -57,8 +57,8 @@ 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 subUid = "10001"; // String | Sub account user ID + String currency = "BTC"; // String | Retrieve data of the specified currency. + String subUid = "10001"; // String | Sub account user ID. try { UnifiedAccount result = apiInstance.listUnifiedAccounts() .currency(currency) @@ -82,8 +82,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | [optional] - **subUid** | **String**| Sub account user ID | [optional] + **currency** | **String**| Retrieve data of the specified currency. | [optional] + **subUid** | **String**| Sub account user ID. | [optional] ### Return type @@ -101,13 +101,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **getUnifiedBorrowable** > UnifiedBorrowable getUnifiedBorrowable(currency) -Query about the maximum borrowing for the unified account +Query about the maximum borrowing for the unified account. ### Example @@ -130,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 | Retrieve data of the specified currency. try { UnifiedBorrowable result = apiInstance.getUnifiedBorrowable(currency); System.out.println(result); @@ -151,7 +151,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | + **currency** | **String**| Retrieve data of the specified currency. | ### Return type @@ -169,13 +169,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **getUnifiedTransferable** > UnifiedTransferable getUnifiedTransferable(currency) -Query about the maximum transferable for the unified account +Query about the maximum transferable for the unified account. ### Example @@ -198,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 | Retrieve data of the specified currency. try { UnifiedTransferable result = apiInstance.getUnifiedTransferable(currency); System.out.println(result); @@ -219,7 +219,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency | + **currency** | **String**| Retrieve data of the specified currency. | ### Return type @@ -237,7 +237,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **getUnifiedTransferables** @@ -305,13 +305,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **getUnifiedBorrowableList** > List<UnifiedBorrowable1> getUnifiedBorrowableList(currencies) -Batch query unified account can be borrowed up to a maximum +Batch query unified account can be borrowed up to a maximum. ### Example @@ -373,13 +373,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listUnifiedLoans** > List<UniLoan> listUnifiedLoans().currency(currency).page(page).limit(limit).type(type).execute(); -List loans +List loans. ### Example @@ -402,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 - 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 + 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. + String type = "platform"; // String | Loan type, platform - platform, margin - margin. try { List result = apiInstance.listUnifiedLoans() .currency(currency) @@ -431,10 +431,10 @@ public class Example { 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] - **type** | **String**| Loan type, platform - platform, margin - margin | [optional] + **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] + **type** | **String**| Loan type, platform - platform, margin - margin. | [optional] ### Return type @@ -452,15 +452,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **createUnifiedLoan** > UnifiedLoanResult createUnifiedLoan(unifiedLoan) -Borrow or repay +Borrow or repay. -When borrowing, it is essential to ensure that the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and the user. The interest on the loan will be automatically deducted from the account at regular intervals. It is the user's responsibility to manage the repayment of the borrowed amount. For repayment, the option to repay the entire borrowed amount is available by setting the parameter `repaid_all=true` +When borrowing, it is essential to ensure that the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and the user. The interest on the loan will be automatically deducted from the account at regular intervals. It is the user's responsibility to manage the repayment of the borrowed amount. For repayment, the option to repay the available by setting the parameter `repaid_all=true` ### Example @@ -522,13 +522,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Operated successfully | - | +**200** | Operated successfully. | - | # **listUnifiedLoanRecords** > List<UnifiedLoanRecord> listUnifiedLoanRecords().type(type).currency(currency).page(page).limit(limit).execute(); -Get load records +Get load records. ### Example @@ -551,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 - Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 100 + String type = "type_example"; // String | The types of lending records, borrow - indicates the action of borrowing funds, repaying the borrowed funds + 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. try { List result = apiInstance.listUnifiedLoanRecords() .type(type) @@ -580,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] - **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**| The types of lending records, borrow - indicates the action of borrowing funds, repaying the borrowed funds | [optional] + **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] ### Return type @@ -601,13 +601,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listUnifiedLoanInterestRecords** > List<UniLoanInterestRecord> listUnifiedLoanInterestRecords().currency(currency).page(page).limit(limit).from(from).to(to).type(type).execute(); -List interest records +List interest records. ### Example @@ -630,11 +630,11 @@ 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 - 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 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 = 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 try { List result = apiInstance.listUnifiedLoanInterestRecords() @@ -663,11 +663,11 @@ public class Example { 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 of the query | [optional] - **to** | **Long**| Time range ending, default to current time | [optional] + **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 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] ### Return type @@ -686,15 +686,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **getUnifiedRiskUnits** > UnifiedRiskUnits getUnifiedRiskUnits() -Get user risk unit details +Get user risk unit details. -Retrieve user risk unit details, only valid in portfolio margin mode +Retrieve user risk unit details, only valid in portfolio margin mode. ### Example @@ -752,13 +752,13 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **getUnifiedMode** > UnifiedModeSet getUnifiedMode() -Query mode of the unified account +Query mode of the unified account. Unified account mode: - `classic`: Classic account mode - `multi_currency`: Cross-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single-currency margin mode @@ -818,15 +818,15 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **setUnifiedMode** > setUnifiedMode(unifiedModeSet) -Set mode of the unified account +Set mode of the unified account. -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 mode, mode=multi_currency ``` PUT /unified/unified_mode { \"mode\": \"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\" } ``` +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 @@ -887,13 +887,13 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Success | - | +**204** | Success. | - | # **getUnifiedEstimateRate** > Map<String, String> getUnifiedEstimateRate(currencies) -Get unified estimate rate +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. @@ -957,13 +957,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listCurrencyDiscountTiers** > List<UnifiedDiscount> listCurrencyDiscountTiers() -List currency discount tiers +List currency discount tiers. ### Example @@ -1017,13 +1017,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **listLoanMarginTiers** > List<UnifiedMarginTiers> listLoanMarginTiers() -List loan margin tiers +List loan margin tiers. ### Example @@ -1077,15 +1077,15 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **calculatePortfolioMargin** > UnifiedPortfolioOutput calculatePortfolioMargin(unifiedPortfolioInput) -Portfolio margin calculator +Portfolio margin calculator. -Portfolio Margin Calculator When inputting a simulated position portfolio, each position includes the position name and quantity held, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. When inputting simulated orders, each order includes the market identifier, order price, and order 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 a simulated position portfolio, each position includes the position name and quantity held, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. When inputting simulated orders, each order includes the market identifier, order price, and order of BTC and ETH perpetual contracts, options, and spot markets. Market orders are not included. ### Example @@ -1143,13 +1143,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **getUserLeverageCurrencyConfig** > UnifiedLeverageConfig getUserLeverageCurrencyConfig(currency) -Minimum currency leverage that can be set +Minimum currency leverage that can be set. ### Example @@ -1172,7 +1172,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); UnifiedApi apiInstance = new UnifiedApi(defaultClient); - String currency = "BTC"; // String | Currency + String currency = "BTC"; // String | Currency. try { UnifiedLeverageConfig result = apiInstance.getUserLeverageCurrencyConfig(currency); System.out.println(result); @@ -1193,7 +1193,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Currency | + **currency** | **String**| Currency. | ### Return type @@ -1211,13 +1211,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **getUserLeverageCurrencySetting** > UnifiedLeverageSetting getUserLeverageCurrencySetting().currency(currency).execute(); -Get the leverage multiple of the user currency +Get the leverage multiple of the user currency. Get the user's currency leverage. If currency is not passed, query all currencies. @@ -1242,7 +1242,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); UnifiedApi apiInstance = new UnifiedApi(defaultClient); - String currency = "BTC"; // String | Currency + String currency = "BTC"; // String | Currency. try { UnifiedLeverageSetting result = apiInstance.getUserLeverageCurrencySetting() .currency(currency) @@ -1265,7 +1265,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Currency | [optional] + **currency** | **String**| Currency. | [optional] ### Return type @@ -1283,13 +1283,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **setUserLeverageCurrencySetting** > setUserLeverageCurrencySetting(unifiedLeverageSetting) -Set the loan currency leverage +Set the loan currency leverage. ### Example @@ -1350,13 +1350,13 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Success | - | +**204** | Success. | - | # **listUnifiedCurrencies** > List<UnifiedCurrency> listUnifiedCurrencies().currency(currency).execute(); -List of loan currencies supported by unified account +List of loan currencies supported by unified account. ### Example @@ -1375,7 +1375,7 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); UnifiedApi apiInstance = new UnifiedApi(defaultClient); - String currency = "BTC"; // String | Currency + String currency = "BTC"; // String | Currency. try { List result = apiInstance.listUnifiedCurrencies() .currency(currency) @@ -1398,7 +1398,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Currency | [optional] + **currency** | **String**| Currency. | [optional] ### Return type @@ -1416,13 +1416,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **getHistoryLoanRate** > UnifiedHistoryLoanRate getHistoryLoanRate(currency).tier(tier).page(page).limit(limit).execute(); -get historical lending rates +get historical lending rates. ### Example @@ -1441,10 +1441,10 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 - Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 100 + String currency = "USDT"; // String | Currency. + String tier = "1"; // String | The VIP level of the floating rate that needs to be queried. + Integer page = 1; // Integer | Page number. + Integer limit = 100; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 100. try { UnifiedHistoryLoanRate result = apiInstance.getHistoryLoanRate(currency) .tier(tier) @@ -1469,10 +1469,10 @@ 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] - **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100] + **currency** | **String**| Currency. | + **tier** | **String**| The VIP level of the floating rate that needs 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] ### Return type @@ -1490,13 +1490,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **setUnifiedCollateral** > UnifiedCollateralRes setUnifiedCollateral(unifiedCollateralReq) -Set Collateral Currency +Set Collateral Currency. ### Example @@ -1558,5 +1558,5 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | UpdateSuccess | - | +**200** | UpdateSuccess. | - | diff --git a/docs/UnifiedBalance.md b/docs/UnifiedBalance.md index 0ff634a..a512f81 100644 --- a/docs/UnifiedBalance.md +++ b/docs/UnifiedBalance.md @@ -11,11 +11,11 @@ Name | Type | Description | Notes **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] **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] +**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] **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] -**fundingVersion** | **String** | Funding version | [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] @@ -24,5 +24,5 @@ Name | Type | Description | Notes **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] -**enabledCollateral** | **Boolean** | Currency enabled as margin: true - Enabled, false - Disabled | [optional] +**enabledCollateral** | **Boolean** | Currency enabled as margin: true - Enabled, false - Disabled. | [optional] diff --git a/docs/UnifiedBorrowable.md b/docs/UnifiedBorrowable.md index f23cf0a..23abf56 100644 --- a/docs/UnifiedBorrowable.md +++ b/docs/UnifiedBorrowable.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency detail | [optional] -**amount** | **String** | Max borrowable amount | [optional] +**currency** | **String** | Currency detail. | [optional] +**amount** | **String** | Max borrowable amount. | [optional] diff --git a/docs/UnifiedBorrowable1.md b/docs/UnifiedBorrowable1.md index e099cc2..e9e930f 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 can be borrowed up to a maximum of results. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency detail | [optional] -**amount** | **String** | The maximum amount to borrow | [optional] +**currency** | **String** | Currency detail. | [optional] +**amount** | **String** | The maximum amount to borrow. | [optional] diff --git a/docs/UnifiedCollateralReq.md b/docs/UnifiedCollateralReq.md index 74b0d6e..f146014 100644 --- a/docs/UnifiedCollateralReq.md +++ b/docs/UnifiedCollateralReq.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**collateralType** | [**CollateralTypeEnum**](#CollateralTypeEnum) | User-set collateral mode0(all)-All currencies used as collateral, 1(custom)-Custom currencies used as collateral; when collateral_type is 0(all), the enable_list and disable_list parameters are invalid | [optional] +**collateralType** | [**CollateralTypeEnum**](#CollateralTypeEnum) | User-set collateral mode0(all)-All currencies used as collateral, collateral; when collateral_type is 0(all), the enable_list and disable_list parameters are invalid | [optional] **enableList** | **List<String>** | Currency list, where collateral_type=1(custom) indicates the logic of addition | [optional] -**disableList** | **List<String>** | Cancellation list, indicating the logic of cancellation | [optional] +**disableList** | **List<String>** | Cancellation list, indicating the logic of cancellation. | [optional] ## Enum: CollateralTypeEnum diff --git a/docs/UnifiedCollateralRes.md b/docs/UnifiedCollateralRes.md index 5254657..8c7108a 100644 --- a/docs/UnifiedCollateralRes.md +++ b/docs/UnifiedCollateralRes.md @@ -1,11 +1,11 @@ # UnifiedCollateralRes -Return of unified account collateral mode settings +Return of unified account collateral mode settings. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**isSuccess** | **Boolean** | Whether the setting was successful | [optional] +**isSuccess** | **Boolean** | Whether the setting was successful. | [optional] diff --git a/docs/UnifiedCurrency.md b/docs/UnifiedCurrency.md index b8be591..4f53965 100644 --- a/docs/UnifiedCurrency.md +++ b/docs/UnifiedCurrency.md @@ -5,10 +5,10 @@ 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] +**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] diff --git a/docs/UnifiedDiscount.md b/docs/UnifiedDiscount.md index ea821fa..2b9726c 100644 --- a/docs/UnifiedDiscount.md +++ b/docs/UnifiedDiscount.md @@ -1,12 +1,12 @@ # UnifiedDiscount -Currency discount tiers +Currency discount tiers. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency name | [optional] -**discountTiers** | [**List<UnifiedDiscountTiers>**](UnifiedDiscountTiers.md) | Tiered discount | [optional] +**currency** | **String** | Currency name. | [optional] +**discountTiers** | [**List<UnifiedDiscountTiers>**](UnifiedDiscountTiers.md) | Tiered discount. | [optional] diff --git a/docs/UnifiedDiscountTiers.md b/docs/UnifiedDiscountTiers.md index e48f0f1..91e4f3f 100644 --- a/docs/UnifiedDiscountTiers.md +++ b/docs/UnifiedDiscountTiers.md @@ -5,9 +5,9 @@ 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] -**leverage** | **String** | Position leverage | [optional] +**tier** | **String** | Tier. | [optional] +**discount** | **String** | Discount. | [optional] +**lowerLimit** | **String** | Lower limit. | [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..2eb0e18 100644 --- a/docs/UnifiedHistoryLoanRate.md +++ b/docs/UnifiedHistoryLoanRate.md @@ -5,8 +5,8 @@ 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] +**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] diff --git a/docs/UnifiedHistoryLoanRateRates.md b/docs/UnifiedHistoryLoanRateRates.md index 78d076a..5f311f4 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** | The hourly timestamp corresponding to the interest rate, in milliseconds. | [optional] +**rate** | **String** | Historical interest rates for this hour. | [optional] diff --git a/docs/UnifiedLeverageConfig.md b/docs/UnifiedLeverageConfig.md index f864f11..4ade484 100644 --- a/docs/UnifiedLeverageConfig.md +++ b/docs/UnifiedLeverageConfig.md @@ -5,11 +5,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currentLeverage** | **String** | Current leverage ratio | [optional] -**minLeverage** | **String** | Minimum adjustable leverage ratio | [optional] -**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] +**currentLeverage** | **String** | Current leverage ratio. | [optional] +**minLeverage** | **String** | Minimum adjustable leverage ratio. | [optional] +**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 be borrowed, whichever is smaller | [optional] diff --git a/docs/UnifiedLeverageSetting.md b/docs/UnifiedLeverageSetting.md index 1e45ee2..2b130ac 100644 --- a/docs/UnifiedLeverageSetting.md +++ b/docs/UnifiedLeverageSetting.md @@ -1,12 +1,12 @@ # UnifiedLeverageSetting -Loan currency leverage +Loan currency leverage. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency name | -**leverage** | **String** | multiple | +**currency** | **String** | Currency name. | +**leverage** | **String** | multiple. | diff --git a/docs/UnifiedLoan.md b/docs/UnifiedLoan.md index 0a76782..783acea 100644 --- a/docs/UnifiedLoan.md +++ b/docs/UnifiedLoan.md @@ -1,17 +1,17 @@ # UnifiedLoan -Borrow or repay +Borrow or repay. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency | -**type** | [**TypeEnum**](#TypeEnum) | type: borrow - borrow, repay - repay | -**amount** | **String** | The amount of lending or repaying | +**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] -**text** | **String** | User defined custom ID | [optional] +**text** | **String** | User defined custom ID. | [optional] ## Enum: TypeEnum diff --git a/docs/UnifiedLoanRecord.md b/docs/UnifiedLoanRecord.md index 384ee70..ea2abf1 100644 --- a/docs/UnifiedLoanRecord.md +++ b/docs/UnifiedLoanRecord.md @@ -1,18 +1,18 @@ # UnifiedLoanRecord -Loan records +Loan 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] +**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 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] -**currencyPair** | **String** | Currency pair | [optional] [readonly] -**currency** | **String** | Currency | [optional] [readonly] -**amount** | **String** | The amount of lending or repaying | [optional] [readonly] -**createTime** | **Long** | Created time | [optional] [readonly] +**currencyPair** | **String** | Currency pair. | [optional] [readonly] +**currency** | **String** | Currency. | [optional] [readonly] +**amount** | **String** | The amount of lending or repaying. | [optional] [readonly] +**createTime** | **Long** | Created time. | [optional] [readonly] diff --git a/docs/UnifiedLoanResult.md b/docs/UnifiedLoanResult.md index 86cc27d..3575837 100644 --- a/docs/UnifiedLoanResult.md +++ b/docs/UnifiedLoanResult.md @@ -1,11 +1,11 @@ # UnifiedLoanResult -Unified account loan and repayment response results +Unified account loan and repayment response results. ## 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..73a5fdc 100644 --- a/docs/UnifiedMarginTiers.md +++ b/docs/UnifiedMarginTiers.md @@ -1,12 +1,12 @@ # UnifiedMarginTiers -Unified margin tiers +Unified margin tiers. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency name | [optional] -**marginTiers** | [**List<MarginTiers>**](MarginTiers.md) | Margin tiers | [optional] +**currency** | **String** | Currency name. | [optional] +**marginTiers** | [**List<MarginTiers>**](MarginTiers.md) | Margin tiers. | [optional] diff --git a/docs/UnifiedPortfolioInput.md b/docs/UnifiedPortfolioInput.md index 72ebefb..52fb40a 100644 --- a/docs/UnifiedPortfolioInput.md +++ b/docs/UnifiedPortfolioInput.md @@ -7,11 +7,11 @@ Input for the portfolio margin calculator. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**spotBalances** | [**List<MockSpotBalance>**](MockSpotBalance.md) | Spot | [optional] -**spotOrders** | [**List<MockSpotOrder>**](MockSpotOrder.md) | Spot orders | [optional] -**futuresPositions** | [**List<MockFuturesPosition>**](MockFuturesPosition.md) | Futures positions | [optional] -**futuresOrders** | [**List<MockFuturesOrder>**](MockFuturesOrder.md) | Futures order | [optional] -**optionsPositions** | [**List<MockOptionsPosition>**](MockOptionsPosition.md) | Options positions | [optional] -**optionsOrders** | [**List<MockOptionsOrder>**](MockOptionsOrder.md) | Option orders | [optional] +**spotBalances** | [**List<MockSpotBalance>**](MockSpotBalance.md) | Spot. | [optional] +**spotOrders** | [**List<MockSpotOrder>**](MockSpotOrder.md) | Spot orders. | [optional] +**futuresPositions** | [**List<MockFuturesPosition>**](MockFuturesPosition.md) | Futures positions. | [optional] +**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] diff --git a/docs/UnifiedPortfolioOutput.md b/docs/UnifiedPortfolioOutput.md index 7847d96..571eccf 100644 --- a/docs/UnifiedPortfolioOutput.md +++ b/docs/UnifiedPortfolioOutput.md @@ -8,7 +8,7 @@ The output of the portfolio margin calculator. 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] -**riskUnit** | [**List<MockRiskUnit>**](MockRiskUnit.md) | Risk unit | [optional] +**initialMarginTotal** | **String** | Total initial margin, calculated as the maximum of the following three combinations: position, position + positive delta orders, orders. | [optional] +**calculateTime** | **Long** | Calculate time. | [optional] +**riskUnit** | [**List<MockRiskUnit>**](MockRiskUnit.md) | Risk unit. | [optional] diff --git a/docs/UnifiedRiskUnits.md b/docs/UnifiedRiskUnits.md index 688f93f..ed22873 100644 --- a/docs/UnifiedRiskUnits.md +++ b/docs/UnifiedRiskUnits.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Long** | User ID | [optional] +**userId** | **Long** | User ID. | [optional] **spotHedge** | **Boolean** | Spot hedging status, true - enabled, false - not enabled. | [optional] -**riskUnits** | [**List<RiskUnits>**](RiskUnits.md) | Risk unit | [optional] +**riskUnits** | [**List<RiskUnits>**](RiskUnits.md) | Risk unit. | [optional] diff --git a/docs/UnifiedSettings.md b/docs/UnifiedSettings.md index 56e6dca..a63820f 100644 --- a/docs/UnifiedSettings.md +++ b/docs/UnifiedSettings.md @@ -6,7 +6,7 @@ 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] +**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] diff --git a/docs/UnifiedTransferable.md b/docs/UnifiedTransferable.md index cdeced4..5cf70cc 100644 --- a/docs/UnifiedTransferable.md +++ b/docs/UnifiedTransferable.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency detail | [optional] -**amount** | **String** | The maximum amount that can be transferred out | [optional] +**currency** | **String** | Currency detail. | [optional] +**amount** | **String** | The maximum amount that can be transferred out. | [optional] diff --git a/docs/UserLtvInfo.md b/docs/UserLtvInfo.md index 9577c0c..c2f0107 100644 --- a/docs/UserLtvInfo.md +++ b/docs/UserLtvInfo.md @@ -1,17 +1,17 @@ # UserLtvInfo -User's currency statistics data +User's currency statistics data. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**collateralCurrency** | **String** | Collateral | [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] -**minBorrowAmount** | **String** | Minimum borrowable amount for the loan currency | [optional] -**leftBorrowableAmount** | **String** | Remaining borrowable amount for the loan currency | [optional] +**collateralCurrency** | **String** | Collateral. | [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] +**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..b69844b 100644 --- a/docs/UserSub.md +++ b/docs/UserSub.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**uid** | **Long** | User ID | [optional] +**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] -**refUid** | **Long** | Inviter user ID | [optional] +**type** | **Long** | Type (0-not in the system 1-direct subordinate agent 2-indirect subordinate agent 3-direct customer 4-indirect direct customer 5-ordinary user) | [optional] +**refUid** | **Long** | Inviter user ID. | [optional] diff --git a/docs/UserSubRelation.md b/docs/UserSubRelation.md index 5a2eb51..00ca137 100644 --- a/docs/UserSubRelation.md +++ b/docs/UserSubRelation.md @@ -5,5 +5,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**list** | [**List<UserSub>**](UserSub.md) | Subordinate relationship list | [optional] +**list** | [**List<UserSub>**](UserSub.md) | Subordinate relationship list. | [optional] diff --git a/docs/UserTotalAmount.md b/docs/UserTotalAmount.md index e95cc61..38324ef 100644 --- a/docs/UserTotalAmount.md +++ b/docs/UserTotalAmount.md @@ -1,12 +1,12 @@ # UserTotalAmount -Total borrowed amount and pledged collateral amount by the user +Total borrowed amount and pledged collateral amount by the user. ## 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, calculated in USDT. | [optional] +**collateralAmount** | **String** | Total collateral amount, calculated in USDT. | [optional] diff --git a/docs/WalletApi.md b/docs/WalletApi.md index bf90110..bfd8d24 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 -[**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 -[**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 -[**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 -[**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 +[**listCurrencyChains**](WalletApi.md#listCurrencyChains) | **GET** /wallet/currency_chains | List 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. +[**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. +[**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. +[**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. # **listCurrencyChains** > List<CurrencyChain> listCurrencyChains(currency) -List chains supported for specified currency +List chains supported for specified currency. ### Example @@ -50,7 +50,7 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); WalletApi apiInstance = new WalletApi(defaultClient); - String currency = "GT"; // String | Currency name + String currency = "GT"; // String | Currency name. try { List result = apiInstance.listCurrencyChains(currency); System.out.println(result); @@ -71,7 +71,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Currency name | + **currency** | **String**| Currency name. | ### Return type @@ -89,13 +89,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **getDepositAddress** > DepositAddress getDepositAddress(currency) -Generate currency deposit address +Generate currency deposit address. ### Example @@ -118,7 +118,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); WalletApi apiInstance = new WalletApi(defaultClient); - String currency = "USDT"; // String | Currency name + String currency = "USDT"; // String | Currency name. try { DepositAddress result = apiInstance.getDepositAddress(currency); System.out.println(result); @@ -139,7 +139,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Currency name | + **currency** | **String**| Currency name. | ### Return type @@ -157,15 +157,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Address successfully generated | - | +**200** | Address successfully generated. | - | # **listWithdrawals** > List<WithdrawalRecord> listWithdrawals().currency(currency).withdrawId(withdrawId).assetClass(assetClass).withdrawOrderId(withdrawOrderId).from(from).to(to).limit(limit).offset(offset).execute(); -Retrieve withdrawal records +Retrieve withdrawal records. -Record time range cannot exceed 30 days +Record time range cannot exceed 30 days. ### Example @@ -188,14 +188,14 @@ 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 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 - Integer offset = 0; // Integer | List offset, starting from 0 + 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. + Integer offset = 0; // Integer | List offset, starting from 0. try { List result = apiInstance.listWithdrawals() .currency(currency) @@ -225,14 +225,14 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Filter by currency. Return all currency records if not specified | [optional] + **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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **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] + **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. | - | # **listDeposits** > List<DepositRecord> listDeposits().currency(currency).from(from).to(to).limit(limit).offset(offset).execute(); -Retrieve deposit records +Retrieve deposit records. -Record time range cannot exceed 30 days +Record time range cannot exceed 30 days. ### Example @@ -281,11 +281,11 @@ 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 + 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. - Integer offset = 0; // Integer | List offset, starting from 0 + Integer offset = 0; // Integer | List offset, starting from 0. try { List result = apiInstance.listDeposits() .currency(currency) @@ -312,11 +312,11 @@ 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] + **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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] ### Return type @@ -334,15 +334,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **transfer** > TransactionID transfer(transfer) -Transfer between trading accounts +Transfer between trading accounts. -Transfer between different accounts. Currently support transfers between the following: 1. spot - margin 2. spot - futures(perpetual) 3. spot - delivery 4. spot - options +Transfer between different accounts. Currently support transfers between the following: 1. spot - margin 2. spot - futures(perpetual) 3. options ### Example @@ -404,13 +404,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Balance transferred | - | +**200** | Balance transferred. | - | # **listSubAccountTransfers** > List<SubAccountTransferRecordItem> listSubAccountTransfers().subUid(subUid).from(from).to(to).limit(limit).offset(offset).execute(); -Retrieve transfer records between main and sub accounts +Retrieve transfer records between main and sub accounts. Record time range cannot exceed 30 days > Note: only records after 20-04-10can be retrieved @@ -436,10 +436,10 @@ public class Example { 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 - Integer offset = 0; // Integer | List offset, starting from 0 + 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. + Integer offset = 0; // Integer | List offset, starting from 0. try { List result = apiInstance.listSubAccountTransfers() .subUid(subUid) @@ -467,10 +467,10 @@ 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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **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] + **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] ### Return type @@ -488,13 +488,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **transferWithSubAccount** > TransactionID transferWithSubAccount(subAccountTransfer) -Transfer between main and sub accounts +Transfer between main and sub accounts. Support transferring with sub user's spot or futures account. Note that only main user's spot account is used no matter which sub user's account is operated. @@ -558,15 +558,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Balance transferred | - | +**200** | Balance transferred. | - | # **subAccountToSubAccount** > TransactionID subAccountToSubAccount(subAccountToSubAccount) -Sub-account transfers to sub-account +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. +It is possible to perform balance transfers between two sub-accounts under the same main account. You can use either the API Key of the main account sub-account to initiate the transfer. ### Example @@ -628,13 +628,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Balance transferred | - | +**200** | Balance transferred. | - | # **getTransferOrderStatus** > TransferOrderStatus getTransferOrderStatus().clientOrderId(clientOrderId).txId(txId).execute(); -Transfer status query +Transfer status query. Support querying transfer status based on user-defined client_order_id or tx_id returned by the transfer interface @@ -703,13 +703,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Transfer status obtained successfully | - | +**200** | Transfer status obtained successfully. | - | # **listWithdrawStatus** > List<WithdrawStatus> listWithdrawStatus().currency(currency).execute(); -Retrieve withdrawal status +Retrieve 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 | Retrieve data of the specified currency. 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**| Retrieve data of the specified currency. | [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. | - | # **listSubAccountBalances** > List<SubAccountBalance> listSubAccountBalances().subUid(subUid).execute(); -Retrieve sub account balances +Retrieve sub account balances. ### Example @@ -843,13 +843,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **listSubAccountMarginBalances** > List<SubAccountMarginBalance> listSubAccountMarginBalances().subUid(subUid).execute(); -Query sub accounts' margin balances +Query sub accounts' margin balances. ### Example @@ -913,13 +913,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **listSubAccountFuturesBalances** > List<SubAccountFuturesBalance> listSubAccountFuturesBalances().subUid(subUid).settle(settle).execute(); -Query sub accounts' futures account balances +Query sub accounts' futures account balances. ### Example @@ -943,7 +943,7 @@ public class Example { 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 settle = "usdt"; // String | Query only balances of specified settle currency. try { List result = apiInstance.listSubAccountFuturesBalances() .subUid(subUid) @@ -968,7 +968,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] - **settle** | **String**| Query only balances of specified settle currency | [optional] + **settle** | **String**| Query only balances of specified settle 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. | - | # **listSubAccountCrossMarginBalances** > List<SubAccountCrossMarginBalance> listSubAccountCrossMarginBalances().subUid(subUid).execute(); -Query subaccount's cross_margin account info +Query subaccount's cross_margin account info. ### Example @@ -1056,13 +1056,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved | - | +**200** | List retrieved. | - | # **listSavedAddress** > List<SavedAddress> listSavedAddress(currency).chain(chain).limit(limit).page(page).execute(); -Query saved address +Query saved address. ### Example @@ -1085,10 +1085,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 - Integer page = 1; // Integer | Page number + String currency = "USDT"; // String | Currency. + String chain = "\"\""; // String | Chain name. + String limit = "\"50\""; // String | Maximum number returned, 100 at most. + Integer page = 1; // Integer | Page number. try { List result = apiInstance.listSavedAddress(currency) .chain(chain) @@ -1113,10 +1113,10 @@ public class Example { 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"] - **page** | **Integer**| Page number | [optional] [default to 1] + **currency** | **String**| Currency. | + **chain** | **String**| Chain name. | [optional] [default to ""] + **limit** | **String**| Maximum number returned, 100 at most. | [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. | - | # **getTradeFee** > TradeFee getTradeFee().currencyPair(currencyPair).settle(settle).execute(); -Retrieve personal trading fee +Retrieve personal trading fee. ### Example @@ -1207,15 +1207,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved | - | +**200** | Successfully retrieved. | - | # **getTotalBalance** > TotalBalance getTotalBalance().currency(currency).execute(); -Retrieve user's total balances +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 +This endpoint returns an approximate sum of exchanged amount from all currencies to input currency for each account.The exchange rate and account balance could have been cached for at most 1 minute. It is not recommended to use its result for any trading calculation. For trading calculation, use the corresponding account query endpoint for each account type. For example: - `GET /spot/accounts` to query spot account balance - `GET /margin/accounts` /futures/{settle}/accounts` to query futures account balance ### Example @@ -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 is successfully responded. | - | # **listSmallBalance** > List<SmallBalance> listSmallBalance() -List small balance +List small balance. ### Example @@ -1343,13 +1343,13 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | Success. | - | # **convertSmallBalance** > convertSmallBalance(convertSmallBalance) -Convert small balance +Convert small balance. ### Example @@ -1410,13 +1410,13 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | Success. | - | # **listSmallBalanceHistory** > List<SmallBalanceHistory> listSmallBalanceHistory().currency(currency).page(page).limit(limit).execute(); -List small balance history +List small balance 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 - Integer page = 1; // Integer | Page number - Integer limit = 100; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 100 + String currency = "currency_example"; // String | Currency. + Integer page = 1; // Integer | Page number. + Integer limit = 100; // Integer | Maximum response items. 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] - **page** | **Integer**| Page number | [optional] [default to 1] - **limit** | **Integer**| Maximum response items. Default: 100, minimum: 1, Maximum: 100 | [optional] [default to 100] + **currency** | **String**| 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] ### Return type @@ -1486,13 +1486,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | Success. | - | # **listPushOrders** > List<UidPushOrder> listPushOrders().id(id).from(from).to(to).limit(limit).offset(offset).transactionType(transactionType).execute(); -Retrieve the UID transfer history +Retrieve the UID transfer history. ### Example @@ -1515,11 +1515,11 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); WalletApi apiInstance = new WalletApi(defaultClient); - Integer id = 56; // Integer | Order ID + 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 offset = 0; // Integer | List offset, starting from 0 + Integer limit = 100; // Integer | The maximum number of items returned in the list, the 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`. try { List result = apiInstance.listPushOrders() @@ -1548,11 +1548,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **Integer**| Order ID | [optional] + **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] - **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **limit** | **Integer**| The maximum number of items returned in the list, the 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"] ### Return type @@ -1571,5 +1571,5 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success | - | +**200** | Success. | - | diff --git a/docs/WithdrawStatus.md b/docs/WithdrawStatus.md index 953e781..9dbcb39 100644 --- a/docs/WithdrawStatus.md +++ b/docs/WithdrawStatus.md @@ -5,16 +5,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency | [optional] -**name** | **String** | Currency name | [optional] -**nameCn** | **String** | Currency Chinese name | [optional] -**deposit** | **String** | Deposits fee | [optional] -**withdrawPercent** | **String** | Withdrawal fee rate percentage | [optional] -**withdrawFix** | **String** | Fixed withdrawal fee | [optional] -**withdrawDayLimit** | **String** | Daily allowed withdrawal amount | [optional] -**withdrawAmountMini** | **String** | Minimum withdrawal amount | [optional] -**withdrawDayLimitRemain** | **String** | Daily withdrawal amount left | [optional] -**withdrawEachtimeLimit** | **String** | Maximum amount for each withdrawal | [optional] -**withdrawFixOnChains** | **Map<String, String>** | Fixed withdrawal fee on multiple chains | [optional] -**withdrawPercentOnChains** | **Map<String, String>** | Percentage withdrawal fee on multiple chains | [optional] +**currency** | **String** | Currency. | [optional] +**name** | **String** | Currency name. | [optional] +**nameCn** | **String** | Currency Chinese name. | [optional] +**deposit** | **String** | Deposits fee. | [optional] +**withdrawPercent** | **String** | Withdrawal fee rate percentage. | [optional] +**withdrawFix** | **String** | Fixed withdrawal fee. | [optional] +**withdrawDayLimit** | **String** | Daily allowed withdrawal amount. | [optional] +**withdrawAmountMini** | **String** | Minimum withdrawal amount. | [optional] +**withdrawDayLimitRemain** | **String** | Daily withdrawal amount left. | [optional] +**withdrawEachtimeLimit** | **String** | Maximum amount for each withdrawal. | [optional] +**withdrawFixOnChains** | **Map<String, String>** | Fixed withdrawal fee on multiple chains. | [optional] +**withdrawPercentOnChains** | **Map<String, String>** | Percentage withdrawal fee on multiple chains. | [optional] diff --git a/docs/WithdrawalApi.md b/docs/WithdrawalApi.md index c1d76ab..5734e66 100644 --- a/docs/WithdrawalApi.md +++ b/docs/WithdrawalApi.md @@ -4,16 +4,16 @@ All URIs are relative to *https://api.gateio.ws/api/v4* Method | HTTP request | Description ------------- | ------------- | ------------- -[**withdraw**](WithdrawalApi.md#withdraw) | **POST** /withdrawals | Withdraw -[**withdrawPushOrder**](WithdrawalApi.md#withdrawPushOrder) | **POST** /withdrawals/push | UID transfer -[**cancelWithdrawal**](WithdrawalApi.md#cancelWithdrawal) | **DELETE** /withdrawals/{withdrawal_id} | Cancel withdrawal with specified ID +[**withdraw**](WithdrawalApi.md#withdraw) | **POST** /withdrawals | Withdraw. +[**withdrawPushOrder**](WithdrawalApi.md#withdrawPushOrder) | **POST** /withdrawals/push | UID transfer. +[**cancelWithdrawal**](WithdrawalApi.md#cancelWithdrawal) | **DELETE** /withdrawals/{withdrawal_id} | Cancel withdrawal with specified ID. # **withdraw** > LedgerRecord withdraw(ledgerRecord) -Withdraw +Withdraw. Withdrawals to Gate addresses do not incur transaction fees. @@ -77,13 +77,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Withdraw request is accepted. Refer to withdrawal records for status | - | +**200** | Withdraw request is accepted. Refer to withdrawal records for status. | - | # **withdrawPushOrder** > UidPushWithdrawalResp withdrawPushOrder(uidPushWithdrawal) -UID transfer +UID transfer. Transfers between main spot accounts are allowed; however, both parties cannot be sub-accounts @@ -153,7 +153,7 @@ Name | Type | Description | Notes # **cancelWithdrawal** > LedgerRecord cancelWithdrawal(withdrawalId) -Cancel withdrawal with specified ID +Cancel withdrawal with specified ID. ### Example @@ -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 accepted. Refer to record status for the cancellation result. | - | diff --git a/docs/WithdrawalRecord.md b/docs/WithdrawalRecord.md index db7a2a9..eb20f50 100644 --- a/docs/WithdrawalRecord.md +++ b/docs/WithdrawalRecord.md @@ -5,18 +5,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | Record ID | [optional] [readonly] -**txid** | **String** | Hash record of the withdrawal | [optional] [readonly] -**blockNumber** | **String** | Block Number | [optional] [readonly] +**id** | **String** | Record ID. | [optional] [readonly] +**txid** | **String** | Hash record of the withdrawal. | [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 | -**fee** | **String** | fee | [optional] [readonly] -**currency** | **String** | Currency name | -**address** | **String** | Withdrawal address | [optional] +**timestamp** | **String** | Operation time. | [optional] [readonly] +**amount** | **String** | Currency 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] -**memo** | **String** | Additional remarks with regards to the withdrawal | [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 | [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 | +**chain** | **String** | Name of the chain used in withdrawals. | diff --git a/pom.xml b/pom.xml index 5321e32..151864f 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ gate-api jar gate-api - 6.102.1 + 6.102.6 https://github.com/gateio/gateapi-java.git Java client for gateapi diff --git a/src/main/java/io/gate/gateapi/ApiClient.java b/src/main/java/io/gate/gateapi/ApiClient.java index cced6ac..3d57bef 100644 --- a/src/main/java/io/gate/gateapi/ApiClient.java +++ b/src/main/java/io/gate/gateapi/ApiClient.java @@ -113,7 +113,7 @@ private void init() { json = new JSON(); // Set default User-Agent. - setUserAgent("OpenAPI-Generator/6.102.1/java"); + setUserAgent("OpenAPI-Generator/6.102.6/java"); authentications = new HashMap(); } diff --git a/src/main/java/io/gate/gateapi/api/AccountApi.java b/src/main/java/io/gate/gateapi/api/AccountApi.java index d58c1d9..91d372a 100644 --- a/src/main/java/io/gate/gateapi/api/AccountApi.java +++ b/src/main/java/io/gate/gateapi/api/AccountApi.java @@ -59,7 +59,7 @@ public void setApiClient(ApiClient apiClient) { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ public okhttp3.Call getAccountDetailCall(final ApiCallback _callback) throws ApiException { @@ -98,14 +98,14 @@ private okhttp3.Call getAccountDetailValidateBeforeCall(final ApiCallback _callb } /** - * Get account detail + * Get account detail. * * @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 Successful. -
*/ public AccountDetail getAccountDetail() throws ApiException { @@ -114,14 +114,14 @@ public AccountDetail getAccountDetail() throws ApiException { } /** - * Get account detail + * Get account detail. * * @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 Successful. -
*/ public ApiResponse getAccountDetailWithHttpInfo() throws ApiException { @@ -131,7 +131,7 @@ public ApiResponse getAccountDetailWithHttpInfo() throws ApiExcep } /** - * Get account detail (asynchronously) + * Get account detail. (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 Successful. -
*/ 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 Successful. -
*/ public okhttp3.Call getAccountRateLimitCall(final ApiCallback _callback) throws ApiException { @@ -196,14 +196,14 @@ private okhttp3.Call getAccountRateLimitValidateBeforeCall(final ApiCallback _ca } /** - * Get user transaction rate limit information + * Get user transaction rate limit information. * * @return List<AccountRateLimit> * @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 Successful. -
*/ public List getAccountRateLimit() throws ApiException { @@ -212,14 +212,14 @@ public List getAccountRateLimit() throws ApiException { } /** - * Get user transaction rate limit information + * Get user transaction rate limit information. * * @return ApiResponse<List<AccountRateLimit>> * @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 Successful. -
*/ public ApiResponse> getAccountRateLimitWithHttpInfo() throws ApiException { @@ -229,7 +229,7 @@ public ApiResponse> getAccountRateLimitWithHttpInfo() thr } /** - * Get user transaction rate limit information (asynchronously) + * Get user transaction rate limit information. (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -237,7 +237,7 @@ public ApiResponse> getAccountRateLimitWithHttpInfo() thr * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ 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 Perform a fuzzy search based on the 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. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ 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 + * List STP Groups. + * Retrieve the list of STP groups created by the main account user only. * @return APIlistSTPGroupsRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistSTPGroupsRequest listSTPGroups() { @@ -443,8 +443,8 @@ private okhttp3.Call createSTPGroupValidateBeforeCall(StpGroup stpGroup, final A } /** - * Create STP Group - * Only the main account is allowed to create a new STP user group + * Create STP Group. + * Only the main account is allowed to create a new STP user group. * @param stpGroup (required) * @return StpGroup * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -460,8 +460,8 @@ public StpGroup createSTPGroup(StpGroup stpGroup) throws ApiException { } /** - * Create STP Group - * Only the main account is allowed to create a new STP user group + * Create STP Group. + * Only the main account is allowed to create a new STP user group. * @param stpGroup (required) * @return ApiResponse<StpGroup> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -478,8 +478,8 @@ public ApiResponse createSTPGroupWithHttpInfo(StpGroup stpGroup) throw } /** - * Create STP Group (asynchronously) - * Only the main account is allowed to create a new STP user group + * Create STP 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 * @return The request call @@ -499,14 +499,14 @@ public okhttp3.Call createSTPGroupAsync(StpGroup stpGroup, final ApiCallback Status Code Description Response Headers - 200 List retrieved - + 200 List retrieved. - */ 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 can query the account - * @param stpId STP Group ID (required) + * List users of the STP group. + * Only the main account that created this STP group can query the account. + * @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. -
*/ 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 can query the account - * @param stpId STP Group ID (required) + * List users of the STP group. + * Only the main account that created this STP group can query the account. + * @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. -
*/ public ApiResponse> listSTPGroupsUsersWithHttpInfo(Long stpId) throws ApiException { @@ -586,16 +586,16 @@ public ApiResponse> listSTPGroupsUsersWithHttpInfo(Long stpId } /** - * List users of the STP group (asynchronously) - * Only the main account that created this STP group can query the account - * @param stpId STP Group ID (required) + * List users of the STP group. (asynchronously) + * Only the main account that created this STP group can query the account. + * @param stpId STP Group 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. -
*/ public okhttp3.Call listSTPGroupsUsersAsync(Long stpId, final ApiCallback> _callback) throws ApiException { @@ -607,8 +607,8 @@ public okhttp3.Call listSTPGroupsUsersAsync(Long stpId, final ApiCallback 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 - * @param stpId STP Group ID (required) - * @param requestBody User ID (required) + * Add users to the STP group. + * - Only the master account that created the STP user group is allowed to add users group.- Only accounts under the main account are allowed to be added. Cross-account is not permitted + * @param stpId STP Group ID. (required) + * @param requestBody User 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 @@ -683,10 +683,10 @@ 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 - * @param stpId STP Group ID (required) - * @param requestBody User ID (required) + * Add users to the STP group. + * - Only the master account that created the STP user group is allowed to add users group.- Only accounts under the main account are allowed to be added. Cross-account is not permitted + * @param stpId STP Group ID. (required) + * @param requestBody User 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 @@ -702,10 +702,10 @@ 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 - * @param stpId STP Group ID (required) - * @param requestBody User ID (required) + * Add users to the STP group. (asynchronously) + * - Only the master account that created the STP user group is allowed to add users group.- Only accounts under the main account are allowed to be added. Cross-account is not permitted + * @param stpId STP Group ID. (required) + * @param requestBody 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 @@ -724,15 +724,15 @@ 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 stpId STP Group ID. (required) + * @param userId STP user ID, multiple 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 Success. -
*/ 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 the user in the STP 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 stpId STP Group ID. (required) + * @param userId STP user ID, multiple 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 Success. -
*/ 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 the user in the STP 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 stpId STP Group ID. (required) + * @param userId STP user ID, multiple 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 Success. -
*/ 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 the user in the STP 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 stpId STP Group ID. (required) + * @param userId STP user ID, multiple 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 Success. -
*/ public okhttp3.Call deleteSTPGroupUsersAsync(Long stpId, Long userId, final ApiCallback> _callback) throws ApiException { @@ -851,7 +851,7 @@ public okhttp3.Call deleteSTPGroupUsersAsync(Long stpId, Long userId, final ApiC * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Success. -
*/ public okhttp3.Call getDebitFeeCall(final ApiCallback _callback) throws ApiException { @@ -897,7 +897,7 @@ private okhttp3.Call getDebitFeeValidateBeforeCall(final ApiCallback _callback) * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Success. -
*/ public DebitFee getDebitFee() throws ApiException { @@ -913,7 +913,7 @@ public DebitFee getDebitFee() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Success. -
*/ public ApiResponse getDebitFeeWithHttpInfo() throws ApiException { @@ -931,7 +931,7 @@ public ApiResponse getDebitFeeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Success. -
*/ public okhttp3.Call getDebitFeeAsync(final ApiCallback _callback) throws ApiException { @@ -950,7 +950,7 @@ public okhttp3.Call getDebitFeeAsync(final ApiCallback _callback) thro * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Success. -
*/ public okhttp3.Call setDebitFeeCall(DebitFee debitFee, final ApiCallback _callback) throws ApiException { @@ -1001,7 +1001,7 @@ private okhttp3.Call setDebitFeeValidateBeforeCall(DebitFee debitFee, final ApiC * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Success. -
*/ public void setDebitFee(DebitFee debitFee) throws ApiException { @@ -1017,7 +1017,7 @@ public void setDebitFee(DebitFee debitFee) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Success. -
*/ public ApiResponse setDebitFeeWithHttpInfo(DebitFee debitFee) throws ApiException { @@ -1035,7 +1035,7 @@ public ApiResponse setDebitFeeWithHttpInfo(DebitFee debitFee) throws ApiEx * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Success. -
*/ public okhttp3.Call setDebitFeeAsync(DebitFee debitFee, final ApiCallback _callback) throws ApiException { diff --git a/src/main/java/io/gate/gateapi/api/CollateralLoanApi.java b/src/main/java/io/gate/gateapi/api/CollateralLoanApi.java index 726261a..e06c5e0 100644 --- a/src/main/java/io/gate/gateapi/api/CollateralLoanApi.java +++ b/src/main/java/io/gate/gateapi/api/CollateralLoanApi.java @@ -133,7 +133,7 @@ private APIlistCollateralLoanOrdersRequest() { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistCollateralLoanOrdersRequest */ public APIlistCollateralLoanOrdersRequest page(Integer page) { @@ -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 to be 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. (optional) * @return APIlistCollateralLoanOrdersRequest */ public APIlistCollateralLoanOrdersRequest collateralCurrency(String collateralCurrency) { @@ -163,7 +163,7 @@ public APIlistCollateralLoanOrdersRequest collateralCurrency(String collateralCu /** * Set borrowCurrency - * @param borrowCurrency Borrowed currency (optional) + * @param borrowCurrency Borrowed currency. (optional) * @return APIlistCollateralLoanOrdersRequest */ public APIlistCollateralLoanOrdersRequest borrowCurrency(String borrowCurrency) { @@ -179,7 +179,7 @@ public APIlistCollateralLoanOrdersRequest borrowCurrency(String borrowCurrency) * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -232,13 +232,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callb } /** - * List Orders + * List Orders. * * @return APIlistCollateralLoanOrdersRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistCollateralLoanOrdersRequest listCollateralLoanOrders() { @@ -254,7 +254,7 @@ public APIlistCollateralLoanOrdersRequest listCollateralLoanOrders() { * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Success. -
*/ public okhttp3.Call createCollateralLoanCall(CreateCollateralOrder createCollateralOrder, final ApiCallback _callback) throws ApiException { @@ -298,7 +298,7 @@ private okhttp3.Call createCollateralLoanValidateBeforeCall(CreateCollateralOrde } /** - * Place order + * Place 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 Success. -
*/ public OrderResp createCollateralLoan(CreateCollateralOrder createCollateralOrder) throws ApiException { @@ -315,7 +315,7 @@ public OrderResp createCollateralLoan(CreateCollateralOrder createCollateralOrde } /** - * Place order + * Place 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 Success. -
*/ public ApiResponse createCollateralLoanWithHttpInfo(CreateCollateralOrder createCollateralOrder) throws ApiException { @@ -333,7 +333,7 @@ public ApiResponse createCollateralLoanWithHttpInfo(CreateCollateralO } /** - * Place order (asynchronously) + * Place 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 Success. -
*/ 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 on successful order creation. (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 Success. -
*/ 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 + * Get a single order. * - * @param orderId Order ID returned on successful order creation (required) + * @param orderId Order ID returned on successful order creation. (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 Success. -
*/ public CollateralOrder getCollateralLoanOrderDetail(Long orderId) throws ApiException { @@ -423,15 +423,15 @@ public CollateralOrder getCollateralLoanOrderDetail(Long orderId) throws ApiExce } /** - * Get a single order + * Get a single order. * - * @param orderId Order ID returned on successful order creation (required) + * @param orderId Order ID returned on successful order creation. (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 Success. -
*/ public ApiResponse getCollateralLoanOrderDetailWithHttpInfo(Long orderId) throws ApiException { @@ -441,16 +441,16 @@ public ApiResponse getCollateralLoanOrderDetailWithHttpInfo(Lon } /** - * Get a single order (asynchronously) + * Get a single order. (asynchronously) * - * @param orderId Order ID returned on successful order creation (required) + * @param orderId Order ID returned on successful order creation. (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 Success. -
*/ 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 Operated successfully. -
*/ public okhttp3.Call repayCollateralLoanCall(RepayLoan repayLoan, final ApiCallback _callback) throws ApiException { @@ -513,7 +513,7 @@ private okhttp3.Call repayCollateralLoanValidateBeforeCall(RepayLoan repayLoan, } /** - * Repayment + * 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 Operated successfully. -
*/ public RepayResp repayCollateralLoan(RepayLoan repayLoan) throws ApiException { @@ -530,7 +530,7 @@ public RepayResp repayCollateralLoan(RepayLoan repayLoan) throws ApiException { } /** - * Repayment + * 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 Operated successfully. -
*/ public ApiResponse repayCollateralLoanWithHttpInfo(RepayLoan repayLoan) throws ApiException { @@ -548,7 +548,7 @@ public ApiResponse repayCollateralLoanWithHttpInfo(RepayLoan repayLoa } /** - * Repayment (asynchronously) + * 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 Operated successfully. -
*/ public okhttp3.Call repayCollateralLoanAsync(RepayLoan repayLoan, final ApiCallback _callback) throws ApiException { @@ -664,7 +664,7 @@ private APIlistRepayRecordsRequest(String source) { /** * Set borrowCurrency - * @param borrowCurrency Borrowed currency (optional) + * @param borrowCurrency Borrowed currency. (optional) * @return APIlistRepayRecordsRequest */ public APIlistRepayRecordsRequest borrowCurrency(String borrowCurrency) { @@ -674,7 +674,7 @@ public APIlistRepayRecordsRequest borrowCurrency(String borrowCurrency) { /** * Set collateralCurrency - * @param collateralCurrency Collateral (optional) + * @param collateralCurrency Collateral. (optional) * @return APIlistRepayRecordsRequest */ public APIlistRepayRecordsRequest collateralCurrency(String collateralCurrency) { @@ -684,7 +684,7 @@ public APIlistRepayRecordsRequest collateralCurrency(String collateralCurrency) /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistRepayRecordsRequest */ public APIlistRepayRecordsRequest page(Integer page) { @@ -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 to be 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 of 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 Time range ending, default to current time. (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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -783,14 +783,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) } /** - * Repayment history + * Repayment history. * - * @param source Operation type: repay - Regular repayment, liquidate - Liquidation (required) + * @param source Operation type: repay - Regular repayment, liquidate - Liquidation. (required) * @return APIlistRepayRecordsRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public APIlistRepayRecordsRequest listRepayRecords(String source) { @@ -883,7 +883,7 @@ private APIlistCollateralRecordsRequest() { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistCollateralRecordsRequest */ public APIlistCollateralRecordsRequest page(Integer page) { @@ -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 to be 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 of 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 Time range ending, default to current time. (optional) * @return APIlistCollateralRecordsRequest */ public APIlistCollateralRecordsRequest to(Long to) { @@ -923,7 +923,7 @@ public APIlistCollateralRecordsRequest to(Long to) { /** * Set borrowCurrency - * @param borrowCurrency Borrowed currency (optional) + * @param borrowCurrency Borrowed currency. (optional) * @return APIlistCollateralRecordsRequest */ public APIlistCollateralRecordsRequest borrowCurrency(String borrowCurrency) { @@ -933,7 +933,7 @@ public APIlistCollateralRecordsRequest borrowCurrency(String borrowCurrency) { /** * Set collateralCurrency - * @param collateralCurrency Collateral (optional) + * @param collateralCurrency Collateral. (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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1002,13 +1002,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _call } /** - * Query collateral adjustment records + * Query collateral adjustment records. * * @return APIlistCollateralRecordsRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public APIlistCollateralRecordsRequest listCollateralRecords() { @@ -1024,7 +1024,7 @@ public APIlistCollateralRecordsRequest listCollateralRecords() { * @http.response.details - +
Status Code Description Response Headers
204 Operated successfully -
204 Operated successfully. -
*/ public okhttp3.Call operateCollateralCall(CollateralAlign collateralAlign, final ApiCallback _callback) throws ApiException { @@ -1068,14 +1068,14 @@ private okhttp3.Call operateCollateralValidateBeforeCall(CollateralAlign collate } /** - * Increase or redeem collateral + * Increase or redeem collateral. * * @param collateralAlign (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 Operated successfully. -
*/ public void operateCollateral(CollateralAlign collateralAlign) throws ApiException { @@ -1083,7 +1083,7 @@ public void operateCollateral(CollateralAlign collateralAlign) throws ApiExcepti } /** - * Increase or redeem collateral + * Increase or redeem collateral. * * @param collateralAlign (required) * @return ApiResponse<Void> @@ -1091,7 +1091,7 @@ public void operateCollateral(CollateralAlign collateralAlign) throws ApiExcepti * @http.response.details - +
Status Code Description Response Headers
204 Operated successfully -
204 Operated successfully. -
*/ public ApiResponse operateCollateralWithHttpInfo(CollateralAlign collateralAlign) throws ApiException { @@ -1100,7 +1100,7 @@ public ApiResponse operateCollateralWithHttpInfo(CollateralAlign collatera } /** - * Increase or redeem collateral (asynchronously) + * Increase or redeem collateral. (asynchronously) * * @param collateralAlign (required) * @param _callback The callback to be executed when the API call finishes @@ -1109,7 +1109,7 @@ public ApiResponse operateCollateralWithHttpInfo(CollateralAlign collatera * @http.response.details - +
Status Code Description Response Headers
204 Operated successfully -
204 Operated successfully. -
*/ 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 Successfully retrieved. -
*/ 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 the total borrowing and collateral amount for the user. * * @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 Successfully retrieved. -
*/ 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 the total borrowing and collateral amount for the user. * * @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 Successfully retrieved. -
*/ 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 the total borrowing and collateral amount for the user. (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 Successfully retrieved. -
*/ public okhttp3.Call getUserTotalAmountAsync(final ApiCallback _callback) throws ApiException { @@ -1218,15 +1218,15 @@ public okhttp3.Call getUserTotalAmountAsync(final ApiCallback _ /** * Build call for getUserLtvInfo - * @param collateralCurrency Collateral (required) - * @param borrowCurrency Borrowed currency (required) + * @param collateralCurrency Collateral. (required) + * @param borrowCurrency Borrowed 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 -
200 Successfully retrieved. -
*/ 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. * - * @param collateralCurrency Collateral (required) - * @param borrowCurrency Borrowed currency (required) + * @param collateralCurrency Collateral. (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 Successfully retrieved. -
*/ 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. * - * @param collateralCurrency Collateral (required) - * @param borrowCurrency Borrowed currency (required) + * @param collateralCurrency Collateral. (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 Successfully retrieved. -
*/ public ApiResponse getUserLtvInfoWithHttpInfo(String collateralCurrency, String borrowCurrency) throws ApiException { @@ -1320,17 +1320,17 @@ public ApiResponse getUserLtvInfoWithHttpInfo(String collateralCurr } /** - * Query user's collateralization ratio (asynchronously) + * Query user's collateralization ratio. (asynchronously) * - * @param collateralCurrency Collateral (required) - * @param borrowCurrency Borrowed currency (required) + * @param collateralCurrency Collateral. (required) + * @param borrowCurrency Borrowed 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 -
200 Successfully retrieved. -
*/ public okhttp3.Call getUserLtvInfoAsync(String collateralCurrency, String borrowCurrency, final ApiCallback _callback) throws ApiException { @@ -1417,7 +1417,7 @@ public APIlistCollateralCurrenciesRequest loanCurrency(String loanCurrency) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1470,13 +1470,13 @@ public okhttp3.Call executeAsync(final ApiCallback> } /** - * Query supported borrowing and collateral currencies + * Query supported borrowing and collateral currencies. * * @return APIlistCollateralCurrenciesRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ 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 6ce0d04..b635679 100644 --- a/src/main/java/io/gate/gateapi/api/DeliveryApi.java +++ b/src/main/java/io/gate/gateapi/api/DeliveryApi.java @@ -65,14 +65,14 @@ public void setApiClient(ApiClient apiClient) { /** * Build call for listDeliveryContracts - * @param settle Settle currency (required) + * @param settle Settle 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 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call listDeliveryContractsCall(String settle, final ApiCallback _callback) throws ApiException { @@ -117,15 +117,15 @@ private okhttp3.Call listDeliveryContractsValidateBeforeCall(String settle, fina } /** - * List all futures contracts + * List all futures contracts. * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @return List<DeliveryContract> * @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. -
*/ public List listDeliveryContracts(String settle) throws ApiException { @@ -134,15 +134,15 @@ public List listDeliveryContracts(String settle) throws ApiExc } /** - * List all futures contracts + * List all futures contracts. * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @return ApiResponse<List<DeliveryContract>> * @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. -
*/ public ApiResponse> listDeliveryContractsWithHttpInfo(String settle) throws ApiException { @@ -152,16 +152,16 @@ public ApiResponse> listDeliveryContractsWithHttpInfo(Str } /** - * List all futures contracts (asynchronously) + * List all futures contracts. (asynchronously) * - * @param settle Settle currency (required) + * @param settle Settle 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 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call listDeliveryContractsAsync(String settle, final ApiCallback> _callback) throws ApiException { @@ -173,15 +173,15 @@ public okhttp3.Call listDeliveryContractsAsync(String settle, final ApiCallback< /** * Build call for getDeliveryContract - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (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 Contract information -
200 Contract information. -
*/ public okhttp3.Call getDeliveryContractCall(String settle, String contract, final ApiCallback _callback) throws ApiException { @@ -232,16 +232,16 @@ private okhttp3.Call getDeliveryContractValidateBeforeCall(String settle, String } /** - * Get a single contract + * Get a single contract. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) * @return DeliveryContract * @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 Contract information -
200 Contract information. -
*/ public DeliveryContract getDeliveryContract(String settle, String contract) throws ApiException { @@ -250,16 +250,16 @@ public DeliveryContract getDeliveryContract(String settle, String contract) thro } /** - * Get a single contract + * Get a single contract. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) * @return ApiResponse<DeliveryContract> * @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 Contract information -
200 Contract information. -
*/ public ApiResponse getDeliveryContractWithHttpInfo(String settle, String contract) throws ApiException { @@ -269,17 +269,17 @@ public ApiResponse getDeliveryContractWithHttpInfo(String sett } /** - * Get a single contract (asynchronously) + * Get a single contract. (asynchronously) * - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (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 Contract information -
200 Contract information. -
*/ public okhttp3.Call getDeliveryContractAsync(String settle, String contract, final ApiCallback _callback) throws ApiException { @@ -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 Order depth. 0 means no aggregation is applied. default to 0. (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 Maximum number of order depth data in asks or bids. (optional, default to 10) * @return APIlistDeliveryOrderBookRequest */ public APIlistDeliveryOrderBookRequest limit(Integer limit) { @@ -415,7 +415,7 @@ public APIlistDeliveryOrderBookRequest withId(Boolean withId) { * @http.response.details - +
Status Code Description Response Headers
200 Depth query successful -
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 Depth query successful -
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 Depth query successful -
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 Depth query successful -
200 Depth query successful. -
*/ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -468,15 +468,15 @@ public okhttp3.Call executeAsync(final ApiCallback _callback) } /** - * Futures order book - * Bids will be sorted by price from high to low, while asks sorted reversely - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * Futures order book. + * Bids will be sorted by price from high to low, while asks sorted reversely. + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) * @return APIlistDeliveryOrderBookRequest * @http.response.details - +
Status Code Description Response Headers
200 Depth query successful -
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 to be returned in a single list. (optional, default to 100) * @return APIlistDeliveryTradesRequest */ public APIlistDeliveryTradesRequest limit(Integer limit) { @@ -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. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -677,15 +677,15 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * Futures trading history + * Futures trading history. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) * @return APIlistDeliveryTradesRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistDeliveryTradesRequest listDeliveryTrades(String settle, String contract) { @@ -797,7 +797,7 @@ public APIlistDeliveryCandlesticksRequest from(Long from) { /** * Set to - * @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 (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 specified (optional) * @return APIlistDeliveryCandlesticksRequest */ public APIlistDeliveryCandlesticksRequest to(Long to) { @@ -817,7 +817,7 @@ public APIlistDeliveryCandlesticksRequest limit(Integer limit) { /** * Set interval - * @param interval Time interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial timeweek (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 timeweek, 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -886,15 +886,15 @@ public okhttp3.Call executeAsync(final ApiCallback> _c } /** - * Get futures candlesticks + * Get futures candlesticks. * 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) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) * @return APIlistDeliveryCandlesticksRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public APIlistDeliveryCandlesticksRequest listDeliveryCandlesticks(String settle, String contract) { @@ -970,7 +970,7 @@ private APIlistDeliveryTickersRequest(String settle) { /** * Set contract - * @param contract Futures contract (optional) + * @param contract Futures contract. (optional) * @return APIlistDeliveryTickersRequest */ public APIlistDeliveryTickersRequest contract(String contract) { @@ -986,7 +986,7 @@ public APIlistDeliveryTickersRequest contract(String contract) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1039,14 +1039,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callba } /** - * List futures tickers + * List futures tickers. * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @return APIlistDeliveryTickersRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ 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 to be 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 insurance balance history. * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @return APIlistDeliveryInsuranceLedgerRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public APIlistDeliveryInsuranceLedgerRequest listDeliveryInsuranceLedger(String settle) { @@ -1207,14 +1207,14 @@ public APIlistDeliveryInsuranceLedgerRequest listDeliveryInsuranceLedger(String /** * Build call for listDeliveryAccounts - * @param settle Settle currency (required) + * @param settle Settle 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 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call listDeliveryAccountsCall(String settle, final ApiCallback _callback) throws ApiException { @@ -1259,15 +1259,15 @@ private okhttp3.Call listDeliveryAccountsValidateBeforeCall(String settle, final } /** - * Query futures account + * Query futures account. * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @return FuturesAccount * @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. -
*/ public FuturesAccount listDeliveryAccounts(String settle) throws ApiException { @@ -1276,15 +1276,15 @@ public FuturesAccount listDeliveryAccounts(String settle) throws ApiException { } /** - * Query futures account + * Query futures account. * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @return ApiResponse<FuturesAccount> * @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. -
*/ public ApiResponse listDeliveryAccountsWithHttpInfo(String settle) throws ApiException { @@ -1294,16 +1294,16 @@ public ApiResponse listDeliveryAccountsWithHttpInfo(String settl } /** - * Query futures account (asynchronously) + * Query futures account. (asynchronously) * - * @param settle Settle currency (required) + * @param settle Settle 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 List retrieved -
200 List retrieved. -
*/ 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 to be returned in a single list. (optional, default to 100) * @return APIlistDeliveryAccountBookRequest */ public APIlistDeliveryAccountBookRequest limit(Integer limit) { @@ -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 Changing Type: - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: point_fee: POINT Trading fee - point_refr: POINT Referrer rebate (optional) * @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. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1496,14 +1496,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _ca } /** - * Query account book + * Query account book. * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @return APIlistDeliveryAccountBookRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistDeliveryAccountBookRequest listDeliveryAccountBook(String settle) { @@ -1512,14 +1512,14 @@ public APIlistDeliveryAccountBookRequest listDeliveryAccountBook(String settle) /** * Build call for listDeliveryPositions - * @param settle Settle currency (required) + * @param settle Settle 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 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call listDeliveryPositionsCall(String settle, final ApiCallback _callback) throws ApiException { @@ -1564,15 +1564,15 @@ private okhttp3.Call listDeliveryPositionsValidateBeforeCall(String settle, fina } /** - * List all positions of a user + * List all positions of a user. * - * @param settle Settle currency (required) + * @param settle Settle currency. (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 List retrieved -
200 List retrieved. -
*/ public List listDeliveryPositions(String settle) throws ApiException { @@ -1581,15 +1581,15 @@ public List listDeliveryPositions(String settle) throws ApiException { } /** - * List all positions of a user + * List all positions of a user. * - * @param settle Settle currency (required) + * @param settle Settle currency. (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 List retrieved -
200 List retrieved. -
*/ public ApiResponse> listDeliveryPositionsWithHttpInfo(String settle) throws ApiException { @@ -1599,16 +1599,16 @@ public ApiResponse> listDeliveryPositionsWithHttpInfo(String sett } /** - * List all positions of a user (asynchronously) + * List all positions of a user. (asynchronously) * - * @param settle Settle currency (required) + * @param settle Settle 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 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call listDeliveryPositionsAsync(String settle, final ApiCallback> _callback) throws ApiException { @@ -1620,15 +1620,15 @@ public okhttp3.Call listDeliveryPositionsAsync(String settle, final ApiCallback< /** * Build call for getDeliveryPosition - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (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 Position information -
200 Position information. -
*/ public okhttp3.Call getDeliveryPositionCall(String settle, String contract, final ApiCallback _callback) throws ApiException { @@ -1679,16 +1679,16 @@ private okhttp3.Call getDeliveryPositionValidateBeforeCall(String settle, String } /** - * Get single position + * Get single position. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) * @return 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 Position information -
200 Position information. -
*/ public Position getDeliveryPosition(String settle, String contract) throws ApiException { @@ -1697,16 +1697,16 @@ public Position getDeliveryPosition(String settle, String contract) throws ApiEx } /** - * Get single position + * Get single position. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (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 - +
Status Code Description Response Headers
200 Position information -
200 Position information. -
*/ public ApiResponse getDeliveryPositionWithHttpInfo(String settle, String contract) throws ApiException { @@ -1716,17 +1716,17 @@ public ApiResponse getDeliveryPositionWithHttpInfo(String settle, Stri } /** - * Get single position (asynchronously) + * Get single position. (asynchronously) * - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (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 Position information -
200 Position information. -
*/ public okhttp3.Call getDeliveryPositionAsync(String settle, String contract, final ApiCallback _callback) throws ApiException { @@ -1738,16 +1738,16 @@ 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 amount, positive number increases, negative number (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) + * @param change Margin change amount, positive number increases, negative number. (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 Position information -
200 Position information. -
*/ public okhttp3.Call updateDeliveryPositionMarginCall(String settle, String contract, String change, final ApiCallback _callback) throws ApiException { @@ -1807,17 +1807,17 @@ private okhttp3.Call updateDeliveryPositionMarginValidateBeforeCall(String settl } /** - * Update position margin + * Update position margin. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param change Margin change amount, positive number increases, negative number (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) + * @param change Margin change amount, positive number increases, negative number. (required) * @return 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 Position information -
200 Position information. -
*/ public Position updateDeliveryPositionMargin(String settle, String contract, String change) throws ApiException { @@ -1826,17 +1826,17 @@ public Position updateDeliveryPositionMargin(String settle, String contract, Str } /** - * Update position margin + * Update position margin. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param change Margin change amount, positive number increases, negative number (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) + * @param change Margin change amount, positive number increases, negative number. (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 - +
Status Code Description Response Headers
200 Position information -
200 Position information. -
*/ public ApiResponse updateDeliveryPositionMarginWithHttpInfo(String settle, String contract, String change) throws ApiException { @@ -1846,18 +1846,18 @@ public ApiResponse updateDeliveryPositionMarginWithHttpInfo(String set } /** - * Update position margin (asynchronously) + * Update position margin. (asynchronously) * - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param change Margin change amount, positive number increases, negative number (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) + * @param change Margin change amount, positive number increases, negative number. (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 Position information -
200 Position information. -
*/ public okhttp3.Call updateDeliveryPositionMarginAsync(String settle, String contract, String change, final ApiCallback _callback) throws ApiException { @@ -1869,16 +1869,16 @@ public okhttp3.Call updateDeliveryPositionMarginAsync(String settle, String cont /** * Build call for updateDeliveryPositionLeverage - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param leverage New position leverage (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) + * @param leverage New position leverage. (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 Position information -
200 Position information. -
*/ public okhttp3.Call updateDeliveryPositionLeverageCall(String settle, String contract, String leverage, final ApiCallback _callback) throws ApiException { @@ -1938,17 +1938,17 @@ private okhttp3.Call updateDeliveryPositionLeverageValidateBeforeCall(String set } /** - * Update position leverage + * Update position leverage. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param leverage New position leverage (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) + * @param leverage New position leverage. (required) * @return 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 Position information -
200 Position information. -
*/ public Position updateDeliveryPositionLeverage(String settle, String contract, String leverage) throws ApiException { @@ -1957,17 +1957,17 @@ public Position updateDeliveryPositionLeverage(String settle, String contract, S } /** - * Update position leverage + * Update position leverage. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param leverage New position leverage (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) + * @param leverage New position leverage. (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 - +
Status Code Description Response Headers
200 Position information -
200 Position information. -
*/ public ApiResponse updateDeliveryPositionLeverageWithHttpInfo(String settle, String contract, String leverage) throws ApiException { @@ -1977,18 +1977,18 @@ public ApiResponse updateDeliveryPositionLeverageWithHttpInfo(String s } /** - * Update position leverage (asynchronously) + * Update position leverage. (asynchronously) * - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param leverage New position leverage (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) + * @param leverage New position leverage. (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 Position information -
200 Position information. -
*/ public okhttp3.Call updateDeliveryPositionLeverageAsync(String settle, String contract, String leverage, final ApiCallback _callback) throws ApiException { @@ -2000,16 +2000,16 @@ public okhttp3.Call updateDeliveryPositionLeverageAsync(String settle, String co /** * Build call for updateDeliveryPositionRiskLimit - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param riskLimit New position risk limit (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) + * @param riskLimit New position risk limit. (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 Position information -
200 Position information. -
*/ public okhttp3.Call updateDeliveryPositionRiskLimitCall(String settle, String contract, String riskLimit, final ApiCallback _callback) throws ApiException { @@ -2069,17 +2069,17 @@ private okhttp3.Call updateDeliveryPositionRiskLimitValidateBeforeCall(String se } /** - * Update position risk limit + * Update position risk limit. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param riskLimit New position risk limit (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) + * @param riskLimit New position risk limit. (required) * @return 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 Position information -
200 Position information. -
*/ public Position updateDeliveryPositionRiskLimit(String settle, String contract, String riskLimit) throws ApiException { @@ -2088,17 +2088,17 @@ public Position updateDeliveryPositionRiskLimit(String settle, String contract, } /** - * Update position risk limit + * Update position risk limit. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param riskLimit New position risk limit (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) + * @param riskLimit New position risk limit. (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 - +
Status Code Description Response Headers
200 Position information -
200 Position information. -
*/ public ApiResponse updateDeliveryPositionRiskLimitWithHttpInfo(String settle, String contract, String riskLimit) throws ApiException { @@ -2108,18 +2108,18 @@ public ApiResponse updateDeliveryPositionRiskLimitWithHttpInfo(String } /** - * Update position risk limit (asynchronously) + * Update position risk limit. (asynchronously) * - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param riskLimit New position risk limit (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) + * @param riskLimit New position risk limit. (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 Position information -
200 Position information. -
*/ public okhttp3.Call updateDeliveryPositionRiskLimitAsync(String settle, String contract, String riskLimit, final ApiCallback _callback) throws ApiException { @@ -2229,7 +2229,7 @@ private APIlistDeliveryOrdersRequest(String settle, String status) { /** * Set contract - * @param contract Futures contract (optional) + * @param contract Futures contract. (optional) * @return APIlistDeliveryOrdersRequest */ public APIlistDeliveryOrdersRequest contract(String contract) { @@ -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 to be returned in a single list. (optional, default to 100) * @return APIlistDeliveryOrdersRequest */ public APIlistDeliveryOrdersRequest limit(Integer limit) { @@ -2249,7 +2249,7 @@ public APIlistDeliveryOrdersRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIlistDeliveryOrdersRequest */ public APIlistDeliveryOrdersRequest offset(Integer offset) { @@ -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. Default 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. * 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.
*/ 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. * 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.
*/ 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. * 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.
*/ 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. * 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.
*/ 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 - * @param settle Settle currency (required) - * @param status Only list the orders with this status (required) + * List futures orders. + * Zero-filled order cannot be retrieved 10 minutes after order cancellation. + * @param settle Settle currency. (required) + * @param status Only list the orders with this 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. * 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.
*/ public APIlistDeliveryOrdersRequest listDeliveryOrders(String settle, String status) { @@ -2355,7 +2355,7 @@ public APIlistDeliveryOrdersRequest listDeliveryOrders(String settle, String sta /** * Build call for createDeliveryOrder - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @param futuresOrder (required) * @param _callback Callback for upload/download progress * @return Call to execute @@ -2363,7 +2363,7 @@ public APIlistDeliveryOrdersRequest listDeliveryOrders(String settle, String sta * @http.response.details - +
Status Code Description Response Headers
201 Order details -
201 Order details. -
*/ public okhttp3.Call createDeliveryOrderCall(String settle, FuturesOrder futuresOrder, final ApiCallback _callback) throws ApiException { @@ -2413,16 +2413,16 @@ private okhttp3.Call createDeliveryOrderValidateBeforeCall(String settle, Future } /** - * Create a futures order - * Zero-filled order cannot be retrieved 10 minutes after order cancellation - * @param settle Settle currency (required) + * Create a futures order. + * Zero-filled order cannot be retrieved 10 minutes after order cancellation. + * @param settle Settle currency. (required) * @param futuresOrder (required) * @return 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
201 Order details -
201 Order details. -
*/ public FuturesOrder createDeliveryOrder(String settle, FuturesOrder futuresOrder) throws ApiException { @@ -2431,16 +2431,16 @@ public FuturesOrder createDeliveryOrder(String settle, FuturesOrder futuresOrder } /** - * Create a futures order - * Zero-filled order cannot be retrieved 10 minutes after order cancellation - * @param settle Settle currency (required) + * Create a futures order. + * Zero-filled order cannot be retrieved 10 minutes after order cancellation. + * @param settle Settle currency. (required) * @param futuresOrder (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 - +
Status Code Description Response Headers
201 Order details -
201 Order details. -
*/ public ApiResponse createDeliveryOrderWithHttpInfo(String settle, FuturesOrder futuresOrder) throws ApiException { @@ -2450,9 +2450,9 @@ public ApiResponse createDeliveryOrderWithHttpInfo(String settle, } /** - * Create a futures order (asynchronously) - * Zero-filled order cannot be retrieved 10 minutes after order cancellation - * @param settle Settle currency (required) + * Create a futures order. (asynchronously) + * Zero-filled order 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 * @return The request call @@ -2460,7 +2460,7 @@ public ApiResponse createDeliveryOrderWithHttpInfo(String settle, * @http.response.details - +
Status Code Description Response Headers
201 Order details -
201 Order details. -
*/ public okhttp3.Call createDeliveryOrderAsync(String settle, FuturesOrder futuresOrder, final ApiCallback _callback) throws ApiException { @@ -2472,16 +2472,16 @@ 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 settle Settle currency. (required) + * @param contract Futures contract. (required) + * @param side All bids or 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 All orders matched cancelled. -
*/ 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 - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param side All bids or asks. Both included if not specified (optional) + * Cancel all `open` orders matched. + * Zero-filled order 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) * @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 All orders matched cancelled. -
*/ 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 - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param side All bids or asks. Both included if not specified (optional) + * Cancel all `open` orders matched. + * Zero-filled order 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) * @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 All orders matched cancelled. -
*/ 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 - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param side All bids or asks. Both included if not specified (optional) + * Cancel all `open` orders matched. (asynchronously) + * Zero-filled order 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 _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 All orders matched cancelled. -
*/ public okhttp3.Call cancelDeliveryOrdersAsync(String settle, String contract, String side, final ApiCallback> _callback) throws ApiException { @@ -2601,15 +2601,15 @@ 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 settle Settle currency. (required) + * @param orderId Retrieve the data of the order with the specified 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 Order details -
200 Order details. -
*/ public okhttp3.Call getDeliveryOrderCall(String settle, String orderId, final ApiCallback _callback) throws ApiException { @@ -2660,16 +2660,16 @@ private okhttp3.Call getDeliveryOrderValidateBeforeCall(String settle, String or } /** - * Get a single order - * Zero-filled order 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) + * Get a single order. + * Zero-filled order 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) * @return 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 Order details -
200 Order details. -
*/ public FuturesOrder getDeliveryOrder(String settle, String orderId) throws ApiException { @@ -2678,16 +2678,16 @@ public FuturesOrder getDeliveryOrder(String settle, String orderId) throws ApiEx } /** - * Get a single order - * Zero-filled order 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) + * Get a single order. + * Zero-filled order 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) * @return ApiResponse<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 Order details -
200 Order details. -
*/ public ApiResponse getDeliveryOrderWithHttpInfo(String settle, String orderId) throws ApiException { @@ -2697,17 +2697,17 @@ public ApiResponse getDeliveryOrderWithHttpInfo(String settle, Str } /** - * Get a single order (asynchronously) - * Zero-filled order 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) + * Get a single order. (asynchronously) + * Zero-filled order 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 _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 Order details -
200 Order details. -
*/ public okhttp3.Call getDeliveryOrderAsync(String settle, String orderId, final ApiCallback _callback) throws ApiException { @@ -2719,15 +2719,15 @@ 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 settle Settle currency. (required) + * @param orderId Retrieve the data of the order with the specified 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 Order details -
200 Order details. -
*/ public okhttp3.Call cancelDeliveryOrderCall(String settle, String orderId, final ApiCallback _callback) throws ApiException { @@ -2778,16 +2778,16 @@ private okhttp3.Call cancelDeliveryOrderValidateBeforeCall(String settle, String } /** - * Cancel a single order + * Cancel a single order. * - * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param settle Settle currency. (required) + * @param orderId Retrieve the data of the order with the specified ID. (required) * @return 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 Order details -
200 Order details. -
*/ public FuturesOrder cancelDeliveryOrder(String settle, String orderId) throws ApiException { @@ -2796,16 +2796,16 @@ public FuturesOrder cancelDeliveryOrder(String settle, String orderId) throws Ap } /** - * Cancel a single order + * Cancel a single order. * - * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param settle Settle currency. (required) + * @param orderId Retrieve the data of the order with the specified ID. (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 - +
Status Code Description Response Headers
200 Order details -
200 Order details. -
*/ public ApiResponse cancelDeliveryOrderWithHttpInfo(String settle, String orderId) throws ApiException { @@ -2815,17 +2815,17 @@ public ApiResponse cancelDeliveryOrderWithHttpInfo(String settle, } /** - * Cancel a single order (asynchronously) + * Cancel a single order. (asynchronously) * - * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param settle Settle currency. (required) + * @param orderId Retrieve the data of the order with the specified 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 Order details -
200 Order details. -
*/ public okhttp3.Call cancelDeliveryOrderAsync(String settle, String orderId, final ApiCallback _callback) throws ApiException { @@ -2929,7 +2929,7 @@ private APIgetMyDeliveryTradesRequest(String settle) { /** * Set contract - * @param contract Futures contract (optional) + * @param contract Futures contract. (optional) * @return APIgetMyDeliveryTradesRequest */ public APIgetMyDeliveryTradesRequest contract(String contract) { @@ -2939,7 +2939,7 @@ public APIgetMyDeliveryTradesRequest contract(String contract) { /** * Set order - * @param order Futures order ID, return related data only if specified (optional) + * @param order Futures order ID, return related data only if specified. (optional) * @return APIgetMyDeliveryTradesRequest */ public APIgetMyDeliveryTradesRequest order(Long order) { @@ -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 to be returned in a single list. (optional, default to 100) * @return APIgetMyDeliveryTradesRequest */ public APIgetMyDeliveryTradesRequest limit(Integer limit) { @@ -2959,7 +2959,7 @@ public APIgetMyDeliveryTradesRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIgetMyDeliveryTradesRequest */ public APIgetMyDeliveryTradesRequest offset(Integer offset) { @@ -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. Default 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. * 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.
*/ 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. * 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.
*/ 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. * 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.
*/ 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. * 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.
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -3048,14 +3048,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callba } /** - * List personal trading history + * List personal trading history. * - * @param settle Settle currency (required) + * @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. * 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.
*/ public APIgetMyDeliveryTradesRequest getMyDeliveryTrades(String settle) { @@ -3136,7 +3136,7 @@ private APIlistDeliveryPositionCloseRequest(String settle) { /** * Set contract - * @param contract Futures contract (optional) + * @param contract Futures contract. (optional) * @return APIlistDeliveryPositionCloseRequest */ public APIlistDeliveryPositionCloseRequest contract(String contract) { @@ -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 to be 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. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -3215,14 +3215,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callbac } /** - * List position close history + * List position close history. * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @return APIlistDeliveryPositionCloseRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistDeliveryPositionCloseRequest listDeliveryPositionClose(String settle) { @@ -3308,7 +3308,7 @@ private APIlistDeliveryLiquidatesRequest(String settle) { /** * Set contract - * @param contract Futures contract (optional) + * @param contract Futures contract. (optional) * @return APIlistDeliveryLiquidatesRequest */ public APIlistDeliveryLiquidatesRequest contract(String contract) { @@ -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 to be 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 a 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. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -3397,14 +3397,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _call } /** - * List liquidation history + * List liquidation history. * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @return APIlistDeliveryLiquidatesRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistDeliveryLiquidatesRequest listDeliveryLiquidates(String settle) { @@ -3490,7 +3490,7 @@ private APIlistDeliverySettlementsRequest(String settle) { /** * Set contract - * @param contract Futures contract (optional) + * @param contract Futures contract. (optional) * @return APIlistDeliverySettlementsRequest */ public APIlistDeliverySettlementsRequest contract(String contract) { @@ -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 to be 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 a 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. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -3579,14 +3579,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _ca } /** - * List settlement history + * List settlement history. * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @return APIlistDeliverySettlementsRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistDeliverySettlementsRequest listDeliverySettlements(String settle) { @@ -3672,7 +3672,7 @@ private APIlistDeliveryRiskLimitTiersRequest(String settle) { /** * Set contract - * @param contract Futures contract (optional) + * @param contract Futures contract. (optional) * @return APIlistDeliveryRiskLimitTiersRequest */ public APIlistDeliveryRiskLimitTiersRequest contract(String contract) { @@ -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 to be returned in a single list. (optional, default to 100) * @return APIlistDeliveryRiskLimitTiersRequest */ public APIlistDeliveryRiskLimitTiersRequest limit(Integer limit) { @@ -3692,7 +3692,7 @@ public APIlistDeliveryRiskLimitTiersRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIlistDeliveryRiskLimitTiersRequest */ public APIlistDeliveryRiskLimitTiersRequest offset(Integer offset) { @@ -3708,7 +3708,7 @@ public APIlistDeliveryRiskLimitTiersRequest offset(Integer offset) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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. - * @param settle Settle currency (required) + * 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 empty. + * @param settle Settle currency. (required) * @return APIlistDeliveryRiskLimitTiersRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public APIlistDeliveryRiskLimitTiersRequest listDeliveryRiskLimitTiers(String settle) { @@ -3865,7 +3865,7 @@ private APIlistPriceTriggeredDeliveryOrdersRequest(String settle, String status) /** * Set contract - * @param contract Futures contract, return related data only if specified (optional) + * @param contract Futures contract, return related data only if specified. (optional) * @return APIlistPriceTriggeredDeliveryOrdersRequest */ public APIlistPriceTriggeredDeliveryOrdersRequest contract(String contract) { @@ -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 to be returned in a single list. (optional, default to 100) * @return APIlistPriceTriggeredDeliveryOrdersRequest */ public APIlistPriceTriggeredDeliveryOrdersRequest limit(Integer limit) { @@ -3885,7 +3885,7 @@ public APIlistPriceTriggeredDeliveryOrdersRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIlistPriceTriggeredDeliveryOrdersRequest */ public APIlistPriceTriggeredDeliveryOrdersRequest offset(Integer offset) { @@ -3901,7 +3901,7 @@ public APIlistPriceTriggeredDeliveryOrdersRequest offset(Integer offset) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ 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. - */ public APIlistPriceTriggeredDeliveryOrdersRequest listPriceTriggeredDeliveryOrders(String settle, String status) { @@ -3971,7 +3971,7 @@ public APIlistPriceTriggeredDeliveryOrdersRequest listPriceTriggeredDeliveryOrde /** * Build call for createPriceTriggeredDeliveryOrder - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @param futuresPriceTriggeredOrder (required) * @param _callback Callback for upload/download progress * @return Call to execute @@ -3979,7 +3979,7 @@ public APIlistPriceTriggeredDeliveryOrdersRequest listPriceTriggeredDeliveryOrde * @http.response.details - +
Status Code Description Response Headers
201 Order created -
201 Order created. -
*/ public okhttp3.Call createPriceTriggeredDeliveryOrderCall(String settle, FuturesPriceTriggeredOrder futuresPriceTriggeredOrder, final ApiCallback _callback) throws ApiException { @@ -4029,16 +4029,16 @@ private okhttp3.Call createPriceTriggeredDeliveryOrderValidateBeforeCall(String } /** - * Create a price-triggered order + * Create a price-triggered order. * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @param futuresPriceTriggeredOrder (required) * @return TriggerOrderResponse * @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. -
*/ public TriggerOrderResponse createPriceTriggeredDeliveryOrder(String settle, FuturesPriceTriggeredOrder futuresPriceTriggeredOrder) throws ApiException { @@ -4047,16 +4047,16 @@ public TriggerOrderResponse createPriceTriggeredDeliveryOrder(String settle, Fut } /** - * Create a price-triggered order + * Create a price-triggered order. * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @param futuresPriceTriggeredOrder (required) * @return ApiResponse<TriggerOrderResponse> * @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. -
*/ public ApiResponse createPriceTriggeredDeliveryOrderWithHttpInfo(String settle, FuturesPriceTriggeredOrder futuresPriceTriggeredOrder) throws ApiException { @@ -4066,9 +4066,9 @@ public ApiResponse createPriceTriggeredDeliveryOrderWithHt } /** - * Create a price-triggered order (asynchronously) + * Create a price-triggered order. (asynchronously) * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @param futuresPriceTriggeredOrder (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -4076,7 +4076,7 @@ public ApiResponse createPriceTriggeredDeliveryOrderWithHt * @http.response.details - +
Status Code Description Response Headers
201 Order created -
201 Order created. -
*/ public okhttp3.Call createPriceTriggeredDeliveryOrderAsync(String settle, FuturesPriceTriggeredOrder futuresPriceTriggeredOrder, final ApiCallback _callback) throws ApiException { @@ -4088,15 +4088,15 @@ public okhttp3.Call createPriceTriggeredDeliveryOrderAsync(String settle, Future /** * Build call for cancelPriceTriggeredDeliveryOrderList - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (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 Batch cancellation request accepted. Query order status by listing orders -
200 Batch cancellation request accepted. Query order status by listing orders. -
*/ public okhttp3.Call cancelPriceTriggeredDeliveryOrderListCall(String settle, String contract, final ApiCallback _callback) throws ApiException { @@ -4150,16 +4150,16 @@ private okhttp3.Call cancelPriceTriggeredDeliveryOrderListValidateBeforeCall(Str } /** - * Cancel All Price-triggered Orders + * Cancel All Price-triggered Orders. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) * @return List<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 Batch cancellation request accepted. Query order status by listing orders -
200 Batch cancellation request accepted. Query order status by listing orders. -
*/ public List cancelPriceTriggeredDeliveryOrderList(String settle, String contract) throws ApiException { @@ -4168,16 +4168,16 @@ public List cancelPriceTriggeredDeliveryOrderList(St } /** - * Cancel All Price-triggered Orders + * Cancel All Price-triggered Orders. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) * @return ApiResponse<List<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 Batch cancellation request accepted. Query order status by listing orders -
200 Batch cancellation request accepted. Query order status by listing orders. -
*/ public ApiResponse> cancelPriceTriggeredDeliveryOrderListWithHttpInfo(String settle, String contract) throws ApiException { @@ -4187,17 +4187,17 @@ public ApiResponse> cancelPriceTriggeredDeliver } /** - * Cancel All Price-triggered Orders (asynchronously) + * Cancel All Price-triggered Orders. (asynchronously) * - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (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 Batch cancellation request accepted. Query order status by listing orders -
200 Batch cancellation request accepted. Query order status by listing orders. -
*/ public okhttp3.Call cancelPriceTriggeredDeliveryOrderListAsync(String settle, String contract, final ApiCallback> _callback) throws ApiException { @@ -4209,15 +4209,15 @@ 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 settle Settle currency. (required) + * @param orderId Retrieve the data of the order with the specified 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 Auto order detail -
200 Auto order detail. -
*/ 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 + * Get a price-triggered order. * - * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param settle Settle currency. (required) + * @param orderId Retrieve the data of the order with the specified ID. (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 detail. -
*/ public FuturesPriceTriggeredOrder getPriceTriggeredDeliveryOrder(String settle, String orderId) throws ApiException { @@ -4286,16 +4286,16 @@ public FuturesPriceTriggeredOrder getPriceTriggeredDeliveryOrder(String settle, } /** - * Get a price-triggered order + * Get a price-triggered order. * - * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param settle Settle currency. (required) + * @param orderId Retrieve the data of the order with the specified ID. (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 detail. -
*/ public ApiResponse getPriceTriggeredDeliveryOrderWithHttpInfo(String settle, String orderId) throws ApiException { @@ -4305,17 +4305,17 @@ public ApiResponse getPriceTriggeredDeliveryOrderWit } /** - * Get a price-triggered order (asynchronously) + * Get a price-triggered order. (asynchronously) * - * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param settle Settle currency. (required) + * @param orderId Retrieve the data of the order with the specified 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 Auto order detail -
200 Auto order detail. -
*/ public okhttp3.Call getPriceTriggeredDeliveryOrderAsync(String settle, String orderId, final ApiCallback _callback) throws ApiException { @@ -4327,15 +4327,15 @@ 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 settle Settle currency. (required) + * @param orderId Retrieve the data of the order with the specified 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 Auto order detail -
200 Auto order detail. -
*/ 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 a price-triggered order. * - * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param settle Settle currency. (required) + * @param orderId Retrieve the data of the order with the specified ID. (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 detail. -
*/ public FuturesPriceTriggeredOrder cancelPriceTriggeredDeliveryOrder(String settle, String orderId) throws ApiException { @@ -4404,16 +4404,16 @@ public FuturesPriceTriggeredOrder cancelPriceTriggeredDeliveryOrder(String settl } /** - * cancel a price-triggered order + * cancel a price-triggered order. * - * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param settle Settle currency. (required) + * @param orderId Retrieve the data of the order with the specified ID. (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 detail. -
*/ public ApiResponse cancelPriceTriggeredDeliveryOrderWithHttpInfo(String settle, String orderId) throws ApiException { @@ -4423,17 +4423,17 @@ public ApiResponse cancelPriceTriggeredDeliveryOrder } /** - * cancel a price-triggered order (asynchronously) + * cancel a price-triggered order. (asynchronously) * - * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param settle Settle currency. (required) + * @param orderId Retrieve the data of the order with the specified 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 Auto order detail -
200 Auto order detail. -
*/ 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 fb20471..d71cf5f 100644 --- a/src/main/java/io/gate/gateapi/api/EarnApi.java +++ b/src/main/java/io/gate/gateapi/api/EarnApi.java @@ -66,7 +66,7 @@ public void setApiClient(ApiClient apiClient) { * @http.response.details - +
Status Code Description Response Headers
200 swap success -
200 swap success. -
*/ public okhttp3.Call swapETH2Call(Eth2Swap eth2Swap, final ApiCallback _callback) throws ApiException { @@ -110,14 +110,14 @@ private okhttp3.Call swapETH2ValidateBeforeCall(Eth2Swap eth2Swap, final ApiCall } /** - * ETH2 swap + * ETH2 swap. * * @param eth2Swap (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 swap success -
200 swap success. -
*/ public void swapETH2(Eth2Swap eth2Swap) throws ApiException { @@ -125,7 +125,7 @@ public void swapETH2(Eth2Swap eth2Swap) throws ApiException { } /** - * ETH2 swap + * ETH2 swap. * * @param eth2Swap (required) * @return ApiResponse<Void> @@ -133,7 +133,7 @@ public void swapETH2(Eth2Swap eth2Swap) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 swap success -
200 swap success. -
*/ public ApiResponse swapETH2WithHttpInfo(Eth2Swap eth2Swap) throws ApiException { @@ -142,7 +142,7 @@ public ApiResponse swapETH2WithHttpInfo(Eth2Swap eth2Swap) throws ApiExcep } /** - * ETH2 swap (asynchronously) + * ETH2 swap. (asynchronously) * * @param eth2Swap (required) * @param _callback The callback to be executed when the API call finishes @@ -151,7 +151,7 @@ public ApiResponse swapETH2WithHttpInfo(Eth2Swap eth2Swap) throws ApiExcep * @http.response.details - +
Status Code Description Response Headers
200 swap success -
200 swap success. -
*/ public okhttp3.Call swapETH2Async(Eth2Swap eth2Swap, final ApiCallback _callback) throws ApiException { @@ -168,7 +168,7 @@ public okhttp3.Call swapETH2Async(Eth2Swap eth2Swap, final ApiCallback _ca * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ public okhttp3.Call rateListETH2Call(final ApiCallback _callback) throws ApiException { @@ -207,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 rate of return query. + * Check the ETH earnings rate record 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 Successful. -
*/ public List rateListETH2() throws ApiException { @@ -223,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 rate of return query. + * Check the ETH earnings rate record 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 Successful. -
*/ public ApiResponse> rateListETH2WithHttpInfo() throws ApiException { @@ -240,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 rate of return query. (asynchronously) + * Check the ETH earnings rate record 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 Successful. -
*/ public okhttp3.Call rateListETH2Async(final ApiCallback> _callback) throws ApiException { @@ -319,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) { @@ -335,7 +335,7 @@ public APIlistDualInvestmentPlansRequest planId(Long planId) { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -349,7 +349,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ public List execute() throws ApiException { @@ -364,7 +364,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -379,7 +379,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -388,13 +388,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * Dual Investment product list + * Dual Investment product list. * * @return APIlistDualInvestmentPlansRequest * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ public APIlistDualInvestmentPlansRequest listDualInvestmentPlans() { @@ -477,7 +477,7 @@ private APIlistDualOrdersRequest() { /** * Set from - * @param from Start checkout time (optional) + * @param from Start checkout time. (optional) * @return APIlistDualOrdersRequest */ public APIlistDualOrdersRequest from(Long from) { @@ -487,7 +487,7 @@ public APIlistDualOrdersRequest from(Long from) { /** * Set to - * @param to End settlement time (optional) + * @param to End settlement time. (optional) * @return APIlistDualOrdersRequest */ public APIlistDualOrdersRequest to(Long to) { @@ -497,7 +497,7 @@ public APIlistDualOrdersRequest to(Long to) { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistDualOrdersRequest */ public APIlistDualOrdersRequest page(Integer page) { @@ -507,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 to be returned in a single list. (optional, default to 100) * @return APIlistDualOrdersRequest */ public APIlistDualOrdersRequest limit(Integer limit) { @@ -523,7 +523,7 @@ public APIlistDualOrdersRequest limit(Integer limit) { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -537,7 +537,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ public List execute() throws ApiException { @@ -552,7 +552,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -567,7 +567,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExceptio * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -576,13 +576,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callbac } /** - * Dual Investment order list + * Dual Investment order list. * * @return APIlistDualOrdersRequest * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ public APIlistDualOrdersRequest listDualOrders() { @@ -598,7 +598,7 @@ public APIlistDualOrdersRequest listDualOrders() { * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Success. -
*/ public okhttp3.Call placeDualOrderCall(PlaceDualInvestmentOrder placeDualInvestmentOrder, final ApiCallback _callback) throws ApiException { @@ -642,14 +642,14 @@ private okhttp3.Call placeDualOrderValidateBeforeCall(PlaceDualInvestmentOrder p } /** - * Place Dual Investment order + * Place Dual Investment order. * * @param placeDualInvestmentOrder (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 Success -
200 Success. -
*/ public void placeDualOrder(PlaceDualInvestmentOrder placeDualInvestmentOrder) throws ApiException { @@ -657,7 +657,7 @@ public void placeDualOrder(PlaceDualInvestmentOrder placeDualInvestmentOrder) th } /** - * Place Dual Investment order + * Place Dual Investment order. * * @param placeDualInvestmentOrder (required) * @return ApiResponse<Void> @@ -665,7 +665,7 @@ public void placeDualOrder(PlaceDualInvestmentOrder placeDualInvestmentOrder) th * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Success. -
*/ public ApiResponse placeDualOrderWithHttpInfo(PlaceDualInvestmentOrder placeDualInvestmentOrder) throws ApiException { @@ -674,7 +674,7 @@ public ApiResponse placeDualOrderWithHttpInfo(PlaceDualInvestmentOrder pla } /** - * Place Dual Investment order (asynchronously) + * Place Dual Investment order. (asynchronously) * * @param placeDualInvestmentOrder (required) * @param _callback The callback to be executed when the API call finishes @@ -683,7 +683,7 @@ public ApiResponse placeDualOrderWithHttpInfo(PlaceDualInvestmentOrder pla * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Success. -
*/ public okhttp3.Call placeDualOrderAsync(PlaceDualInvestmentOrder placeDualInvestmentOrder, final ApiCallback _callback) throws ApiException { @@ -784,7 +784,7 @@ public APIlistStructuredProductsRequest type(String type) { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistStructuredProductsRequest */ public APIlistStructuredProductsRequest page(Integer page) { @@ -794,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 to be returned in a single list. (optional, default to 100) * @return APIlistStructuredProductsRequest */ public APIlistStructuredProductsRequest limit(Integer limit) { @@ -810,7 +810,7 @@ public APIlistStructuredProductsRequest limit(Integer limit) { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -824,7 +824,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ public List execute() throws ApiException { @@ -839,7 +839,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -854,7 +854,7 @@ public ApiResponse> executeWithHttpInfo() throws * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -863,14 +863,14 @@ public okhttp3.Call executeAsync(final ApiCallback Status Code Description Response Headers - 200 Successful - + 200 Successful. - */ public APIlistStructuredProductsRequest listStructuredProducts(String status) { @@ -973,7 +973,7 @@ public APIlistStructuredOrdersRequest to(Long to) { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistStructuredOrdersRequest */ public APIlistStructuredOrdersRequest page(Integer page) { @@ -983,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 to be returned in a single list. (optional, default to 100) * @return APIlistStructuredOrdersRequest */ public APIlistStructuredOrdersRequest limit(Integer limit) { @@ -999,7 +999,7 @@ public APIlistStructuredOrdersRequest limit(Integer limit) { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1013,7 +1013,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ public List execute() throws ApiException { @@ -1028,7 +1028,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1043,7 +1043,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiEx * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1052,13 +1052,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _c } /** - * Structured Product Order List + * Structured Product Order List. * * @return APIlistStructuredOrdersRequest * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ public APIlistStructuredOrdersRequest listStructuredOrders() { @@ -1074,7 +1074,7 @@ public APIlistStructuredOrdersRequest listStructuredOrders() { * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Success. -
*/ public okhttp3.Call placeStructuredOrderCall(StructuredBuy structuredBuy, final ApiCallback _callback) throws ApiException { @@ -1118,14 +1118,14 @@ private okhttp3.Call placeStructuredOrderValidateBeforeCall(StructuredBuy struct } /** - * Place Structured Product Order + * Place Structured Product Order. * * @param structuredBuy (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 Success -
200 Success. -
*/ public void placeStructuredOrder(StructuredBuy structuredBuy) throws ApiException { @@ -1133,7 +1133,7 @@ public void placeStructuredOrder(StructuredBuy structuredBuy) throws ApiExceptio } /** - * Place Structured Product Order + * Place Structured Product Order. * * @param structuredBuy (required) * @return ApiResponse<Void> @@ -1141,7 +1141,7 @@ public void placeStructuredOrder(StructuredBuy structuredBuy) throws ApiExceptio * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Success. -
*/ public ApiResponse placeStructuredOrderWithHttpInfo(StructuredBuy structuredBuy) throws ApiException { @@ -1150,7 +1150,7 @@ public ApiResponse placeStructuredOrderWithHttpInfo(StructuredBuy structur } /** - * Place Structured Product Order (asynchronously) + * Place Structured Product Order. (asynchronously) * * @param structuredBuy (required) * @param _callback The callback to be executed when the API call finishes @@ -1159,7 +1159,7 @@ public ApiResponse placeStructuredOrderWithHttpInfo(StructuredBuy structur * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Success. -
*/ public okhttp3.Call placeStructuredOrderAsync(StructuredBuy structuredBuy, final ApiCallback _callback) throws ApiException { @@ -1177,7 +1177,7 @@ public okhttp3.Call placeStructuredOrderAsync(StructuredBuy structuredBuy, final * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ public okhttp3.Call findCoinCall(FindCoin findCoin, final ApiCallback _callback) throws ApiException { @@ -1221,7 +1221,7 @@ private okhttp3.Call findCoinValidateBeforeCall(FindCoin findCoin, final ApiCall } /** - * Staking Coins + * Staking Coins. * * @param findCoin (required) * @return List<String> @@ -1229,7 +1229,7 @@ private okhttp3.Call findCoinValidateBeforeCall(FindCoin findCoin, final ApiCall * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ public List findCoin(FindCoin findCoin) throws ApiException { @@ -1238,7 +1238,7 @@ public List findCoin(FindCoin findCoin) throws ApiException { } /** - * Staking Coins + * Staking Coins. * * @param findCoin (required) * @return ApiResponse<List<String>> @@ -1246,7 +1246,7 @@ public List findCoin(FindCoin findCoin) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ public ApiResponse> findCoinWithHttpInfo(FindCoin findCoin) throws ApiException { @@ -1256,7 +1256,7 @@ public ApiResponse> findCoinWithHttpInfo(FindCoin findCoin) throws } /** - * Staking Coins (asynchronously) + * Staking Coins. (asynchronously) * * @param findCoin (required) * @param _callback The callback to be executed when the API call finishes @@ -1265,7 +1265,7 @@ public ApiResponse> findCoinWithHttpInfo(FindCoin findCoin) throws * @http.response.details - +
Status Code Description Response Headers
200 Successful -
200 Successful. -
*/ public okhttp3.Call findCoinAsync(FindCoin findCoin, final ApiCallback> _callback) throws ApiException { @@ -1284,7 +1284,7 @@ public okhttp3.Call findCoinAsync(FindCoin findCoin, final ApiCallback Status Code Description Response Headers - 200 swap success - + 200 swap success. - */ public okhttp3.Call swapStakingCoinCall(SwapCoin swapCoin, final ApiCallback _callback) throws ApiException { @@ -1328,7 +1328,7 @@ private okhttp3.Call swapStakingCoinValidateBeforeCall(SwapCoin swapCoin, final } /** - * On-chain Token Swap for Earned Coins + * On-chain Token Swap for Earned Coins. * * @param swapCoin (required) * @return SwapCoinStruct @@ -1336,7 +1336,7 @@ private okhttp3.Call swapStakingCoinValidateBeforeCall(SwapCoin swapCoin, final * @http.response.details - +
Status Code Description Response Headers
200 swap success -
200 swap success. -
*/ public SwapCoinStruct swapStakingCoin(SwapCoin swapCoin) throws ApiException { @@ -1345,7 +1345,7 @@ public SwapCoinStruct swapStakingCoin(SwapCoin swapCoin) throws ApiException { } /** - * On-chain Token Swap for Earned Coins + * On-chain Token Swap for Earned Coins. * * @param swapCoin (required) * @return ApiResponse<SwapCoinStruct> @@ -1353,7 +1353,7 @@ public SwapCoinStruct swapStakingCoin(SwapCoin swapCoin) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 swap success -
200 swap success. -
*/ public ApiResponse swapStakingCoinWithHttpInfo(SwapCoin swapCoin) throws ApiException { @@ -1363,7 +1363,7 @@ public ApiResponse swapStakingCoinWithHttpInfo(SwapCoin swapCoin } /** - * On-chain Token Swap for Earned Coins (asynchronously) + * On-chain Token Swap for Earned Coins. (asynchronously) * * @param swapCoin (required) * @param _callback The callback to be executed when the API call finishes @@ -1372,7 +1372,7 @@ public ApiResponse swapStakingCoinWithHttpInfo(SwapCoin swapCoin * @http.response.details - +
Status Code Description Response Headers
200 swap success -
200 swap success. -
*/ public okhttp3.Call swapStakingCoinAsync(SwapCoin swapCoin, final ApiCallback _callback) throws ApiException { diff --git a/src/main/java/io/gate/gateapi/api/EarnUniApi.java b/src/main/java/io/gate/gateapi/api/EarnUniApi.java index 989782c..0c0d06f 100644 --- a/src/main/java/io/gate/gateapi/api/EarnUniApi.java +++ b/src/main/java/io/gate/gateapi/api/EarnUniApi.java @@ -64,7 +64,7 @@ public void setApiClient(ApiClient apiClient) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call listUniCurrenciesCall(final ApiCallback _callback) throws ApiException { @@ -103,14 +103,14 @@ private okhttp3.Call listUniCurrenciesValidateBeforeCall(final ApiCallback _call } /** - * List currencies for lending + * List currencies for lending. * * @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 Successfully retrieved. -
*/ public List listUniCurrencies() throws ApiException { @@ -119,14 +119,14 @@ public List listUniCurrencies() throws ApiException { } /** - * List currencies for lending + * List currencies for lending. * * @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 Successfully retrieved. -
*/ public ApiResponse> listUniCurrenciesWithHttpInfo() throws ApiException { @@ -136,7 +136,7 @@ public ApiResponse> listUniCurrenciesWithHttpInfo() throws Api } /** - * List currencies for lending (asynchronously) + * List currencies for lending. (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -144,7 +144,7 @@ public ApiResponse> listUniCurrenciesWithHttpInfo() throws Api * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call listUniCurrenciesAsync(final ApiCallback> _callback) throws ApiException { @@ -156,14 +156,14 @@ public okhttp3.Call listUniCurrenciesAsync(final ApiCallback> /** * Build call for getUniCurrency - * @param currency Currency (required) + * @param currency 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 -
200 Successfully retrieved. -
*/ public okhttp3.Call getUniCurrencyCall(String currency, final ApiCallback _callback) throws ApiException { @@ -208,15 +208,15 @@ private okhttp3.Call getUniCurrencyValidateBeforeCall(String currency, final Api } /** - * Get currency detail for lending + * Get currency detail for lending. * - * @param currency Currency (required) + * @param currency Currency. (required) * @return 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 Successfully retrieved. -
*/ public UniCurrency getUniCurrency(String currency) throws ApiException { @@ -225,15 +225,15 @@ public UniCurrency getUniCurrency(String currency) throws ApiException { } /** - * Get currency detail for lending + * Get currency detail for lending. * - * @param currency Currency (required) + * @param currency Currency. (required) * @return ApiResponse<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 Successfully retrieved. -
*/ public ApiResponse getUniCurrencyWithHttpInfo(String currency) throws ApiException { @@ -243,16 +243,16 @@ public ApiResponse getUniCurrencyWithHttpInfo(String currency) thro } /** - * Get currency detail for lending (asynchronously) + * Get currency detail for lending. (asynchronously) * - * @param currency Currency (required) + * @param currency 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 -
200 Successfully retrieved. -
*/ public okhttp3.Call getUniCurrencyAsync(String currency, final ApiCallback _callback) throws ApiException { @@ -333,7 +333,7 @@ private APIlistUserUniLendsRequest() { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Retrieve data of the specified currency. (optional) * @return APIlistUserUniLendsRequest */ public APIlistUserUniLendsRequest currency(String currency) { @@ -343,7 +343,7 @@ public APIlistUserUniLendsRequest currency(String currency) { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistUserUniLendsRequest */ public APIlistUserUniLendsRequest page(Integer page) { @@ -353,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 response items. Default: 100, minimum: 1, Maximum: 100. (optional, default to 100) * @return APIlistUserUniLendsRequest */ public APIlistUserUniLendsRequest limit(Integer limit) { @@ -369,7 +369,7 @@ public APIlistUserUniLendsRequest limit(Integer limit) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -383,7 +383,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public List execute() throws ApiException { @@ -398,7 +398,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -413,7 +413,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -422,13 +422,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) thr } /** - * List user's lending orders + * List user's lending orders. * * @return APIlistUserUniLendsRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public APIlistUserUniLendsRequest listUserUniLends() { @@ -444,7 +444,7 @@ public APIlistUserUniLendsRequest listUserUniLends() { * @http.response.details - +
Status Code Description Response Headers
204 Operated successfully -
204 Operated successfully. -
*/ public okhttp3.Call createUniLendCall(CreateUniLend createUniLend, final ApiCallback _callback) throws ApiException { @@ -488,14 +488,14 @@ private okhttp3.Call createUniLendValidateBeforeCall(CreateUniLend createUniLend } /** - * Lend or redeem - * 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 determination, no interest will be earned 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. + * Lend or redeem. + * 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 Operated successfully. -
*/ public void createUniLend(CreateUniLend createUniLend) throws ApiException { @@ -503,15 +503,15 @@ public void createUniLend(CreateUniLend createUniLend) throws ApiException { } /** - * Lend or redeem - * 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 determination, no interest will be earned 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. + * Lend or redeem. + * 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 Operated successfully. -
*/ public ApiResponse createUniLendWithHttpInfo(CreateUniLend createUniLend) throws ApiException { @@ -520,8 +520,8 @@ public ApiResponse createUniLendWithHttpInfo(CreateUniLend createUniLend) } /** - * Lend or redeem (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 determination, no interest will be earned 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. + * Lend or redeem. (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 @@ -529,7 +529,7 @@ public ApiResponse createUniLendWithHttpInfo(CreateUniLend createUniLend) * @http.response.details - +
Status Code Description Response Headers
204 Operated successfully -
204 Operated successfully. -
*/ public okhttp3.Call createUniLendAsync(CreateUniLend createUniLend, final ApiCallback _callback) throws ApiException { @@ -547,7 +547,7 @@ public okhttp3.Call createUniLendAsync(CreateUniLend createUniLend, final ApiCal * @http.response.details - +
Status Code Description Response Headers
204 Updated -
204 Updated. -
*/ public okhttp3.Call changeUniLendCall(PatchUniLend patchUniLend, final ApiCallback _callback) throws ApiException { @@ -591,14 +591,14 @@ private okhttp3.Call changeUniLendValidateBeforeCall(PatchUniLend patchUniLend, } /** - * Amend lending order - * Currently only supports amending the minimum interest rate (hour) + * Amend lending order. + * Currently only supports amending the minimum interest rate (hour). * @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. -
*/ public void changeUniLend(PatchUniLend patchUniLend) throws ApiException { @@ -606,15 +606,15 @@ public void changeUniLend(PatchUniLend patchUniLend) throws ApiException { } /** - * Amend lending order - * Currently only supports amending the minimum interest rate (hour) + * Amend lending order. + * Currently only supports amending the minimum interest rate (hour). * @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. -
*/ public ApiResponse changeUniLendWithHttpInfo(PatchUniLend patchUniLend) throws ApiException { @@ -623,8 +623,8 @@ public ApiResponse changeUniLendWithHttpInfo(PatchUniLend patchUniLend) th } /** - * Amend lending order (asynchronously) - * Currently only supports amending the minimum interest rate (hour) + * Amend lending order. (asynchronously) + * Currently only supports amending the minimum interest rate (hour). * @param patchUniLend (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -632,7 +632,7 @@ public ApiResponse changeUniLendWithHttpInfo(PatchUniLend patchUniLend) th * @http.response.details - +
Status Code Description Response Headers
204 Updated -
204 Updated. -
*/ public okhttp3.Call changeUniLendAsync(PatchUniLend patchUniLend, final ApiCallback _callback) throws ApiException { @@ -727,7 +727,7 @@ private APIlistUniLendRecordsRequest() { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Retrieve data of the specified currency. (optional) * @return APIlistUniLendRecordsRequest */ public APIlistUniLendRecordsRequest currency(String currency) { @@ -737,7 +737,7 @@ public APIlistUniLendRecordsRequest currency(String currency) { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistUniLendRecordsRequest */ public APIlistUniLendRecordsRequest page(Integer page) { @@ -747,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 response items. Default: 100, minimum: 1, Maximum: 100. (optional, default to 100) * @return APIlistUniLendRecordsRequest */ public APIlistUniLendRecordsRequest limit(Integer limit) { @@ -777,7 +777,7 @@ public APIlistUniLendRecordsRequest to(Long to) { /** * Set type - * @param type type: lend - lend, redeem - redeem (optional) + * @param type type: lend - lend, redeem - redeem. (optional) * @return APIlistUniLendRecordsRequest */ public APIlistUniLendRecordsRequest type(String type) { @@ -793,7 +793,7 @@ public APIlistUniLendRecordsRequest type(String type) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -807,7 +807,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public List execute() throws ApiException { @@ -822,7 +822,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -837,7 +837,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExceptio * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -846,13 +846,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callbac } /** - * List records of lending + * List records of lending. * * @return APIlistUniLendRecordsRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public APIlistUniLendRecordsRequest listUniLendRecords() { @@ -861,14 +861,14 @@ public APIlistUniLendRecordsRequest listUniLendRecords() { /** * Build call for getUniInterest - * @param currency Currency (required) + * @param currency 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 -
200 Successfully retrieved. -
*/ public okhttp3.Call getUniInterestCall(String currency, final ApiCallback _callback) throws ApiException { @@ -913,15 +913,15 @@ private okhttp3.Call getUniInterestValidateBeforeCall(String currency, final Api } /** - * Get the user's total interest income of specified currency + * Get the user's total interest income of specified currency. * - * @param currency Currency (required) + * @param currency Currency. (required) * @return UniLendInterest * @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 Successfully retrieved. -
*/ public UniLendInterest getUniInterest(String currency) throws ApiException { @@ -930,15 +930,15 @@ public UniLendInterest getUniInterest(String currency) throws ApiException { } /** - * Get the user's total interest income of specified currency + * Get the user's total interest income of specified currency. * - * @param currency Currency (required) + * @param currency Currency. (required) * @return ApiResponse<UniLendInterest> * @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 Successfully retrieved. -
*/ public ApiResponse getUniInterestWithHttpInfo(String currency) throws ApiException { @@ -948,16 +948,16 @@ public ApiResponse getUniInterestWithHttpInfo(String currency) } /** - * Get the user's total interest income of specified currency (asynchronously) + * Get the user's total interest income of specified currency. (asynchronously) * - * @param currency Currency (required) + * @param currency 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 -
200 Successfully retrieved. -
*/ public okhttp3.Call getUniInterestAsync(String currency, final ApiCallback _callback) throws ApiException { @@ -1048,7 +1048,7 @@ private APIlistUniInterestRecordsRequest() { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Retrieve data of the specified currency. (optional) * @return APIlistUniInterestRecordsRequest */ public APIlistUniInterestRecordsRequest currency(String currency) { @@ -1058,7 +1058,7 @@ public APIlistUniInterestRecordsRequest currency(String currency) { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistUniInterestRecordsRequest */ public APIlistUniInterestRecordsRequest page(Integer page) { @@ -1068,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 response items. Default: 100, minimum: 1, Maximum: 100. (optional, default to 100) * @return APIlistUniInterestRecordsRequest */ public APIlistUniInterestRecordsRequest limit(Integer limit) { @@ -1104,7 +1104,7 @@ public APIlistUniInterestRecordsRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1118,7 +1118,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public List execute() throws ApiException { @@ -1133,7 +1133,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1148,7 +1148,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExce * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1157,13 +1157,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _cal } /** - * List interest records + * List interest records. * * @return APIlistUniInterestRecordsRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public APIlistUniInterestRecordsRequest listUniInterestRecords() { @@ -1172,14 +1172,14 @@ public APIlistUniInterestRecordsRequest listUniInterestRecords() { /** * Build call for getUniInterestStatus - * @param currency Currency (required) + * @param currency 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 -
200 Successfully retrieved. -
*/ public okhttp3.Call getUniInterestStatusCall(String currency, final ApiCallback _callback) throws ApiException { @@ -1224,15 +1224,15 @@ private okhttp3.Call getUniInterestStatusValidateBeforeCall(String currency, fin } /** - * query currency interest compounding status + * query currency interest compounding status. * - * @param currency Currency (required) + * @param currency Currency. (required) * @return UniCurrencyInterest * @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 Successfully retrieved. -
*/ public UniCurrencyInterest getUniInterestStatus(String currency) throws ApiException { @@ -1241,15 +1241,15 @@ public UniCurrencyInterest getUniInterestStatus(String currency) throws ApiExcep } /** - * query currency interest compounding status + * query currency interest compounding status. * - * @param currency Currency (required) + * @param currency Currency. (required) * @return ApiResponse<UniCurrencyInterest> * @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 Successfully retrieved. -
*/ public ApiResponse getUniInterestStatusWithHttpInfo(String currency) throws ApiException { @@ -1259,16 +1259,16 @@ public ApiResponse getUniInterestStatusWithHttpInfo(String } /** - * query currency interest compounding status (asynchronously) + * query currency interest compounding status. (asynchronously) * - * @param currency Currency (required) + * @param currency 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 -
200 Successfully retrieved. -
*/ public okhttp3.Call getUniInterestStatusAsync(String currency, final ApiCallback _callback) throws ApiException { @@ -1280,16 +1280,16 @@ 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 asset Currency name (required) + * @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 asset 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 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:48+0000 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 -
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 { @@ -1355,17 +1355,17 @@ 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-07-15 06:48+0000 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, unit s, maximum span of 30 days (required) - * @param to End timestamp, unit s, maximum span of 30 days (required) - * @param asset Currency name (required) + * UniLoan currency annualized trend chart. + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <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, unit s, maximum span of 30 days. (required) + * @param to End timestamp, unit s, maximum span of 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-07-15 06:48+0000 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 -
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 { @@ -1374,17 +1374,17 @@ 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-07-15 06:48+0000 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, unit s, maximum span of 30 days (required) - * @param to End timestamp, unit s, maximum span of 30 days (required) - * @param asset Currency name (required) + * UniLoan currency annualized trend chart. + * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <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, unit s, maximum span of 30 days. (required) + * @param to End timestamp, unit s, maximum span of 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-07-15 06:48+0000 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 -
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 { @@ -1394,18 +1394,18 @@ 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-07-15 06:48+0000 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, unit s, maximum span of 30 days (required) - * @param to End timestamp, unit s, maximum span of 30 days (required) - * @param asset Currency name (required) + * UniLoan currency annualized trend chart. (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 from Start timestamp, unit s, maximum span of 30 days. (required) + * @param to End timestamp, unit s, maximum span of 30 days. (required) + * @param asset 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 Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-15 06:48+0000 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 -
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 { @@ -1423,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-07-15 06:48+0000 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 -
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 { @@ -1462,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-07-15 06:48+0000 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 + * Currency estimate 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-07-15 06:48+0000 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 -
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 { @@ -1478,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-07-15 06:48+0000 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 + * Currency estimate 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-07-15 06:48+0000 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 -
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 { @@ -1495,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-07-15 06:48+0000 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 + * Currency estimate 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-07-15 06:48+0000 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 -
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 14e4473..5032327 100644 --- a/src/main/java/io/gate/gateapi/api/FlashSwapApi.java +++ b/src/main/java/io/gate/gateapi/api/FlashSwapApi.java @@ -122,7 +122,7 @@ private APIlistFlashSwapCurrencyPairRequest() { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Retrieve data of the specified currency. (optional) * @return APIlistFlashSwapCurrencyPairRequest */ public APIlistFlashSwapCurrencyPairRequest currency(String currency) { @@ -132,7 +132,7 @@ public APIlistFlashSwapCurrencyPairRequest currency(String currency) { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistFlashSwapCurrencyPairRequest */ public APIlistFlashSwapCurrencyPairRequest page(Integer page) { @@ -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 response items. Default: 100, 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -211,13 +211,13 @@ public okhttp3.Call executeAsync(final ApiCallback> } /** - * List All Supported Currency Pairs In Flash Swap + * List All Supported Currency Pairs In Flash Swap. * `BTC_GT` represents selling BTC and buying GT. The limits for each currency may vary across different currency pairs. It is not necessary that two currencies that can be swapped instantaneously can be exchanged with each other. For example, it is possible to sell BTC and buy GT, but it does not necessarily mean that GT can be sold to buy BTC. * @return APIlistFlashSwapCurrencyPairRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public APIlistFlashSwapCurrencyPairRequest listFlashSwapCurrencyPair() { @@ -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 If results are sorted by id in reverse order. Default to `true` - `true`: sort by id in descending order(recent first) - ascending order(oldest first) (optional) * @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 to be returned in a single list. (optional, default to 100) * @return APIlistFlashSwapOrdersRequest */ public APIlistFlashSwapOrdersRequest limit(Integer limit) { @@ -360,7 +360,7 @@ public APIlistFlashSwapOrdersRequest limit(Integer limit) { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistFlashSwapOrdersRequest */ public APIlistFlashSwapOrdersRequest page(Integer page) { @@ -376,7 +376,7 @@ public APIlistFlashSwapOrdersRequest page(Integer page) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ 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 + * List all flash swap orders. * * @return APIlistFlashSwapOrdersRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ 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 The flash swap order is created successfully. -
*/ public okhttp3.Call createFlashSwapOrderCall(FlashSwapOrderRequest flashSwapOrderRequest, final ApiCallback _callback) throws ApiException { @@ -495,7 +495,7 @@ private okhttp3.Call createFlashSwapOrderValidateBeforeCall(FlashSwapOrderReques } /** - * Create a flash swap order + * Create a flash swap order. * Initiate a flash swap preview in advance because order creation requires a preview result * @param flashSwapOrderRequest (required) * @return FlashSwapOrder @@ -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 The flash swap order is created successfully. -
*/ public FlashSwapOrder createFlashSwapOrder(FlashSwapOrderRequest flashSwapOrderRequest) throws ApiException { @@ -512,7 +512,7 @@ public FlashSwapOrder createFlashSwapOrder(FlashSwapOrderRequest flashSwapOrderR } /** - * Create a flash swap order + * Create a flash swap order. * Initiate a flash swap preview in advance because order creation requires a preview result * @param flashSwapOrderRequest (required) * @return ApiResponse<FlashSwapOrder> @@ -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 The flash swap order is created successfully. -
*/ public ApiResponse createFlashSwapOrderWithHttpInfo(FlashSwapOrderRequest flashSwapOrderRequest) throws ApiException { @@ -530,7 +530,7 @@ public ApiResponse createFlashSwapOrderWithHttpInfo(FlashSwapOrd } /** - * Create a flash swap order (asynchronously) + * Create a flash swap order. (asynchronously) * Initiate a flash swap preview in advance because order creation requires a preview result * @param flashSwapOrderRequest (required) * @param _callback The callback to be executed when the API call finishes @@ -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 The flash swap order is created successfully. -
*/ public okhttp3.Call createFlashSwapOrderAsync(FlashSwapOrderRequest flashSwapOrderRequest, final ApiCallback _callback) throws ApiException { @@ -551,14 +551,14 @@ public okhttp3.Call createFlashSwapOrderAsync(FlashSwapOrderRequest flashSwapOrd /** * Build call for getFlashSwapOrder - * @param orderId Flash swap order ID (required) + * @param orderId Flash swap order 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 -
200 Successfully retrieved. -
*/ public okhttp3.Call getFlashSwapOrderCall(Integer orderId, final ApiCallback _callback) throws ApiException { @@ -603,15 +603,15 @@ private okhttp3.Call getFlashSwapOrderValidateBeforeCall(Integer orderId, final } /** - * Get a single flash swap order's detail + * Get a single flash swap order's detail. * - * @param orderId Flash swap order ID (required) + * @param orderId Flash swap order ID. (required) * @return FlashSwapOrder * @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 Successfully retrieved. -
*/ public FlashSwapOrder getFlashSwapOrder(Integer orderId) throws ApiException { @@ -620,15 +620,15 @@ public FlashSwapOrder getFlashSwapOrder(Integer orderId) throws ApiException { } /** - * Get a single flash swap order's detail + * Get a single flash swap order's detail. * - * @param orderId Flash swap order ID (required) + * @param orderId Flash swap order ID. (required) * @return ApiResponse<FlashSwapOrder> * @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 Successfully retrieved. -
*/ public ApiResponse getFlashSwapOrderWithHttpInfo(Integer orderId) throws ApiException { @@ -638,16 +638,16 @@ public ApiResponse getFlashSwapOrderWithHttpInfo(Integer orderId } /** - * Get a single flash swap order's detail (asynchronously) + * Get a single flash swap order's detail. (asynchronously) * - * @param orderId Flash swap order ID (required) + * @param orderId Flash swap order 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 -
200 Successfully retrieved. -
*/ 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 The flash swap order successfully previewed. - */ 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 + * Initiate a 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 The flash swap order successfully previewed. -
*/ public FlashSwapOrderPreview previewFlashSwapOrder(FlashSwapPreviewRequest flashSwapPreviewRequest) throws ApiException { @@ -727,7 +727,7 @@ public FlashSwapOrderPreview previewFlashSwapOrder(FlashSwapPreviewRequest flash } /** - * Initiate a flash swap order preview + * Initiate a 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 The flash swap order successfully previewed. -
*/ public ApiResponse previewFlashSwapOrderWithHttpInfo(FlashSwapPreviewRequest flashSwapPreviewRequest) throws ApiException { @@ -745,7 +745,7 @@ public ApiResponse previewFlashSwapOrderWithHttpInfo(Flas } /** - * Initiate a flash swap order preview (asynchronously) + * Initiate a 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 The flash swap order successfully previewed. -
*/ 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 2771b5a..1041847 100644 --- a/src/main/java/io/gate/gateapi/api/FuturesApi.java +++ b/src/main/java/io/gate/gateapi/api/FuturesApi.java @@ -152,7 +152,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 to be returned in a single list. (optional, default to 100) * @return APIlistFuturesContractsRequest */ public APIlistFuturesContractsRequest limit(Integer limit) { @@ -162,7 +162,7 @@ public APIlistFuturesContractsRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIlistFuturesContractsRequest */ public APIlistFuturesContractsRequest offset(Integer offset) { @@ -178,7 +178,7 @@ public APIlistFuturesContractsRequest offset(Integer offset) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -192,7 +192,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public List execute() throws ApiException { @@ -207,7 +207,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -222,7 +222,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -231,14 +231,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) th } /** - * List all futures contracts + * List all futures contracts. * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @return APIlistFuturesContractsRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistFuturesContractsRequest listFuturesContracts(String settle) { @@ -247,15 +247,15 @@ public APIlistFuturesContractsRequest listFuturesContracts(String settle) { /** * Build call for getFuturesContract - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (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 Contract information -
200 Contract information. -
*/ public okhttp3.Call getFuturesContractCall(String settle, String contract, final ApiCallback _callback) throws ApiException { @@ -306,16 +306,16 @@ private okhttp3.Call getFuturesContractValidateBeforeCall(String settle, String } /** - * Get a single contract + * Get a single contract. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) * @return Contract * @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 Contract information -
200 Contract information. -
*/ public Contract getFuturesContract(String settle, String contract) throws ApiException { @@ -324,16 +324,16 @@ public Contract getFuturesContract(String settle, String contract) throws ApiExc } /** - * Get a single contract + * Get a single contract. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) * @return ApiResponse<Contract> * @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 Contract information -
200 Contract information. -
*/ public ApiResponse getFuturesContractWithHttpInfo(String settle, String contract) throws ApiException { @@ -343,17 +343,17 @@ public ApiResponse getFuturesContractWithHttpInfo(String settle, Strin } /** - * Get a single contract (asynchronously) + * Get a single contract. (asynchronously) * - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (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 Contract information -
200 Contract information. -
*/ public okhttp3.Call getFuturesContractAsync(String settle, String contract, final ApiCallback _callback) throws ApiException { @@ -453,7 +453,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 Order depth. 0 means no aggregation is applied. default to 0. (optional, default to "0") * @return APIlistFuturesOrderBookRequest */ public APIlistFuturesOrderBookRequest interval(String interval) { @@ -463,7 +463,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 Maximum number of order depth data in asks or bids. (optional, default to 10) * @return APIlistFuturesOrderBookRequest */ public APIlistFuturesOrderBookRequest limit(Integer limit) { @@ -489,7 +489,7 @@ public APIlistFuturesOrderBookRequest withId(Boolean withId) { * @http.response.details - +
Status Code Description Response Headers
200 Depth query successful -
200 Depth query successful. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -503,7 +503,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Depth query successful -
200 Depth query successful. -
*/ public FuturesOrderBook execute() throws ApiException { @@ -518,7 +518,7 @@ public FuturesOrderBook execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Depth query successful -
200 Depth query successful. -
*/ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -533,7 +533,7 @@ public ApiResponse executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Depth query successful -
200 Depth query successful. -
*/ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -542,15 +542,15 @@ public okhttp3.Call executeAsync(final ApiCallback _callback) } /** - * Futures order book - * Bids will be sorted by price from high to low, while asks sorted reversely - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * Futures order book. + * Bids will be sorted by price from high to low, while asks sorted reversely. + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) * @return APIlistFuturesOrderBookRequest * @http.response.details - +
Status Code Description Response Headers
200 Depth query successful -
200 Depth query successful. -
*/ public APIlistFuturesOrderBookRequest listFuturesOrderBook(String settle, String contract) { @@ -657,7 +657,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 to be returned in a single list. (optional, default to 100) * @return APIlistFuturesTradesRequest */ public APIlistFuturesTradesRequest limit(Integer limit) { @@ -667,7 +667,7 @@ public APIlistFuturesTradesRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIlistFuturesTradesRequest */ public APIlistFuturesTradesRequest offset(Integer offset) { @@ -697,7 +697,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) { @@ -713,7 +713,7 @@ public APIlistFuturesTradesRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -727,7 +727,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public List execute() throws ApiException { @@ -742,7 +742,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -757,7 +757,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -766,15 +766,15 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * Futures trading history + * Futures trading history. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) * @return APIlistFuturesTradesRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistFuturesTradesRequest listFuturesTrades(String settle, String contract) { @@ -886,7 +886,7 @@ public APIlistFuturesCandlesticksRequest from(Long from) { /** * Set to - * @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 (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 specified (optional) * @return APIlistFuturesCandlesticksRequest */ public APIlistFuturesCandlesticksRequest to(Long to) { @@ -906,7 +906,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 natual week(Mon-Sun), while `7d` means every 7d since unix 0. 1 natual month, not 30 days (optional, default to "5m") * @return APIlistFuturesCandlesticksRequest */ public APIlistFuturesCandlesticksRequest interval(String interval) { @@ -922,7 +922,7 @@ public APIlistFuturesCandlesticksRequest interval(String interval) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ 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 Successfully retrieved -
200 Successfully retrieved. -
*/ public List execute() throws ApiException { @@ -951,7 +951,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -966,7 +966,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExc * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -975,15 +975,15 @@ public okhttp3.Call executeAsync(final ApiCallback> _ca } /** - * Get futures candlesticks + * Get futures candlesticks. * 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) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) * @return APIlistFuturesCandlesticksRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public APIlistFuturesCandlesticksRequest listFuturesCandlesticks(String settle, String contract) { @@ -1095,7 +1095,7 @@ public APIlistFuturesPremiumIndexRequest from(Long from) { /** * Set to - * @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 (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 specified (optional) * @return APIlistFuturesPremiumIndexRequest */ public APIlistFuturesPremiumIndexRequest to(Long to) { @@ -1115,7 +1115,7 @@ public APIlistFuturesPremiumIndexRequest limit(Integer limit) { /** * Set interval - * @param interval Interval time between data points (optional, default to "5m") + * @param interval Interval time between data points. (optional, default to "5m") * @return APIlistFuturesPremiumIndexRequest */ public APIlistFuturesPremiumIndexRequest interval(String interval) { @@ -1131,7 +1131,7 @@ public APIlistFuturesPremiumIndexRequest interval(String interval) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1145,7 +1145,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public List execute() throws ApiException { @@ -1160,7 +1160,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1175,7 +1175,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiEx * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1184,15 +1184,15 @@ public okhttp3.Call executeAsync(final ApiCallback> _c } /** - * Premium Index K-Line + * Premium Index K-Line. * 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) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) * @return APIlistFuturesPremiumIndexRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public APIlistFuturesPremiumIndexRequest listFuturesPremiumIndex(String settle, String contract) { @@ -1268,7 +1268,7 @@ private APIlistFuturesTickersRequest(String settle) { /** * Set contract - * @param contract Futures contract, return related data only if specified (optional) + * @param contract Futures contract, return related data only if specified. (optional) * @return APIlistFuturesTickersRequest */ public APIlistFuturesTickersRequest contract(String contract) { @@ -1284,7 +1284,7 @@ public APIlistFuturesTickersRequest contract(String contract) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1298,7 +1298,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public List execute() throws ApiException { @@ -1313,7 +1313,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1328,7 +1328,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExceptio * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1337,14 +1337,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callbac } /** - * List futures tickers + * List futures tickers. * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @return APIlistFuturesTickersRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public APIlistFuturesTickersRequest listFuturesTickers(String settle) { @@ -1441,7 +1441,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 to be returned in a single list. (optional, default to 100) * @return APIlistFuturesFundingRateHistoryRequest */ public APIlistFuturesFundingRateHistoryRequest limit(Integer limit) { @@ -1477,7 +1477,7 @@ public APIlistFuturesFundingRateHistoryRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 History retrieved -
200 History retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1491,7 +1491,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 History retrieved -
200 History retrieved. -
*/ public List execute() throws ApiException { @@ -1506,7 +1506,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 History retrieved -
200 History retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1521,7 +1521,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExce * @http.response.details - +
Status Code Description Response Headers
200 History retrieved -
200 History retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1530,15 +1530,15 @@ public okhttp3.Call executeAsync(final ApiCallback> _cal } /** - * Funding rate history + * Funding rate history. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) * @return APIlistFuturesFundingRateHistoryRequest * @http.response.details - +
Status Code Description Response Headers
200 History retrieved -
200 History retrieved. -
*/ public APIlistFuturesFundingRateHistoryRequest listFuturesFundingRateHistory(String settle, String contract) { @@ -1614,7 +1614,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 to be returned in a single list. (optional, default to 100) * @return APIlistFuturesInsuranceLedgerRequest */ public APIlistFuturesInsuranceLedgerRequest limit(Integer limit) { @@ -1630,7 +1630,7 @@ public APIlistFuturesInsuranceLedgerRequest limit(Integer limit) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1644,7 +1644,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public List execute() throws ApiException { @@ -1659,7 +1659,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1674,7 +1674,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcept * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1683,14 +1683,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callb } /** - * Futures insurance balance history + * Futures insurance balance history. * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @return APIlistFuturesInsuranceLedgerRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public APIlistFuturesInsuranceLedgerRequest listFuturesInsuranceLedger(String settle) { @@ -1787,7 +1787,7 @@ private APIlistContractStatsRequest(String settle, String contract) { /** * Set from - * @param from Start timestamp (optional) + * @param from Start timestamp. (optional) * @return APIlistContractStatsRequest */ public APIlistContractStatsRequest from(Long from) { @@ -1823,7 +1823,7 @@ public APIlistContractStatsRequest limit(Integer limit) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1837,7 +1837,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public List execute() throws ApiException { @@ -1852,7 +1852,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1867,7 +1867,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1876,15 +1876,15 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * Futures stats + * Futures stats. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) * @return APIlistContractStatsRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistContractStatsRequest listContractStats(String settle, String contract) { @@ -1893,15 +1893,15 @@ public APIlistContractStatsRequest listContractStats(String settle, String contr /** * Build call for getIndexConstituents - * @param settle Settle currency (required) - * @param index Index name (required) + * @param settle Settle currency. (required) + * @param index Index 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 Successfully retrieved. -
*/ public okhttp3.Call getIndexConstituentsCall(String settle, String index, final ApiCallback _callback) throws ApiException { @@ -1952,16 +1952,16 @@ private okhttp3.Call getIndexConstituentsValidateBeforeCall(String settle, Strin } /** - * Get index constituents + * Get index constituents. * - * @param settle Settle currency (required) - * @param index Index name (required) + * @param settle Settle currency. (required) + * @param index Index name. (required) * @return FuturesIndexConstituents * @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 Successfully retrieved. -
*/ public FuturesIndexConstituents getIndexConstituents(String settle, String index) throws ApiException { @@ -1970,16 +1970,16 @@ public FuturesIndexConstituents getIndexConstituents(String settle, String index } /** - * Get index constituents + * Get index constituents. * - * @param settle Settle currency (required) - * @param index Index name (required) + * @param settle Settle currency. (required) + * @param index Index name. (required) * @return ApiResponse<FuturesIndexConstituents> * @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 Successfully retrieved. -
*/ public ApiResponse getIndexConstituentsWithHttpInfo(String settle, String index) throws ApiException { @@ -1989,17 +1989,17 @@ public ApiResponse getIndexConstituentsWithHttpInfo(St } /** - * Get index constituents (asynchronously) + * Get index constituents. (asynchronously) * - * @param settle Settle currency (required) - * @param index Index name (required) + * @param settle Settle currency. (required) + * @param index Index 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 Successfully retrieved. -
*/ public okhttp3.Call getIndexConstituentsAsync(String settle, String index, final ApiCallback _callback) throws ApiException { @@ -2093,7 +2093,7 @@ private APIlistLiquidatedOrdersRequest(String settle) { /** * Set contract - * @param contract Futures contract, return related data only if specified (optional) + * @param contract Futures contract, return related data only if specified. (optional) * @return APIlistLiquidatedOrdersRequest */ public APIlistLiquidatedOrdersRequest contract(String contract) { @@ -2123,7 +2123,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 to be returned in a single list. (optional, default to 100) * @return APIlistLiquidatedOrdersRequest */ public APIlistLiquidatedOrdersRequest limit(Integer limit) { @@ -2139,7 +2139,7 @@ public APIlistLiquidatedOrdersRequest limit(Integer limit) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2153,7 +2153,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public List execute() throws ApiException { @@ -2168,7 +2168,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -2183,7 +2183,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcept * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2192,14 +2192,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callb } /** - * Retrieve liquidation history - * The maximum time interval between `from` and `to` is **3600 seconds**. Certain private fields will **not be returned** in public endpoints; refer to individual field descriptions for details. - * @param settle Settle currency (required) + * Retrieve liquidation history. + * The time interval between from and to is maximum 3600. Some private fields are not returned by public interfaces, refer to field descriptions for interfaces, refer to field descriptions for details + * @param settle Settle currency. (required) * @return APIlistLiquidatedOrdersRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistLiquidatedOrdersRequest listLiquidatedOrders(String settle) { @@ -2285,7 +2285,7 @@ private APIlistFuturesRiskLimitTiersRequest(String settle) { /** * Set contract - * @param contract Futures contract, return related data only if specified (optional) + * @param contract Futures contract, return related data only if specified. (optional) * @return APIlistFuturesRiskLimitTiersRequest */ public APIlistFuturesRiskLimitTiersRequest contract(String contract) { @@ -2295,7 +2295,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 to be returned in a single list. (optional, default to 100) * @return APIlistFuturesRiskLimitTiersRequest */ public APIlistFuturesRiskLimitTiersRequest limit(Integer limit) { @@ -2305,7 +2305,7 @@ public APIlistFuturesRiskLimitTiersRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIlistFuturesRiskLimitTiersRequest */ public APIlistFuturesRiskLimitTiersRequest offset(Integer offset) { @@ -2321,7 +2321,7 @@ public APIlistFuturesRiskLimitTiersRequest offset(Integer offset) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2335,7 +2335,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public List execute() throws ApiException { @@ -2350,7 +2350,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -2365,7 +2365,7 @@ public ApiResponse> executeWithHttpInfo() throws Api * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2374,14 +2374,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. - * @param settle Settle currency (required) + * 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 empty. + * @param settle Settle currency. (required) * @return APIlistFuturesRiskLimitTiersRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public APIlistFuturesRiskLimitTiersRequest listFuturesRiskLimitTiers(String settle) { @@ -2390,14 +2390,14 @@ public APIlistFuturesRiskLimitTiersRequest listFuturesRiskLimitTiers(String sett /** * Build call for listFuturesAccounts - * @param settle Settle currency (required) + * @param settle Settle 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 -
200 Successfully retrieved. -
*/ public okhttp3.Call listFuturesAccountsCall(String settle, final ApiCallback _callback) throws ApiException { @@ -2442,15 +2442,15 @@ private okhttp3.Call listFuturesAccountsValidateBeforeCall(String settle, final } /** - * Query futures account + * Query futures account. * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @return FuturesAccount * @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 Successfully retrieved. -
*/ public FuturesAccount listFuturesAccounts(String settle) throws ApiException { @@ -2459,15 +2459,15 @@ public FuturesAccount listFuturesAccounts(String settle) throws ApiException { } /** - * Query futures account + * Query futures account. * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @return ApiResponse<FuturesAccount> * @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 Successfully retrieved. -
*/ public ApiResponse listFuturesAccountsWithHttpInfo(String settle) throws ApiException { @@ -2477,16 +2477,16 @@ public ApiResponse listFuturesAccountsWithHttpInfo(String settle } /** - * Query futures account (asynchronously) + * Query futures account. (asynchronously) * - * @param settle Settle currency (required) + * @param settle Settle 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 -
200 Successfully retrieved. -
*/ public okhttp3.Call listFuturesAccountsAsync(String settle, final ApiCallback _callback) throws ApiException { @@ -2590,7 +2590,7 @@ private APIlistFuturesAccountBookRequest(String settle) { /** * Set contract - * @param contract Futures contract, return related data only if specified (optional) + * @param contract Futures contract, return related data only if specified. (optional) * @return APIlistFuturesAccountBookRequest */ public APIlistFuturesAccountBookRequest contract(String contract) { @@ -2600,7 +2600,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 to be returned in a single list. (optional, default to 100) * @return APIlistFuturesAccountBookRequest */ public APIlistFuturesAccountBookRequest limit(Integer limit) { @@ -2610,7 +2610,7 @@ public APIlistFuturesAccountBookRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIlistFuturesAccountBookRequest */ public APIlistFuturesAccountBookRequest offset(Integer offset) { @@ -2640,7 +2640,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 Changing Type： - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: point_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction (optional) * @return APIlistFuturesAccountBookRequest */ public APIlistFuturesAccountBookRequest type(String type) { @@ -2656,7 +2656,7 @@ public APIlistFuturesAccountBookRequest type(String type) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2670,7 +2670,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public List execute() throws ApiException { @@ -2685,7 +2685,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -2700,7 +2700,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExc * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2709,14 +2709,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _ca } /** - * Query account book - * If the contract field is passed, only records containing this field after 2023-10-30 can be filtered。 2023-10-30 can be filtered。 2023-10-30 can be filtered。 - * @param settle Settle currency (required) + * Query account book. + * If the contract field is passed, only records containing this field after 2023-10-30 can be filtered。 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. -
*/ public APIlistFuturesAccountBookRequest listFuturesAccountBook(String settle) { @@ -2812,7 +2812,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 to be returned in a single list. (optional, default to 100) * @return APIlistPositionsRequest */ public APIlistPositionsRequest limit(Integer limit) { @@ -2822,7 +2822,7 @@ public APIlistPositionsRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIlistPositionsRequest */ public APIlistPositionsRequest offset(Integer offset) { @@ -2838,7 +2838,7 @@ public APIlistPositionsRequest offset(Integer offset) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2852,7 +2852,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public List execute() throws ApiException { @@ -2867,7 +2867,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -2882,7 +2882,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2891,14 +2891,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) th } /** - * List all positions of a user + * List all positions of a user. * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @return APIlistPositionsRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistPositionsRequest listPositions(String settle) { @@ -2983,7 +2983,7 @@ private APIgetPositionRequest(String settle, String contract) { * @http.response.details - +
Status Code Description Response Headers
200 Position information -
200 Position information. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2997,7 +2997,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Position information -
200 Position information. -
*/ public Position execute() throws ApiException { @@ -3012,7 +3012,7 @@ public Position execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Position information -
200 Position information. -
*/ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -3027,7 +3027,7 @@ public ApiResponse executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Position information -
200 Position information. -
*/ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -3036,15 +3036,15 @@ public okhttp3.Call executeAsync(final ApiCallback _callback) throws A } /** - * Get single position + * Get single position. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) * @return APIgetPositionRequest * @http.response.details - +
Status Code Description Response Headers
200 Position information -
200 Position information. -
*/ public APIgetPositionRequest getPosition(String settle, String contract) { @@ -3053,16 +3053,16 @@ 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 amount, positive number increases, negative number (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) + * @param change Margin change amount, positive number increases, negative number. (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 Position information -
200 Position information. -
*/ public okhttp3.Call updatePositionMarginCall(String settle, String contract, String change, final ApiCallback _callback) throws ApiException { @@ -3122,17 +3122,17 @@ private okhttp3.Call updatePositionMarginValidateBeforeCall(String settle, Strin } /** - * Update position margin + * Update position margin. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param change Margin change amount, positive number increases, negative number (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) + * @param change Margin change amount, positive number increases, negative number. (required) * @return 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 Position information -
200 Position information. -
*/ public Position updatePositionMargin(String settle, String contract, String change) throws ApiException { @@ -3141,17 +3141,17 @@ public Position updatePositionMargin(String settle, String contract, String chan } /** - * Update position margin + * Update position margin. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param change Margin change amount, positive number increases, negative number (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) + * @param change Margin change amount, positive number increases, negative number. (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 - +
Status Code Description Response Headers
200 Position information -
200 Position information. -
*/ public ApiResponse updatePositionMarginWithHttpInfo(String settle, String contract, String change) throws ApiException { @@ -3161,18 +3161,18 @@ public ApiResponse updatePositionMarginWithHttpInfo(String settle, Str } /** - * Update position margin (asynchronously) + * Update position margin. (asynchronously) * - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param change Margin change amount, positive number increases, negative number (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) + * @param change Margin change amount, positive number increases, negative number. (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 Position information -
200 Position information. -
*/ public okhttp3.Call updatePositionMarginAsync(String settle, String contract, String change, final ApiCallback _callback) throws ApiException { @@ -3184,17 +3184,17 @@ public okhttp3.Call updatePositionMarginAsync(String settle, String contract, St /** * Build call for updatePositionLeverage - * @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 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 _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 Position information -
200 Position information. -
*/ public okhttp3.Call updatePositionLeverageCall(String settle, String contract, String leverage, String crossLeverageLimit, final ApiCallback _callback) throws ApiException { @@ -3258,18 +3258,18 @@ private okhttp3.Call updatePositionLeverageValidateBeforeCall(String settle, Str } /** - * Update position leverage + * Update position leverage. * - * @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 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) * @return 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 Position information -
200 Position information. -
*/ public Position updatePositionLeverage(String settle, String contract, String leverage, String crossLeverageLimit) throws ApiException { @@ -3278,18 +3278,18 @@ public Position updatePositionLeverage(String settle, String contract, String le } /** - * Update position leverage + * Update position leverage. * - * @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 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) * @return ApiResponse<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 Position information -
200 Position information. -
*/ public ApiResponse updatePositionLeverageWithHttpInfo(String settle, String contract, String leverage, String crossLeverageLimit) throws ApiException { @@ -3299,19 +3299,19 @@ public ApiResponse updatePositionLeverageWithHttpInfo(String settle, S } /** - * Update position leverage (asynchronously) + * Update position leverage. (asynchronously) * - * @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 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 _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 Position information -
200 Position information. -
*/ public okhttp3.Call updatePositionLeverageAsync(String settle, String contract, String leverage, String crossLeverageLimit, final ApiCallback _callback) throws ApiException { @@ -3323,7 +3323,7 @@ public okhttp3.Call updatePositionLeverageAsync(String settle, String contract, /** * Build call for updatePositionCrossMode - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @param futuresPositionCrossMode (required) * @param _callback Callback for upload/download progress * @return Call to execute @@ -3331,7 +3331,7 @@ public okhttp3.Call updatePositionLeverageAsync(String settle, String contract, * @http.response.details - +
Status Code Description Response Headers
200 Position information -
200 Position information. -
*/ public okhttp3.Call updatePositionCrossModeCall(String settle, FuturesPositionCrossMode futuresPositionCrossMode, final ApiCallback _callback) throws ApiException { @@ -3381,16 +3381,16 @@ private okhttp3.Call updatePositionCrossModeValidateBeforeCall(String settle, Fu } /** - * Switch to the full position-by-store mode + * Switch to the full position-by-store mode. * - * @param settle Settle currency (required) + * @param settle Settle currency. (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 - +
Status Code Description Response Headers
200 Position information -
200 Position information. -
*/ public Position updatePositionCrossMode(String settle, FuturesPositionCrossMode futuresPositionCrossMode) throws ApiException { @@ -3399,16 +3399,16 @@ public Position updatePositionCrossMode(String settle, FuturesPositionCrossMode } /** - * Switch to the full position-by-store mode + * Switch to the full position-by-store mode. * - * @param settle Settle currency (required) + * @param settle Settle currency. (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 - +
Status Code Description Response Headers
200 Position information -
200 Position information. -
*/ public ApiResponse updatePositionCrossModeWithHttpInfo(String settle, FuturesPositionCrossMode futuresPositionCrossMode) throws ApiException { @@ -3418,9 +3418,9 @@ public ApiResponse updatePositionCrossModeWithHttpInfo(String settle, } /** - * Switch to the full position-by-store mode (asynchronously) + * Switch to the full position-by-store mode. (asynchronously) * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @param futuresPositionCrossMode (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -3428,7 +3428,7 @@ public ApiResponse updatePositionCrossModeWithHttpInfo(String settle, * @http.response.details - +
Status Code Description Response Headers
200 Position information -
200 Position information. -
*/ public okhttp3.Call updatePositionCrossModeAsync(String settle, FuturesPositionCrossMode futuresPositionCrossMode, final ApiCallback _callback) throws ApiException { @@ -3440,16 +3440,16 @@ public okhttp3.Call updatePositionCrossModeAsync(String settle, FuturesPositionC /** * Build call for updatePositionRiskLimit - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param riskLimit New Risk Limit Value (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (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 Position information -
200 Position information. -
*/ public okhttp3.Call updatePositionRiskLimitCall(String settle, String contract, String riskLimit, final ApiCallback _callback) throws ApiException { @@ -3509,17 +3509,17 @@ private okhttp3.Call updatePositionRiskLimitValidateBeforeCall(String settle, St } /** - * Update position risk limit + * Update position risk limit. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param riskLimit New Risk Limit Value (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (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 - +
Status Code Description Response Headers
200 Position information -
200 Position information. -
*/ public Position updatePositionRiskLimit(String settle, String contract, String riskLimit) throws ApiException { @@ -3528,17 +3528,17 @@ public Position updatePositionRiskLimit(String settle, String contract, String r } /** - * Update position risk limit + * Update position risk limit. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param riskLimit New Risk Limit Value (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (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 - +
Status Code Description Response Headers
200 Position information -
200 Position information. -
*/ public ApiResponse updatePositionRiskLimitWithHttpInfo(String settle, String contract, String riskLimit) throws ApiException { @@ -3548,18 +3548,18 @@ public ApiResponse updatePositionRiskLimitWithHttpInfo(String settle, } /** - * Update position risk limit (asynchronously) + * Update position risk limit. (asynchronously) * - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param riskLimit New Risk Limit Value (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (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 Position information -
200 Position information. -
*/ public okhttp3.Call updatePositionRiskLimitAsync(String settle, String contract, String riskLimit, final ApiCallback _callback) throws ApiException { @@ -3571,15 +3571,15 @@ public okhttp3.Call updatePositionRiskLimitAsync(String settle, String contract, /** * Build call for setDualMode - * @param settle Settle currency (required) - * @param dualMode Whether to enable dual mode (required) + * @param settle Settle currency. (required) + * @param dualMode Whether to enable dual mode. (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 -
200 Updated. -
*/ public okhttp3.Call setDualModeCall(String settle, Boolean dualMode, final ApiCallback _callback) throws ApiException { @@ -3633,16 +3633,16 @@ private okhttp3.Call setDualModeValidateBeforeCall(String settle, Boolean dualMo } /** - * Enable or disable dual mode - * The prerequisite for changing mode is that all positions have no holdings - * @param settle Settle currency (required) - * @param dualMode Whether to enable dual mode (required) + * Enable or disable dual mode. + * The prerequisite for changing mode is that all positions have no holdings. + * @param settle Settle currency. (required) + * @param dualMode Whether to enable dual mode. (required) * @return FuturesAccount * @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. -
*/ public FuturesAccount setDualMode(String settle, Boolean dualMode) throws ApiException { @@ -3651,16 +3651,16 @@ public FuturesAccount setDualMode(String settle, Boolean dualMode) throws ApiExc } /** - * Enable or disable dual mode - * The prerequisite for changing mode is that all positions have no holdings - * @param settle Settle currency (required) - * @param dualMode Whether to enable dual mode (required) + * Enable or disable dual mode. + * The prerequisite for changing mode is that all positions have no holdings. + * @param settle Settle currency. (required) + * @param dualMode Whether to enable dual mode. (required) * @return ApiResponse<FuturesAccount> * @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. -
*/ public ApiResponse setDualModeWithHttpInfo(String settle, Boolean dualMode) throws ApiException { @@ -3670,17 +3670,17 @@ public ApiResponse setDualModeWithHttpInfo(String settle, Boolea } /** - * Enable or disable dual mode (asynchronously) - * The prerequisite for changing mode is that all positions have no holdings - * @param settle Settle currency (required) - * @param dualMode Whether to enable dual mode (required) + * Enable or disable dual mode. (asynchronously) + * The prerequisite for changing mode is that all positions have no holdings. + * @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 * @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 -
200 Updated. -
*/ public okhttp3.Call setDualModeAsync(String settle, Boolean dualMode, final ApiCallback _callback) throws ApiException { @@ -3768,7 +3768,7 @@ private APIgetDualModePositionRequest(String settle, String contract) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -3782,7 +3782,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public List execute() throws ApiException { @@ -3797,7 +3797,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -3812,7 +3812,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -3821,15 +3821,15 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) th } /** - * Retrieve position detail in dual mode + * Retrieve position detail in dual mode. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) * @return APIgetDualModePositionRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public APIgetDualModePositionRequest getDualModePosition(String settle, String contract) { @@ -3838,17 +3838,17 @@ 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 amount, positive number increases, negative number (required) - * @param dualSide Long or short position (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) + * @param change Margin change amount, positive number increases, negative number. (required) + * @param dualSide Long or short position. (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 Successfully retrieved. -
*/ public okhttp3.Call updateDualModePositionMarginCall(String settle, String contract, String change, String dualSide, final ApiCallback _callback) throws ApiException { @@ -3917,18 +3917,18 @@ private okhttp3.Call updateDualModePositionMarginValidateBeforeCall(String settl } /** - * Update position margin in dual mode + * Update position margin in dual mode. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param change Margin change amount, positive number increases, negative number (required) - * @param dualSide Long or short position (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) + * @param change Margin change amount, positive number increases, negative number. (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 Successfully retrieved. -
*/ public List updateDualModePositionMargin(String settle, String contract, String change, String dualSide) throws ApiException { @@ -3937,18 +3937,18 @@ public List updateDualModePositionMargin(String settle, String contrac } /** - * Update position margin in dual mode + * Update position margin in dual mode. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param change Margin change amount, positive number increases, negative number (required) - * @param dualSide Long or short position (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) + * @param change Margin change amount, positive number increases, negative number. (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 Successfully retrieved. -
*/ public ApiResponse> updateDualModePositionMarginWithHttpInfo(String settle, String contract, String change, String dualSide) throws ApiException { @@ -3958,19 +3958,19 @@ public ApiResponse> updateDualModePositionMarginWithHttpInfo(Stri } /** - * Update position margin in dual mode (asynchronously) + * Update position margin in dual mode. (asynchronously) * - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param change Margin change amount, positive number increases, negative number (required) - * @param dualSide Long or short position (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (required) + * @param change Margin change amount, positive number increases, negative number. (required) + * @param dualSide Long or short position. (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 Successfully retrieved. -
*/ public okhttp3.Call updateDualModePositionMarginAsync(String settle, String contract, String change, String dualSide, final ApiCallback> _callback) throws ApiException { @@ -3982,17 +3982,17 @@ public okhttp3.Call updateDualModePositionMarginAsync(String settle, String cont /** * Build call for updateDualModePositionLeverage - * @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 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 _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 Successfully retrieved. -
*/ public okhttp3.Call updateDualModePositionLeverageCall(String settle, String contract, String leverage, String crossLeverageLimit, final ApiCallback _callback) throws ApiException { @@ -4056,18 +4056,18 @@ private okhttp3.Call updateDualModePositionLeverageValidateBeforeCall(String set } /** - * Update position leverage in dual mode + * Update position leverage in dual mode. * - * @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 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) * @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 Successfully retrieved. -
*/ public List updateDualModePositionLeverage(String settle, String contract, String leverage, String crossLeverageLimit) throws ApiException { @@ -4076,18 +4076,18 @@ public List updateDualModePositionLeverage(String settle, String contr } /** - * Update position leverage in dual mode + * Update position leverage in dual mode. * - * @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 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) * @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 Successfully retrieved. -
*/ public ApiResponse> updateDualModePositionLeverageWithHttpInfo(String settle, String contract, String leverage, String crossLeverageLimit) throws ApiException { @@ -4097,19 +4097,19 @@ public ApiResponse> updateDualModePositionLeverageWithHttpInfo(St } /** - * Update position leverage in dual mode (asynchronously) + * Update position leverage in dual mode. (asynchronously) * - * @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 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 _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 Successfully retrieved. -
*/ public okhttp3.Call updateDualModePositionLeverageAsync(String settle, String contract, String leverage, String crossLeverageLimit, final ApiCallback> _callback) throws ApiException { @@ -4121,16 +4121,16 @@ 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 settle Settle currency. (required) + * @param contract Futures contract. (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 Successfully retrieved. -
*/ public okhttp3.Call updateDualModePositionRiskLimitCall(String settle, String contract, String riskLimit, final ApiCallback _callback) throws ApiException { @@ -4190,17 +4190,17 @@ private okhttp3.Call updateDualModePositionRiskLimitValidateBeforeCall(String se } /** - * Update position risk limit in dual mode + * Update position risk limit in dual mode. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param riskLimit New Risk Limit Value (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (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 Successfully retrieved. -
*/ public List updateDualModePositionRiskLimit(String settle, String contract, String riskLimit) throws ApiException { @@ -4209,17 +4209,17 @@ public List updateDualModePositionRiskLimit(String settle, String cont } /** - * Update position risk limit in dual mode + * Update position risk limit in dual mode. * - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param riskLimit New Risk Limit Value (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (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 Successfully retrieved. -
*/ public ApiResponse> updateDualModePositionRiskLimitWithHttpInfo(String settle, String contract, String riskLimit) throws ApiException { @@ -4229,18 +4229,18 @@ public ApiResponse> updateDualModePositionRiskLimitWithHttpInfo(S } /** - * Update position risk limit in dual mode (asynchronously) + * Update position risk limit in dual mode. (asynchronously) * - * @param settle Settle currency (required) - * @param contract Futures contract (required) - * @param riskLimit New Risk Limit Value (required) + * @param settle Settle currency. (required) + * @param contract Futures contract. (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 Successfully retrieved. -
*/ public okhttp3.Call updateDualModePositionRiskLimitAsync(String settle, String contract, String riskLimit, final ApiCallback> _callback) throws ApiException { @@ -4345,7 +4345,7 @@ private APIlistFuturesOrdersRequest(String settle, String status) { /** * Set contract - * @param contract Futures contract, return related data only if specified (optional) + * @param contract Futures contract, return related data only if specified. (optional) * @return APIlistFuturesOrdersRequest */ public APIlistFuturesOrdersRequest contract(String contract) { @@ -4355,7 +4355,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 to be returned in a single list. (optional, default to 100) * @return APIlistFuturesOrdersRequest */ public APIlistFuturesOrdersRequest limit(Integer limit) { @@ -4365,7 +4365,7 @@ public APIlistFuturesOrdersRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIlistFuturesOrdersRequest */ public APIlistFuturesOrdersRequest offset(Integer offset) { @@ -4391,7 +4391,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. * X-Pagination-Limit - Request limit specified.
* X-Pagination-Offset - Request offset specified.
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -4405,7 +4405,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. * X-Pagination-Limit - Request limit specified.
* X-Pagination-Offset - Request offset specified.
*/ public List execute() throws ApiException { @@ -4420,7 +4420,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. * X-Pagination-Limit - Request limit specified.
* X-Pagination-Offset - Request offset specified.
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -4435,7 +4435,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. * X-Pagination-Limit - Request limit specified.
* X-Pagination-Offset - Request offset specified.
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -4444,15 +4444,15 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * List futures orders + * List futures orders. * - 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 settle Settle currency. (required) + * @param status Only list the orders with this 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. * X-Pagination-Limit - Request limit specified.
* X-Pagination-Offset - Request offset specified.
*/ public APIlistFuturesOrdersRequest listFuturesOrders(String settle, String status) { @@ -4461,7 +4461,7 @@ public APIlistFuturesOrdersRequest listFuturesOrders(String settle, String statu /** * Build call for createFuturesOrder - * @param settle Settle currency (required) + * @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) * @param _callback Callback for upload/download progress @@ -4470,7 +4470,7 @@ public APIlistFuturesOrdersRequest listFuturesOrders(String settle, String statu * @http.response.details - +
Status Code Description Response Headers
201 Order details -
201 Order details. -
*/ public okhttp3.Call createFuturesOrderCall(String settle, FuturesOrder futuresOrder, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -4524,9 +4524,9 @@ 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` - * @param settle Settle currency (required) + * 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 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) * @return FuturesOrder @@ -4534,7 +4534,7 @@ private okhttp3.Call createFuturesOrderValidateBeforeCall(String settle, Futures * @http.response.details - +
Status Code Description Response Headers
201 Order details -
201 Order details. -
*/ public FuturesOrder createFuturesOrder(String settle, FuturesOrder futuresOrder, String xGateExptime) throws ApiException { @@ -4543,9 +4543,9 @@ 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` - * @param settle Settle currency (required) + * 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 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) * @return ApiResponse<FuturesOrder> @@ -4553,7 +4553,7 @@ public FuturesOrder createFuturesOrder(String settle, FuturesOrder futuresOrder, * @http.response.details - +
Status Code Description Response Headers
201 Order details -
201 Order details. -
*/ public ApiResponse createFuturesOrderWithHttpInfo(String settle, FuturesOrder futuresOrder, String xGateExptime) throws ApiException { @@ -4563,9 +4563,9 @@ 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` - * @param settle Settle currency (required) + * 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 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) * @param _callback The callback to be executed when the API call finishes @@ -4574,7 +4574,7 @@ public ApiResponse createFuturesOrderWithHttpInfo(String settle, F * @http.response.details - +
Status Code Description Response Headers
201 Order details -
201 Order details. -
*/ public okhttp3.Call createFuturesOrderAsync(String settle, FuturesOrder futuresOrder, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -4586,17 +4586,17 @@ public okhttp3.Call createFuturesOrderAsync(String settle, FuturesOrder futuresO /** * Build call for cancelFuturesOrders - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * @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, both are included if not specified. Set to bid to cancel all buy orders, set to ask to cancel all sell ordersspecified. Set to bid to cancel all buy orders, set to ask to cancel all (optional) + * @param side Specify all buy orders or all sell orders, both are included if not specified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell orders (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 All orders matched cancelled. -
*/ public okhttp3.Call cancelFuturesOrdersCall(String settle, String contract, String xGateExptime, String side, final ApiCallback _callback) throws ApiException { @@ -4658,18 +4658,18 @@ private okhttp3.Call cancelFuturesOrdersValidateBeforeCall(String settle, String } /** - * Cancel all `open` orders matched - * Zero-filled order cannot be retrieved 10 minutes after order cancellation - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * Cancel all `open` orders matched. + * Zero-filled order 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, both are included if not specified. Set to bid to cancel all buy orders, set to ask to cancel all sell ordersspecified. Set to bid to cancel all buy orders, set to ask to cancel all (optional) + * @param side Specify all buy orders or all sell orders, both are included if not specified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell orders (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 All orders matched cancelled. -
*/ public List cancelFuturesOrders(String settle, String contract, String xGateExptime, String side) throws ApiException { @@ -4678,18 +4678,18 @@ public List cancelFuturesOrders(String settle, String contract, St } /** - * Cancel all `open` orders matched - * Zero-filled order cannot be retrieved 10 minutes after order cancellation - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * Cancel all `open` orders matched. + * Zero-filled order 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, both are included if not specified. Set to bid to cancel all buy orders, set to ask to cancel all sell ordersspecified. Set to bid to cancel all buy orders, set to ask to cancel all (optional) + * @param side Specify all buy orders or all sell orders, both are included if not specified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell orders (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 All orders matched cancelled. -
*/ public ApiResponse> cancelFuturesOrdersWithHttpInfo(String settle, String contract, String xGateExptime, String side) throws ApiException { @@ -4699,19 +4699,19 @@ public ApiResponse> cancelFuturesOrdersWithHttpInfo(String se } /** - * Cancel all `open` orders matched (asynchronously) - * Zero-filled order cannot be retrieved 10 minutes after order cancellation - * @param settle Settle currency (required) - * @param contract Futures contract (required) + * Cancel all `open` orders matched. (asynchronously) + * Zero-filled order 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, both are included if not specified. Set to bid to cancel all buy orders, set to ask to cancel all sell ordersspecified. Set to bid to cancel all buy orders, set to ask to cancel all (optional) + * @param side Specify all buy orders or all sell orders, both are included if not specified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell orders (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 All orders matched cancelled. -
*/ public okhttp3.Call cancelFuturesOrdersAsync(String settle, String contract, String xGateExptime, String side, final ApiCallback> _callback) throws ApiException { @@ -4810,7 +4810,7 @@ private APIgetOrdersWithTimeRangeRequest(String settle) { /** * Set contract - * @param contract Futures contract, return related data only if specified (optional) + * @param contract Futures contract, return related data only if specified. (optional) * @return APIgetOrdersWithTimeRangeRequest */ public APIgetOrdersWithTimeRangeRequest contract(String contract) { @@ -4840,7 +4840,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 to be returned in a single list. (optional, default to 100) * @return APIgetOrdersWithTimeRangeRequest */ public APIgetOrdersWithTimeRangeRequest limit(Integer limit) { @@ -4850,7 +4850,7 @@ public APIgetOrdersWithTimeRangeRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIgetOrdersWithTimeRangeRequest */ public APIgetOrdersWithTimeRangeRequest offset(Integer offset) { @@ -4866,7 +4866,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. * X-Pagination-Limit - Request limit specified.
* X-Pagination-Offset - Request offset specified.
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -4880,7 +4880,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. * X-Pagination-Limit - Request limit specified.
* X-Pagination-Offset - Request offset specified.
*/ public List execute() throws ApiException { @@ -4895,7 +4895,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. * X-Pagination-Limit - Request limit specified.
* X-Pagination-Offset - Request offset specified.
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -4910,7 +4910,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. * X-Pagination-Limit - Request limit specified.
* X-Pagination-Offset - Request offset specified.
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -4919,14 +4919,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * List Futures Orders By Time Range + * List Futures Orders By Time Range. * - * @param settle Settle currency (required) + * @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. * X-Pagination-Limit - Request limit specified.
* X-Pagination-Offset - Request offset specified.
*/ public APIgetOrdersWithTimeRangeRequest getOrdersWithTimeRange(String settle) { @@ -4935,7 +4935,7 @@ public APIgetOrdersWithTimeRangeRequest getOrdersWithTimeRange(String settle) { /** * Build call for createBatchFuturesOrder - * @param settle Settle currency (required) + * @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) * @param _callback Callback for upload/download progress @@ -4944,7 +4944,7 @@ public APIgetOrdersWithTimeRangeRequest getOrdersWithTimeRange(String settle) { * @http.response.details - +
Status Code Description Response Headers
200 Request is completed -
200 Request is completed. -
*/ public okhttp3.Call createBatchFuturesOrderCall(String settle, List futuresOrder, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -4998,9 +4998,9 @@ private okhttp3.Call createBatchFuturesOrderValidateBeforeCall(String settle, Li } /** - * Create a batch of futures orders + * Create a batch of 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 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) * @return List<BatchFuturesOrder> @@ -5008,7 +5008,7 @@ private okhttp3.Call createBatchFuturesOrderValidateBeforeCall(String settle, Li * @http.response.details - +
Status Code Description Response Headers
200 Request is completed -
200 Request is completed. -
*/ public List createBatchFuturesOrder(String settle, List futuresOrder, String xGateExptime) throws ApiException { @@ -5017,9 +5017,9 @@ public List createBatchFuturesOrder(String settle, List createBatchFuturesOrder(String settle, List Status Code Description Response Headers - 200 Request is completed - + 200 Request is completed. - */ public ApiResponse> createBatchFuturesOrderWithHttpInfo(String settle, List futuresOrder, String xGateExptime) throws ApiException { @@ -5037,9 +5037,9 @@ public ApiResponse> createBatchFuturesOrderWithHttpInfo( } /** - * Create a batch of futures orders (asynchronously) + * Create a batch of 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 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) * @param _callback The callback to be executed when the API call finishes @@ -5048,7 +5048,7 @@ public ApiResponse> createBatchFuturesOrderWithHttpInfo( * @http.response.details - +
Status Code Description Response Headers
200 Request is completed -
200 Request is completed. -
*/ public okhttp3.Call createBatchFuturesOrderAsync(String settle, List futuresOrder, String xGateExptime, final ApiCallback> _callback) throws ApiException { @@ -5060,15 +5060,15 @@ public okhttp3.Call createBatchFuturesOrderAsync(String settle, List Status Code Description Response Headers - 200 Order details - + 200 Order details. - */ public okhttp3.Call getFuturesOrderCall(String settle, String orderId, final ApiCallback _callback) throws ApiException { @@ -5119,16 +5119,16 @@ private okhttp3.Call getFuturesOrderValidateBeforeCall(String settle, String ord } /** - * Get a single order + * Get a single order. * - 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 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. finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. (required) * @return 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 Order details -
200 Order details. -
*/ public FuturesOrder getFuturesOrder(String settle, String orderId) throws ApiException { @@ -5137,16 +5137,16 @@ public FuturesOrder getFuturesOrder(String settle, String orderId) throws ApiExc } /** - * Get a single order + * Get a single order. * - 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 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. finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. (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 - +
Status Code Description Response Headers
200 Order details -
200 Order details. -
*/ public ApiResponse getFuturesOrderWithHttpInfo(String settle, String orderId) throws ApiException { @@ -5156,17 +5156,17 @@ public ApiResponse getFuturesOrderWithHttpInfo(String settle, Stri } /** - * Get a single order (asynchronously) + * Get a single order. (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 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. 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 * @http.response.details - +
Status Code Description Response Headers
200 Order details -
200 Order details. -
*/ public okhttp3.Call getFuturesOrderAsync(String settle, String orderId, final ApiCallback _callback) throws ApiException { @@ -5178,8 +5178,8 @@ 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 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. 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 @@ -5188,7 +5188,7 @@ public okhttp3.Call getFuturesOrderAsync(String settle, String orderId, final Ap * @http.response.details - +
Status Code Description Response Headers
200 Order details -
200 Order details. -
*/ public okhttp3.Call amendFuturesOrderCall(String settle, String orderId, FuturesOrderAmendment futuresOrderAmendment, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -5248,10 +5248,10 @@ private okhttp3.Call amendFuturesOrderValidateBeforeCall(String settle, String o } /** - * Amend an order + * Amend an 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 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. 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 @@ -5259,7 +5259,7 @@ private okhttp3.Call amendFuturesOrderValidateBeforeCall(String settle, String o * @http.response.details - +
Status Code Description Response Headers
200 Order details -
200 Order details. -
*/ public FuturesOrder amendFuturesOrder(String settle, String orderId, FuturesOrderAmendment futuresOrderAmendment, String xGateExptime) throws ApiException { @@ -5268,10 +5268,10 @@ public FuturesOrder amendFuturesOrder(String settle, String orderId, FuturesOrde } /** - * Amend an order + * Amend an 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 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. 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> @@ -5279,7 +5279,7 @@ public FuturesOrder amendFuturesOrder(String settle, String orderId, FuturesOrde * @http.response.details - +
Status Code Description Response Headers
200 Order details -
200 Order details. -
*/ public ApiResponse amendFuturesOrderWithHttpInfo(String settle, String orderId, FuturesOrderAmendment futuresOrderAmendment, String xGateExptime) throws ApiException { @@ -5289,10 +5289,10 @@ public ApiResponse amendFuturesOrderWithHttpInfo(String settle, St } /** - * Amend an order (asynchronously) + * Amend an 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 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. 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 @@ -5301,7 +5301,7 @@ public ApiResponse amendFuturesOrderWithHttpInfo(String settle, St * @http.response.details - +
Status Code Description Response Headers
200 Order details -
200 Order details. -
*/ public okhttp3.Call amendFuturesOrderAsync(String settle, String orderId, FuturesOrderAmendment futuresOrderAmendment, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -5313,8 +5313,8 @@ 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 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. 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 @@ -5322,7 +5322,7 @@ public okhttp3.Call amendFuturesOrderAsync(String settle, String orderId, Future * @http.response.details - +
Status Code Description Response Headers
200 Order details -
200 Order details. -
*/ public okhttp3.Call cancelFuturesOrderCall(String settle, String orderId, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -5377,17 +5377,17 @@ private okhttp3.Call cancelFuturesOrderValidateBeforeCall(String settle, String } /** - * Cancel a single order + * Cancel a 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 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. 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 * @http.response.details - +
Status Code Description Response Headers
200 Order details -
200 Order details. -
*/ public FuturesOrder cancelFuturesOrder(String settle, String orderId, String xGateExptime) throws ApiException { @@ -5396,17 +5396,17 @@ public FuturesOrder cancelFuturesOrder(String settle, String orderId, String xGa } /** - * Cancel a single order + * Cancel a 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 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. 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 * @http.response.details - +
Status Code Description Response Headers
200 Order details -
200 Order details. -
*/ public ApiResponse cancelFuturesOrderWithHttpInfo(String settle, String orderId, String xGateExptime) throws ApiException { @@ -5416,10 +5416,10 @@ public ApiResponse cancelFuturesOrderWithHttpInfo(String settle, S } /** - * Cancel a single order (asynchronously) + * Cancel a 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 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. 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 @@ -5427,7 +5427,7 @@ public ApiResponse cancelFuturesOrderWithHttpInfo(String settle, S * @http.response.details - +
Status Code Description Response Headers
200 Order details -
200 Order details. -
*/ public okhttp3.Call cancelFuturesOrderAsync(String settle, String orderId, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -5526,7 +5526,7 @@ private APIgetMyTradesRequest(String settle) { /** * Set contract - * @param contract Futures contract, return related data only if specified (optional) + * @param contract Futures contract, return related data only if specified. (optional) * @return APIgetMyTradesRequest */ public APIgetMyTradesRequest contract(String contract) { @@ -5536,7 +5536,7 @@ public APIgetMyTradesRequest contract(String contract) { /** * Set order - * @param order Futures order ID, return related data only if specified (optional) + * @param order Futures order ID, return related data only if specified. (optional) * @return APIgetMyTradesRequest */ public APIgetMyTradesRequest order(Long order) { @@ -5546,7 +5546,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 to be returned in a single list. (optional, default to 100) * @return APIgetMyTradesRequest */ public APIgetMyTradesRequest limit(Integer limit) { @@ -5556,7 +5556,7 @@ public APIgetMyTradesRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIgetMyTradesRequest */ public APIgetMyTradesRequest offset(Integer offset) { @@ -5582,7 +5582,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. * X-Pagination-Limit - Request limit specified.
* X-Pagination-Offset - Request offset specified.
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -5596,7 +5596,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. * X-Pagination-Limit - Request limit specified.
* X-Pagination-Offset - Request offset specified.
*/ public List execute() throws ApiException { @@ -5611,7 +5611,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. * X-Pagination-Limit - Request limit specified.
* X-Pagination-Offset - Request offset specified.
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -5626,7 +5626,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. * X-Pagination-Limit - Request limit specified.
* X-Pagination-Offset - Request offset specified.
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -5635,14 +5635,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callba } /** - * List personal trading history + * List personal trading history. * 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) + * @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. * X-Pagination-Limit - Request limit specified.
* X-Pagination-Offset - Request offset specified.
*/ public APIgetMyTradesRequest getMyTrades(String settle) { @@ -5743,7 +5743,7 @@ private APIgetMyTradesWithTimeRangeRequest(String settle) { /** * Set contract - * @param contract Futures contract, return related data only if specified (optional) + * @param contract Futures contract, return related data only if specified. (optional) * @return APIgetMyTradesWithTimeRangeRequest */ public APIgetMyTradesWithTimeRangeRequest contract(String contract) { @@ -5773,7 +5773,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 to be returned in a single list. (optional, default to 100) * @return APIgetMyTradesWithTimeRangeRequest */ public APIgetMyTradesWithTimeRangeRequest limit(Integer limit) { @@ -5783,7 +5783,7 @@ public APIgetMyTradesWithTimeRangeRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIgetMyTradesWithTimeRangeRequest */ public APIgetMyTradesWithTimeRangeRequest offset(Integer offset) { @@ -5809,7 +5809,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. * X-Pagination-Limit - Request limit specified.
* X-Pagination-Offset - Request offset specified.
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -5823,7 +5823,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. * X-Pagination-Limit - Request limit specified.
* X-Pagination-Offset - Request offset specified.
*/ public List execute() throws ApiException { @@ -5838,7 +5838,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. * X-Pagination-Limit - Request limit specified.
* X-Pagination-Offset - Request offset specified.
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -5853,7 +5853,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. * X-Pagination-Limit - Request limit specified.
* X-Pagination-Offset - Request offset specified.
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -5862,14 +5862,14 @@ public okhttp3.Call executeAsync(final ApiCallback } /** - * List personal trading history by time range + * List personal trading history by time range. * - * @param settle Settle currency (required) + * @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. * X-Pagination-Limit - Request limit specified.
* X-Pagination-Offset - Request offset specified.
*/ public APIgetMyTradesWithTimeRangeRequest getMyTradesWithTimeRange(String settle) { @@ -5975,7 +5975,7 @@ private APIlistPositionCloseRequest(String settle) { /** * Set contract - * @param contract Futures contract, return related data only if specified (optional) + * @param contract Futures contract, return related data only if specified. (optional) * @return APIlistPositionCloseRequest */ public APIlistPositionCloseRequest contract(String contract) { @@ -5985,7 +5985,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 to be returned in a single list. (optional, default to 100) * @return APIlistPositionCloseRequest */ public APIlistPositionCloseRequest limit(Integer limit) { @@ -5995,7 +5995,7 @@ public APIlistPositionCloseRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIlistPositionCloseRequest */ public APIlistPositionCloseRequest offset(Integer offset) { @@ -6025,7 +6025,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) { @@ -6035,7 +6035,7 @@ public APIlistPositionCloseRequest side(String side) { /** * Set pnl - * @param pnl Query profit or loss (optional) + * @param pnl Query profit or loss. (optional) * @return APIlistPositionCloseRequest */ public APIlistPositionCloseRequest pnl(String pnl) { @@ -6051,7 +6051,7 @@ public APIlistPositionCloseRequest pnl(String pnl) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -6065,7 +6065,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public List execute() throws ApiException { @@ -6080,7 +6080,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -6095,7 +6095,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExceptio * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -6104,14 +6104,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callbac } /** - * List position close history + * List position close history. * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @return APIlistPositionCloseRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistPositionCloseRequest listPositionClose(String settle) { @@ -6197,7 +6197,7 @@ private APIlistLiquidatesRequest(String settle) { /** * Set contract - * @param contract Futures contract, return related data only if specified (optional) + * @param contract Futures contract, return related data only if specified. (optional) * @return APIlistLiquidatesRequest */ public APIlistLiquidatesRequest contract(String contract) { @@ -6207,7 +6207,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 to be returned in a single list. (optional, default to 100) * @return APIlistLiquidatesRequest */ public APIlistLiquidatesRequest limit(Integer limit) { @@ -6217,7 +6217,7 @@ public APIlistLiquidatesRequest limit(Integer limit) { /** * Set at - * @param at Specify a liquidation timestamp (optional, default to 0) + * @param at Specify a liquidation timestamp. (optional, default to 0) * @return APIlistLiquidatesRequest */ public APIlistLiquidatesRequest at(Integer at) { @@ -6233,7 +6233,7 @@ public APIlistLiquidatesRequest at(Integer at) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -6247,7 +6247,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public List execute() throws ApiException { @@ -6262,7 +6262,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -6277,7 +6277,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcep * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -6286,14 +6286,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _call } /** - * List liquidation history + * List liquidation history. * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @return APIlistLiquidatesRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistLiquidatesRequest listLiquidates(String settle) { @@ -6379,7 +6379,7 @@ private APIlistAutoDeleveragesRequest(String settle) { /** * Set contract - * @param contract Futures contract, return related data only if specified (optional) + * @param contract Futures contract, return related data only if specified. (optional) * @return APIlistAutoDeleveragesRequest */ public APIlistAutoDeleveragesRequest contract(String contract) { @@ -6389,7 +6389,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 to be returned in a single list. (optional, default to 100) * @return APIlistAutoDeleveragesRequest */ public APIlistAutoDeleveragesRequest limit(Integer limit) { @@ -6399,7 +6399,7 @@ public APIlistAutoDeleveragesRequest limit(Integer limit) { /** * Set at - * @param at Specify an auto-deleveraging timestamp (optional, default to 0) + * @param at Specify an auto-deleveraging timestamp. (optional, default to 0) * @return APIlistAutoDeleveragesRequest */ public APIlistAutoDeleveragesRequest at(Integer at) { @@ -6415,7 +6415,7 @@ public APIlistAutoDeleveragesRequest at(Integer at) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -6429,7 +6429,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public List execute() throws ApiException { @@ -6444,7 +6444,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -6459,7 +6459,7 @@ public ApiResponse> executeWithHttpInfo() throws Api * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -6468,14 +6468,14 @@ public okhttp3.Call executeAsync(final ApiCallback> } /** - * List Auto-Deleveraging History + * List Auto-Deleveraging History. * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @return APIlistAutoDeleveragesRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistAutoDeleveragesRequest listAutoDeleverages(String settle) { @@ -6484,7 +6484,7 @@ public APIlistAutoDeleveragesRequest listAutoDeleverages(String settle) { /** * Build call for countdownCancelAllFutures - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @param countdownCancelAllFuturesTask (required) * @param _callback Callback for upload/download progress * @return Call to execute @@ -6492,7 +6492,7 @@ public APIlistAutoDeleveragesRequest listAutoDeleverages(String settle) { * @http.response.details - +
Status Code Description Response Headers
200 Set countdown successfully -
200 Set countdown successfully. -
*/ public okhttp3.Call countdownCancelAllFuturesCall(String settle, CountdownCancelAllFuturesTask countdownCancelAllFuturesTask, final ApiCallback _callback) throws ApiException { @@ -6542,16 +6542,16 @@ private okhttp3.Call countdownCancelAllFuturesValidateBeforeCall(String settle, } /** - * Countdown cancel orders - * Heartbeat detection for contract orders: When the user-set `timeout` time is reached, if neither the existing countdown is canceled nor a new countdown is set, the relevant contract orders will be automatically canceled. This API can be called repeatedly to set a new countdown 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) + * Countdown cancel orders. + * Heartbeat detection for contract orders: When the user-set `timeout` time is reached, if neither the existing countdown is canceled nor a new countdown is set, the relevant contract orders will be automatically canceled. This API can be called repeatedly to or cancel the countdown. Usage example: Repeatedly call this API at 30-second intervals, setting the `timeout` to 30 (seconds) each time. If this API is not called again within 30 seconds, all open orders on your specified `market` will be automatically canceled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will terminate, and the automatic order cancellation function will be disabled. + * @param settle Settle currency. (required) * @param countdownCancelAllFuturesTask (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 Set countdown successfully. -
*/ public TriggerTime countdownCancelAllFutures(String settle, CountdownCancelAllFuturesTask countdownCancelAllFuturesTask) throws ApiException { @@ -6560,16 +6560,16 @@ public TriggerTime countdownCancelAllFutures(String settle, CountdownCancelAllFu } /** - * Countdown cancel orders - * Heartbeat detection for contract orders: When the user-set `timeout` time is reached, if neither the existing countdown is canceled nor a new countdown is set, the relevant contract orders will be automatically canceled. This API can be called repeatedly to set a new countdown 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) + * Countdown cancel orders. + * Heartbeat detection for contract orders: When the user-set `timeout` time is reached, if neither the existing countdown is canceled nor a new countdown is set, the relevant contract orders will be automatically canceled. This API can be called repeatedly to or cancel the countdown. Usage example: Repeatedly call this API at 30-second intervals, setting the `timeout` to 30 (seconds) each time. If this API is not called again within 30 seconds, all open orders on your specified `market` will be automatically canceled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will terminate, and the automatic order cancellation function will be disabled. + * @param settle Settle currency. (required) * @param countdownCancelAllFuturesTask (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 Set countdown successfully. -
*/ public ApiResponse countdownCancelAllFuturesWithHttpInfo(String settle, CountdownCancelAllFuturesTask countdownCancelAllFuturesTask) throws ApiException { @@ -6579,9 +6579,9 @@ public ApiResponse countdownCancelAllFuturesWithHttpInfo(String set } /** - * Countdown cancel orders (asynchronously) - * 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 set a new countdown 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) + * Countdown cancel orders. (asynchronously) + * 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 * @return The request call @@ -6589,7 +6589,7 @@ public ApiResponse countdownCancelAllFuturesWithHttpInfo(String set * @http.response.details - +
Status Code Description Response Headers
200 Set countdown successfully -
200 Set countdown successfully. -
*/ public okhttp3.Call countdownCancelAllFuturesAsync(String settle, CountdownCancelAllFuturesTask countdownCancelAllFuturesTask, final ApiCallback _callback) throws ApiException { @@ -6668,7 +6668,7 @@ private APIgetFuturesFeeRequest(String settle) { /** * Set contract - * @param contract Futures contract, return related data only if specified (optional) + * @param contract Futures contract, return related data only if specified. (optional) * @return APIgetFuturesFeeRequest */ public APIgetFuturesFeeRequest contract(String contract) { @@ -6684,7 +6684,7 @@ public APIgetFuturesFeeRequest contract(String contract) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -6698,7 +6698,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public Map execute() throws ApiException { @@ -6713,7 +6713,7 @@ public Map execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -6728,7 +6728,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExce * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -6737,14 +6737,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _cal } /** - * Query user trading fee rates + * Query user trading fee rates. * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @return APIgetFuturesFeeRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public APIgetFuturesFeeRequest getFuturesFee(String settle) { @@ -6753,7 +6753,7 @@ public APIgetFuturesFeeRequest getFuturesFee(String settle) { /** * Build call for cancelBatchFutureOrders - * @param settle Settle currency (required) + * @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) * @param _callback Callback for upload/download progress @@ -6762,7 +6762,7 @@ public APIgetFuturesFeeRequest getFuturesFee(String settle) { * @http.response.details - +
Status Code Description Response Headers
200 Order cancellation operation completed -
200 Order cancellation operation completed. -
*/ public okhttp3.Call cancelBatchFutureOrdersCall(String settle, List requestBody, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -6816,9 +6816,9 @@ private okhttp3.Call cancelBatchFutureOrdersValidateBeforeCall(String settle, Li } /** - * Cancel a batch of orders with an ID list - * Multiple different order IDs can be specified. A maximum of 20 records - * @param settle Settle currency (required) + * Cancel a batch of orders with an ID list. + * Multiple different order IDs can be specified. A maximum of 20 records. + * @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) * @return List<FutureCancelOrderResult> @@ -6826,7 +6826,7 @@ private okhttp3.Call cancelBatchFutureOrdersValidateBeforeCall(String settle, Li * @http.response.details - +
Status Code Description Response Headers
200 Order cancellation operation completed -
200 Order cancellation operation completed. -
*/ public List cancelBatchFutureOrders(String settle, List requestBody, String xGateExptime) throws ApiException { @@ -6835,9 +6835,9 @@ public List cancelBatchFutureOrders(String settle, List } /** - * Cancel a batch of orders with an ID list - * Multiple different order IDs can be specified. A maximum of 20 records - * @param settle Settle currency (required) + * Cancel a batch of orders with an ID list. + * Multiple different order IDs can be specified. A maximum of 20 records. + * @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) * @return ApiResponse<List<FutureCancelOrderResult>> @@ -6845,7 +6845,7 @@ public List cancelBatchFutureOrders(String settle, List * @http.response.details - +
Status Code Description Response Headers
200 Order cancellation operation completed -
200 Order cancellation operation completed. -
*/ public ApiResponse> cancelBatchFutureOrdersWithHttpInfo(String settle, List requestBody, String xGateExptime) throws ApiException { @@ -6855,9 +6855,9 @@ public ApiResponse> cancelBatchFutureOrdersWithHtt } /** - * Cancel a batch of orders with an ID list (asynchronously) - * Multiple different order IDs can be specified. A maximum of 20 records - * @param settle Settle currency (required) + * Cancel a batch of orders with an ID list. (asynchronously) + * Multiple different order IDs can be specified. A maximum of 20 records. + * @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) * @param _callback The callback to be executed when the API call finishes @@ -6866,7 +6866,7 @@ public ApiResponse> cancelBatchFutureOrdersWithHtt * @http.response.details - +
Status Code Description Response Headers
200 Order cancellation operation completed -
200 Order cancellation operation completed. -
*/ public okhttp3.Call cancelBatchFutureOrdersAsync(String settle, List requestBody, String xGateExptime, final ApiCallback> _callback) throws ApiException { @@ -6878,7 +6878,7 @@ public okhttp3.Call cancelBatchFutureOrdersAsync(String settle, List req /** * Build call for amendBatchFutureOrders - * @param settle Settle currency (required) + * @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) * @param _callback Callback for upload/download progress @@ -6887,7 +6887,7 @@ public okhttp3.Call cancelBatchFutureOrdersAsync(String settle, List req * @http.response.details - +
Status Code Description Response Headers
200 Request is completed -
200 Request is completed. -
*/ public okhttp3.Call amendBatchFutureOrdersCall(String settle, List batchAmendOrderReq, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -6941,9 +6941,9 @@ private okhttp3.Call amendBatchFutureOrdersValidateBeforeCall(String settle, Lis } /** - * Batch modify orders with specified IDs - * Multiple different order IDs can be specified. A maximum of 10 orders can - * @param settle Settle currency (required) + * Batch modify orders with specified IDs. + * Multiple different order IDs can be specified. A maximum of 10 orders can. + * @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) * @return List<BatchFuturesOrder> @@ -6951,7 +6951,7 @@ private okhttp3.Call amendBatchFutureOrdersValidateBeforeCall(String settle, Lis * @http.response.details - +
Status Code Description Response Headers
200 Request is completed -
200 Request is completed. -
*/ public List amendBatchFutureOrders(String settle, List batchAmendOrderReq, String xGateExptime) throws ApiException { @@ -6960,9 +6960,9 @@ public List amendBatchFutureOrders(String settle, List amendBatchFutureOrders(String settle, List Status Code Description Response Headers - 200 Request is completed - + 200 Request is completed. - */ public ApiResponse> amendBatchFutureOrdersWithHttpInfo(String settle, List batchAmendOrderReq, String xGateExptime) throws ApiException { @@ -6980,9 +6980,9 @@ public ApiResponse> amendBatchFutureOrdersWithHttpInfo(S } /** - * Batch modify orders with specified IDs (asynchronously) - * Multiple different order IDs can be specified. A maximum of 10 orders can - * @param settle Settle currency (required) + * Batch modify orders with specified IDs. (asynchronously) + * Multiple different order IDs can be specified. A maximum of 10 orders can. + * @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) * @param _callback The callback to be executed when the API call finishes @@ -6991,7 +6991,7 @@ public ApiResponse> amendBatchFutureOrdersWithHttpInfo(S * @http.response.details - +
Status Code Description Response Headers
200 Request is completed -
200 Request is completed. -
*/ public okhttp3.Call amendBatchFutureOrdersAsync(String settle, List batchAmendOrderReq, String xGateExptime, final ApiCallback> _callback) throws ApiException { @@ -7003,15 +7003,15 @@ public okhttp3.Call amendBatchFutureOrdersAsync(String settle, List Status Code Description Response Headers - 200 Successfully retrieved - + 200 Successfully retrieved. - */ public okhttp3.Call getFuturesRiskLimitTableCall(String settle, String tableId, final ApiCallback _callback) throws ApiException { @@ -7065,16 +7065,16 @@ private okhttp3.Call getFuturesRiskLimitTableValidateBeforeCall(String settle, S } /** - * Query risk limit table by table_id + * Query risk limit table by table_id. * Just pass table_id. - * @param settle Settle currency (required) - * @param tableId Risk limit table ID (required) + * @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 Successfully retrieved -
200 Successfully retrieved. -
*/ public List getFuturesRiskLimitTable(String settle, String tableId) throws ApiException { @@ -7083,16 +7083,16 @@ public List getFuturesRiskLimitTable(String settle, String } /** - * Query risk limit table by table_id + * Query risk limit table by table_id. * Just pass table_id. - * @param settle Settle currency (required) - * @param tableId Risk limit table ID (required) + * @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 Successfully retrieved -
200 Successfully retrieved. -
*/ public ApiResponse> getFuturesRiskLimitTableWithHttpInfo(String settle, String tableId) throws ApiException { @@ -7102,17 +7102,17 @@ public ApiResponse> getFuturesRiskLimitTableWithHttpI } /** - * Query risk limit table by table_id (asynchronously) + * 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 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 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call getFuturesRiskLimitTableAsync(String settle, String tableId, final ApiCallback> _callback) throws ApiException { @@ -7212,7 +7212,7 @@ private APIlistPriceTriggeredOrdersRequest(String settle, String status) { /** * Set contract - * @param contract Futures contract, return related data only if specified (optional) + * @param contract Futures contract, return related data only if specified. (optional) * @return APIlistPriceTriggeredOrdersRequest */ public APIlistPriceTriggeredOrdersRequest contract(String contract) { @@ -7222,7 +7222,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 to be returned in a single list. (optional, default to 100) * @return APIlistPriceTriggeredOrdersRequest */ public APIlistPriceTriggeredOrdersRequest limit(Integer limit) { @@ -7232,7 +7232,7 @@ public APIlistPriceTriggeredOrdersRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIlistPriceTriggeredOrdersRequest */ public APIlistPriceTriggeredOrdersRequest offset(Integer offset) { @@ -7248,7 +7248,7 @@ public APIlistPriceTriggeredOrdersRequest offset(Integer offset) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -7262,7 +7262,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public List execute() throws ApiException { @@ -7277,7 +7277,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -7292,7 +7292,7 @@ public ApiResponse> executeWithHttpInfo() throw * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -7301,15 +7301,15 @@ public okhttp3.Call executeAsync(final ApiCallback Status Code Description Response Headers - 200 List retrieved - + 200 List retrieved. - */ public APIlistPriceTriggeredOrdersRequest listPriceTriggeredOrders(String settle, String status) { @@ -7318,7 +7318,7 @@ public APIlistPriceTriggeredOrdersRequest listPriceTriggeredOrders(String settle /** * Build call for createPriceTriggeredOrder - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @param futuresPriceTriggeredOrder (required) * @param _callback Callback for upload/download progress * @return Call to execute @@ -7326,7 +7326,7 @@ public APIlistPriceTriggeredOrdersRequest listPriceTriggeredOrders(String settle * @http.response.details - +
Status Code Description Response Headers
201 Order created -
201 Order created. -
*/ public okhttp3.Call createPriceTriggeredOrderCall(String settle, FuturesPriceTriggeredOrder futuresPriceTriggeredOrder, final ApiCallback _callback) throws ApiException { @@ -7376,16 +7376,16 @@ private okhttp3.Call createPriceTriggeredOrderValidateBeforeCall(String settle, } /** - * Create a price-triggered order + * Create a price-triggered order. * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @param futuresPriceTriggeredOrder (required) * @return TriggerOrderResponse * @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. -
*/ public TriggerOrderResponse createPriceTriggeredOrder(String settle, FuturesPriceTriggeredOrder futuresPriceTriggeredOrder) throws ApiException { @@ -7394,16 +7394,16 @@ public TriggerOrderResponse createPriceTriggeredOrder(String settle, FuturesPric } /** - * Create a price-triggered order + * Create a price-triggered order. * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @param futuresPriceTriggeredOrder (required) * @return ApiResponse<TriggerOrderResponse> * @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. -
*/ public ApiResponse createPriceTriggeredOrderWithHttpInfo(String settle, FuturesPriceTriggeredOrder futuresPriceTriggeredOrder) throws ApiException { @@ -7413,9 +7413,9 @@ public ApiResponse createPriceTriggeredOrderWithHttpInfo(S } /** - * Create a price-triggered order (asynchronously) + * Create a price-triggered order. (asynchronously) * - * @param settle Settle currency (required) + * @param settle Settle currency. (required) * @param futuresPriceTriggeredOrder (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -7423,7 +7423,7 @@ public ApiResponse createPriceTriggeredOrderWithHttpInfo(S * @http.response.details - +
Status Code Description Response Headers
201 Order created -
201 Order created. -
*/ public okhttp3.Call createPriceTriggeredOrderAsync(String settle, FuturesPriceTriggeredOrder futuresPriceTriggeredOrder, final ApiCallback _callback) throws ApiException { @@ -7435,15 +7435,15 @@ public okhttp3.Call createPriceTriggeredOrderAsync(String settle, FuturesPriceTr /** * Build call for cancelPriceTriggeredOrderList - * @param settle Settle currency (required) - * @param contract Futures contract, return related data only if specified (optional) + * @param settle Settle currency. (required) + * @param contract Futures contract, return related data only if 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 Batch cancellation request accepted. Query order status by listing orders -
200 Batch cancellation request accepted. Query order status by listing orders. -
*/ public okhttp3.Call cancelPriceTriggeredOrderListCall(String settle, String contract, final ApiCallback _callback) throws ApiException { @@ -7492,16 +7492,16 @@ private okhttp3.Call cancelPriceTriggeredOrderListValidateBeforeCall(String sett } /** - * Cancel All Price-triggered Orders + * Cancel All Price-triggered Orders. * - * @param settle Settle currency (required) - * @param contract Futures contract, return related data only if specified (optional) + * @param settle Settle currency. (required) + * @param contract Futures contract, return related data only if specified. (optional) * @return List<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 Batch cancellation request accepted. Query order status by listing orders -
200 Batch cancellation request accepted. Query order status by listing orders. -
*/ public List cancelPriceTriggeredOrderList(String settle, String contract) throws ApiException { @@ -7510,16 +7510,16 @@ public List cancelPriceTriggeredOrderList(String set } /** - * Cancel All Price-triggered Orders + * Cancel All Price-triggered Orders. * - * @param settle Settle currency (required) - * @param contract Futures contract, return related data only if specified (optional) + * @param settle Settle currency. (required) + * @param contract Futures contract, return related data only if specified. (optional) * @return ApiResponse<List<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 Batch cancellation request accepted. Query order status by listing orders -
200 Batch cancellation request accepted. Query order status by listing orders. -
*/ public ApiResponse> cancelPriceTriggeredOrderListWithHttpInfo(String settle, String contract) throws ApiException { @@ -7529,17 +7529,17 @@ public ApiResponse> cancelPriceTriggeredOrderLi } /** - * Cancel All Price-triggered Orders (asynchronously) + * Cancel All Price-triggered Orders. (asynchronously) * - * @param settle Settle currency (required) - * @param contract Futures contract, return related data only if specified (optional) + * @param settle Settle currency. (required) + * @param contract Futures contract, return related data only if 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 Batch cancellation request accepted. Query order status by listing orders -
200 Batch cancellation request accepted. Query order status by listing orders. -
*/ public okhttp3.Call cancelPriceTriggeredOrderListAsync(String settle, String contract, final ApiCallback> _callback) throws ApiException { @@ -7551,15 +7551,15 @@ 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 settle Settle currency. (required) + * @param orderId Retrieve the data of the order with the specified 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 Auto order detail -
200 Auto order detail. -
*/ public okhttp3.Call getPriceTriggeredOrderCall(String settle, String orderId, final ApiCallback _callback) throws ApiException { @@ -7610,16 +7610,16 @@ private okhttp3.Call getPriceTriggeredOrderValidateBeforeCall(String settle, Str } /** - * Get a price-triggered order + * Get a price-triggered order. * - * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param settle Settle currency. (required) + * @param orderId Retrieve the data of the order with the specified ID. (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 detail. -
*/ public FuturesPriceTriggeredOrder getPriceTriggeredOrder(String settle, String orderId) throws ApiException { @@ -7628,16 +7628,16 @@ public FuturesPriceTriggeredOrder getPriceTriggeredOrder(String settle, String o } /** - * Get a price-triggered order + * Get a price-triggered order. * - * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param settle Settle currency. (required) + * @param orderId Retrieve the data of the order with the specified ID. (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 detail. -
*/ public ApiResponse getPriceTriggeredOrderWithHttpInfo(String settle, String orderId) throws ApiException { @@ -7647,17 +7647,17 @@ public ApiResponse getPriceTriggeredOrderWithHttpInf } /** - * Get a price-triggered order (asynchronously) + * Get a price-triggered order. (asynchronously) * - * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param settle Settle currency. (required) + * @param orderId Retrieve the data of the order with the specified 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 Auto order detail -
200 Auto order detail. -
*/ public okhttp3.Call getPriceTriggeredOrderAsync(String settle, String orderId, final ApiCallback _callback) throws ApiException { @@ -7669,15 +7669,15 @@ 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 settle Settle currency. (required) + * @param orderId Retrieve the data of the order with the specified 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 Auto order detail -
200 Auto order detail. -
*/ public okhttp3.Call cancelPriceTriggeredOrderCall(String settle, String orderId, final ApiCallback _callback) throws ApiException { @@ -7728,16 +7728,16 @@ private okhttp3.Call cancelPriceTriggeredOrderValidateBeforeCall(String settle, } /** - * cancel a price-triggered order + * cancel a price-triggered order. * - * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param settle Settle currency. (required) + * @param orderId Retrieve the data of the order with the specified ID. (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 detail. -
*/ public FuturesPriceTriggeredOrder cancelPriceTriggeredOrder(String settle, String orderId) throws ApiException { @@ -7746,16 +7746,16 @@ public FuturesPriceTriggeredOrder cancelPriceTriggeredOrder(String settle, Strin } /** - * cancel a price-triggered order + * cancel a price-triggered order. * - * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param settle Settle currency. (required) + * @param orderId Retrieve the data of the order with the specified ID. (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 detail. -
*/ public ApiResponse cancelPriceTriggeredOrderWithHttpInfo(String settle, String orderId) throws ApiException { @@ -7765,17 +7765,17 @@ public ApiResponse cancelPriceTriggeredOrderWithHttp } /** - * cancel a price-triggered order (asynchronously) + * cancel a price-triggered order. (asynchronously) * - * @param settle Settle currency (required) - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param settle Settle currency. (required) + * @param orderId Retrieve the data of the order with the specified 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 Auto order detail -
200 Auto order detail. -
*/ 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 3f6a795..9507541 100644 --- a/src/main/java/io/gate/gateapi/api/MarginApi.java +++ b/src/main/java/io/gate/gateapi/api/MarginApi.java @@ -116,7 +116,7 @@ private APIlistMarginAccountsRequest() { /** * Set currencyPair - * @param currencyPair Currency pair (optional) + * @param currencyPair Currency pair. (optional) * @return APIlistMarginAccountsRequest */ public APIlistMarginAccountsRequest currencyPair(String currencyPair) { @@ -132,7 +132,7 @@ public APIlistMarginAccountsRequest currencyPair(String currencyPair) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -146,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. -
*/ public List execute() throws ApiException { @@ -161,7 +161,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -176,7 +176,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExceptio * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -185,13 +185,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callbac } /** - * Margin account list + * Margin account list. * * @return APIlistMarginAccountsRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistMarginAccountsRequest listMarginAccounts() { @@ -319,7 +319,7 @@ public APIlistMarginAccountBookRequest type(String type) { /** * Set from - * @param from Start timestamp of the query (optional) + * @param from Start timestamp of the query. (optional) * @return APIlistMarginAccountBookRequest */ public APIlistMarginAccountBookRequest from(Long from) { @@ -329,7 +329,7 @@ public APIlistMarginAccountBookRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to Time range ending, default to current time. (optional) * @return APIlistMarginAccountBookRequest */ public APIlistMarginAccountBookRequest to(Long to) { @@ -339,7 +339,7 @@ public APIlistMarginAccountBookRequest to(Long to) { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistMarginAccountBookRequest */ public APIlistMarginAccountBookRequest page(Integer page) { @@ -349,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 to be returned in a single list. (optional, default to 100) * @return APIlistMarginAccountBookRequest */ public APIlistMarginAccountBookRequest limit(Integer limit) { @@ -365,7 +365,7 @@ public APIlistMarginAccountBookRequest limit(Integer limit) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -379,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. -
*/ public List execute() throws ApiException { @@ -394,7 +394,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -409,7 +409,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExce * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -418,13 +418,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _cal } /** - * List margin account balance change history + * List margin account balance change history. * Only transferals from and to margin account are provided for now. Time range allows 30 days at most * @return APIlistMarginAccountBookRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistMarginAccountBookRequest listMarginAccountBook() { @@ -492,7 +492,7 @@ private APIlistFundingAccountsRequest() { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Retrieve data of the specified currency. (optional) * @return APIlistFundingAccountsRequest */ public APIlistFundingAccountsRequest currency(String currency) { @@ -508,7 +508,7 @@ public APIlistFundingAccountsRequest currency(String currency) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -522,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. -
*/ public List execute() throws ApiException { @@ -537,7 +537,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -552,7 +552,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcepti * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -561,13 +561,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callba } /** - * Funding account list + * Funding account list. * * @return APIlistFundingAccountsRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistFundingAccountsRequest listFundingAccounts() { @@ -582,7 +582,7 @@ public APIlistFundingAccountsRequest listFundingAccounts() { * @http.response.details - +
Status Code Description Response Headers
200 Current auto repayment setting -
200 Current auto repayment setting. -
*/ public okhttp3.Call getAutoRepayStatusCall(final ApiCallback _callback) throws ApiException { @@ -621,14 +621,14 @@ private okhttp3.Call getAutoRepayStatusValidateBeforeCall(final ApiCallback _cal } /** - * Retrieve user auto repayment setting + * Retrieve user auto repayment setting. * * @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 Current auto repayment setting. -
*/ public AutoRepaySetting getAutoRepayStatus() throws ApiException { @@ -637,14 +637,14 @@ public AutoRepaySetting getAutoRepayStatus() throws ApiException { } /** - * Retrieve user auto repayment setting + * Retrieve user auto repayment setting. * * @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 Current auto repayment setting. -
*/ public ApiResponse getAutoRepayStatusWithHttpInfo() throws ApiException { @@ -654,7 +654,7 @@ public ApiResponse getAutoRepayStatusWithHttpInfo() throws Api } /** - * Retrieve user auto repayment setting (asynchronously) + * Retrieve user auto repayment setting. (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -662,7 +662,7 @@ public ApiResponse getAutoRepayStatusWithHttpInfo() throws Api * @http.response.details - +
Status Code Description Response Headers
200 Current auto repayment setting -
200 Current auto repayment setting. -
*/ public okhttp3.Call getAutoRepayStatusAsync(final ApiCallback _callback) throws ApiException { @@ -674,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 New auto repayment status. `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 Current auto repayment setting. -
*/ public okhttp3.Call setAutoRepayCall(String status, final ApiCallback _callback) throws ApiException { @@ -729,15 +729,15 @@ private okhttp3.Call setAutoRepayValidateBeforeCall(String status, final ApiCall } /** - * Update user's auto repayment setting + * Update user's auto repayment setting. * - * @param status New auto repayment status. `on` - enabled, `off` - disabled (required) + * @param status New auto repayment status. `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 Current auto repayment setting. -
*/ public AutoRepaySetting setAutoRepay(String status) throws ApiException { @@ -746,15 +746,15 @@ public AutoRepaySetting setAutoRepay(String status) throws ApiException { } /** - * Update user's auto repayment setting + * Update user's auto repayment setting. * - * @param status New auto repayment status. `on` - enabled, `off` - disabled (required) + * @param status New auto repayment status. `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 Current auto repayment setting. -
*/ public ApiResponse setAutoRepayWithHttpInfo(String status) throws ApiException { @@ -764,16 +764,16 @@ public ApiResponse setAutoRepayWithHttpInfo(String status) thr } /** - * Update user's auto repayment setting (asynchronously) + * Update user's auto repayment setting. (asynchronously) * - * @param status New auto repayment status. `on` - enabled, `off` - disabled (required) + * @param status New auto repayment status. `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 Current auto repayment setting. -
*/ public okhttp3.Call setAutoRepayAsync(String status, final ApiCallback _callback) throws ApiException { @@ -855,7 +855,7 @@ private APIgetMarginTransferableRequest(String currency) { /** * Set currencyPair - * @param currencyPair Currency pair (optional) + * @param currencyPair Currency pair. (optional) * @return APIgetMarginTransferableRequest */ public APIgetMarginTransferableRequest currencyPair(String currencyPair) { @@ -871,7 +871,7 @@ public APIgetMarginTransferableRequest currencyPair(String currencyPair) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -885,7 +885,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public MarginTransferable execute() throws ApiException { @@ -900,7 +900,7 @@ public MarginTransferable execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -915,7 +915,7 @@ public ApiResponse executeWithHttpInfo() throws ApiException * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -924,14 +924,14 @@ public okhttp3.Call executeAsync(final ApiCallback _callback } /** - * Get the max transferable amount for a specific margin currency + * Get the max transferable amount for a specific margin currency. * - * @param currency Retrieve data of the specified currency (required) + * @param currency Retrieve data of the specified currency. (required) * @return APIgetMarginTransferableRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public APIgetMarginTransferableRequest getMarginTransferable(String currency) { @@ -940,14 +940,14 @@ public APIgetMarginTransferableRequest getMarginTransferable(String currency) { /** * Build call for getUserMarginTier - * @param currencyPair Currency pair (required) + * @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 Successfully retrieved. -
*/ public okhttp3.Call getUserMarginTierCall(String currencyPair, final ApiCallback _callback) throws ApiException { @@ -995,15 +995,15 @@ private okhttp3.Call getUserMarginTierValidateBeforeCall(String currencyPair, fi } /** - * Check the user's own leverage lending gradient in the current market + * Check the user's own leverage lending gradient in the current market. * - * @param currencyPair Currency pair (required) + * @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 Successfully retrieved. -
*/ public List getUserMarginTier(String currencyPair) throws ApiException { @@ -1012,15 +1012,15 @@ public List getUserMarginTier(String currencyPair) throws Ap } /** - * Check the user's own leverage lending gradient in the current market + * Check the user's own leverage lending gradient in the current market. * - * @param currencyPair Currency pair (required) + * @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 Successfully retrieved. -
*/ public ApiResponse> getUserMarginTierWithHttpInfo(String currencyPair) throws ApiException { @@ -1030,16 +1030,16 @@ public ApiResponse> getUserMarginTierWithHttpInfo(Strin } /** - * Check the user's own leverage lending gradient in the current market (asynchronously) + * Check the user's own leverage lending gradient in the current market. (asynchronously) * - * @param currencyPair Currency pair (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 Successfully retrieved. -
*/ public okhttp3.Call getUserMarginTierAsync(String currencyPair, final ApiCallback> _callback) throws ApiException { @@ -1051,14 +1051,14 @@ public okhttp3.Call getUserMarginTierAsync(String currencyPair, final ApiCallbac /** * Build call for getMarketMarginTier - * @param currencyPair Currency pair (required) + * @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 Successfully retrieved. -
*/ public okhttp3.Call getMarketMarginTierCall(String currencyPair, final ApiCallback _callback) throws ApiException { @@ -1106,15 +1106,15 @@ private okhttp3.Call getMarketMarginTierValidateBeforeCall(String currencyPair, } /** - * Query the current market leverage lending gradient + * Query the current market leverage lending gradient. * - * @param currencyPair Currency pair (required) + * @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 Successfully retrieved. -
*/ public List getMarketMarginTier(String currencyPair) throws ApiException { @@ -1123,15 +1123,15 @@ public List getMarketMarginTier(String currencyPair) throws } /** - * Query the current market leverage lending gradient + * Query the current market leverage lending gradient. * - * @param currencyPair Currency pair (required) + * @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 Successfully retrieved. -
*/ public ApiResponse> getMarketMarginTierWithHttpInfo(String currencyPair) throws ApiException { @@ -1141,16 +1141,16 @@ public ApiResponse> getMarketMarginTierWithHttpInfo(Str } /** - * Query the current market leverage lending gradient (asynchronously) + * Query the current market leverage lending gradient. (asynchronously) * - * @param currencyPair Currency pair (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 Successfully retrieved. -
*/ public okhttp3.Call getMarketMarginTierAsync(String currencyPair, final ApiCallback> _callback) throws ApiException { @@ -1169,7 +1169,7 @@ public okhttp3.Call getMarketMarginTierAsync(String currencyPair, final ApiCallb * @http.response.details - +
Status Code Description Response Headers
204 Success -
204 Success. -
*/ public okhttp3.Call setUserMarketLeverageCall(MarginMarketLeverage marginMarketLeverage, final ApiCallback _callback) throws ApiException { @@ -1213,14 +1213,14 @@ private okhttp3.Call setUserMarketLeverageValidateBeforeCall(MarginMarketLeverag } /** - * Set the user market leverage multiple + * 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 -
204 Success. -
*/ public void setUserMarketLeverage(MarginMarketLeverage marginMarketLeverage) throws ApiException { @@ -1228,7 +1228,7 @@ public void setUserMarketLeverage(MarginMarketLeverage marginMarketLeverage) thr } /** - * Set the user market leverage multiple + * Set the user market leverage multiple. * * @param marginMarketLeverage (required) * @return ApiResponse<Void> @@ -1236,7 +1236,7 @@ public void setUserMarketLeverage(MarginMarketLeverage marginMarketLeverage) thr * @http.response.details - +
Status Code Description Response Headers
204 Success -
204 Success. -
*/ public ApiResponse setUserMarketLeverageWithHttpInfo(MarginMarketLeverage marginMarketLeverage) throws ApiException { @@ -1245,7 +1245,7 @@ public ApiResponse setUserMarketLeverageWithHttpInfo(MarginMarketLeverage } /** - * Set the user market leverage multiple (asynchronously) + * Set the user market leverage multiple. (asynchronously) * * @param marginMarketLeverage (required) * @param _callback The callback to be executed when the API call finishes @@ -1254,7 +1254,7 @@ public ApiResponse setUserMarketLeverageWithHttpInfo(MarginMarketLeverage * @http.response.details - +
Status Code Description Response Headers
204 Success -
204 Success. -
*/ public okhttp3.Call setUserMarketLeverageAsync(MarginMarketLeverage marginMarketLeverage, final ApiCallback _callback) throws ApiException { @@ -1324,7 +1324,7 @@ private APIlistMarginUserAccountRequest() { /** * Set currencyPair - * @param currencyPair Currency pair (optional) + * @param currencyPair Currency pair. (optional) * @return APIlistMarginUserAccountRequest */ public APIlistMarginUserAccountRequest currencyPair(String currencyPair) { @@ -1340,7 +1340,7 @@ public APIlistMarginUserAccountRequest currencyPair(String currencyPair) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1354,7 +1354,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public List execute() throws ApiException { @@ -1369,7 +1369,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1384,7 +1384,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExceptio * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1393,13 +1393,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callbac } /** - * Query the user's leverage account list + * 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 -
200 List retrieved. -
*/ public APIlistMarginUserAccountRequest listMarginUserAccount() { @@ -1494,7 +1494,7 @@ private APIlistCrossMarginLoansRequest(Integer status) { /** * Set currency - * @param currency Filter by currency (optional) + * @param currency Filter by currency. (optional) * @return APIlistCrossMarginLoansRequest */ public APIlistCrossMarginLoansRequest currency(String currency) { @@ -1504,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 to be returned in a single list. (optional, default to 100) * @return APIlistCrossMarginLoansRequest */ public APIlistCrossMarginLoansRequest limit(Integer limit) { @@ -1514,7 +1514,7 @@ public APIlistCrossMarginLoansRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIlistCrossMarginLoansRequest */ public APIlistCrossMarginLoansRequest offset(Integer offset) { @@ -1540,7 +1540,7 @@ public APIlistCrossMarginLoansRequest reverse(Boolean reverse) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
* @deprecated */ @@ -1556,7 +1556,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
* @deprecated */ @@ -1573,7 +1573,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
* @deprecated */ @@ -1590,7 +1590,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcept * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
* @deprecated */ @@ -1601,14 +1601,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callb } /** - * List cross margin borrow history. (deprecated) + * List cross margin borrow history. (deprecated). * Sort by creation time in descending order by default. Set `reverse=false` to return ascending results. - * @param status Filter by status. Supported values are 2 and 3. (deprecated.) (required) + * @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 Successfully retrieved. -
* @deprecated */ @@ -1719,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 to be returned in a single list. (optional, default to 100) * @return APIlistCrossMarginRepaymentsRequest */ public APIlistCrossMarginRepaymentsRequest limit(Integer limit) { @@ -1729,7 +1729,7 @@ public APIlistCrossMarginRepaymentsRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIlistCrossMarginRepaymentsRequest */ public APIlistCrossMarginRepaymentsRequest offset(Integer offset) { @@ -1755,7 +1755,7 @@ public APIlistCrossMarginRepaymentsRequest reverse(Boolean reverse) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
* @deprecated */ @@ -1771,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. -
* @deprecated */ @@ -1788,7 +1788,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
* @deprecated */ @@ -1805,7 +1805,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiE * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
* @deprecated */ @@ -1816,13 +1816,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _ } /** - * Retrieve cross margin repayments. (deprecated) + * Retrieve cross margin repayments. (deprecated). * Sort by creation time in descending order by default. Set `reverse=false` to return ascending results. * @return APIlistCrossMarginRepaymentsRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
* @deprecated */ diff --git a/src/main/java/io/gate/gateapi/api/MarginUniApi.java b/src/main/java/io/gate/gateapi/api/MarginUniApi.java index bda12f4..7af17f7 100644 --- a/src/main/java/io/gate/gateapi/api/MarginUniApi.java +++ b/src/main/java/io/gate/gateapi/api/MarginUniApi.java @@ -60,7 +60,7 @@ public void setApiClient(ApiClient apiClient) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call listUniCurrencyPairsCall(final ApiCallback _callback) throws ApiException { @@ -99,14 +99,14 @@ private okhttp3.Call listUniCurrencyPairsValidateBeforeCall(final ApiCallback _c } /** - * List lending markets + * List lending markets. * * @return List<UniCurrencyPair> * @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 Successfully retrieved. -
*/ public List listUniCurrencyPairs() throws ApiException { @@ -115,14 +115,14 @@ public List listUniCurrencyPairs() throws ApiException { } /** - * List lending markets + * List lending markets. * * @return ApiResponse<List<UniCurrencyPair>> * @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 Successfully retrieved. -
*/ public ApiResponse> listUniCurrencyPairsWithHttpInfo() throws ApiException { @@ -132,7 +132,7 @@ public ApiResponse> listUniCurrencyPairsWithHttpInfo() thr } /** - * List lending markets (asynchronously) + * List lending markets. (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -140,7 +140,7 @@ public ApiResponse> listUniCurrencyPairsWithHttpInfo() thr * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call listUniCurrencyPairsAsync(final ApiCallback> _callback) throws ApiException { @@ -152,14 +152,14 @@ public okhttp3.Call listUniCurrencyPairsAsync(final ApiCallback Status Code Description Response Headers - 200 Successfully retrieved - + 200 Successfully retrieved. - */ public okhttp3.Call getUniCurrencyPairCall(String currencyPair, final ApiCallback _callback) throws ApiException { @@ -204,15 +204,15 @@ private okhttp3.Call getUniCurrencyPairValidateBeforeCall(String currencyPair, f } /** - * Get detail of lending market + * Get detail of lending market. * - * @param currencyPair Currency pair (required) + * @param currencyPair Currency pair. (required) * @return UniCurrencyPair * @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 Successfully retrieved. -
*/ public UniCurrencyPair getUniCurrencyPair(String currencyPair) throws ApiException { @@ -221,15 +221,15 @@ public UniCurrencyPair getUniCurrencyPair(String currencyPair) throws ApiExcepti } /** - * Get detail of lending market + * Get detail of lending market. * - * @param currencyPair Currency pair (required) + * @param currencyPair Currency pair. (required) * @return ApiResponse<UniCurrencyPair> * @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 Successfully retrieved. -
*/ public ApiResponse getUniCurrencyPairWithHttpInfo(String currencyPair) throws ApiException { @@ -239,16 +239,16 @@ public ApiResponse getUniCurrencyPairWithHttpInfo(String curren } /** - * Get detail of lending market (asynchronously) + * Get detail of lending market. (asynchronously) * - * @param currencyPair Currency pair (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 Successfully retrieved. -
*/ 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 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 -
200 Successfully retrieved. -
*/ public okhttp3.Call getMarginUniEstimateRateCall(List currencies, final ApiCallback _callback) throws ApiException { @@ -315,15 +315,15 @@ private okhttp3.Call getMarginUniEstimateRateValidateBeforeCall(List cur } /** - * Estimate interest Rate + * 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) + * @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 -
200 Successfully retrieved. -
*/ public Map getMarginUniEstimateRate(List currencies) throws ApiException { @@ -332,15 +332,15 @@ public Map getMarginUniEstimateRate(List currencies) thr } /** - * Estimate interest Rate + * 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) + * @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 -
200 Successfully retrieved. -
*/ public ApiResponse> getMarginUniEstimateRateWithHttpInfo(List currencies) throws ApiException { @@ -350,16 +350,16 @@ public ApiResponse> getMarginUniEstimateRateWithHttpInfo(Lis } /** - * Estimate interest Rate (asynchronously) + * 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) + * @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 -
200 Successfully retrieved. -
*/ public okhttp3.Call getMarginUniEstimateRateAsync(List currencies, final ApiCallback> _callback) throws ApiException { @@ -445,7 +445,7 @@ private APIlistUniLoansRequest() { /** * Set currencyPair - * @param currencyPair Currency pair (optional) + * @param currencyPair Currency pair. (optional) * @return APIlistUniLoansRequest */ public APIlistUniLoansRequest currencyPair(String currencyPair) { @@ -455,7 +455,7 @@ public APIlistUniLoansRequest currencyPair(String currencyPair) { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Retrieve data of the specified currency. (optional) * @return APIlistUniLoansRequest */ public APIlistUniLoansRequest currency(String currency) { @@ -465,7 +465,7 @@ public APIlistUniLoansRequest currency(String currency) { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistUniLoansRequest */ public APIlistUniLoansRequest page(Integer page) { @@ -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 response items. 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -544,13 +544,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) thr } /** - * List loans + * List loans. * * @return APIlistUniLoansRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public APIlistUniLoansRequest listUniLoans() { @@ -566,7 +566,7 @@ public APIlistUniLoansRequest listUniLoans() { * @http.response.details - +
Status Code Description Response Headers
204 Operated successfully -
204 Operated successfully. -
*/ public okhttp3.Call createUniLoanCall(CreateUniLoan createUniLoan, final ApiCallback _callback) throws ApiException { @@ -610,14 +610,14 @@ private okhttp3.Call createUniLoanValidateBeforeCall(CreateUniLoan createUniLoan } /** - * Borrow or repay + * Borrow or repay. * * @param createUniLoan (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 Operated successfully. -
*/ public void createUniLoan(CreateUniLoan createUniLoan) throws ApiException { @@ -625,7 +625,7 @@ public void createUniLoan(CreateUniLoan createUniLoan) throws ApiException { } /** - * Borrow or repay + * Borrow or repay. * * @param createUniLoan (required) * @return ApiResponse<Void> @@ -633,7 +633,7 @@ public void createUniLoan(CreateUniLoan createUniLoan) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
204 Operated successfully -
204 Operated successfully. -
*/ public ApiResponse createUniLoanWithHttpInfo(CreateUniLoan createUniLoan) throws ApiException { @@ -642,7 +642,7 @@ public ApiResponse createUniLoanWithHttpInfo(CreateUniLoan createUniLoan) } /** - * Borrow or repay (asynchronously) + * Borrow or repay. (asynchronously) * * @param createUniLoan (required) * @param _callback The callback to be executed when the API call finishes @@ -651,7 +651,7 @@ public ApiResponse createUniLoanWithHttpInfo(CreateUniLoan createUniLoan) * @http.response.details - +
Status Code Description Response Headers
204 Operated successfully -
204 Operated successfully. -
*/ 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 Retrieve data of the specified currency. (optional) * @return APIlistUniLoanRecordsRequest */ public APIlistUniLoanRecordsRequest currency(String currency) { @@ -761,7 +761,7 @@ public APIlistUniLoanRecordsRequest currency(String currency) { /** * Set currencyPair - * @param currencyPair Currency pair (optional) + * @param currencyPair Currency pair. (optional) * @return APIlistUniLoanRecordsRequest */ public APIlistUniLoanRecordsRequest currencyPair(String currencyPair) { @@ -771,7 +771,7 @@ public APIlistUniLoanRecordsRequest currencyPair(String currencyPair) { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistUniLoanRecordsRequest */ public APIlistUniLoanRecordsRequest page(Integer page) { @@ -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 response items. 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -850,13 +850,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callbac } /** - * Get load records + * Get load records. * * @return APIlistUniLoanRecordsRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public APIlistUniLoanRecordsRequest listUniLoanRecords() { @@ -949,7 +949,7 @@ private APIlistUniLoanInterestRecordsRequest() { /** * Set currencyPair - * @param currencyPair Currency pair (optional) + * @param currencyPair Currency pair. (optional) * @return APIlistUniLoanInterestRecordsRequest */ public APIlistUniLoanInterestRecordsRequest currencyPair(String currencyPair) { @@ -959,7 +959,7 @@ public APIlistUniLoanInterestRecordsRequest currencyPair(String currencyPair) { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Retrieve data of the specified currency. (optional) * @return APIlistUniLoanInterestRecordsRequest */ public APIlistUniLoanInterestRecordsRequest currency(String currency) { @@ -969,7 +969,7 @@ public APIlistUniLoanInterestRecordsRequest currency(String currency) { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistUniLoanInterestRecordsRequest */ public APIlistUniLoanInterestRecordsRequest page(Integer page) { @@ -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 to be returned in a single list. (optional, default to 100) * @return APIlistUniLoanInterestRecordsRequest */ public APIlistUniLoanInterestRecordsRequest limit(Integer limit) { @@ -1015,7 +1015,7 @@ public APIlistUniLoanInterestRecordsRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1068,13 +1068,13 @@ public okhttp3.Call executeAsync(final ApiCallback> } /** - * List interest records + * List interest records. * * @return APIlistUniLoanInterestRecordsRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public APIlistUniLoanInterestRecordsRequest listUniLoanInterestRecords() { @@ -1083,15 +1083,15 @@ public APIlistUniLoanInterestRecordsRequest listUniLoanInterestRecords() { /** * Build call for getUniBorrowable - * @param currency Retrieve data of the specified currency (required) - * @param currencyPair Currency pair (required) + * @param currency Retrieve data of the specified currency. (required) + * @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 Successfully retrieved. -
*/ 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 + * Get maximum borrowable. * - * @param currency Retrieve data of the specified currency (required) - * @param currencyPair Currency pair (required) + * @param currency Retrieve data of the specified currency. (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 Successfully retrieved. -
*/ public MaxUniBorrowable getUniBorrowable(String currency, String currencyPair) throws ApiException { @@ -1166,16 +1166,16 @@ public MaxUniBorrowable getUniBorrowable(String currency, String currencyPair) t } /** - * Get maximum borrowable + * Get maximum borrowable. * - * @param currency Retrieve data of the specified currency (required) - * @param currencyPair Currency pair (required) + * @param currency Retrieve data of the specified currency. (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 Successfully retrieved. -
*/ public ApiResponse getUniBorrowableWithHttpInfo(String currency, String currencyPair) throws ApiException { @@ -1185,17 +1185,17 @@ public ApiResponse getUniBorrowableWithHttpInfo(String currenc } /** - * Get maximum borrowable (asynchronously) + * Get maximum borrowable. (asynchronously) * - * @param currency Retrieve data of the specified currency (required) - * @param currencyPair Currency pair (required) + * @param currency Retrieve data of the specified currency. (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 Successfully retrieved. -
*/ 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 941eea6..0faf990 100644 --- a/src/main/java/io/gate/gateapi/api/MultiCollateralLoanApi.java +++ b/src/main/java/io/gate/gateapi/api/MultiCollateralLoanApi.java @@ -136,7 +136,7 @@ private APIlistMultiCollateralOrdersRequest() { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistMultiCollateralOrdersRequest */ public APIlistMultiCollateralOrdersRequest page(Integer page) { @@ -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 to be 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 Query the current interest rate of the currency in the previous hour (optional) + * @param sort Query the current interest rate of the currency in the previous hour. (optional) * @return APIlistMultiCollateralOrdersRequest */ public APIlistMultiCollateralOrdersRequest sort(String sort) { @@ -182,7 +182,7 @@ public APIlistMultiCollateralOrdersRequest orderType(String orderType) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -235,13 +235,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _ } /** - * List Multi-Collateral Orders + * List Multi-Collateral Orders. * * @return APIlistMultiCollateralOrdersRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistMultiCollateralOrdersRequest listMultiCollateralOrders() { @@ -257,7 +257,7 @@ public APIlistMultiCollateralOrdersRequest listMultiCollateralOrders() { * @http.response.details - +
Status Code Description Response Headers
200 Success -
200 Success. -
*/ public okhttp3.Call createMultiCollateralCall(CreateMultiCollateralOrder createMultiCollateralOrder, final ApiCallback _callback) throws ApiException { @@ -301,7 +301,7 @@ private okhttp3.Call createMultiCollateralValidateBeforeCall(CreateMultiCollater } /** - * Create Multi-Collateral Order + * Create Multi-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 Success. -
*/ public OrderResp createMultiCollateral(CreateMultiCollateralOrder createMultiCollateralOrder) throws ApiException { @@ -318,7 +318,7 @@ public OrderResp createMultiCollateral(CreateMultiCollateralOrder createMultiCol } /** - * Create Multi-Collateral Order + * Create Multi-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 Success. -
*/ public ApiResponse createMultiCollateralWithHttpInfo(CreateMultiCollateralOrder createMultiCollateralOrder) throws ApiException { @@ -336,7 +336,7 @@ public ApiResponse createMultiCollateralWithHttpInfo(CreateMultiColla } /** - * Create Multi-Collateral Order (asynchronously) + * Create Multi-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 Success. -
*/ 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 on successful order creation. (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 Success. -
*/ 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 + * Get Multi-Collateral Order Detail. * - * @param orderId Order ID returned on successful order creation (required) + * @param orderId Order ID returned on successful order creation. (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 Success. -
*/ public MultiCollateralOrder getMultiCollateralOrderDetail(String orderId) throws ApiException { @@ -426,15 +426,15 @@ public MultiCollateralOrder getMultiCollateralOrderDetail(String orderId) throws } /** - * Get Multi-Collateral Order Detail + * Get Multi-Collateral Order Detail. * - * @param orderId Order ID returned on successful order creation (required) + * @param orderId Order ID returned on successful order creation. (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 Success. -
*/ public ApiResponse getMultiCollateralOrderDetailWithHttpInfo(String orderId) throws ApiException { @@ -444,16 +444,16 @@ public ApiResponse getMultiCollateralOrderDetailWithHttpIn } /** - * Get Multi-Collateral Order Detail (asynchronously) + * Get Multi-Collateral Order Detail. (asynchronously) * - * @param orderId Order ID returned on successful order creation (required) + * @param orderId Order ID returned on successful order creation. (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 Success. -
*/ public okhttp3.Call getMultiCollateralOrderDetailAsync(String orderId, final ApiCallback _callback) throws ApiException { @@ -555,7 +555,7 @@ private APIlistMultiRepayRecordsRequest(String type) { /** * Set borrowCurrency - * @param borrowCurrency Borrowed currency (optional) + * @param borrowCurrency Borrowed currency. (optional) * @return APIlistMultiRepayRecordsRequest */ public APIlistMultiRepayRecordsRequest borrowCurrency(String borrowCurrency) { @@ -565,7 +565,7 @@ public APIlistMultiRepayRecordsRequest borrowCurrency(String borrowCurrency) { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistMultiRepayRecordsRequest */ public APIlistMultiRepayRecordsRequest page(Integer page) { @@ -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 to be 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 of 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 Time range ending, default to current time. (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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 + * List Multi-Collateral Repay Records. * - * @param type Operation type: repay - Regular repayment, liquidate - Liquidation (required) + * @param type Operation type: repay - Regular repayment, liquidate - Liquidation. (required) * @return APIlistMultiRepayRecordsRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ 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 Operated successfully. -
*/ 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 + * Repay Multi-Collateral Loan. * * @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 Operated successfully. -
*/ public MultiRepayResp repayMultiCollateralLoan(RepayMultiLoan repayMultiLoan) throws ApiException { @@ -748,7 +748,7 @@ public MultiRepayResp repayMultiCollateralLoan(RepayMultiLoan repayMultiLoan) th } /** - * Repay Multi-Collateral Loan + * Repay Multi-Collateral Loan. * * @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 Operated successfully. -
*/ public ApiResponse repayMultiCollateralLoanWithHttpInfo(RepayMultiLoan repayMultiLoan) throws ApiException { @@ -766,7 +766,7 @@ public ApiResponse repayMultiCollateralLoanWithHttpInfo(RepayMul } /** - * Repay Multi-Collateral Loan (asynchronously) + * Repay Multi-Collateral Loan. (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 Operated successfully. -
*/ public okhttp3.Call repayMultiCollateralLoanAsync(RepayMultiLoan repayMultiLoan, final ApiCallback _callback) throws ApiException { @@ -866,7 +866,7 @@ private APIlistMultiCollateralRecordsRequest() { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistMultiCollateralRecordsRequest */ public APIlistMultiCollateralRecordsRequest page(Integer page) { @@ -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 to be 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 of 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 Time range ending, default to current time. (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. (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. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -975,13 +975,13 @@ public okhttp3.Call executeAsync(final ApiCallback> } /** - * Query collateral adjustment records + * Query collateral adjustment records. * * @return APIlistMultiCollateralRecordsRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistMultiCollateralRecordsRequest listMultiCollateralRecords() { @@ -997,7 +997,7 @@ public APIlistMultiCollateralRecordsRequest listMultiCollateralRecords() { * @http.response.details - +
Status Code Description Response Headers
200 Operated successfully -
200 Operated successfully. -
*/ public okhttp3.Call operateMultiCollateralCall(CollateralAdjust collateralAdjust, final ApiCallback _callback) throws ApiException { @@ -1041,7 +1041,7 @@ private okhttp3.Call operateMultiCollateralValidateBeforeCall(CollateralAdjust c } /** - * Operate Multi-Collateral + * Operate Multi-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 Operated successfully. -
*/ public CollateralAdjustRes operateMultiCollateral(CollateralAdjust collateralAdjust) throws ApiException { @@ -1058,7 +1058,7 @@ public CollateralAdjustRes operateMultiCollateral(CollateralAdjust collateralAdj } /** - * Operate Multi-Collateral + * Operate Multi-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 Operated successfully. -
*/ public ApiResponse operateMultiCollateralWithHttpInfo(CollateralAdjust collateralAdjust) throws ApiException { @@ -1076,7 +1076,7 @@ public ApiResponse operateMultiCollateralWithHttpInfo(Colla } /** - * Operate Multi-Collateral (asynchronously) + * Operate Multi-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 Operated successfully. -
*/ 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 type: collateral - Collateral currency, borrow - Borrowing (required) - * @param currency When it is a collateral currency, multiple currencies can be passed separated by commas;when it is a borrowing currency, only one currenc (required) + * @param type Currency type: collateral - Collateral currency, borrow - Borrowing. (required) + * @param currency When it is a collateral currency, multiple currencies can be passed separated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one commas; when it is a borrowing currency, only one currency can be passed (required) * @param _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 Successfully retrieved. -
*/ 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 + * List User Currency Quota. * - * @param type Currency type: collateral - Collateral currency, borrow - Borrowing (required) - * @param currency When it is a collateral currency, multiple currencies can be passed separated by commas;when it is a borrowing currency, only one currenc (required) + * @param type Currency type: collateral - Collateral currency, borrow - Borrowing. (required) + * @param currency When it is a collateral currency, multiple currencies can be passed separated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one commas; when it is a borrowing currency, only one currency can be passed (required) * @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 Successfully retrieved. -
*/ 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 + * List User Currency Quota. * - * @param type Currency type: collateral - Collateral currency, borrow - Borrowing (required) - * @param currency When it is a collateral currency, multiple currencies can be passed separated by commas;when it is a borrowing currency, only one currenc (required) + * @param type Currency type: collateral - Collateral currency, borrow - Borrowing. (required) + * @param currency When it is a collateral currency, multiple currencies can be passed separated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one commas; when it is a borrowing currency, only one currency can be passed (required) * @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 Successfully retrieved. -
*/ public ApiResponse> listUserCurrencyQuotaWithHttpInfo(String type, String currency) throws ApiException { @@ -1199,17 +1199,17 @@ public ApiResponse> listUserCurrencyQuotaWithHttpInfo(String } /** - * List User Currency Quota (asynchronously) + * List User Currency Quota. (asynchronously) * - * @param type Currency type: collateral - Collateral currency, borrow - Borrowing (required) - * @param currency When it is a collateral currency, multiple currencies can be passed separated by commas;when it is a borrowing currency, only one currenc (required) + * @param type Currency type: collateral - Collateral currency, borrow - Borrowing. (required) + * @param currency When it is a collateral currency, multiple currencies can be passed separated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one commas; when it is a borrowing currency, only one currency can be passed (required) * @param _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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 in Multi-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 Successfully retrieved. -
*/ 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 in Multi-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 Successfully retrieved. -
*/ 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 in Multi-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 Successfully retrieved. -
*/ 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 Successfully retrieved. - */ public okhttp3.Call getMultiCollateralLtvCall(final ApiCallback _callback) throws ApiException { @@ -1364,14 +1364,14 @@ private okhttp3.Call getMultiCollateralLtvValidateBeforeCall(final ApiCallback _ } /** - * Get Multi-Collateral ratio + * Get Multi-Collateral ratio. * The Multi-Collateral ratio is fixed, irrespective of the 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 Successfully retrieved. -
*/ public CollateralLtv getMultiCollateralLtv() throws ApiException { @@ -1380,14 +1380,14 @@ public CollateralLtv getMultiCollateralLtv() throws ApiException { } /** - * Get Multi-Collateral ratio + * Get Multi-Collateral ratio. * The Multi-Collateral ratio is fixed, irrespective of the 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 Successfully retrieved. -
*/ public ApiResponse getMultiCollateralLtvWithHttpInfo() throws ApiException { @@ -1397,7 +1397,7 @@ public ApiResponse getMultiCollateralLtvWithHttpInfo() throws Api } /** - * Get Multi-Collateral ratio (asynchronously) + * Get Multi-Collateral ratio. (asynchronously) * The Multi-Collateral ratio is fixed, irrespective of the currency. * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1405,7 +1405,7 @@ public ApiResponse getMultiCollateralLtvWithHttpInfo() throws Api * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 fixed interest rates for the currency for 7 days and 30 days. * * @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 Successfully retrieved. -
*/ 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 fixed interest rates for the currency for 7 days and 30 days. * * @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 Successfully retrieved. -
*/ 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 fixed interest rates for the currency for 7 days and 30 days. (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 Successfully retrieved. -
*/ 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 transferred. (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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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. * Query the current interest rate of the currency in the previous hour. * @param currencies Specify currency name query array, separated by commas, maximum 100items. (required) * @return APIgetMultiCollateralCurrentRateRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ 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 8609883..76972a4 100644 --- a/src/main/java/io/gate/gateapi/api/OptionsApi.java +++ b/src/main/java/io/gate/gateapi/api/OptionsApi.java @@ -74,7 +74,7 @@ public void setApiClient(ApiClient apiClient) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call listOptionsUnderlyingsCall(final ApiCallback _callback) throws ApiException { @@ -113,14 +113,14 @@ private okhttp3.Call listOptionsUnderlyingsValidateBeforeCall(final ApiCallback } /** - * List all underlyings + * List all underlyings. * * @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. -
*/ public List listOptionsUnderlyings() throws ApiException { @@ -129,14 +129,14 @@ public List listOptionsUnderlyings() throws ApiException { } /** - * List all underlyings + * List all underlyings. * * @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. -
*/ public ApiResponse> listOptionsUnderlyingsWithHttpInfo() throws ApiException { @@ -146,7 +146,7 @@ public ApiResponse> listOptionsUnderlyingsWithHttpInfo() } /** - * List all underlyings (asynchronously) + * List all underlyings. (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. -
*/ public okhttp3.Call listOptionsUnderlyingsAsync(final ApiCallback> _callback) throws ApiException { @@ -166,14 +166,14 @@ public okhttp3.Call listOptionsUnderlyingsAsync(final ApiCallback Status Code Description Response Headers - 200 List expiration times of specified underlying - + 200 List expiration times of specified underlying. - */ public okhttp3.Call listOptionsExpirationsCall(String underlying, final ApiCallback _callback) throws ApiException { @@ -221,15 +221,15 @@ private okhttp3.Call listOptionsExpirationsValidateBeforeCall(String underlying, } /** - * List all expiration times + * List all expiration times. * - * @param underlying Underlying (Obtained by listing underlying endpoint) (required) + * @param underlying Underlying (Obtained by listing underlying endpoint). (required) * @return List<Long> * @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 expiration times of specified underlying -
200 List expiration times of specified underlying. -
*/ public List listOptionsExpirations(String underlying) throws ApiException { @@ -238,15 +238,15 @@ public List listOptionsExpirations(String underlying) throws ApiException } /** - * List all expiration times + * List all expiration times. * - * @param underlying Underlying (Obtained by listing underlying endpoint) (required) + * @param underlying Underlying (Obtained by listing underlying endpoint). (required) * @return ApiResponse<List<Long>> * @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 expiration times of specified underlying -
200 List expiration times of specified underlying. -
*/ public ApiResponse> listOptionsExpirationsWithHttpInfo(String underlying) throws ApiException { @@ -256,16 +256,16 @@ public ApiResponse> listOptionsExpirationsWithHttpInfo(String underly } /** - * List all expiration times (asynchronously) + * List all expiration times. (asynchronously) * - * @param underlying Underlying (Obtained by listing underlying endpoint) (required) + * @param underlying Underlying (Obtained by listing underlying endpoint). (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 expiration times of specified underlying -
200 List expiration times of 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 the expiration time. (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. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ 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 the contracts with specified underlying and expiration time. * - * @param underlying Underlying (Obtained by listing underlying endpoint) (required) + * @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. -
*/ 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 Successfully retrieved. -
*/ 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 detail. * * @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 Successfully retrieved. -
*/ 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 detail. * * @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 Successfully retrieved. -
*/ public ApiResponse getOptionsContractWithHttpInfo(String contract) throws ApiException { @@ -519,7 +519,7 @@ public ApiResponse getOptionsContractWithHttpInfo(String contra } /** - * Query specified contract detail (asynchronously) + * Query specified contract detail. (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 Successfully retrieved. -
*/ 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 to be returned in a single list. (optional, default to 100) * @return APIlistOptionsSettlementsRequest */ public APIlistOptionsSettlementsRequest limit(Integer limit) { @@ -635,7 +635,7 @@ public APIlistOptionsSettlementsRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIlistOptionsSettlementsRequest */ public APIlistOptionsSettlementsRequest offset(Integer offset) { @@ -671,7 +671,7 @@ public APIlistOptionsSettlementsRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -724,14 +724,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _cal } /** - * List settlement history + * List settlement history. * - * @param underlying Underlying (Obtained by listing underlying endpoint) (required) + * @param underlying Underlying (Obtained by listing underlying endpoint). (required) * @return APIlistOptionsSettlementsRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistOptionsSettlementsRequest listOptionsSettlements(String underlying) { @@ -741,7 +741,7 @@ public APIlistOptionsSettlementsRequest listOptionsSettlements(String underlying /** * Build call for getOptionsSettlement * @param contract (required) - * @param underlying Underlying (Obtained by listing underlying endpoint) (required) + * @param underlying Underlying (Obtained by listing underlying endpoint). (required) * @param at (required) * @param _callback Callback for upload/download progress * @return Call to execute @@ -749,7 +749,7 @@ public APIlistOptionsSettlementsRequest listOptionsSettlements(String underlying * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call getOptionsSettlementCall(String contract, String underlying, Long at, final ApiCallback _callback) throws ApiException { @@ -812,17 +812,17 @@ private okhttp3.Call getOptionsSettlementValidateBeforeCall(String contract, Str } /** - * Get specified contract's settlement + * Get specified contract's settlement. * * @param contract (required) - * @param underlying Underlying (Obtained by listing underlying endpoint) (required) + * @param underlying Underlying (Obtained by listing underlying endpoint). (required) * @param at (required) * @return OptionsSettlement * @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 Successfully retrieved. -
*/ public OptionsSettlement getOptionsSettlement(String contract, String underlying, Long at) throws ApiException { @@ -831,17 +831,17 @@ public OptionsSettlement getOptionsSettlement(String contract, String underlying } /** - * Get specified contract's settlement + * Get specified contract's settlement. * * @param contract (required) - * @param underlying Underlying (Obtained by listing underlying endpoint) (required) + * @param underlying Underlying (Obtained by listing underlying endpoint). (required) * @param at (required) * @return ApiResponse<OptionsSettlement> * @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 Successfully retrieved. -
*/ public ApiResponse getOptionsSettlementWithHttpInfo(String contract, String underlying, Long at) throws ApiException { @@ -851,10 +851,10 @@ public ApiResponse getOptionsSettlementWithHttpInfo(String co } /** - * Get specified contract's settlement (asynchronously) + * Get specified contract's settlement. (asynchronously) * * @param contract (required) - * @param underlying Underlying (Obtained by listing underlying endpoint) (required) + * @param underlying Underlying (Obtained by listing underlying endpoint). (required) * @param at (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -862,7 +862,7 @@ public ApiResponse getOptionsSettlementWithHttpInfo(String co * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call getOptionsSettlementAsync(String contract, String underlying, Long at, final ApiCallback _callback) throws ApiException { @@ -964,7 +964,7 @@ private APIlistMyOptionsSettlementsRequest(String underlying) { /** * Set contract - * @param contract Options contract name (optional) + * @param contract Options contract name. (optional) * @return APIlistMyOptionsSettlementsRequest */ public APIlistMyOptionsSettlementsRequest contract(String contract) { @@ -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 to be returned in a single list. (optional, default to 100) * @return APIlistMyOptionsSettlementsRequest */ public APIlistMyOptionsSettlementsRequest limit(Integer limit) { @@ -984,7 +984,7 @@ public APIlistMyOptionsSettlementsRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIlistMyOptionsSettlementsRequest */ public APIlistMyOptionsSettlementsRequest offset(Integer offset) { @@ -1020,7 +1020,7 @@ public APIlistMyOptionsSettlementsRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1073,14 +1073,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _ } /** - * List my options settlements + * List my options settlements. * - * @param underlying Underlying (Obtained by listing underlying endpoint) (required) + * @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. -
*/ 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 Order depth. 0 means no aggregation is applied. default to 0. (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 Maximum number of order depth data in asks or bids. (optional, default to 10) * @return APIlistOptionsOrderBookRequest */ public APIlistOptionsOrderBookRequest limit(Integer limit) { @@ -1205,7 +1205,7 @@ public APIlistOptionsOrderBookRequest withId(Boolean withId) { * @http.response.details - +
Status Code Description Response Headers
200 Depth query successful -
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 Depth query successful -
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 Depth query successful -
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 Depth query successful -
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 - * Bids will be sorted by price from high to low, while asks sorted reversely - * @param contract Options contract name (required) + * Options 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 Depth query successful -
200 Depth query successful. -
*/ public APIlistOptionsOrderBookRequest listOptionsOrderBook(String contract) { @@ -1274,14 +1274,14 @@ public APIlistOptionsOrderBookRequest listOptionsOrderBook(String contract) { /** * Build call for listOptionsTickers - * @param underlying Underlying (Obtained by listing underlying endpoint) (required) + * @param underlying Underlying (Obtained by listing underlying endpoint). (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 Successfully retrieved. -
*/ public okhttp3.Call listOptionsTickersCall(String underlying, final ApiCallback _callback) throws ApiException { @@ -1329,15 +1329,15 @@ private okhttp3.Call listOptionsTickersValidateBeforeCall(String underlying, fin } /** - * List tickers of options contracts + * List tickers of options contracts. * - * @param underlying Underlying (Obtained by listing underlying endpoint) (required) + * @param underlying Underlying (Obtained by listing underlying endpoint). (required) * @return List<OptionsTicker> * @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 Successfully retrieved. -
*/ public List listOptionsTickers(String underlying) throws ApiException { @@ -1346,15 +1346,15 @@ public List listOptionsTickers(String underlying) throws ApiExcep } /** - * List tickers of options contracts + * List tickers of options contracts. * - * @param underlying Underlying (Obtained by listing underlying endpoint) (required) + * @param underlying Underlying (Obtained by listing underlying endpoint). (required) * @return ApiResponse<List<OptionsTicker>> * @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 Successfully retrieved. -
*/ public ApiResponse> listOptionsTickersWithHttpInfo(String underlying) throws ApiException { @@ -1364,16 +1364,16 @@ public ApiResponse> listOptionsTickersWithHttpInfo(String un } /** - * List tickers of options contracts (asynchronously) + * List tickers of options contracts. (asynchronously) * - * @param underlying Underlying (Obtained by listing underlying endpoint) (required) + * @param underlying Underlying (Obtained by listing underlying endpoint). (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 Successfully retrieved. -
*/ public okhttp3.Call listOptionsTickersAsync(String underlying, final ApiCallback> _callback) throws ApiException { @@ -1385,14 +1385,14 @@ public okhttp3.Call listOptionsTickersAsync(String underlying, final ApiCallback /** * Build call for listOptionsUnderlyingTickers - * @param underlying Underlying (required) + * @param underlying Underlying. (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 Successfully retrieved. -
*/ public okhttp3.Call listOptionsUnderlyingTickersCall(String underlying, final ApiCallback _callback) throws ApiException { @@ -1437,15 +1437,15 @@ private okhttp3.Call listOptionsUnderlyingTickersValidateBeforeCall(String under } /** - * Get underlying ticker + * Get underlying ticker. * - * @param underlying Underlying (required) + * @param underlying Underlying. (required) * @return OptionsUnderlyingTicker * @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 Successfully retrieved. -
*/ public OptionsUnderlyingTicker listOptionsUnderlyingTickers(String underlying) throws ApiException { @@ -1454,15 +1454,15 @@ public OptionsUnderlyingTicker listOptionsUnderlyingTickers(String underlying) t } /** - * Get underlying ticker + * Get underlying ticker. * - * @param underlying Underlying (required) + * @param underlying Underlying. (required) * @return ApiResponse<OptionsUnderlyingTicker> * @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 Successfully retrieved. -
*/ public ApiResponse listOptionsUnderlyingTickersWithHttpInfo(String underlying) throws ApiException { @@ -1472,16 +1472,16 @@ public ApiResponse listOptionsUnderlyingTickersWithHttp } /** - * Get underlying ticker (asynchronously) + * Get underlying ticker. (asynchronously) * - * @param underlying Underlying (required) + * @param underlying Underlying. (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 Successfully retrieved. -
*/ 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 to be returned in a single list. (optional, default to 100) * @return APIlistOptionsCandlesticksRequest */ public APIlistOptionsCandlesticksRequest limit(Integer limit) { @@ -1608,7 +1608,7 @@ public APIlistOptionsCandlesticksRequest to(Long to) { /** * Set interval - * @param interval Interval time between data points (optional, default to 5m) + * @param interval Interval time 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1677,14 +1677,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _ca } /** - * Get options candlesticks + * Get options candlesticks. * - * @param contract Options contract name (required) + * @param contract Options contract name. (required) * @return APIlistOptionsCandlesticksRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ 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 to be returned in a single list. (optional, default to 100) * @return APIlistOptionsUnderlyingCandlesticksRequest */ public APIlistOptionsUnderlyingCandlesticksRequest limit(Integer limit) { @@ -1808,7 +1808,7 @@ public APIlistOptionsUnderlyingCandlesticksRequest to(Long to) { /** * Set interval - * @param interval Interval time between data points (optional, default to 5m) + * @param interval Interval time 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 + * Mark price candlesticks of an underlying. * - * @param underlying Underlying (Obtained by listing underlying endpoint) (required) + * @param underlying Underlying (Obtained by listing underlying endpoint). (required) * @return APIlistOptionsUnderlyingCandlesticksRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public APIlistOptionsUnderlyingCandlesticksRequest listOptionsUnderlyingCandlesticks(String underlying) { @@ -1977,7 +1977,7 @@ private APIlistOptionsTradesRequest() { /** * Set contract - * @param contract Options contract name (optional) + * @param contract Options contract name. (optional) * @return APIlistOptionsTradesRequest */ public APIlistOptionsTradesRequest contract(String contract) { @@ -1987,7 +1987,7 @@ public APIlistOptionsTradesRequest contract(String contract) { /** * Set type - * @param type `C` is call, while `P` is put (optional) + * @param type `C` is call, while `P` is 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 to be returned in a single list. (optional, default to 100) * @return APIlistOptionsTradesRequest */ public APIlistOptionsTradesRequest limit(Integer limit) { @@ -2007,7 +2007,7 @@ public APIlistOptionsTradesRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIlistOptionsTradesRequest */ public APIlistOptionsTradesRequest offset(Integer offset) { @@ -2043,7 +2043,7 @@ public APIlistOptionsTradesRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2096,13 +2096,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * Options trade history + * Options trade history. * * @return APIlistOptionsTradesRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistOptionsTradesRequest listOptionsTrades() { @@ -2117,7 +2117,7 @@ public APIlistOptionsTradesRequest listOptionsTrades() { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call listOptionsAccountCall(final ApiCallback _callback) throws ApiException { @@ -2156,14 +2156,14 @@ private okhttp3.Call listOptionsAccountValidateBeforeCall(final ApiCallback _cal } /** - * List options account + * List options account. * * @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 Successfully retrieved. -
*/ public OptionsAccount listOptionsAccount() throws ApiException { @@ -2172,14 +2172,14 @@ public OptionsAccount listOptionsAccount() throws ApiException { } /** - * List options account + * List options account. * * @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 Successfully retrieved. -
*/ public ApiResponse listOptionsAccountWithHttpInfo() throws ApiException { @@ -2189,7 +2189,7 @@ public ApiResponse listOptionsAccountWithHttpInfo() throws ApiEx } /** - * List options account (asynchronously) + * List options account. (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 Successfully retrieved. -
*/ 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 to be returned in a single list. (optional, default to 100) * @return APIlistOptionsAccountBookRequest */ public APIlistOptionsAccountBookRequest limit(Integer limit) { @@ -2298,7 +2298,7 @@ public APIlistOptionsAccountBookRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIlistOptionsAccountBookRequest */ public APIlistOptionsAccountBookRequest offset(Integer offset) { @@ -2344,7 +2344,7 @@ public APIlistOptionsAccountBookRequest type(String type) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2397,13 +2397,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _ca } /** - * List account changing history + * List account changing history. * * @return APIlistOptionsAccountBookRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistOptionsAccountBookRequest listOptionsAccountBook() { @@ -2471,7 +2471,7 @@ private APIlistOptionsPositionsRequest() { /** * Set underlying - * @param underlying Underlying (optional) + * @param underlying Underlying. (optional) * @return APIlistOptionsPositionsRequest */ public APIlistOptionsPositionsRequest underlying(String underlying) { @@ -2487,7 +2487,7 @@ public APIlistOptionsPositionsRequest underlying(String underlying) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2540,13 +2540,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callb } /** - * List user's positions of specified underlying + * List user's positions of specified underlying. * * @return APIlistOptionsPositionsRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistOptionsPositionsRequest listOptionsPositions() { @@ -2562,7 +2562,7 @@ public APIlistOptionsPositionsRequest listOptionsPositions() { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call getOptionsPositionCall(String contract, final ApiCallback _callback) throws ApiException { @@ -2607,7 +2607,7 @@ private okhttp3.Call getOptionsPositionValidateBeforeCall(String contract, final } /** - * Get specified contract position + * Get specified contract position. * * @param contract (required) * @return OptionsPosition @@ -2615,7 +2615,7 @@ private okhttp3.Call getOptionsPositionValidateBeforeCall(String contract, final * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public OptionsPosition getOptionsPosition(String contract) throws ApiException { @@ -2624,7 +2624,7 @@ public OptionsPosition getOptionsPosition(String contract) throws ApiException { } /** - * Get specified contract position + * Get specified contract position. * * @param contract (required) * @return ApiResponse<OptionsPosition> @@ -2632,7 +2632,7 @@ public OptionsPosition getOptionsPosition(String contract) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public ApiResponse getOptionsPositionWithHttpInfo(String contract) throws ApiException { @@ -2642,7 +2642,7 @@ public ApiResponse getOptionsPositionWithHttpInfo(String contra } /** - * Get specified contract position (asynchronously) + * Get specified contract position. (asynchronously) * * @param contract (required) * @param _callback The callback to be executed when the API call finishes @@ -2651,7 +2651,7 @@ public ApiResponse getOptionsPositionWithHttpInfo(String contra * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call getOptionsPositionAsync(String contract, final ApiCallback _callback) throws ApiException { @@ -2733,7 +2733,7 @@ private APIlistOptionsPositionCloseRequest(String underlying) { /** * Set contract - * @param contract Options contract name (optional) + * @param contract Options contract name. (optional) * @return APIlistOptionsPositionCloseRequest */ public APIlistOptionsPositionCloseRequest contract(String contract) { @@ -2749,7 +2749,7 @@ public APIlistOptionsPositionCloseRequest contract(String contract) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2802,14 +2802,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _ } /** - * List user's liquidation history of specified underlying + * List user's liquidation history of specified underlying. * - * @param underlying Underlying (Obtained by listing underlying endpoint) (required) + * @param underlying Underlying (Obtained by listing underlying endpoint). (required) * @return APIlistOptionsPositionCloseRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistOptionsPositionCloseRequest listOptionsPositionClose(String underlying) { @@ -2913,7 +2913,7 @@ private APIlistOptionsOrdersRequest(String status) { /** * Set contract - * @param contract Options contract name (optional) + * @param contract Options contract name. (optional) * @return APIlistOptionsOrdersRequest */ public APIlistOptionsOrdersRequest contract(String contract) { @@ -2923,7 +2923,7 @@ public APIlistOptionsOrdersRequest contract(String contract) { /** * Set underlying - * @param underlying Underlying (optional) + * @param underlying Underlying. (optional) * @return APIlistOptionsOrdersRequest */ public APIlistOptionsOrdersRequest underlying(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 to be returned in a single list. (optional, default to 100) * @return APIlistOptionsOrdersRequest */ public APIlistOptionsOrdersRequest limit(Integer limit) { @@ -2943,7 +2943,7 @@ public APIlistOptionsOrdersRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIlistOptionsOrdersRequest */ public APIlistOptionsOrdersRequest offset(Integer offset) { @@ -2979,7 +2979,7 @@ public APIlistOptionsOrdersRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -3032,14 +3032,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * List options orders + * List options orders. * - * @param status Only list the orders with this status (required) + * @param status Only list the orders with this status. (required) * @return APIlistOptionsOrdersRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistOptionsOrdersRequest listOptionsOrders(String status) { @@ -3055,7 +3055,7 @@ public APIlistOptionsOrdersRequest listOptionsOrders(String status) { * @http.response.details - +
Status Code Description Response Headers
201 Order detail -
201 Order detail. -
*/ public okhttp3.Call createOptionsOrderCall(OptionsOrder optionsOrder, final ApiCallback _callback) throws ApiException { @@ -3099,7 +3099,7 @@ private okhttp3.Call createOptionsOrderValidateBeforeCall(OptionsOrder optionsOr } /** - * Create an options order + * Create an options order. * * @param optionsOrder (required) * @return OptionsOrder @@ -3107,7 +3107,7 @@ private okhttp3.Call createOptionsOrderValidateBeforeCall(OptionsOrder optionsOr * @http.response.details - +
Status Code Description Response Headers
201 Order detail -
201 Order detail. -
*/ public OptionsOrder createOptionsOrder(OptionsOrder optionsOrder) throws ApiException { @@ -3116,7 +3116,7 @@ public OptionsOrder createOptionsOrder(OptionsOrder optionsOrder) throws ApiExce } /** - * Create an options order + * Create an options order. * * @param optionsOrder (required) * @return ApiResponse<OptionsOrder> @@ -3124,7 +3124,7 @@ public OptionsOrder createOptionsOrder(OptionsOrder optionsOrder) throws ApiExce * @http.response.details - +
Status Code Description Response Headers
201 Order detail -
201 Order detail. -
*/ public ApiResponse createOptionsOrderWithHttpInfo(OptionsOrder optionsOrder) throws ApiException { @@ -3134,7 +3134,7 @@ public ApiResponse createOptionsOrderWithHttpInfo(OptionsOrder opt } /** - * Create an options order (asynchronously) + * Create an options order. (asynchronously) * * @param optionsOrder (required) * @param _callback The callback to be executed when the API call finishes @@ -3143,7 +3143,7 @@ public ApiResponse createOptionsOrderWithHttpInfo(OptionsOrder opt * @http.response.details - +
Status Code Description Response Headers
201 Order detail -
201 Order detail. -
*/ public okhttp3.Call createOptionsOrderAsync(OptionsOrder optionsOrder, final ApiCallback _callback) throws ApiException { @@ -3155,16 +3155,16 @@ 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 contract Options contract name. (optional) + * @param underlying Underlying. (optional) + * @param side All bids or 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 All orders matched cancelled. -
*/ 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 `open` orders matched. * - * @param contract Options contract name (optional) - * @param underlying Underlying (optional) - * @param side All bids or asks. Both included if not specified (optional) + * @param contract Options contract name. (optional) + * @param underlying Underlying. (optional) + * @param side All bids or 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 All orders matched cancelled. -
*/ 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 `open` orders matched. * - * @param contract Options contract name (optional) - * @param underlying Underlying (optional) - * @param side All bids or asks. Both included if not specified (optional) + * @param contract Options contract name. (optional) + * @param underlying Underlying. (optional) + * @param side All bids or 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 All orders matched cancelled. -
*/ 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 `open` orders matched. (asynchronously) * - * @param contract Options contract name (optional) - * @param underlying Underlying (optional) - * @param side All bids or asks. Both included if not specified (optional) + * @param contract Options contract name. (optional) + * @param underlying Underlying. (optional) + * @param side All bids or 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 All orders matched cancelled. -
*/ public okhttp3.Call cancelOptionsOrdersAsync(String contract, String underlying, String side, final ApiCallback> _callback) throws ApiException { @@ -3277,14 +3277,14 @@ 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 on successful order creation. (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 Order detail -
200 Order detail. -
*/ public okhttp3.Call getOptionsOrderCall(Long orderId, final ApiCallback _callback) throws ApiException { @@ -3329,15 +3329,15 @@ private okhttp3.Call getOptionsOrderValidateBeforeCall(Long orderId, final ApiCa } /** - * Get a single order + * Get a single order. * - * @param orderId Order ID returned on successful order creation (required) + * @param orderId Order ID returned on successful order creation. (required) * @return 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 Order detail -
200 Order detail. -
*/ public OptionsOrder getOptionsOrder(Long orderId) throws ApiException { @@ -3346,15 +3346,15 @@ public OptionsOrder getOptionsOrder(Long orderId) throws ApiException { } /** - * Get a single order + * Get a single order. * - * @param orderId Order ID returned on successful order creation (required) + * @param orderId Order ID returned on successful order creation. (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 - +
Status Code Description Response Headers
200 Order detail -
200 Order detail. -
*/ public ApiResponse getOptionsOrderWithHttpInfo(Long orderId) throws ApiException { @@ -3364,16 +3364,16 @@ public ApiResponse getOptionsOrderWithHttpInfo(Long orderId) throw } /** - * Get a single order (asynchronously) + * Get a single order. (asynchronously) * - * @param orderId Order ID returned on successful order creation (required) + * @param orderId Order ID returned on successful order creation. (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 Order detail -
200 Order detail. -
*/ public okhttp3.Call getOptionsOrderAsync(Long orderId, final ApiCallback _callback) throws ApiException { @@ -3385,14 +3385,14 @@ public okhttp3.Call getOptionsOrderAsync(Long orderId, final ApiCallback Status Code Description Response Headers - 200 Order detail - + 200 Order detail. - */ public okhttp3.Call cancelOptionsOrderCall(Long orderId, final ApiCallback _callback) throws ApiException { @@ -3437,15 +3437,15 @@ private okhttp3.Call cancelOptionsOrderValidateBeforeCall(Long orderId, final Ap } /** - * Cancel a single order + * Cancel a single order. * - * @param orderId Order ID returned on successful order creation (required) + * @param orderId Order ID returned on successful order creation. (required) * @return 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 Order detail -
200 Order detail. -
*/ public OptionsOrder cancelOptionsOrder(Long orderId) throws ApiException { @@ -3454,15 +3454,15 @@ public OptionsOrder cancelOptionsOrder(Long orderId) throws ApiException { } /** - * Cancel a single order + * Cancel a single order. * - * @param orderId Order ID returned on successful order creation (required) + * @param orderId Order ID returned on successful order creation. (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 - +
Status Code Description Response Headers
200 Order detail -
200 Order detail. -
*/ public ApiResponse cancelOptionsOrderWithHttpInfo(Long orderId) throws ApiException { @@ -3472,16 +3472,16 @@ public ApiResponse cancelOptionsOrderWithHttpInfo(Long orderId) th } /** - * Cancel a single order (asynchronously) + * Cancel a single order. (asynchronously) * - * @param orderId Order ID returned on successful order creation (required) + * @param orderId Order ID returned on successful order creation. (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 Order detail -
200 Order detail. -
*/ public okhttp3.Call cancelOptionsOrderAsync(Long orderId, final ApiCallback _callback) throws ApiException { @@ -3500,7 +3500,7 @@ public okhttp3.Call cancelOptionsOrderAsync(Long orderId, final ApiCallback Status Code Description Response Headers - 200 Set countdown successfully - + 200 Set countdown successfully. - */ public okhttp3.Call countdownCancelAllOptionsCall(CountdownCancelAllOptionsTask countdownCancelAllOptionsTask, final ApiCallback _callback) throws ApiException { @@ -3544,15 +3544,15 @@ 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. + * Countdown cancel orders. + * Option order heartbeat detection, when the `timeout` time set by the user is reached, if the existing countdown is not canceled or a new countdown is set, the related `option pending order` will be automatically canceled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at intervals of 30 seconds, with each countdown `timeout` set to 30 (seconds). If this interface is not called again within 30 seconds, all pending orders on the `underlying` `contract` you specified will be automatically cancelled. If `underlying` `contract` is not specified, user will be automatically cancelled If `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the automatic order cancellation function will be cancelled. * @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 Set countdown successfully. -
*/ public TriggerTime countdownCancelAllOptions(CountdownCancelAllOptionsTask countdownCancelAllOptionsTask) throws ApiException { @@ -3561,15 +3561,15 @@ 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. + * Countdown cancel orders. + * Option order heartbeat detection, when the `timeout` time set by the user is reached, if the existing countdown is not canceled or a new countdown is set, the related `option pending order` will be automatically canceled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at intervals of 30 seconds, with each countdown `timeout` set to 30 (seconds). If this interface is not called again within 30 seconds, all pending orders on the `underlying` `contract` you specified will be automatically cancelled. If `underlying` `contract` is not specified, user will be automatically cancelled If `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the automatic order cancellation function will be cancelled. * @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 Set countdown successfully. -
*/ public ApiResponse countdownCancelAllOptionsWithHttpInfo(CountdownCancelAllOptionsTask countdownCancelAllOptionsTask) throws ApiException { @@ -3579,8 +3579,8 @@ 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. + * 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, 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 Set countdown successfully. -
*/ public okhttp3.Call countdownCancelAllOptionsAsync(CountdownCancelAllOptionsTask countdownCancelAllOptionsTask, final ApiCallback _callback) throws ApiException { @@ -3690,7 +3690,7 @@ private APIlistMyOptionsTradesRequest(String underlying) { /** * Set contract - * @param contract Options contract name (optional) + * @param contract Options contract name. (optional) * @return APIlistMyOptionsTradesRequest */ public APIlistMyOptionsTradesRequest contract(String contract) { @@ -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 to be returned in a single list. (optional, default to 100) * @return APIlistMyOptionsTradesRequest */ public APIlistMyOptionsTradesRequest limit(Integer limit) { @@ -3710,7 +3710,7 @@ public APIlistMyOptionsTradesRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIlistMyOptionsTradesRequest */ public APIlistMyOptionsTradesRequest offset(Integer offset) { @@ -3746,7 +3746,7 @@ public APIlistMyOptionsTradesRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -3799,14 +3799,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callba } /** - * List personal trading history + * List personal trading history. * - * @param underlying Underlying (Obtained by listing underlying endpoint) (required) + * @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. -
*/ public APIlistMyOptionsTradesRequest listMyOptionsTrades(String underlying) { @@ -3874,7 +3874,7 @@ private APIgetOptionsMMPRequest() { /** * Set underlying - * @param underlying Underlying (optional) + * @param underlying Underlying. (optional) * @return APIgetOptionsMMPRequest */ public APIgetOptionsMMPRequest underlying(String underlying) { @@ -3890,7 +3890,7 @@ public APIgetOptionsMMPRequest underlying(String underlying) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ public APIgetOptionsMMPRequest getOptionsMMP() { @@ -3965,7 +3965,7 @@ public APIgetOptionsMMPRequest getOptionsMMP() { * @http.response.details - +
Status Code Description Response Headers
200 MMP Information -
200 MMP Information. -
*/ public okhttp3.Call setOptionsMMPCall(OptionsMMP optionsMMP, final ApiCallback _callback) throws ApiException { @@ -4017,7 +4017,7 @@ private okhttp3.Call setOptionsMMPValidateBeforeCall(OptionsMMP optionsMMP, fina * @http.response.details - +
Status Code Description Response Headers
200 MMP Information -
200 MMP Information. -
*/ public OptionsMMP setOptionsMMP(OptionsMMP optionsMMP) throws ApiException { @@ -4034,7 +4034,7 @@ public OptionsMMP setOptionsMMP(OptionsMMP optionsMMP) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 MMP Information -
200 MMP Information. -
*/ public ApiResponse setOptionsMMPWithHttpInfo(OptionsMMP optionsMMP) throws ApiException { @@ -4053,7 +4053,7 @@ public ApiResponse setOptionsMMPWithHttpInfo(OptionsMMP optionsMMP) * @http.response.details - +
Status Code Description Response Headers
200 MMP Information -
200 MMP Information. -
*/ public okhttp3.Call setOptionsMMPAsync(OptionsMMP optionsMMP, final ApiCallback _callback) throws ApiException { @@ -4072,7 +4072,7 @@ public okhttp3.Call setOptionsMMPAsync(OptionsMMP optionsMMP, final ApiCallback< * @http.response.details - +
Status Code Description Response Headers
200 MMP Information -
200 MMP Information. -
*/ public okhttp3.Call resetOptionsMMPCall(OptionsMMPReset optionsMMPReset, final ApiCallback _callback) throws ApiException { @@ -4124,7 +4124,7 @@ private okhttp3.Call resetOptionsMMPValidateBeforeCall(OptionsMMPReset optionsMM * @http.response.details - +
Status Code Description Response Headers
200 MMP Information -
200 MMP Information. -
*/ public OptionsMMP resetOptionsMMP(OptionsMMPReset optionsMMPReset) throws ApiException { @@ -4141,7 +4141,7 @@ public OptionsMMP resetOptionsMMP(OptionsMMPReset optionsMMPReset) throws ApiExc * @http.response.details - +
Status Code Description Response Headers
200 MMP Information -
200 MMP Information. -
*/ public ApiResponse resetOptionsMMPWithHttpInfo(OptionsMMPReset optionsMMPReset) throws ApiException { @@ -4160,7 +4160,7 @@ public ApiResponse resetOptionsMMPWithHttpInfo(OptionsMMPReset optio * @http.response.details - +
Status Code Description Response Headers
200 MMP Information -
200 MMP Information. -
*/ public okhttp3.Call resetOptionsMMPAsync(OptionsMMPReset optionsMMPReset, final ApiCallback _callback) throws ApiException { diff --git a/src/main/java/io/gate/gateapi/api/RebateApi.java b/src/main/java/io/gate/gateapi/api/RebateApi.java index e4b826a..591b747 100644 --- a/src/main/java/io/gate/gateapi/api/RebateApi.java +++ b/src/main/java/io/gate/gateapi/api/RebateApi.java @@ -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 currency pair, if not specified, return all currency pairs. (optional) * @return APIagencyTransactionHistoryRequest */ public APIagencyTransactionHistoryRequest currencyPair(String currencyPair) { @@ -151,7 +151,7 @@ public APIagencyTransactionHistoryRequest currencyPair(String currencyPair) { /** * Set userId - * @param userId User ID. If not specified, all user records will be returned (optional) + * @param userId User ID. If not specified, all user records will be returned. (optional) * @return APIagencyTransactionHistoryRequest */ public APIagencyTransactionHistoryRequest userId(Long userId) { @@ -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 Time range beginning, default to 7 days before current time. (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 Time range ending, default to current time. (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 to be returned in a single list. (optional, default to 100) * @return APIagencyTransactionHistoryRequest */ public APIagencyTransactionHistoryRequest limit(Integer limit) { @@ -191,7 +191,7 @@ public APIagencyTransactionHistoryRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIagencyTransactionHistoryRequest */ public APIagencyTransactionHistoryRequest offset(Integer offset) { @@ -207,7 +207,7 @@ public APIagencyTransactionHistoryRequest offset(Integer offset) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -260,13 +260,13 @@ public okhttp3.Call executeAsync(final ApiCallback Status Code Description Response Headers - 200 List retrieved - + 200 List retrieved. - */ public APIagencyTransactionHistoryRequest agencyTransactionHistory() { @@ -359,7 +359,7 @@ private APIagencyCommissionsHistoryRequest() { /** * Set currency - * @param currency Filter by currency. Return all currency records if not specified (optional) + * @param currency Filter by currency. Return all currency records if not specified. (optional) * @return APIagencyCommissionsHistoryRequest */ public APIagencyCommissionsHistoryRequest currency(String currency) { @@ -369,7 +369,7 @@ public APIagencyCommissionsHistoryRequest currency(String currency) { /** * Set userId - * @param userId User ID. If not specified, all user records will be returned (optional) + * @param userId User ID. If not specified, all user records will be returned. (optional) * @return APIagencyCommissionsHistoryRequest */ public APIagencyCommissionsHistoryRequest userId(Long userId) { @@ -379,7 +379,7 @@ public APIagencyCommissionsHistoryRequest userId(Long userId) { /** * Set from - * @param from Time range beginning, default to 7 days before current time (optional) + * @param from Time range beginning, default to 7 days before current time. (optional) * @return APIagencyCommissionsHistoryRequest */ public APIagencyCommissionsHistoryRequest from(Long from) { @@ -389,7 +389,7 @@ public APIagencyCommissionsHistoryRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to Time range ending, default to current time. (optional) * @return APIagencyCommissionsHistoryRequest */ public APIagencyCommissionsHistoryRequest to(Long to) { @@ -399,7 +399,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 to be returned in a single list. (optional, default to 100) * @return APIagencyCommissionsHistoryRequest */ public APIagencyCommissionsHistoryRequest limit(Integer limit) { @@ -409,7 +409,7 @@ public APIagencyCommissionsHistoryRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIagencyCommissionsHistoryRequest */ public APIagencyCommissionsHistoryRequest offset(Integer offset) { @@ -425,7 +425,7 @@ public APIagencyCommissionsHistoryRequest offset(Integer offset) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -439,7 +439,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public List execute() throws ApiException { @@ -454,7 +454,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -469,7 +469,7 @@ public ApiResponse> executeWithHttpInfo() throws A * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -478,13 +478,13 @@ public okhttp3.Call executeAsync(final ApiCallback } /** - * The agency obtains the commission history of the recommended user - * Record time range cannot exceed 30 days + * The agency obtains the commission history of the recommended user. + * Record time range cannot exceed 30 days. * @return APIagencyCommissionsHistoryRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIagencyCommissionsHistoryRequest agencyCommissionsHistory() { @@ -577,7 +577,7 @@ private APIpartnerTransactionHistoryRequest() { /** * Set currencyPair - * @param currencyPair Specify the currency pair, if not specified, return all currency pairs (optional) + * @param currencyPair Specify the currency pair, if not specified, return all currency pairs. (optional) * @return APIpartnerTransactionHistoryRequest */ public APIpartnerTransactionHistoryRequest currencyPair(String currencyPair) { @@ -587,7 +587,7 @@ public APIpartnerTransactionHistoryRequest currencyPair(String currencyPair) { /** * Set userId - * @param userId User ID. If not specified, all user records will be returned (optional) + * @param userId User ID. If not specified, all user records will be returned. (optional) * @return APIpartnerTransactionHistoryRequest */ public APIpartnerTransactionHistoryRequest userId(Long userId) { @@ -597,7 +597,7 @@ public APIpartnerTransactionHistoryRequest userId(Long userId) { /** * Set from - * @param from Time range beginning, default to 7 days before current time (optional) + * @param from Time range beginning, default to 7 days before current time. (optional) * @return APIpartnerTransactionHistoryRequest */ public APIpartnerTransactionHistoryRequest from(Long from) { @@ -607,7 +607,7 @@ public APIpartnerTransactionHistoryRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to Time range ending, default to current time. (optional) * @return APIpartnerTransactionHistoryRequest */ public APIpartnerTransactionHistoryRequest to(Long to) { @@ -617,7 +617,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 to be returned in a single list. (optional, default to 100) * @return APIpartnerTransactionHistoryRequest */ public APIpartnerTransactionHistoryRequest limit(Integer limit) { @@ -627,7 +627,7 @@ public APIpartnerTransactionHistoryRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIpartnerTransactionHistoryRequest */ public APIpartnerTransactionHistoryRequest offset(Integer offset) { @@ -643,7 +643,7 @@ public APIpartnerTransactionHistoryRequest offset(Integer offset) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -657,7 +657,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public PartnerTransactionHistory execute() throws ApiException { @@ -672,7 +672,7 @@ public PartnerTransactionHistory execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -687,7 +687,7 @@ public ApiResponse executeWithHttpInfo() throws ApiEx * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -696,13 +696,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 records of recommended users. + * Record time range cannot exceed 30 days. * @return APIpartnerTransactionHistoryRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIpartnerTransactionHistoryRequest partnerTransactionHistory() { @@ -795,7 +795,7 @@ private APIpartnerCommissionsHistoryRequest() { /** * Set currency - * @param currency Filter by currency. Return all currency records if not specified (optional) + * @param currency Filter by currency. Return all currency records if not specified. (optional) * @return APIpartnerCommissionsHistoryRequest */ public APIpartnerCommissionsHistoryRequest currency(String currency) { @@ -805,7 +805,7 @@ public APIpartnerCommissionsHistoryRequest currency(String currency) { /** * Set userId - * @param userId User ID. If not specified, all user records will be returned (optional) + * @param userId User ID. If not specified, all user records will be returned. (optional) * @return APIpartnerCommissionsHistoryRequest */ public APIpartnerCommissionsHistoryRequest userId(Long userId) { @@ -815,7 +815,7 @@ public APIpartnerCommissionsHistoryRequest userId(Long userId) { /** * Set from - * @param from Time range beginning, default to 7 days before current time (optional) + * @param from Time range beginning, default to 7 days before current time. (optional) * @return APIpartnerCommissionsHistoryRequest */ public APIpartnerCommissionsHistoryRequest from(Long from) { @@ -825,7 +825,7 @@ public APIpartnerCommissionsHistoryRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to Time range ending, default to current time. (optional) * @return APIpartnerCommissionsHistoryRequest */ public APIpartnerCommissionsHistoryRequest to(Long to) { @@ -835,7 +835,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 to be returned in a single list. (optional, default to 100) * @return APIpartnerCommissionsHistoryRequest */ public APIpartnerCommissionsHistoryRequest limit(Integer limit) { @@ -845,7 +845,7 @@ public APIpartnerCommissionsHistoryRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIpartnerCommissionsHistoryRequest */ public APIpartnerCommissionsHistoryRequest offset(Integer offset) { @@ -861,7 +861,7 @@ public APIpartnerCommissionsHistoryRequest offset(Integer offset) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -875,7 +875,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public PartnerCommissionHistory execute() throws ApiException { @@ -890,7 +890,7 @@ public PartnerCommissionHistory execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -905,7 +905,7 @@ public ApiResponse executeWithHttpInfo() throws ApiExc * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -914,13 +914,13 @@ public okhttp3.Call executeAsync(final ApiCallback _ca } /** - * Partner obtains commission records of recommended users - * Record time range cannot exceed 30 days + * Partner obtains commission records of recommended users. + * Record time range cannot exceed 30 days. * @return APIpartnerCommissionsHistoryRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIpartnerCommissionsHistoryRequest partnerCommissionsHistory() { @@ -998,7 +998,7 @@ private APIpartnerSubListRequest() { /** * Set userId - * @param userId User ID. If not specified, all user records will be returned (optional) + * @param userId User ID. If not specified, all user records will be returned. (optional) * @return APIpartnerSubListRequest */ public APIpartnerSubListRequest userId(Long userId) { @@ -1008,7 +1008,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 to be returned in a single list. (optional, default to 100) * @return APIpartnerSubListRequest */ public APIpartnerSubListRequest limit(Integer limit) { @@ -1018,7 +1018,7 @@ public APIpartnerSubListRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIpartnerSubListRequest */ public APIpartnerSubListRequest offset(Integer offset) { @@ -1034,7 +1034,7 @@ public APIpartnerSubListRequest offset(Integer offset) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1048,7 +1048,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public PartnerSubList execute() throws ApiException { @@ -1063,7 +1063,7 @@ public PartnerSubList execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -1078,7 +1078,7 @@ public ApiResponse executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -1087,13 +1087,13 @@ public okhttp3.Call executeAsync(final ApiCallback _callback) th } /** - * Partner subordinate list - * Including sub-agents, direct customers, indirect customers + * Partner subordinate list. + * Including sub-agents, direct customers, indirect customers. * @return APIpartnerSubListRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIpartnerSubListRequest partnerSubList() { @@ -1181,7 +1181,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 to be returned in a single list. (optional, default to 100) * @return APIrebateBrokerCommissionHistoryRequest */ public APIrebateBrokerCommissionHistoryRequest limit(Integer limit) { @@ -1191,7 +1191,7 @@ public APIrebateBrokerCommissionHistoryRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIrebateBrokerCommissionHistoryRequest */ public APIrebateBrokerCommissionHistoryRequest offset(Integer offset) { @@ -1201,7 +1201,7 @@ public APIrebateBrokerCommissionHistoryRequest offset(Integer offset) { /** * Set userId - * @param userId User ID. If not specified, all user records will be returned (optional) + * @param userId User ID. If not specified, all user records will be returned. (optional) * @return APIrebateBrokerCommissionHistoryRequest */ public APIrebateBrokerCommissionHistoryRequest userId(Long userId) { @@ -1221,7 +1221,7 @@ public APIrebateBrokerCommissionHistoryRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to Time range ending, default to current time. (optional) * @return APIrebateBrokerCommissionHistoryRequest */ public APIrebateBrokerCommissionHistoryRequest to(Long to) { @@ -1237,7 +1237,7 @@ public APIrebateBrokerCommissionHistoryRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1251,7 +1251,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public List execute() throws ApiException { @@ -1266,7 +1266,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1281,7 +1281,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcep * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1290,13 +1290,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _call } /** - * The broker obtains the user's commission rebate records - * Record time range cannot exceed 30 days + * The broker obtains the user's commission rebate records. + * Record time range cannot exceed 30 days. * @return APIrebateBrokerCommissionHistoryRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIrebateBrokerCommissionHistoryRequest rebateBrokerCommissionHistory() { @@ -1384,7 +1384,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 to be returned in a single list. (optional, default to 100) * @return APIrebateBrokerTransactionHistoryRequest */ public APIrebateBrokerTransactionHistoryRequest limit(Integer limit) { @@ -1394,7 +1394,7 @@ public APIrebateBrokerTransactionHistoryRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIrebateBrokerTransactionHistoryRequest */ public APIrebateBrokerTransactionHistoryRequest offset(Integer offset) { @@ -1404,7 +1404,7 @@ public APIrebateBrokerTransactionHistoryRequest offset(Integer offset) { /** * Set userId - * @param userId User ID. If not specified, all user records will be returned (optional) + * @param userId User ID. If not specified, all user records will be returned. (optional) * @return APIrebateBrokerTransactionHistoryRequest */ public APIrebateBrokerTransactionHistoryRequest userId(Long userId) { @@ -1424,7 +1424,7 @@ public APIrebateBrokerTransactionHistoryRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to Time range ending, default to current time. (optional) * @return APIrebateBrokerTransactionHistoryRequest */ public APIrebateBrokerTransactionHistoryRequest to(Long to) { @@ -1440,7 +1440,7 @@ public APIrebateBrokerTransactionHistoryRequest to(Long to) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1454,7 +1454,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public List execute() throws ApiException { @@ -1469,7 +1469,7 @@ public List execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1484,7 +1484,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExce * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1493,13 +1493,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _cal } /** - * The broker obtains the user's trading history - * Record time range cannot exceed 30 days + * The broker obtains the user's trading history. + * Record time range cannot exceed 30 days. * @return APIrebateBrokerTransactionHistoryRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIrebateBrokerTransactionHistoryRequest rebateBrokerTransactionHistory() { @@ -1514,7 +1514,7 @@ public APIrebateBrokerTransactionHistoryRequest rebateBrokerTransactionHistory() * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call rebateUserInfoCall(final ApiCallback _callback) throws ApiException { @@ -1553,14 +1553,14 @@ private okhttp3.Call rebateUserInfoValidateBeforeCall(final ApiCallback _callbac } /** - * User retrieves rebate information + * User retrieves 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 Successfully retrieved. -
*/ public List rebateUserInfo() throws ApiException { @@ -1569,14 +1569,14 @@ public List rebateUserInfo() throws ApiException { } /** - * User retrieves rebate information + * User retrieves 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 Successfully retrieved. -
*/ public ApiResponse> rebateUserInfoWithHttpInfo() throws ApiException { @@ -1586,7 +1586,7 @@ public ApiResponse> rebateUserInfoWithHttpInfo() throws Api } /** - * User retrieves rebate information (asynchronously) + * User retrieves rebate information. (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1594,7 +1594,7 @@ public ApiResponse> rebateUserInfoWithHttpInfo() throws Api * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call rebateUserInfoAsync(final ApiCallback> _callback) throws ApiException { @@ -1606,14 +1606,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 the user's ID list, split by,, if there are more than 100, take 100. (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. -
*/ public okhttp3.Call userSubRelationCall(String userIdList, final ApiCallback _callback) throws ApiException { @@ -1661,15 +1661,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 in the system. + * @param userIdList Query the user's ID list, split by,, if there are more than 100, take 100. (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. -
*/ public UserSubRelation userSubRelation(String userIdList) throws ApiException { @@ -1678,15 +1678,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 in the system. + * @param userIdList Query the user's ID list, split by,, if there are more than 100, take 100. (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. -
*/ public ApiResponse userSubRelationWithHttpInfo(String userIdList) throws ApiException { @@ -1696,16 +1696,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 in the system. + * @param userIdList Query the user's ID list, split by,, if there are more than 100, take 100. (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. -
*/ 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 ff1d2f2..a9a50f0 100644 --- a/src/main/java/io/gate/gateapi/api/SpotApi.java +++ b/src/main/java/io/gate/gateapi/api/SpotApi.java @@ -77,7 +77,7 @@ public void setApiClient(ApiClient apiClient) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call listCurrenciesCall(final ApiCallback _callback) throws ApiException { @@ -116,14 +116,14 @@ private okhttp3.Call listCurrenciesValidateBeforeCall(final ApiCallback _callbac } /** - * List all currencies' details + * 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. * @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. -
*/ public List listCurrencies() throws ApiException { @@ -132,14 +132,14 @@ public List listCurrencies() throws ApiException { } /** - * List all currencies' details + * 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. * @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. -
*/ public ApiResponse> listCurrenciesWithHttpInfo() throws ApiException { @@ -149,7 +149,7 @@ public ApiResponse> listCurrenciesWithHttpInfo() throws ApiExcept } /** - * List all currencies' details (asynchronously) + * 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. * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -157,7 +157,7 @@ public ApiResponse> listCurrenciesWithHttpInfo() throws ApiExcept * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public okhttp3.Call listCurrenciesAsync(final ApiCallback> _callback) throws ApiException { @@ -169,14 +169,14 @@ public okhttp3.Call listCurrenciesAsync(final ApiCallback> _callb /** * Build call for getCurrency - * @param currency Currency name (required) + * @param currency 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 Successfully retrieved. -
*/ public okhttp3.Call getCurrencyCall(String currency, final ApiCallback _callback) throws ApiException { @@ -221,15 +221,15 @@ private okhttp3.Call getCurrencyValidateBeforeCall(String currency, final ApiCal } /** - * Get details of a specific currency + * Get details of a specific currency. * - * @param currency Currency name (required) + * @param currency Currency name. (required) * @return 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 Successfully retrieved -
200 Successfully retrieved. -
*/ public Currency getCurrency(String currency) throws ApiException { @@ -238,15 +238,15 @@ public Currency getCurrency(String currency) throws ApiException { } /** - * Get details of a specific currency + * Get details of a specific currency. * - * @param currency Currency name (required) + * @param currency Currency name. (required) * @return ApiResponse<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 Successfully retrieved -
200 Successfully retrieved. -
*/ public ApiResponse getCurrencyWithHttpInfo(String currency) throws ApiException { @@ -256,16 +256,16 @@ public ApiResponse getCurrencyWithHttpInfo(String currency) throws Api } /** - * Get details of a specific currency (asynchronously) + * Get details of a specific currency. (asynchronously) * - * @param currency Currency name (required) + * @param currency 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 Successfully retrieved. -
*/ public okhttp3.Call getCurrencyAsync(String currency, final ApiCallback _callback) throws ApiException { @@ -283,7 +283,7 @@ public okhttp3.Call getCurrencyAsync(String currency, final ApiCallback Status Code Description Response Headers - 200 All currency pairs retrieved - + 200 All currency pairs retrieved. - */ public okhttp3.Call listCurrencyPairsCall(final ApiCallback _callback) throws ApiException { @@ -322,14 +322,14 @@ private okhttp3.Call listCurrencyPairsValidateBeforeCall(final ApiCallback _call } /** - * List all currency pairs supported + * List all currency pairs supported. * * @return List<CurrencyPair> * @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 currency pairs retrieved -
200 All currency pairs retrieved. -
*/ public List listCurrencyPairs() throws ApiException { @@ -338,14 +338,14 @@ public List listCurrencyPairs() throws ApiException { } /** - * List all currency pairs supported + * List all currency pairs supported. * * @return ApiResponse<List<CurrencyPair>> * @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 currency pairs retrieved -
200 All currency pairs retrieved. -
*/ public ApiResponse> listCurrencyPairsWithHttpInfo() throws ApiException { @@ -355,7 +355,7 @@ public ApiResponse> listCurrencyPairsWithHttpInfo() throws Ap } /** - * List all currency pairs supported (asynchronously) + * List all currency pairs supported. (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -363,7 +363,7 @@ public ApiResponse> listCurrencyPairsWithHttpInfo() throws Ap * @http.response.details - +
Status Code Description Response Headers
200 All currency pairs retrieved -
200 All currency pairs retrieved. -
*/ public okhttp3.Call listCurrencyPairsAsync(final ApiCallback> _callback) throws ApiException { @@ -375,14 +375,14 @@ public okhttp3.Call listCurrencyPairsAsync(final ApiCallback> /** * Build call for getCurrencyPair - * @param currencyPair Currency pair (required) + * @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 Successfully retrieved. -
*/ public okhttp3.Call getCurrencyPairCall(String currencyPair, final ApiCallback _callback) throws ApiException { @@ -427,15 +427,15 @@ private okhttp3.Call getCurrencyPairValidateBeforeCall(String currencyPair, fina } /** - * Get details of a specifc currency pair + * Get details of a specifc currency pair. * - * @param currencyPair Currency pair (required) + * @param currencyPair Currency pair. (required) * @return CurrencyPair * @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 Successfully retrieved. -
*/ public CurrencyPair getCurrencyPair(String currencyPair) throws ApiException { @@ -444,15 +444,15 @@ public CurrencyPair getCurrencyPair(String currencyPair) throws ApiException { } /** - * Get details of a specifc currency pair + * Get details of a specifc currency pair. * - * @param currencyPair Currency pair (required) + * @param currencyPair Currency pair. (required) * @return ApiResponse<CurrencyPair> * @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 Successfully retrieved. -
*/ public ApiResponse getCurrencyPairWithHttpInfo(String currencyPair) throws ApiException { @@ -462,16 +462,16 @@ public ApiResponse getCurrencyPairWithHttpInfo(String currencyPair } /** - * Get details of a specifc currency pair (asynchronously) + * Get details of a specifc currency pair. (asynchronously) * - * @param currencyPair Currency pair (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 Successfully retrieved. -
*/ public okhttp3.Call getCurrencyPairAsync(String currencyPair, final ApiCallback _callback) throws ApiException { @@ -547,7 +547,7 @@ private APIlistTickersRequest() { /** * Set currencyPair - * @param currencyPair Currency pair (optional) + * @param currencyPair Currency pair. (optional) * @return APIlistTickersRequest */ public APIlistTickersRequest currencyPair(String currencyPair) { @@ -557,7 +557,7 @@ public APIlistTickersRequest currencyPair(String currencyPair) { /** * Set timezone - * @param timezone Timezone (optional) + * @param timezone Timezone. (optional) * @return APIlistTickersRequest */ public APIlistTickersRequest timezone(String timezone) { @@ -573,7 +573,7 @@ public APIlistTickersRequest timezone(String timezone) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -626,13 +626,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) thro } /** - * Retrieve ticker information + * Retrieve ticker information. * Return only related data if `currency_pair` is specified; otherwise return all of them * @return APIlistTickersRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ 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 Order depth. 0 means no aggregation is applied. default to 0. (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 Maximum number of order depth data in asks or bids. (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 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -810,14 +810,14 @@ public okhttp3.Call executeAsync(final ApiCallback _callback) throws } /** - * Retrieve order book - * Market depth buy orders are sorted by price from high to low, sell orders are reversed are reversed - * @param currencyPair Currency pair (required) + * Retrieve order book. + * Market depth buy orders are sorted by price from high to low, sell orders are reversed + * @param currencyPair Currency pair. (required) * @return APIlistOrderBookRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ 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 records to be returned in a single list. Default: 100, Minimum: 1, Maximum: 1000 (optional, default to 100) * @return APIlistTradesRequest */ public APIlistTradesRequest limit(Integer limit) { @@ -951,7 +951,7 @@ public APIlistTradesRequest reverse(Boolean reverse) { /** * Set from - * @param from Start timestamp of the query (optional) + * @param from Start timestamp of 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 Time range ending, default to current time. (optional) * @return APIlistTradesRequest */ public APIlistTradesRequest to(Long to) { @@ -971,7 +971,7 @@ public APIlistTradesRequest to(Long to) { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistTradesRequest */ public APIlistTradesRequest page(Integer page) { @@ -987,7 +987,7 @@ public APIlistTradesRequest page(Integer page) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ 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. - * @param currencyPair Currency pair (required) + * Retrieve market trades. + * Supports `from` and `to` by time range query or page-turn query based on `last_id`. By default, is the last 30 days. The query method based on `last_id` page turn is no longer recommended. If `last_id` is specified, the time range query parameters will be ignored. The maximum number of pages when searching data using limit&page paging function is 100,0, that is, limit * (page - 1) <= 100,0. + * @param currencyPair Currency pair. (required) * @return APIlistTradesRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistTradesRequest listTrades(String currencyPair) { @@ -1161,7 +1161,7 @@ public APIlistCandlesticksRequest from(Long from) { /** * Set to - * @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 (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 specified (optional) * @return APIlistCandlesticksRequest */ public APIlistCandlesticksRequest to(Long to) { @@ -1187,7 +1187,7 @@ public APIlistCandlesticksRequest interval(String interval) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback>> _callback) throws ApiException { @@ -1240,14 +1240,14 @@ public okhttp3.Call executeAsync(final ApiCallback>> _callback } /** - * Market candlesticks + * Market candlesticks. * 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) + * @param currencyPair Currency pair. (required) * @return APIlistCandlesticksRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public APIlistCandlesticksRequest listCandlesticks(String currencyPair) { @@ -1332,7 +1332,7 @@ public APIgetFeeRequest currencyPair(String currencyPair) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
* @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 Successfully retrieved. -
* @deprecated */ @@ -1365,7 +1365,7 @@ public SpotFee execute() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
* @deprecated */ @@ -1382,7 +1382,7 @@ public ApiResponse executeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
* @deprecated */ @@ -1393,13 +1393,13 @@ public okhttp3.Call executeAsync(final ApiCallback _callback) throws Ap } /** - * Query user trading fee rates + * Query user trading fee rates. * This API is deprecated in favour of new fee retrieving API `/wallet/fee`. * @return APIgetFeeRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
* @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 A request can only query up to 50 currency pairs. (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 Successfully retrieved. -
*/ 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 + * Query a batch of user trading fee rates. * - * @param currencyPairs A request can only query up to 50 currency pairs (required) + * @param currencyPairs A request can only query up to 50 currency pairs. (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 Successfully retrieved. -
*/ 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 + * Query a batch of user trading fee rates. * - * @param currencyPairs A request can only query up to 50 currency pairs (required) + * @param currencyPairs A request can only query up to 50 currency pairs. (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 Successfully retrieved. -
*/ 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) + * Query a batch of user trading fee rates. (asynchronously) * - * @param currencyPairs A request can only query up to 50 currency pairs (required) + * @param currencyPairs A request can only query up to 50 currency pairs. (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 Successfully retrieved. -
*/ 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 Retrieve data of the specified currency. (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. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ 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 accounts. * * @return APIlistSpotAccountsRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistSpotAccountsRequest listSpotAccounts() { @@ -1753,7 +1753,7 @@ private APIlistSpotAccountBookRequest() { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Retrieve data of the specified currency. (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 of 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 Time range ending, default to current time. (optional) * @return APIlistSpotAccountBookRequest */ public APIlistSpotAccountBookRequest to(Long to) { @@ -1783,7 +1783,7 @@ public APIlistSpotAccountBookRequest to(Long to) { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistSpotAccountBookRequest */ public APIlistSpotAccountBookRequest page(Integer page) { @@ -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 to be returned in a single list. (optional, default to 100) * @return APIlistSpotAccountBookRequest */ public APIlistSpotAccountBookRequest limit(Integer limit) { @@ -1829,7 +1829,7 @@ public APIlistSpotAccountBookRequest code(String code) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ 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 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,0, that is, limit * (page - 1) <= 100,0. * @return APIlistSpotAccountBookRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistSpotAccountBookRequest listSpotAccountBook() { @@ -1905,7 +1905,7 @@ public APIlistSpotAccountBookRequest listSpotAccountBook() { * @http.response.details - +
Status Code Description Response Headers
200 Request is completed -
200 Request is completed. -
*/ public okhttp3.Call createBatchOrdersCall(List order, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -1953,7 +1953,7 @@ private okhttp3.Call createBatchOrdersValidateBeforeCall(List order, Stri } /** - * Create a batch of orders + * 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 * @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) @@ -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 is completed. -
*/ public List createBatchOrders(List order, String xGateExptime) throws ApiException { @@ -1971,7 +1971,7 @@ public List createBatchOrders(List order, String xGateExptime } /** - * Create a batch of orders + * 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 * @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) @@ -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 is completed. -
*/ public ApiResponse> createBatchOrdersWithHttpInfo(List order, String xGateExptime) throws ApiException { @@ -1990,7 +1990,7 @@ public ApiResponse> createBatchOrdersWithHttpInfo(List o } /** - * Create a batch of orders (asynchronously) + * 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 * @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) @@ -2000,7 +2000,7 @@ public ApiResponse> createBatchOrdersWithHttpInfo(List o * @http.response.details - +
Status Code Description Response Headers
200 Request is completed -
200 Request is completed. -
*/ public okhttp3.Call createBatchOrdersAsync(List order, String xGateExptime, final ApiCallback> _callback) throws ApiException { @@ -2081,7 +2081,7 @@ private APIlistAllOpenOrdersRequest() { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistAllOpenOrdersRequest */ public APIlistAllOpenOrdersRequest page(Integer page) { @@ -2091,7 +2091,7 @@ public APIlistAllOpenOrdersRequest page(Integer page) { /** * Set limit - * @param limit Maximum number of records returned in one page in each currency pair (optional, default to 100) + * @param limit Maximum number of records returned in one page in each currency pair. (optional, default to 100) * @return APIlistAllOpenOrdersRequest */ public APIlistAllOpenOrdersRequest limit(Integer limit) { @@ -2117,7 +2117,7 @@ public APIlistAllOpenOrdersRequest account(String account) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2170,13 +2170,13 @@ 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. + * List all open orders. + * Query the current order list of all trading pairs. Please note that the paging parameter controls the number of pending orders in each trading pair. There is no paging control trading pairs. All trading pairs with pending orders will be returned. * @return APIlistAllOpenOrdersRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ public APIlistAllOpenOrdersRequest listAllOpenOrders() { @@ -2192,7 +2192,7 @@ public APIlistAllOpenOrdersRequest listAllOpenOrders() { * @http.response.details - +
Status Code Description Response Headers
201 order created -
201 order created. -
*/ public okhttp3.Call createCrossLiquidateOrderCall(LiquidateOrder liquidateOrder, final ApiCallback _callback) throws ApiException { @@ -2236,7 +2236,7 @@ private okhttp3.Call createCrossLiquidateOrderValidateBeforeCall(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 * @param liquidateOrder (required) * @return Order @@ -2244,7 +2244,7 @@ private okhttp3.Call createCrossLiquidateOrderValidateBeforeCall(LiquidateOrder * @http.response.details - +
Status Code Description Response Headers
201 order created -
201 order created. -
*/ public Order createCrossLiquidateOrder(LiquidateOrder liquidateOrder) throws ApiException { @@ -2253,7 +2253,7 @@ public Order createCrossLiquidateOrder(LiquidateOrder liquidateOrder) throws Api } /** - * 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 * @param liquidateOrder (required) * @return ApiResponse<Order> @@ -2261,7 +2261,7 @@ public Order createCrossLiquidateOrder(LiquidateOrder liquidateOrder) throws Api * @http.response.details - +
Status Code Description Response Headers
201 order created -
201 order created. -
*/ public ApiResponse createCrossLiquidateOrderWithHttpInfo(LiquidateOrder liquidateOrder) throws ApiException { @@ -2271,7 +2271,7 @@ public ApiResponse createCrossLiquidateOrderWithHttpInfo(LiquidateOrder l } /** - * close position when cross-currency is disabled (asynchronously) + * 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 * @param liquidateOrder (required) * @param _callback The callback to be executed when the API call finishes @@ -2280,7 +2280,7 @@ public ApiResponse createCrossLiquidateOrderWithHttpInfo(LiquidateOrder l * @http.response.details - +
Status Code Description Response Headers
201 order created -
201 order created. -
*/ public okhttp3.Call createCrossLiquidateOrderAsync(LiquidateOrder liquidateOrder, final ApiCallback _callback) throws ApiException { @@ -2398,7 +2398,7 @@ private APIlistOrdersRequest(String currencyPair, String status) { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistOrdersRequest */ public APIlistOrdersRequest page(Integer page) { @@ -2428,7 +2428,7 @@ public APIlistOrdersRequest account(String account) { /** * Set from - * @param from Start timestamp of the query (optional) + * @param from Start timestamp of 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 Time range ending, default to current time. (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 All bids or 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. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2517,15 +2517,15 @@ 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. + * List orders. + * Note that the query results are spot order lists for spot, unified account and warehouse-by-site leverage accounts by default. `status` is set to `open`, that is, when querying the pending order list, only pagination control of `page` and `limit` is supported. `limit` Maximum setting is only allowed to 100 . The `side` and `from`, `to` parameters for time range query are not supported. `status` when querying historical delegations, in addition to pagination queries, `from` and `to` are also supported by time range queries. In addition, it supports setting the `side` parameter to filter one-side history. The parameters of the time range filtering are processed according to the order end time. * @param currencyPair Retrieve results with specified currency pair. It is required for open orders, but optional for finished ones. (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. -
*/ public APIlistOrdersRequest listOrders(String currencyPair, String status) { @@ -2590,8 +2590,8 @@ 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 + * Create an order. + * Support spot, margin, leverage, and full-position leverage orders. Use different accounts through the `account` field, default is `spot`, that is, use the spot account to place an order if the user is `unified` account, default is to place an order with a unified account When using leveraged account trading, that is, when `account` is set to `margin`, you can set `auto_borrow` to `true`, In the case of insufficient account balance, the system will automatically execute the `POST /margin/uni/loans` to borrow the insufficient part. Whether the assets obtained after the leveraged order is automatically used to return the borrowing orders of the leveraged account in a position-by-store leverage account depends on the automatic repayment settings of the user's position-by-store leverage account**, The account automatic repayment settings can be queried and set through `/margin/auto_repay`. Use unified is set to `unified`, `auto_borrow` \" can also be enableTo realize the insufficient part of automatic borrowing, but unlike the leverage account, whether the entrustment of a unified account is automatically repayable depends on the when placing an order`auto_repay` setting, this setting is only effective for the current entrustment, that is, only the assets obtained after the entrustment transaction will be used to repay the borrowing orders of the full-position leverage account. Unified account ordering currently supports `auto_borrow` and `auto_repay` at the same time. Auto repayment will be triggered at the end of the order, i.e. `status` is `cancelled` or `closed` . **Delegation Status** The entrustment status in the pending order is `open`, which remains at `open` until all the quantity is traded. If it is eaten, the order ends and the status becomes `closed`. If the order is cancelled before all transactions are completed, regardless of whether there are partial transactions, the status will become `cancelled` **Iceberg Entrustment** `iceberg` is used to set the number of iceberg delegations displayed, and does not support complete hiding. Note that when hidden part of the transaction is charged according to the taker's handling rate. **Restrict user transactions** Set `stp_act` to decide to use strategies that limit user transactions * @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 @@ -2608,8 +2608,8 @@ 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 + * Create an order. + * Support spot, margin, leverage, and full-position leverage orders. Use different accounts through the `account` field, default is `spot`, that is, use the spot account to place an order if the user is `unified` account, default is to place an order with a unified account When using leveraged account trading, that is, when `account` is set to `margin`, you can set `auto_borrow` to `true`, In the case of insufficient account balance, the system will automatically execute the `POST /margin/uni/loans` to borrow the insufficient part. Whether the assets obtained after the leveraged order is automatically used to return the borrowing orders of the leveraged account in a position-by-store leverage account depends on the automatic repayment settings of the user's position-by-store leverage account**, The account automatic repayment settings can be queried and set through `/margin/auto_repay`. Use unified is set to `unified`, `auto_borrow` \" can also be enableTo realize the insufficient part of automatic borrowing, but unlike the leverage account, whether the entrustment of a unified account is automatically repayable depends on the when placing an order`auto_repay` setting, this setting is only effective for the current entrustment, that is, only the assets obtained after the entrustment transaction will be used to repay the borrowing orders of the full-position leverage account. Unified account ordering currently supports `auto_borrow` and `auto_repay` at the same time. Auto repayment will be triggered at the end of the order, i.e. `status` is `cancelled` or `closed` . **Delegation Status** The entrustment status in the pending order is `open`, which remains at `open` until all the quantity is traded. If it is eaten, the order ends and the status becomes `closed`. If the order is cancelled before all transactions are completed, regardless of whether there are partial transactions, the status will become `cancelled` **Iceberg Entrustment** `iceberg` is used to set the number of iceberg delegations displayed, and does not support complete hiding. Note that when hidden part of the transaction is charged according to the taker's handling rate. **Restrict user transactions** Set `stp_act` to decide to use strategies that limit user transactions * @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> @@ -2627,8 +2627,8 @@ 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 + * 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 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 * @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 @@ -2649,8 +2649,8 @@ 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 currencyPair Currency pair. (optional) + * @param side All bids or 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) @@ -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. Query order status by listing orders. -
*/ public okhttp3.Call cancelOrdersCall(String currencyPair, String side, String account, String actionMode, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -2719,10 +2719,10 @@ 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 - * @param currencyPair Currency pair (optional) - * @param side All bids or asks. Both included if not specified (optional) + * Cancel all `open` orders in specified currency pair. + * When the `account` parameter is not specified, all pending orders including spot, unified account, and position-by-position leverage will be cancelled. When transaction pairs are revoked You can specify a certain account separately to cancel all orders under the specified account + * @param currencyPair Currency pair. (optional) + * @param side All bids or 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) @@ -2731,7 +2731,7 @@ private okhttp3.Call cancelOrdersValidateBeforeCall(String currencyPair, String * @http.response.details - +
Status Code Description Response Headers
200 Batch cancellation request accepted. Query order status by listing orders -
200 Batch cancellation request accepted. Query order status by listing orders. -
*/ public List cancelOrders(String currencyPair, String side, String account, String actionMode, String xGateExptime) throws ApiException { @@ -2740,10 +2740,10 @@ 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 - * @param currencyPair Currency pair (optional) - * @param side All bids or asks. Both included if not specified (optional) + * Cancel all `open` orders in specified currency pair. + * When the `account` parameter is not specified, all pending orders including spot, unified account, and position-by-position leverage will be cancelled. When transaction pairs are revoked You can specify a certain account separately to cancel all orders under the specified account + * @param currencyPair Currency pair. (optional) + * @param side All bids or 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) @@ -2752,7 +2752,7 @@ public List cancelOrders(String currencyPair, String side, String a * @http.response.details - +
Status Code Description Response Headers
200 Batch cancellation request accepted. Query order status by listing orders -
200 Batch cancellation request accepted. Query order status by listing orders. -
*/ public ApiResponse> cancelOrdersWithHttpInfo(String currencyPair, String side, String account, String actionMode, String xGateExptime) throws ApiException { @@ -2762,10 +2762,10 @@ 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 - * @param currencyPair Currency pair (optional) - * @param side All bids or asks. Both included if not specified (optional) + * 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 transaction pairs are revoked You can specify a certain account separately to cancel all orders under the specified 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: 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) @@ -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. Query order status by listing orders. -
*/ public okhttp3.Call cancelOrdersAsync(String currencyPair, String side, String account, String actionMode, String xGateExptime, final ApiCallback> _callback) throws ApiException { @@ -2795,7 +2795,7 @@ public okhttp3.Call cancelOrdersAsync(String currencyPair, String side, String a * @http.response.details - +
Status Code Description Response Headers
200 Batch cancellation completed -
200 Batch cancellation completed. -
*/ public okhttp3.Call cancelBatchOrdersCall(List cancelBatchOrder, 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 a batch of orders with an 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) @@ -2852,7 +2852,7 @@ private okhttp3.Call cancelBatchOrdersValidateBeforeCall(List * @http.response.details - +
Status Code Description Response Headers
200 Batch cancellation completed -
200 Batch cancellation completed. -
*/ public List cancelBatchOrders(List cancelBatchOrder, String xGateExptime) throws ApiException { @@ -2861,7 +2861,7 @@ public List cancelBatchOrders(List cancelBa } /** - * Cancel a batch of orders with an ID list + * Cancel a batch of orders with an 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) @@ -2870,7 +2870,7 @@ public List cancelBatchOrders(List cancelBa * @http.response.details - +
Status Code Description Response Headers
200 Batch cancellation completed -
200 Batch cancellation completed. -
*/ public ApiResponse> cancelBatchOrdersWithHttpInfo(List cancelBatchOrder, String xGateExptime) throws ApiException { @@ -2880,7 +2880,7 @@ public ApiResponse> cancelBatchOrdersWithHttpInfo(List> cancelBatchOrdersWithHttpInfo(List Status Code Description Response Headers - 200 Batch cancellation completed - + 200 Batch cancellation completed. - */ public okhttp3.Call cancelBatchOrdersAsync(List cancelBatchOrder, String xGateExptime, final ApiCallback> _callback) throws ApiException { @@ -2903,7 +2903,7 @@ public okhttp3.Call cancelBatchOrdersAsync(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 currencyPair Specify the transaction pair to query. If you are querying pending order records, this field is traded records, this field can be left blank. (required) * @param account Specify query account. (optional) * @param _callback Callback for upload/download progress * @return Call to execute @@ -2911,7 +2911,7 @@ public okhttp3.Call cancelBatchOrdersAsync(List cancelBatchOrd * @http.response.details - +
Status Code Description Response Headers
200 Detail retrieved -
200 Detail retrieved. -
*/ public okhttp3.Call getOrderCall(String orderId, String currencyPair, String account, final ApiCallback _callback) throws ApiException { @@ -2969,17 +2969,17 @@ private okhttp3.Call getOrderValidateBeforeCall(String orderId, String currencyP } /** - * Get a single order + * Get a single order. * By default, orders for spot, unified account and warehouse-by-site leverage account are checked. * @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 currencyPair Specify the transaction pair to query. If you are querying pending order records, this field is traded records, this field can be left blank. (required) * @param 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 - +
Status Code Description Response Headers
200 Detail retrieved -
200 Detail retrieved. -
*/ public Order getOrder(String orderId, String currencyPair, String account) throws ApiException { @@ -2988,17 +2988,17 @@ public Order getOrder(String orderId, String currencyPair, String account) throw } /** - * Get a single order + * Get a single order. * By default, orders for spot, unified account and warehouse-by-site leverage account are checked. * @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 currencyPair Specify the transaction pair to query. If you are querying pending order records, this field is traded records, this field can be left blank. (required) * @param 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 - +
Status Code Description Response Headers
200 Detail retrieved -
200 Detail retrieved. -
*/ public ApiResponse getOrderWithHttpInfo(String orderId, String currencyPair, String account) throws ApiException { @@ -3008,10 +3008,10 @@ public ApiResponse getOrderWithHttpInfo(String orderId, String currencyPa } /** - * Get a single order (asynchronously) + * Get a single order. (asynchronously) * By default, orders for spot, unified account and warehouse-by-site leverage account are checked. * @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 currencyPair Specify the transaction pair to query. If you are querying pending order records, this field is traded records, this field can be left blank. (required) * @param account Specify query account. (optional) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -3019,7 +3019,7 @@ public ApiResponse getOrderWithHttpInfo(String orderId, String currencyPa * @http.response.details - +
Status Code Description Response Headers
200 Detail retrieved -
200 Detail retrieved. -
*/ public okhttp3.Call getOrderAsync(String orderId, String currencyPair, String account, final ApiCallback _callback) throws ApiException { @@ -3032,7 +3032,7 @@ 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 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 xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) @@ -3042,7 +3042,7 @@ public okhttp3.Call getOrderAsync(String orderId, String currencyPair, String ac * @http.response.details - +
Status Code Description Response Headers
200 Order cancelled -
200 Order cancelled. -
*/ public okhttp3.Call cancelOrderCall(String orderId, String currencyPair, String account, String actionMode, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -3108,10 +3108,10 @@ private okhttp3.Call cancelOrderValidateBeforeCall(String orderId, String curren } /** - * Cancel a single order + * Cancel a 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 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 xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) @@ -3120,7 +3120,7 @@ private okhttp3.Call cancelOrderValidateBeforeCall(String orderId, String curren * @http.response.details - +
Status Code Description Response Headers
200 Order cancelled -
200 Order cancelled. -
*/ public Order cancelOrder(String orderId, String currencyPair, String account, String actionMode, String xGateExptime) throws ApiException { @@ -3129,10 +3129,10 @@ public Order cancelOrder(String orderId, String currencyPair, String account, St } /** - * Cancel a single order + * Cancel a 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 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 xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) @@ -3141,7 +3141,7 @@ public Order cancelOrder(String orderId, String currencyPair, String account, St * @http.response.details - +
Status Code Description Response Headers
200 Order cancelled -
200 Order cancelled. -
*/ public ApiResponse cancelOrderWithHttpInfo(String orderId, String currencyPair, String account, String actionMode, String xGateExptime) throws ApiException { @@ -3151,10 +3151,10 @@ public ApiResponse cancelOrderWithHttpInfo(String orderId, String currenc } /** - * Cancel a single order (asynchronously) + * Cancel a 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 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 xGateExptime Specify the expiration time (milliseconds); if the GATE receives the request time greater than the expiration time, the request will be rejected (optional) @@ -3164,7 +3164,7 @@ public ApiResponse cancelOrderWithHttpInfo(String orderId, String currenc * @http.response.details - +
Status Code Description Response Headers
200 Order cancelled -
200 Order cancelled. -
*/ public okhttp3.Call cancelOrderAsync(String orderId, String currencyPair, String account, String actionMode, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -3178,7 +3178,7 @@ public okhttp3.Call cancelOrderAsync(String orderId, String currencyPair, String * Build call for amendOrder * @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 currencyPair Currency pair. (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 @@ -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. -
*/ public okhttp3.Call amendOrderCall(String orderId, OrderPatch orderPatch, String currencyPair, String account, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -3249,11 +3249,11 @@ private okhttp3.Call amendOrderValidateBeforeCall(String orderId, OrderPatch ord } /** - * Amend an 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 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 operation. + * Amend an 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 currencyPair Currency pair. (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 @@ -3261,7 +3261,7 @@ private okhttp3.Call amendOrderValidateBeforeCall(String orderId, OrderPatch ord * @http.response.details - +
Status Code Description Response Headers
200 Updated -
200 Updated. -
*/ public Order amendOrder(String orderId, OrderPatch orderPatch, String currencyPair, String account, String xGateExptime) throws ApiException { @@ -3270,11 +3270,11 @@ public Order amendOrder(String orderId, OrderPatch orderPatch, String currencyPa } /** - * Amend an 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 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 operation. + * Amend an 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 currencyPair Currency pair. (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> @@ -3282,7 +3282,7 @@ public Order amendOrder(String orderId, OrderPatch orderPatch, String currencyPa * @http.response.details - +
Status Code Description Response Headers
200 Updated -
200 Updated. -
*/ public ApiResponse amendOrderWithHttpInfo(String orderId, OrderPatch orderPatch, String currencyPair, String account, String xGateExptime) throws ApiException { @@ -3292,11 +3292,11 @@ public ApiResponse amendOrderWithHttpInfo(String orderId, OrderPatch orde } /** - * Amend an 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 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 operation. + * Amend an 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 currencyPair Currency pair. (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 @@ -3305,7 +3305,7 @@ public ApiResponse amendOrderWithHttpInfo(String orderId, OrderPatch orde * @http.response.details - +
Status Code Description Response Headers
200 Updated -
200 Updated. -
*/ public okhttp3.Call amendOrderAsync(String orderId, OrderPatch orderPatch, String currencyPair, String account, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -3406,7 +3406,7 @@ private APIlistMyTradesRequest() { /** * Set currencyPair - * @param currencyPair Retrieve results with specified currency pair (optional) + * @param currencyPair Retrieve results with specified currency pair. (optional) * @return APIlistMyTradesRequest */ public APIlistMyTradesRequest currencyPair(String currencyPair) { @@ -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 records to be returned in a single list. Default: 100, Minimum: 1, Maximum: 1000 (optional, default to 100) * @return APIlistMyTradesRequest */ public APIlistMyTradesRequest limit(Integer limit) { @@ -3426,7 +3426,7 @@ public APIlistMyTradesRequest limit(Integer limit) { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistMyTradesRequest */ public APIlistMyTradesRequest page(Integer page) { @@ -3456,7 +3456,7 @@ public APIlistMyTradesRequest account(String account) { /** * Set from - * @param from Start timestamp of the query (optional) + * @param from Start timestamp of 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 Time range ending, default to current time. (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. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ 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. + * 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 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. -
*/ public APIlistMyTradesRequest listMyTrades() { @@ -3556,7 +3556,7 @@ public APIlistMyTradesRequest listMyTrades() { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ public okhttp3.Call getSystemTimeCall(final ApiCallback _callback) throws ApiException { @@ -3595,14 +3595,14 @@ private okhttp3.Call getSystemTimeValidateBeforeCall(final ApiCallback _callback } /** - * Get server current time + * Get server current time. * * @return SystemTime * @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 Successfully retrieved. -
*/ public SystemTime getSystemTime() throws ApiException { @@ -3611,14 +3611,14 @@ public SystemTime getSystemTime() throws ApiException { } /** - * Get server current time + * Get server current time. * * @return ApiResponse<SystemTime> * @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 Successfully retrieved. -
*/ public ApiResponse getSystemTimeWithHttpInfo() throws ApiException { @@ -3628,7 +3628,7 @@ public ApiResponse getSystemTimeWithHttpInfo() throws ApiException { } /** - * Get server current time (asynchronously) + * Get server current time. (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -3636,7 +3636,7 @@ public ApiResponse getSystemTimeWithHttpInfo() throws ApiException { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ 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 Set countdown successfully. -
*/ public okhttp3.Call countdownCancelAllSpotCall(CountdownCancelAllSpotTask countdownCancelAllSpotTask, final ApiCallback _callback) throws ApiException { @@ -3699,15 +3699,15 @@ private okhttp3.Call countdownCancelAllSpotValidateBeforeCall(CountdownCancelAll } /** - * Countdown cancel orders - * Spot order heartbeat detection. If there is no \"cancel existing countdown\" or \"set new countdown\" when the user-set `timeout` time is reached, the related `spot pending orders` will be automatically cancelled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at 30s intervals, setting the countdown `timeout` to `30 (seconds)` each time. If this interface is not called again within 30 seconds, all pending orders on the `market` you specified will be automatically cancelled. If no `market` is specified, all market pending orders will be 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. + * Countdown cancel orders. + * Spot order heartbeat detection. If there is no \"cancel existing countdown\" or \"set new countdown\" when the user-set `timeout` time is reached, the related `spot pending orders` will be automatically cancelled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at 30s intervals, setting the countdown `timeout` to `30 (seconds)` each time. If this interface is not called again within 30 seconds, all pending orders on the `market` you specified will be automatically cancelled. If no `market` is specified, all market cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will be terminated and the automatic order cancellation function will be cancelled. * @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 Set countdown successfully. -
*/ public TriggerTime countdownCancelAllSpot(CountdownCancelAllSpotTask countdownCancelAllSpotTask) throws ApiException { @@ -3716,15 +3716,15 @@ public TriggerTime countdownCancelAllSpot(CountdownCancelAllSpotTask countdownCa } /** - * Countdown cancel orders - * Spot order heartbeat detection. If there is no \"cancel existing countdown\" or \"set new countdown\" when the user-set `timeout` time is reached, the related `spot pending orders` will be automatically cancelled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at 30s intervals, setting the countdown `timeout` to `30 (seconds)` each time. If this interface is not called again within 30 seconds, all pending orders on the `market` you specified will be automatically cancelled. If no `market` is specified, all market pending orders will be 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. + * Countdown cancel orders. + * Spot order heartbeat detection. If there is no \"cancel existing countdown\" or \"set new countdown\" when the user-set `timeout` time is reached, the related `spot pending orders` will be automatically cancelled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at 30s intervals, setting the countdown `timeout` to `30 (seconds)` each time. If this interface is not called again within 30 seconds, all pending orders on the `market` you specified will be automatically cancelled. If no `market` is specified, all market cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will be terminated and the automatic order cancellation function will be cancelled. * @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 Set countdown successfully. -
*/ public ApiResponse countdownCancelAllSpotWithHttpInfo(CountdownCancelAllSpotTask countdownCancelAllSpotTask) throws ApiException { @@ -3734,8 +3734,8 @@ public ApiResponse countdownCancelAllSpotWithHttpInfo(CountdownCanc } /** - * Countdown cancel orders (asynchronously) - * 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 pending orders will be 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. + * Countdown cancel orders. (asynchronously) + * 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 Set countdown successfully. -
*/ public okhttp3.Call countdownCancelAllSpotAsync(CountdownCancelAllSpotTask countdownCancelAllSpotTask, final ApiCallback _callback) throws ApiException { @@ -3763,7 +3763,7 @@ public okhttp3.Call countdownCancelAllSpotAsync(CountdownCancelAllSpotTask count * @http.response.details - +
Status Code Description Response Headers
200 Order modification executed successfully -
200 Order modification executed successfully. -
*/ public okhttp3.Call amendBatchOrdersCall(List batchAmendItem, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -3811,8 +3811,8 @@ private okhttp3.Call amendBatchOrdersValidateBeforeCall(List bat } /** - * Batch modification of orders - * Modify orders in spot, unified account and isolated margin account by default. Modify uncompleted orders, up to 5 orders can be modified at a time. Request parameters should be passed in array format. If there are order modification failures during the batch modification process, the modification of the next order will continue to be executed, and the execution will return with the corresponding order failure information. The call order of batch modification orders is consistent with the order list order. The return content order of batch modification orders is consistent with the order list order. + * Batch modification of orders. + * Modify orders in spot, unified account and isolated margin account by default. Modify uncompleted orders, up to 5 orders can be modified at a time. Request parameters should be passed in array format. If there are order modification failures during the batch modification process, the modification of the next order will continue to be executed, and the execution will return with the corresponding order failure information. The call order of batch modification orders is consistent with the order list order. The return is consistent with the order list order. * @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> @@ -3820,7 +3820,7 @@ private okhttp3.Call amendBatchOrdersValidateBeforeCall(List bat * @http.response.details - +
Status Code Description Response Headers
200 Order modification executed successfully -
200 Order modification executed successfully. -
*/ public List amendBatchOrders(List batchAmendItem, String xGateExptime) throws ApiException { @@ -3829,8 +3829,8 @@ public List amendBatchOrders(List batchAmendItem, St } /** - * Batch modification of orders - * Modify orders in spot, unified account and isolated margin account by default. Modify uncompleted orders, up to 5 orders can be modified at a time. Request parameters should be passed in array format. If there are order modification failures during the batch modification process, the modification of the next order will continue to be executed, and the execution will return with the corresponding order failure information. The call order of batch modification orders is consistent with the order list order. The return content order of batch modification orders is consistent with the order list order. + * Batch modification of orders. + * Modify orders in spot, unified account and isolated margin account by default. Modify uncompleted orders, up to 5 orders can be modified at a time. Request parameters should be passed in array format. If there are order modification failures during the batch modification process, the modification of the next order will continue to be executed, and the execution will return with the corresponding order failure information. The call order of batch modification orders is consistent with the order list order. The return is consistent with the order list order. * @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>> @@ -3838,7 +3838,7 @@ public List amendBatchOrders(List batchAmendItem, St * @http.response.details - +
Status Code Description Response Headers
200 Order modification executed successfully -
200 Order modification executed successfully. -
*/ public ApiResponse> amendBatchOrdersWithHttpInfo(List batchAmendItem, String xGateExptime) throws ApiException { @@ -3848,8 +3848,8 @@ public ApiResponse> amendBatchOrdersWithHttpInfo(List> amendBatchOrdersWithHttpInfo(List Status Code Description Response Headers - 200 Order modification executed successfully - + 200 Order modification executed successfully. - */ public okhttp3.Call amendBatchOrdersAsync(List batchAmendItem, String xGateExptime, final ApiCallback> _callback) throws ApiException { @@ -3978,7 +3978,7 @@ private APIgetSpotInsuranceHistoryRequest(String business, String currency, Long /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIgetSpotInsuranceHistoryRequest */ public APIgetSpotInsuranceHistoryRequest page(Integer page) { @@ -3988,7 +3988,7 @@ public APIgetSpotInsuranceHistoryRequest page(Integer page) { /** * Set limit - * @param limit The maximum number of items returned in the list, the default value is 30 (optional, default to 30) + * @param limit The maximum number of items returned in the list, the default value is 30. (optional, default to 30) * @return APIgetSpotInsuranceHistoryRequest */ public APIgetSpotInsuranceHistoryRequest limit(Integer limit) { @@ -4004,7 +4004,7 @@ public APIgetSpotInsuranceHistoryRequest limit(Integer limit) { * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ 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 Successfully retrieved. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -4057,17 +4057,17 @@ public okhttp3.Call executeAsync(final ApiCallback> _ } /** - * Query spot insurance fund historical data + * Query spot insurance fund historical data. * * @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 currency Currency. (required) + * @param from Start timestamp, seconds. (required) + * @param to End timestamp, in seconds. (required) * @return APIgetSpotInsuranceHistoryRequest * @http.response.details - +
Status Code Description Response Headers
200 Successfully retrieved -
200 Successfully retrieved. -
*/ 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 Currency pair. (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. Portfolio margin account must 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 to be returned in a single list. (optional, default to 100) * @return APIlistSpotPriceTriggeredOrdersRequest */ public APIlistSpotPriceTriggeredOrdersRequest limit(Integer limit) { @@ -4191,7 +4191,7 @@ public APIlistSpotPriceTriggeredOrdersRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIlistSpotPriceTriggeredOrdersRequest */ public APIlistSpotPriceTriggeredOrdersRequest offset(Integer offset) { @@ -4207,7 +4207,7 @@ public APIlistSpotPriceTriggeredOrdersRequest offset(Integer offset) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -4260,14 +4260,14 @@ public okhttp3.Call executeAsync(final ApiCallback } /** - * Retrieve running auto order list + * Retrieve running auto order list. * - * @param status Only list the orders with this status (required) + * @param status Only list the orders with this status. (required) * @return APIlistSpotPriceTriggeredOrdersRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ 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. -
*/ 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 a 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. -
*/ public TriggerOrderResponse createSpotPriceTriggeredOrder(SpotPriceTriggeredOrder spotPriceTriggeredOrder) throws ApiException { @@ -4344,7 +4344,7 @@ public TriggerOrderResponse createSpotPriceTriggeredOrder(SpotPriceTriggeredOrde } /** - * Create a price-triggered order + * Create a 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. -
*/ public ApiResponse createSpotPriceTriggeredOrderWithHttpInfo(SpotPriceTriggeredOrder spotPriceTriggeredOrder) throws ApiException { @@ -4362,7 +4362,7 @@ public ApiResponse createSpotPriceTriggeredOrderWithHttpIn } /** - * Create a price-triggered order (asynchronously) + * Create a 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. -
*/ 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 Currency pair. (optional) + * @param account Trading account type. Portfolio margin account must 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. Query order status by listing orders. -
*/ 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 Price-triggered Orders. * - * @param market Currency pair (optional) - * @param account Trading account type. Portfolio margin account must set to `unified` (optional) + * @param market Currency pair. (optional) + * @param account Trading account type. Portfolio margin account must 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. Query order status by listing orders. -
*/ 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 Price-triggered Orders. * - * @param market Currency pair (optional) - * @param account Trading account type. Portfolio margin account must set to `unified` (optional) + * @param market Currency pair. (optional) + * @param account Trading account type. Portfolio margin account must 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. Query order status by listing orders. -
*/ public ApiResponse> cancelSpotPriceTriggeredOrderListWithHttpInfo(String market, String account) throws ApiException { @@ -4475,17 +4475,17 @@ public ApiResponse> cancelSpotPriceTriggeredOrderL } /** - * Cancel All Price-triggered Orders (asynchronously) + * Cancel All Price-triggered Orders. (asynchronously) * - * @param market Currency pair (optional) - * @param account Trading account type. Portfolio margin account must set to `unified` (optional) + * @param market Currency pair. (optional) + * @param account Trading account type. Portfolio margin account must 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. Query order status by listing orders. -
*/ 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 Retrieve the data of the order with the specified 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 Auto order detail -
200 Auto order detail. -
*/ 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 + * Get a price-triggered order. * - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId Retrieve the data of the order with the specified ID. (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 detail. -
*/ public SpotPriceTriggeredOrder getSpotPriceTriggeredOrder(String orderId) throws ApiException { @@ -4566,15 +4566,15 @@ public SpotPriceTriggeredOrder getSpotPriceTriggeredOrder(String orderId) throws } /** - * Get a price-triggered order + * Get a price-triggered order. * - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId Retrieve the data of the order with the specified ID. (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 detail. -
*/ public ApiResponse getSpotPriceTriggeredOrderWithHttpInfo(String orderId) throws ApiException { @@ -4584,16 +4584,16 @@ public ApiResponse getSpotPriceTriggeredOrderWithHttpIn } /** - * Get a price-triggered order (asynchronously) + * Get a price-triggered order. (asynchronously) * - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId Retrieve the data of the order with the specified 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 Auto order detail -
200 Auto order detail. -
*/ 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 Retrieve the data of the order with the specified 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 Auto order detail -
200 Auto order detail. -
*/ 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 a price-triggered order. * - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId Retrieve the data of the order with the specified ID. (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 detail. -
*/ public SpotPriceTriggeredOrder cancelSpotPriceTriggeredOrder(String orderId) throws ApiException { @@ -4674,15 +4674,15 @@ public SpotPriceTriggeredOrder cancelSpotPriceTriggeredOrder(String orderId) thr } /** - * cancel a price-triggered order + * cancel a price-triggered order. * - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId Retrieve the data of the order with the specified ID. (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 detail. -
*/ public ApiResponse cancelSpotPriceTriggeredOrderWithHttpInfo(String orderId) throws ApiException { @@ -4692,16 +4692,16 @@ public ApiResponse cancelSpotPriceTriggeredOrderWithHtt } /** - * cancel a price-triggered order (asynchronously) + * cancel a price-triggered order. (asynchronously) * - * @param orderId Retrieve the data of the order with the specified ID (required) + * @param orderId Retrieve the data of the order with the specified 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 Auto order detail -
200 Auto order detail. -
*/ 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 b4b8b32..b1e79b6 100644 --- a/src/main/java/io/gate/gateapi/api/SubAccountApi.java +++ b/src/main/java/io/gate/gateapi/api/SubAccountApi.java @@ -126,7 +126,7 @@ public APIlistSubAccountsRequest type(String type) { * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ 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. -
*/ 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. -
*/ 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. -
*/ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -179,13 +179,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) } /** - * List sub-accounts + * List sub-accounts. * * @return APIlistSubAccountsRequest * @http.response.details - +
Status Code Description Response Headers
200 List retrieved -
200 List retrieved. -
*/ 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 { @@ -245,7 +245,7 @@ private okhttp3.Call createSubAccountsValidateBeforeCall(SubAccount subAccount, } /** - * Create a new sub-account + * Create a new sub-account. * * @param subAccount (required) * @return SubAccount @@ -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 { @@ -262,7 +262,7 @@ public SubAccount createSubAccounts(SubAccount subAccount) throws ApiException { } /** - * Create a new sub-account + * Create a new sub-account. * * @param subAccount (required) * @return ApiResponse<SubAccount> @@ -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 { @@ -280,7 +280,7 @@ public ApiResponse createSubAccountsWithHttpInfo(SubAccount subAccou } /** - * Create a new sub-account (asynchronously) + * Create a new sub-account. (asynchronously) * * @param subAccount (required) * @param _callback The callback to be executed when the API call finishes @@ -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 Successful. -
*/ 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 the 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 Successful. -
*/ public SubAccount getSubAccount(Long userId) throws ApiException { @@ -370,15 +370,15 @@ public SubAccount getSubAccount(Long userId) throws ApiException { } /** - * Get the sub-account + * Get the 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 Successful. -
*/ public ApiResponse getSubAccountWithHttpInfo(Long userId) throws ApiException { @@ -388,16 +388,16 @@ public ApiResponse getSubAccountWithHttpInfo(Long userId) throws Api } /** - * Get the sub-account (asynchronously) + * Get 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 Successful -
200 Successful. -
*/ 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. - */ 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 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. -
*/ 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 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. -
*/ 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 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. -
*/ 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,16 +575,16 @@ private okhttp3.Call createSubAccountKeysValidateBeforeCall(Long userId, SubAcco } /** - * Create API Key of the sub-account + * Create API Key of the sub-account. * - * @param userId Sub-account user id (required) + * @param userId Sub-account user id. (required) * @param subAccountKey (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 Created Successfully -
    200 Created Successfully. -
    */ public SubAccountKey createSubAccountKeys(Long userId, SubAccountKey subAccountKey) throws ApiException { @@ -593,16 +593,16 @@ public SubAccountKey createSubAccountKeys(Long userId, SubAccountKey subAccountK } /** - * Create API Key of the sub-account + * Create API Key of the sub-account. * - * @param userId Sub-account user id (required) + * @param userId Sub-account user id. (required) * @param subAccountKey (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 Created Successfully -
    200 Created Successfully. -
    */ public ApiResponse createSubAccountKeysWithHttpInfo(Long userId, SubAccountKey subAccountKey) throws ApiException { @@ -612,9 +612,9 @@ public ApiResponse createSubAccountKeysWithHttpInfo(Long userId, } /** - * Create API Key of the sub-account (asynchronously) + * Create API Key of the sub-account. (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,7 +622,7 @@ public ApiResponse createSubAccountKeysWithHttpInfo(Long userId, * @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 { @@ -634,15 +634,15 @@ public okhttp3.Call createSubAccountKeysAsync(Long userId, SubAccountKey subAcco /** * 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 The API Key of the sub-account. (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 Successful. -
    */ 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 the API Key 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 The API Key of the sub-account. (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 Successful. -
    */ 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 the API Key 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 The API Key of the sub-account. (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 Successful. -
    */ 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 the API Key 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 The API Key of the sub-account. (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 Successful. -
    */ 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 The API Key of the sub-account. (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. -
    */ 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 API key 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 The API Key of the sub-account. (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. -
    */ 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 API key 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 The API Key of the sub-account. (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. -
    */ 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 API key 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 The API Key of the sub-account. (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. -
    */ 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 The API Key of the sub-account. (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 Delete 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 API key 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 The API Key of the sub-account. (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 Delete 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 API key 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 The API Key of the sub-account. (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 Delete 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 API key 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 The API Key of the sub-account. (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 Delete 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 The user id of the sub-account. (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 Lock 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 the sub-account. * - * @param userId The user id of the sub-account (required) + * @param userId The user id of the sub-account. (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 Lock successfully. -
    */ public void lockSubAccount(Long userId) throws ApiException { @@ -1056,15 +1056,15 @@ public void lockSubAccount(Long userId) throws ApiException { } /** - * Lock the sub-account + * Lock the sub-account. * - * @param userId The user id of the sub-account (required) + * @param userId The user id of the sub-account. (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 Lock 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 the sub-account. (asynchronously) * - * @param userId The user id of the sub-account (required) + * @param userId The user id of the sub-account. (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 Lock 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 The user id of the sub-account. (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 Unlock 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 the sub-account. * - * @param userId The user id of the sub-account (required) + * @param userId The user id of the sub-account. (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 Unlock successfully. -
    */ public void unlockSubAccount(Long userId) throws ApiException { @@ -1160,15 +1160,15 @@ public void unlockSubAccount(Long userId) throws ApiException { } /** - * Unlock the sub-account + * Unlock the sub-account. * - * @param userId The user id of the sub-account (required) + * @param userId The user id of the sub-account. (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 Unlock 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 the sub-account. (asynchronously) * - * @param userId The user id of the sub-account (required) + * @param userId The user id of the sub-account. (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 Unlock 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 Successfully retrieved. -
    */ public okhttp3.Call listUnifiedModeCall(final ApiCallback _callback) throws ApiException { @@ -1242,14 +1242,14 @@ private okhttp3.Call listUnifiedModeValidateBeforeCall(final ApiCallback _callba } /** - * Get sub-account mode + * Get sub-account mode. * Unified account mode： - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode * @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 Successfully retrieved. -
    */ public List listUnifiedMode() throws ApiException { @@ -1258,14 +1258,14 @@ public List listUnifiedMode() throws ApiException { } /** - * Get sub-account mode + * Get sub-account mode. * Unified account mode： - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode * @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 Successfully retrieved. -
    */ public ApiResponse> listUnifiedModeWithHttpInfo() throws ApiException { @@ -1275,7 +1275,7 @@ public ApiResponse> listUnifiedModeWithHttpInfo() throws ApiEx } /** - * Get sub-account mode (asynchronously) + * Get sub-account mode. (asynchronously) * 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 @@ -1283,7 +1283,7 @@ public ApiResponse> listUnifiedModeWithHttpInfo() throws ApiEx * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ 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 dc4f1c5..50f3aaa 100644 --- a/src/main/java/io/gate/gateapi/api/UnifiedApi.java +++ b/src/main/java/io/gate/gateapi/api/UnifiedApi.java @@ -134,7 +134,7 @@ private APIlistUnifiedAccountsRequest() { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Retrieve data of the specified currency. (optional) * @return APIlistUnifiedAccountsRequest */ public APIlistUnifiedAccountsRequest currency(String currency) { @@ -144,7 +144,7 @@ public APIlistUnifiedAccountsRequest currency(String currency) { /** * Set subUid - * @param subUid Sub account user ID (optional) + * @param subUid Sub account user ID. (optional) * @return APIlistUnifiedAccountsRequest */ public APIlistUnifiedAccountsRequest subUid(String subUid) { @@ -160,7 +160,7 @@ public APIlistUnifiedAccountsRequest subUid(String subUid) { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -174,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. -
    */ public UnifiedAccount execute() throws ApiException { @@ -189,7 +189,7 @@ public UnifiedAccount execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -204,7 +204,7 @@ public ApiResponse executeWithHttpInfo() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -213,13 +213,13 @@ public okhttp3.Call executeAsync(final ApiCallback _callback) th } /** - * Get unified account information + * Get unified account information. * The assets of each currency in the account will be adjusted according to their liquidity, defined by corresponding adjustment coefficients, and then uniformly converted to USD to calculate the total asset value and position value of the account. You can refer to the [Formula](#portfolio-account) in the documentation * @return APIlistUnifiedAccountsRequest * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public APIlistUnifiedAccountsRequest listUnifiedAccounts() { @@ -228,14 +228,14 @@ public APIlistUnifiedAccountsRequest listUnifiedAccounts() { /** * Build call for getUnifiedBorrowable - * @param currency Retrieve data of the specified currency (required) + * @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 -
    200 Successfully retrieved. -
    */ public okhttp3.Call getUnifiedBorrowableCall(String currency, final ApiCallback _callback) throws ApiException { @@ -283,15 +283,15 @@ private okhttp3.Call getUnifiedBorrowableValidateBeforeCall(String currency, fin } /** - * Query about the maximum borrowing for the unified account + * Query about the maximum borrowing for the unified account. * - * @param currency Retrieve data of the specified currency (required) + * @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 -
    200 Successfully retrieved. -
    */ public UnifiedBorrowable getUnifiedBorrowable(String currency) throws ApiException { @@ -300,15 +300,15 @@ public UnifiedBorrowable getUnifiedBorrowable(String currency) throws ApiExcepti } /** - * Query about the maximum borrowing for the unified account + * Query about the maximum borrowing for the unified account. * - * @param currency Retrieve data of the specified currency (required) + * @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 -
    200 Successfully retrieved. -
    */ public ApiResponse getUnifiedBorrowableWithHttpInfo(String currency) throws ApiException { @@ -318,16 +318,16 @@ public ApiResponse getUnifiedBorrowableWithHttpInfo(String cu } /** - * Query about the maximum borrowing for the unified account (asynchronously) + * Query about the maximum borrowing for the unified account. (asynchronously) * - * @param currency Retrieve data of the specified currency (required) + * @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 -
    200 Successfully retrieved. -
    */ public okhttp3.Call getUnifiedBorrowableAsync(String currency, final ApiCallback _callback) throws ApiException { @@ -339,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 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 -
    200 Successfully retrieved. -
    */ public okhttp3.Call getUnifiedTransferableCall(String currency, final ApiCallback _callback) throws ApiException { @@ -394,15 +394,15 @@ private okhttp3.Call getUnifiedTransferableValidateBeforeCall(String currency, f } /** - * Query about the maximum transferable for the unified account + * Query about the maximum transferable for the unified account. * - * @param currency Retrieve data of the specified currency (required) + * @param currency Retrieve data of the specified currency. (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 Successfully retrieved. -
    */ public UnifiedTransferable getUnifiedTransferable(String currency) throws ApiException { @@ -411,15 +411,15 @@ public UnifiedTransferable getUnifiedTransferable(String currency) throws ApiExc } /** - * Query about the maximum transferable for the unified account + * Query about the maximum transferable for the unified account. * - * @param currency Retrieve data of the specified currency (required) + * @param currency Retrieve data of the specified currency. (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 Successfully retrieved. -
    */ public ApiResponse getUnifiedTransferableWithHttpInfo(String currency) throws ApiException { @@ -429,16 +429,16 @@ public ApiResponse getUnifiedTransferableWithHttpInfo(Strin } /** - * Query about the maximum transferable for the unified account (asynchronously) + * Query about the maximum transferable for the unified account. (asynchronously) * - * @param currency Retrieve data of the specified currency (required) + * @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 -
    200 Successfully retrieved. -
    */ public okhttp3.Call getUnifiedTransferableAsync(String currency, final ApiCallback _callback) throws ApiException { @@ -457,7 +457,7 @@ public okhttp3.Call getUnifiedTransferableAsync(String currency, final ApiCallba * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public okhttp3.Call getUnifiedTransferablesCall(String currencies, final ApiCallback _callback) throws ApiException { @@ -513,7 +513,7 @@ private okhttp3.Call getUnifiedTransferablesValidateBeforeCall(String currencies * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public List getUnifiedTransferables(String currencies) throws ApiException { @@ -530,7 +530,7 @@ public List getUnifiedTransferables(String currencies) thro * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public ApiResponse> getUnifiedTransferablesWithHttpInfo(String currencies) throws ApiException { @@ -549,7 +549,7 @@ public ApiResponse> getUnifiedTransferablesWithHttpInf * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public okhttp3.Call getUnifiedTransferablesAsync(String currencies, final ApiCallback> _callback) throws ApiException { @@ -568,7 +568,7 @@ public okhttp3.Call getUnifiedTransferablesAsync(String currencies, final ApiCal * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public okhttp3.Call getUnifiedBorrowableListCall(List currencies, final ApiCallback _callback) throws ApiException { @@ -616,7 +616,7 @@ private okhttp3.Call getUnifiedBorrowableListValidateBeforeCall(List cur } /** - * Batch query unified account can be borrowed up to a maximum + * Batch query unified account can be borrowed up to a maximum. * * @param currencies Specify the currency names for querying in an array, separated by commas, with a maximum of 10 currencies. (required) * @return List<UnifiedBorrowable1> @@ -624,7 +624,7 @@ private okhttp3.Call getUnifiedBorrowableListValidateBeforeCall(List cur * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public List getUnifiedBorrowableList(List currencies) throws ApiException { @@ -633,7 +633,7 @@ public List getUnifiedBorrowableList(List currencies } /** - * Batch query unified account can be borrowed up to a maximum + * Batch query unified account can be borrowed up to a maximum. * * @param currencies Specify the currency names for querying in an array, separated by commas, with a maximum of 10 currencies. (required) * @return ApiResponse<List<UnifiedBorrowable1>> @@ -641,7 +641,7 @@ public List getUnifiedBorrowableList(List currencies * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public ApiResponse> getUnifiedBorrowableListWithHttpInfo(List currencies) throws ApiException { @@ -651,7 +651,7 @@ public ApiResponse> getUnifiedBorrowableListWithHttpInf } /** - * Batch query unified account can be borrowed up to a maximum (asynchronously) + * Batch query unified account can be borrowed up to a maximum. (asynchronously) * * @param currencies Specify the currency names for querying in an array, separated by commas, with a maximum of 10 currencies. (required) * @param _callback The callback to be executed when the API call finishes @@ -660,7 +660,7 @@ public ApiResponse> getUnifiedBorrowableListWithHttpInf * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public okhttp3.Call getUnifiedBorrowableListAsync(List currencies, final ApiCallback> _callback) throws ApiException { @@ -746,7 +746,7 @@ private APIlistUnifiedLoansRequest() { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Retrieve data of the specified currency. (optional) * @return APIlistUnifiedLoansRequest */ public APIlistUnifiedLoansRequest currency(String currency) { @@ -756,7 +756,7 @@ public APIlistUnifiedLoansRequest currency(String currency) { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistUnifiedLoansRequest */ public APIlistUnifiedLoansRequest page(Integer page) { @@ -766,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 response items. Default: 100, minimum: 1, Maximum: 100. (optional, default to 100) * @return APIlistUnifiedLoansRequest */ public APIlistUnifiedLoansRequest limit(Integer limit) { @@ -776,7 +776,7 @@ public APIlistUnifiedLoansRequest limit(Integer limit) { /** * Set type - * @param type Loan type, platform - platform, margin - margin (optional) + * @param type Loan type, platform - platform, margin - margin. (optional) * @return APIlistUnifiedLoansRequest */ public APIlistUnifiedLoansRequest type(String type) { @@ -792,7 +792,7 @@ public APIlistUnifiedLoansRequest type(String type) { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -806,7 +806,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public List execute() throws ApiException { @@ -821,7 +821,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -836,7 +836,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -845,13 +845,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) thr } /** - * List loans + * List loans. * * @return APIlistUnifiedLoansRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public APIlistUnifiedLoansRequest listUnifiedLoans() { @@ -867,7 +867,7 @@ public APIlistUnifiedLoansRequest listUnifiedLoans() { * @http.response.details - +
    Status Code Description Response Headers
    200 Operated successfully -
    200 Operated successfully. -
    */ public okhttp3.Call createUnifiedLoanCall(UnifiedLoan unifiedLoan, final ApiCallback _callback) throws ApiException { @@ -911,15 +911,15 @@ 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` + * Borrow or repay. + * When borrowing, it is essential to ensure that the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and the user. The interest on the loan will be automatically deducted from the account at regular intervals. It is the user's responsibility to manage the repayment of the borrowed amount. For repayment, the option to repay the available by setting the parameter `repaid_all=true` * @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 Operated successfully. -
    */ public UnifiedLoanResult createUnifiedLoan(UnifiedLoan unifiedLoan) throws ApiException { @@ -928,15 +928,15 @@ 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` + * Borrow or repay. + * When borrowing, it is essential to ensure that the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and the user. The interest on the loan will be automatically deducted from the account at regular intervals. It is the user's responsibility to manage the repayment of the borrowed amount. For repayment, the option to repay the available by setting the parameter `repaid_all=true` * @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 Operated successfully. -
    */ public ApiResponse createUnifiedLoanWithHttpInfo(UnifiedLoan unifiedLoan) throws ApiException { @@ -946,8 +946,8 @@ 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` + * 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 available by setting the parameter `repaid_all=true` * @param unifiedLoan (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -955,7 +955,7 @@ public ApiResponse createUnifiedLoanWithHttpInfo(UnifiedLoan * @http.response.details - +
    Status Code Description Response Headers
    200 Operated successfully -
    200 Operated successfully. -
    */ public okhttp3.Call createUnifiedLoanAsync(UnifiedLoan unifiedLoan, final ApiCallback _callback) throws ApiException { @@ -1041,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 The types of lending records, borrow - indicates the action of borrowing funds, repaying the borrowed funds (optional) * @return APIlistUnifiedLoanRecordsRequest */ public APIlistUnifiedLoanRecordsRequest type(String type) { @@ -1051,7 +1051,7 @@ public APIlistUnifiedLoanRecordsRequest type(String type) { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Retrieve data of the specified currency. (optional) * @return APIlistUnifiedLoanRecordsRequest */ public APIlistUnifiedLoanRecordsRequest currency(String currency) { @@ -1061,7 +1061,7 @@ public APIlistUnifiedLoanRecordsRequest currency(String currency) { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistUnifiedLoanRecordsRequest */ public APIlistUnifiedLoanRecordsRequest page(Integer page) { @@ -1071,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 response items. Default: 100, minimum: 1, Maximum: 100. (optional, default to 100) * @return APIlistUnifiedLoanRecordsRequest */ public APIlistUnifiedLoanRecordsRequest limit(Integer limit) { @@ -1087,7 +1087,7 @@ public APIlistUnifiedLoanRecordsRequest limit(Integer limit) { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1101,7 +1101,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public List execute() throws ApiException { @@ -1116,7 +1116,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1131,7 +1131,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExce * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1140,13 +1140,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _cal } /** - * Get load records + * Get load records. * * @return APIlistUnifiedLoanRecordsRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public APIlistUnifiedLoanRecordsRequest listUnifiedLoanRecords() { @@ -1239,7 +1239,7 @@ private APIlistUnifiedLoanInterestRecordsRequest() { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Retrieve data of the specified currency. (optional) * @return APIlistUnifiedLoanInterestRecordsRequest */ public APIlistUnifiedLoanInterestRecordsRequest currency(String currency) { @@ -1249,7 +1249,7 @@ public APIlistUnifiedLoanInterestRecordsRequest currency(String currency) { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistUnifiedLoanInterestRecordsRequest */ public APIlistUnifiedLoanInterestRecordsRequest page(Integer page) { @@ -1259,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 response items. Default: 100, minimum: 1, Maximum: 100. (optional, default to 100) * @return APIlistUnifiedLoanInterestRecordsRequest */ public APIlistUnifiedLoanInterestRecordsRequest limit(Integer limit) { @@ -1269,7 +1269,7 @@ public APIlistUnifiedLoanInterestRecordsRequest limit(Integer limit) { /** * Set from - * @param from Start timestamp of the query (optional) + * @param from Start timestamp of the query. (optional) * @return APIlistUnifiedLoanInterestRecordsRequest */ public APIlistUnifiedLoanInterestRecordsRequest from(Long from) { @@ -1279,7 +1279,7 @@ public APIlistUnifiedLoanInterestRecordsRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to Time range ending, default to current time. (optional) * @return APIlistUnifiedLoanInterestRecordsRequest */ public APIlistUnifiedLoanInterestRecordsRequest to(Long to) { @@ -1305,7 +1305,7 @@ public APIlistUnifiedLoanInterestRecordsRequest type(String type) { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1319,7 +1319,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public List execute() throws ApiException { @@ -1334,7 +1334,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1349,7 +1349,7 @@ public ApiResponse> executeWithHttpInfo() throws Api * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1358,13 +1358,13 @@ public okhttp3.Call executeAsync(final ApiCallback> } /** - * List interest records + * List interest records. * * @return APIlistUnifiedLoanInterestRecordsRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public APIlistUnifiedLoanInterestRecordsRequest listUnifiedLoanInterestRecords() { @@ -1379,7 +1379,7 @@ public APIlistUnifiedLoanInterestRecordsRequest listUnifiedLoanInterestRecords() * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public okhttp3.Call getUnifiedRiskUnitsCall(final ApiCallback _callback) throws ApiException { @@ -1418,14 +1418,14 @@ 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. + * Retrieve 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 Successfully retrieved. -
    */ public UnifiedRiskUnits getUnifiedRiskUnits() throws ApiException { @@ -1434,14 +1434,14 @@ 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. + * Retrieve 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 Successfully retrieved. -
    */ public ApiResponse getUnifiedRiskUnitsWithHttpInfo() throws ApiException { @@ -1451,15 +1451,15 @@ 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. (asynchronously) + * Retrieve 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 Successfully retrieved. -
    */ public okhttp3.Call getUnifiedRiskUnitsAsync(final ApiCallback _callback) throws ApiException { @@ -1477,7 +1477,7 @@ public okhttp3.Call getUnifiedRiskUnitsAsync(final ApiCallback * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public okhttp3.Call getUnifiedModeCall(final ApiCallback _callback) throws ApiException { @@ -1516,14 +1516,14 @@ private okhttp3.Call getUnifiedModeValidateBeforeCall(final ApiCallback _callbac } /** - * Query mode of the unified account + * Query mode of the unified account. * Unified account mode: - `classic`: Classic account mode - `multi_currency`: Cross-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single-currency margin mode * @return UnifiedModeSet * @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 Successfully retrieved. -
    */ public UnifiedModeSet getUnifiedMode() throws ApiException { @@ -1532,14 +1532,14 @@ public UnifiedModeSet getUnifiedMode() throws ApiException { } /** - * Query mode of the unified account + * Query mode of the unified account. * Unified account mode: - `classic`: Classic account mode - `multi_currency`: Cross-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single-currency margin mode * @return ApiResponse<UnifiedModeSet> * @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 Successfully retrieved. -
    */ public ApiResponse getUnifiedModeWithHttpInfo() throws ApiException { @@ -1549,7 +1549,7 @@ public ApiResponse getUnifiedModeWithHttpInfo() throws ApiExcept } /** - * Query mode of the unified account (asynchronously) + * Query mode of the unified account. (asynchronously) * Unified account mode: - `classic`: Classic account mode - `multi_currency`: Cross-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single-currency margin mode * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1557,7 +1557,7 @@ public ApiResponse getUnifiedModeWithHttpInfo() throws ApiExcept * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public okhttp3.Call getUnifiedModeAsync(final ApiCallback _callback) throws ApiException { @@ -1576,7 +1576,7 @@ public okhttp3.Call getUnifiedModeAsync(final ApiCallback _callb * @http.response.details - +
    Status Code Description Response Headers
    204 Success -
    204 Success. -
    */ public okhttp3.Call setUnifiedModeCall(UnifiedModeSet unifiedModeSet, final ApiCallback _callback) throws ApiException { @@ -1620,14 +1620,14 @@ private okhttp3.Call setUnifiedModeValidateBeforeCall(UnifiedModeSet unifiedMode } /** - * Set mode of the unified account - * 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 mode, mode=multi_currency ``` PUT /unified/unified_mode { \"mode\": \"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\" } ``` + * Set mode of the unified account. + * 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 Success. -
    */ public void setUnifiedMode(UnifiedModeSet unifiedModeSet) throws ApiException { @@ -1635,15 +1635,15 @@ public void setUnifiedMode(UnifiedModeSet unifiedModeSet) throws ApiException { } /** - * Set mode of the unified account - * 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 mode, mode=multi_currency ``` PUT /unified/unified_mode { \"mode\": \"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\" } ``` + * Set mode of the unified account. + * 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 Success. -
    */ public ApiResponse setUnifiedModeWithHttpInfo(UnifiedModeSet unifiedModeSet) throws ApiException { @@ -1652,8 +1652,8 @@ public ApiResponse setUnifiedModeWithHttpInfo(UnifiedModeSet unifiedModeSe } /** - * Set mode of the unified account (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 mode, mode=multi_currency ``` PUT /unified/unified_mode { \"mode\": \"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\" } ``` + * Set mode of the unified account. (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 @@ -1661,7 +1661,7 @@ public ApiResponse setUnifiedModeWithHttpInfo(UnifiedModeSet unifiedModeSe * @http.response.details - +
    Status Code Description Response Headers
    204 Success -
    204 Success. -
    */ public okhttp3.Call setUnifiedModeAsync(UnifiedModeSet unifiedModeSet, final ApiCallback _callback) throws ApiException { @@ -1679,7 +1679,7 @@ public okhttp3.Call setUnifiedModeAsync(UnifiedModeSet unifiedModeSet, final Api * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public okhttp3.Call getUnifiedEstimateRateCall(List currencies, final ApiCallback _callback) throws ApiException { @@ -1727,7 +1727,7 @@ private okhttp3.Call getUnifiedEstimateRateValidateBeforeCall(List curre } /** - * Get unified estimate rate + * 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) * @return Map<String, String> @@ -1735,7 +1735,7 @@ private okhttp3.Call getUnifiedEstimateRateValidateBeforeCall(List curre * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public Map getUnifiedEstimateRate(List currencies) throws ApiException { @@ -1744,7 +1744,7 @@ public Map getUnifiedEstimateRate(List currencies) throw } /** - * Get unified estimate rate + * 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) * @return ApiResponse<Map<String, String>> @@ -1752,7 +1752,7 @@ public Map getUnifiedEstimateRate(List currencies) throw * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public ApiResponse> getUnifiedEstimateRateWithHttpInfo(List currencies) throws ApiException { @@ -1762,7 +1762,7 @@ public ApiResponse> getUnifiedEstimateRateWithHttpInfo(List< } /** - * Get unified estimate rate (asynchronously) + * 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) * @param _callback The callback to be executed when the API call finishes @@ -1771,7 +1771,7 @@ public ApiResponse> getUnifiedEstimateRateWithHttpInfo(List< * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public okhttp3.Call getUnifiedEstimateRateAsync(List currencies, final ApiCallback> _callback) throws ApiException { @@ -1789,7 +1789,7 @@ public okhttp3.Call getUnifiedEstimateRateAsync(List currencies, final A * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public okhttp3.Call listCurrencyDiscountTiersCall(final ApiCallback _callback) throws ApiException { @@ -1828,14 +1828,14 @@ private okhttp3.Call listCurrencyDiscountTiersValidateBeforeCall(final ApiCallba } /** - * List currency discount tiers + * List currency discount tiers. * * @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 Successfully retrieved. -
    */ public List listCurrencyDiscountTiers() throws ApiException { @@ -1844,14 +1844,14 @@ public List listCurrencyDiscountTiers() throws ApiException { } /** - * List currency discount tiers + * List currency discount tiers. * * @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 Successfully retrieved. -
    */ public ApiResponse> listCurrencyDiscountTiersWithHttpInfo() throws ApiException { @@ -1861,7 +1861,7 @@ public ApiResponse> listCurrencyDiscountTiersWithHttpInfo( } /** - * List currency discount tiers (asynchronously) + * List currency discount tiers. (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1869,7 +1869,7 @@ public ApiResponse> listCurrencyDiscountTiersWithHttpInfo( * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public okhttp3.Call listCurrencyDiscountTiersAsync(final ApiCallback> _callback) throws ApiException { @@ -1887,7 +1887,7 @@ public okhttp3.Call listCurrencyDiscountTiersAsync(final ApiCallback Status Code Description Response Headers - 200 Successfully retrieved - + 200 Successfully retrieved. - */ public okhttp3.Call listLoanMarginTiersCall(final ApiCallback _callback) throws ApiException { @@ -1926,14 +1926,14 @@ private okhttp3.Call listLoanMarginTiersValidateBeforeCall(final ApiCallback _ca } /** - * List loan margin tiers + * List loan margin tiers. * * @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 Successfully retrieved. -
    */ public List listLoanMarginTiers() throws ApiException { @@ -1942,14 +1942,14 @@ public List listLoanMarginTiers() throws ApiException { } /** - * List loan margin tiers + * List loan margin tiers. * * @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 Successfully retrieved. -
    */ public ApiResponse> listLoanMarginTiersWithHttpInfo() throws ApiException { @@ -1959,7 +1959,7 @@ public ApiResponse> listLoanMarginTiersWithHttpInfo() t } /** - * List loan margin tiers (asynchronously) + * List loan margin tiers. (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1967,7 +1967,7 @@ public ApiResponse> listLoanMarginTiersWithHttpInfo() t * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public okhttp3.Call listLoanMarginTiersAsync(final ApiCallback> _callback) throws ApiException { @@ -1986,7 +1986,7 @@ public okhttp3.Call listLoanMarginTiersAsync(final ApiCallback Status Code Description Response Headers - 200 Successfully retrieved - + 200 Successfully retrieved. - */ public okhttp3.Call calculatePortfolioMarginCall(UnifiedPortfolioInput unifiedPortfolioInput, final ApiCallback _callback) throws ApiException { @@ -2030,15 +2030,15 @@ 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. + * Portfolio Margin Calculator When inputting a simulated position portfolio, each position includes the position name and quantity held, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. When inputting simulated orders, each order includes the market identifier, order price, and order of BTC and ETH perpetual contracts, options, and spot markets. Market orders are not included. * @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 Successfully retrieved. -
    */ public UnifiedPortfolioOutput calculatePortfolioMargin(UnifiedPortfolioInput unifiedPortfolioInput) throws ApiException { @@ -2047,15 +2047,15 @@ 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. + * Portfolio Margin Calculator When inputting a simulated position portfolio, each position includes the position name and quantity held, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. When inputting simulated orders, each order includes the market identifier, order price, and order of BTC and ETH perpetual contracts, options, and spot markets. Market orders are not included. * @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 Successfully retrieved. -
    */ public ApiResponse calculatePortfolioMarginWithHttpInfo(UnifiedPortfolioInput unifiedPortfolioInput) throws ApiException { @@ -2065,8 +2065,8 @@ 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. (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 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 @@ -2074,7 +2074,7 @@ public ApiResponse calculatePortfolioMarginWithHttpInfo( * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public okhttp3.Call calculatePortfolioMarginAsync(UnifiedPortfolioInput unifiedPortfolioInput, final ApiCallback _callback) throws ApiException { @@ -2086,14 +2086,14 @@ public okhttp3.Call calculatePortfolioMarginAsync(UnifiedPortfolioInput unifiedP /** * Build call for getUserLeverageCurrencyConfig - * @param currency Currency (required) + * @param currency 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 -
    200 Successfully retrieved. -
    */ public okhttp3.Call getUserLeverageCurrencyConfigCall(String currency, final ApiCallback _callback) throws ApiException { @@ -2141,15 +2141,15 @@ private okhttp3.Call getUserLeverageCurrencyConfigValidateBeforeCall(String curr } /** - * Minimum currency leverage that can be set + * Minimum currency leverage that can be set. * - * @param currency Currency (required) + * @param currency Currency. (required) * @return UnifiedLeverageConfig * @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 Successfully retrieved. -
    */ public UnifiedLeverageConfig getUserLeverageCurrencyConfig(String currency) throws ApiException { @@ -2158,15 +2158,15 @@ public UnifiedLeverageConfig getUserLeverageCurrencyConfig(String currency) thro } /** - * Minimum currency leverage that can be set + * Minimum currency leverage that can be set. * - * @param currency Currency (required) + * @param currency Currency. (required) * @return ApiResponse<UnifiedLeverageConfig> * @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 Successfully retrieved. -
    */ public ApiResponse getUserLeverageCurrencyConfigWithHttpInfo(String currency) throws ApiException { @@ -2176,16 +2176,16 @@ public ApiResponse getUserLeverageCurrencyConfigWithHttpI } /** - * Minimum currency leverage that can be set (asynchronously) + * Minimum currency leverage that can be set. (asynchronously) * - * @param currency Currency (required) + * @param currency 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 -
    200 Successfully retrieved. -
    */ public okhttp3.Call getUserLeverageCurrencyConfigAsync(String currency, final ApiCallback _callback) throws ApiException { @@ -2256,7 +2256,7 @@ private APIgetUserLeverageCurrencySettingRequest() { /** * Set currency - * @param currency Currency (optional) + * @param currency Currency. (optional) * @return APIgetUserLeverageCurrencySettingRequest */ public APIgetUserLeverageCurrencySettingRequest currency(String currency) { @@ -2272,7 +2272,7 @@ public APIgetUserLeverageCurrencySettingRequest currency(String currency) { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2286,7 +2286,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public UnifiedLeverageSetting execute() throws ApiException { @@ -2301,7 +2301,7 @@ public UnifiedLeverageSetting execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -2316,7 +2316,7 @@ public ApiResponse executeWithHttpInfo() throws ApiExcep * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -2325,13 +2325,13 @@ public okhttp3.Call executeAsync(final ApiCallback _call } /** - * Get the leverage multiple of the user currency + * Get the leverage multiple of the user currency. * Get the user's currency leverage. If currency is not passed, query all currencies. * @return APIgetUserLeverageCurrencySettingRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public APIgetUserLeverageCurrencySettingRequest getUserLeverageCurrencySetting() { @@ -2347,7 +2347,7 @@ public APIgetUserLeverageCurrencySettingRequest getUserLeverageCurrencySetting() * @http.response.details - +
    Status Code Description Response Headers
    204 Success -
    204 Success. -
    */ public okhttp3.Call setUserLeverageCurrencySettingCall(UnifiedLeverageSetting unifiedLeverageSetting, final ApiCallback _callback) throws ApiException { @@ -2391,14 +2391,14 @@ private okhttp3.Call setUserLeverageCurrencySettingValidateBeforeCall(UnifiedLev } /** - * Set the loan currency leverage + * Set the 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 Success. -
    */ public void setUserLeverageCurrencySetting(UnifiedLeverageSetting unifiedLeverageSetting) throws ApiException { @@ -2406,7 +2406,7 @@ public void setUserLeverageCurrencySetting(UnifiedLeverageSetting unifiedLeverag } /** - * Set the loan currency leverage + * Set the loan currency leverage. * * @param unifiedLeverageSetting (required) * @return ApiResponse<Void> @@ -2414,7 +2414,7 @@ public void setUserLeverageCurrencySetting(UnifiedLeverageSetting unifiedLeverag * @http.response.details - +
    Status Code Description Response Headers
    204 Success -
    204 Success. -
    */ public ApiResponse setUserLeverageCurrencySettingWithHttpInfo(UnifiedLeverageSetting unifiedLeverageSetting) throws ApiException { @@ -2423,7 +2423,7 @@ public ApiResponse setUserLeverageCurrencySettingWithHttpInfo(UnifiedLever } /** - * Set the loan currency leverage (asynchronously) + * Set the loan currency leverage. (asynchronously) * * @param unifiedLeverageSetting (required) * @param _callback The callback to be executed when the API call finishes @@ -2432,7 +2432,7 @@ public ApiResponse setUserLeverageCurrencySettingWithHttpInfo(UnifiedLever * @http.response.details - +
    Status Code Description Response Headers
    204 Success -
    204 Success. -
    */ public okhttp3.Call setUserLeverageCurrencySettingAsync(UnifiedLeverageSetting unifiedLeverageSetting, final ApiCallback _callback) throws ApiException { @@ -2502,7 +2502,7 @@ private APIlistUnifiedCurrenciesRequest() { /** * Set currency - * @param currency Currency (optional) + * @param currency Currency. (optional) * @return APIlistUnifiedCurrenciesRequest */ public APIlistUnifiedCurrenciesRequest currency(String currency) { @@ -2518,7 +2518,7 @@ public APIlistUnifiedCurrenciesRequest currency(String currency) { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2532,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. -
    */ public List execute() throws ApiException { @@ -2547,7 +2547,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -2562,7 +2562,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcept * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2571,13 +2571,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callb } /** - * List of loan currencies supported by unified account + * List of loan currencies supported by unified account. * * @return APIlistUnifiedCurrenciesRequest * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public APIlistUnifiedCurrenciesRequest listUnifiedCurrencies() { @@ -2666,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 The VIP level of the floating rate that needs to be queried. (optional) * @return APIgetHistoryLoanRateRequest */ public APIgetHistoryLoanRateRequest tier(String tier) { @@ -2676,7 +2676,7 @@ public APIgetHistoryLoanRateRequest tier(String tier) { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIgetHistoryLoanRateRequest */ public APIgetHistoryLoanRateRequest page(Integer page) { @@ -2686,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 response items. Default: 100, minimum: 1, Maximum: 100. (optional, default to 100) * @return APIgetHistoryLoanRateRequest */ public APIgetHistoryLoanRateRequest limit(Integer limit) { @@ -2702,7 +2702,7 @@ public APIgetHistoryLoanRateRequest limit(Integer limit) { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2716,7 +2716,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public UnifiedHistoryLoanRate execute() throws ApiException { @@ -2731,7 +2731,7 @@ public UnifiedHistoryLoanRate execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -2746,7 +2746,7 @@ public ApiResponse executeWithHttpInfo() throws ApiExcep * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -2755,14 +2755,14 @@ public okhttp3.Call executeAsync(final ApiCallback _call } /** - * get historical lending rates + * get historical lending rates. * - * @param currency Currency (required) + * @param currency Currency. (required) * @return APIgetHistoryLoanRateRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public APIgetHistoryLoanRateRequest getHistoryLoanRate(String currency) { @@ -2778,7 +2778,7 @@ public APIgetHistoryLoanRateRequest getHistoryLoanRate(String currency) { * @http.response.details - +
    Status Code Description Response Headers
    200 UpdateSuccess -
    200 UpdateSuccess. -
    */ public okhttp3.Call setUnifiedCollateralCall(UnifiedCollateralReq unifiedCollateralReq, final ApiCallback _callback) throws ApiException { @@ -2822,7 +2822,7 @@ private okhttp3.Call setUnifiedCollateralValidateBeforeCall(UnifiedCollateralReq } /** - * Set Collateral Currency + * Set Collateral Currency. * * @param unifiedCollateralReq (required) * @return UnifiedCollateralRes @@ -2830,7 +2830,7 @@ private okhttp3.Call setUnifiedCollateralValidateBeforeCall(UnifiedCollateralReq * @http.response.details - +
    Status Code Description Response Headers
    200 UpdateSuccess -
    200 UpdateSuccess. -
    */ public UnifiedCollateralRes setUnifiedCollateral(UnifiedCollateralReq unifiedCollateralReq) throws ApiException { @@ -2839,7 +2839,7 @@ public UnifiedCollateralRes setUnifiedCollateral(UnifiedCollateralReq unifiedCol } /** - * Set Collateral Currency + * Set Collateral Currency. * * @param unifiedCollateralReq (required) * @return ApiResponse<UnifiedCollateralRes> @@ -2847,7 +2847,7 @@ public UnifiedCollateralRes setUnifiedCollateral(UnifiedCollateralReq unifiedCol * @http.response.details - +
    Status Code Description Response Headers
    200 UpdateSuccess -
    200 UpdateSuccess. -
    */ public ApiResponse setUnifiedCollateralWithHttpInfo(UnifiedCollateralReq unifiedCollateralReq) throws ApiException { @@ -2857,7 +2857,7 @@ public ApiResponse setUnifiedCollateralWithHttpInfo(Unifie } /** - * Set Collateral Currency (asynchronously) + * Set Collateral Currency. (asynchronously) * * @param unifiedCollateralReq (required) * @param _callback The callback to be executed when the API call finishes @@ -2866,7 +2866,7 @@ public ApiResponse setUnifiedCollateralWithHttpInfo(Unifie * @http.response.details - +
    Status Code Description Response Headers
    200 UpdateSuccess -
    200 UpdateSuccess. -
    */ public okhttp3.Call setUnifiedCollateralAsync(UnifiedCollateralReq unifiedCollateralReq, final ApiCallback _callback) throws ApiException { diff --git a/src/main/java/io/gate/gateapi/api/WalletApi.java b/src/main/java/io/gate/gateapi/api/WalletApi.java index 2ffe939..5f9f0ce 100644 --- a/src/main/java/io/gate/gateapi/api/WalletApi.java +++ b/src/main/java/io/gate/gateapi/api/WalletApi.java @@ -70,14 +70,14 @@ public void setApiClient(ApiClient apiClient) { /** * Build call for listCurrencyChains - * @param currency Currency name (required) + * @param currency 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 Successfully retrieved. -
    */ public okhttp3.Call listCurrencyChainsCall(String currency, final ApiCallback _callback) throws ApiException { @@ -125,15 +125,15 @@ private okhttp3.Call listCurrencyChainsValidateBeforeCall(String currency, final } /** - * List chains supported for specified currency + * List chains supported for specified currency. * - * @param currency Currency name (required) + * @param currency Currency name. (required) * @return List<CurrencyChain> * @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 Successfully retrieved. -
    */ public List listCurrencyChains(String currency) throws ApiException { @@ -142,15 +142,15 @@ public List listCurrencyChains(String currency) throws ApiExcepti } /** - * List chains supported for specified currency + * List chains supported for specified currency. * - * @param currency Currency name (required) + * @param currency Currency name. (required) * @return ApiResponse<List<CurrencyChain>> * @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 Successfully retrieved. -
    */ public ApiResponse> listCurrencyChainsWithHttpInfo(String currency) throws ApiException { @@ -160,16 +160,16 @@ public ApiResponse> listCurrencyChainsWithHttpInfo(String cu } /** - * List chains supported for specified currency (asynchronously) + * List chains supported for specified currency. (asynchronously) * - * @param currency Currency name (required) + * @param currency 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 Successfully retrieved. -
    */ public okhttp3.Call listCurrencyChainsAsync(String currency, final ApiCallback> _callback) throws ApiException { @@ -181,14 +181,14 @@ public okhttp3.Call listCurrencyChainsAsync(String currency, final ApiCallback Status Code Description Response Headers - 200 Address successfully generated - + 200 Address successfully generated. - */ public okhttp3.Call getDepositAddressCall(String currency, final ApiCallback _callback) throws ApiException { @@ -236,15 +236,15 @@ private okhttp3.Call getDepositAddressValidateBeforeCall(String currency, final } /** - * Generate currency deposit address + * Generate currency deposit address. * - * @param currency Currency name (required) + * @param currency Currency name. (required) * @return DepositAddress * @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 Address successfully generated -
    200 Address successfully generated. -
    */ public DepositAddress getDepositAddress(String currency) throws ApiException { @@ -253,15 +253,15 @@ public DepositAddress getDepositAddress(String currency) throws ApiException { } /** - * Generate currency deposit address + * Generate currency deposit address. * - * @param currency Currency name (required) + * @param currency Currency name. (required) * @return ApiResponse<DepositAddress> * @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 Address successfully generated -
    200 Address successfully generated. -
    */ public ApiResponse getDepositAddressWithHttpInfo(String currency) throws ApiException { @@ -271,16 +271,16 @@ public ApiResponse getDepositAddressWithHttpInfo(String currency } /** - * Generate currency deposit address (asynchronously) + * Generate currency deposit address. (asynchronously) * - * @param currency Currency name (required) + * @param currency 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 Address successfully generated -
    200 Address successfully generated. -
    */ public okhttp3.Call getDepositAddressAsync(String currency, final ApiCallback _callback) throws ApiException { @@ -386,7 +386,7 @@ private APIlistWithdrawalsRequest() { /** * Set currency - * @param currency Filter by currency. Return all currency records if not specified (optional) + * @param currency Filter by currency. Return all currency records if not specified. (optional) * @return APIlistWithdrawalsRequest */ public APIlistWithdrawalsRequest currency(String currency) { @@ -426,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 Time range beginning, default to 7 days before current time. (optional) * @return APIlistWithdrawalsRequest */ public APIlistWithdrawalsRequest from(Long from) { @@ -436,7 +436,7 @@ public APIlistWithdrawalsRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to Time range ending, default to current time. (optional) * @return APIlistWithdrawalsRequest */ public APIlistWithdrawalsRequest to(Long to) { @@ -446,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 to be returned in a single list. (optional, default to 100) * @return APIlistWithdrawalsRequest */ public APIlistWithdrawalsRequest limit(Integer limit) { @@ -456,7 +456,7 @@ public APIlistWithdrawalsRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIlistWithdrawalsRequest */ public APIlistWithdrawalsRequest offset(Integer offset) { @@ -472,7 +472,7 @@ public APIlistWithdrawalsRequest offset(Integer offset) { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -486,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. -
    */ public List execute() throws ApiException { @@ -501,7 +501,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -516,7 +516,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcep * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -525,13 +525,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _call } /** - * Retrieve withdrawal records - * Record time range cannot exceed 30 days + * Retrieve withdrawal records. + * Record time range cannot exceed 30 days. * @return APIlistWithdrawalsRequest * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public APIlistWithdrawalsRequest listWithdrawals() { @@ -619,7 +619,7 @@ private APIlistDepositsRequest() { /** * Set currency - * @param currency Filter by currency. Return all currency records if not specified (optional) + * @param currency Filter by currency. Return all currency records if not specified. (optional) * @return APIlistDepositsRequest */ public APIlistDepositsRequest currency(String currency) { @@ -629,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 Time range beginning, default to 7 days before current time. (optional) * @return APIlistDepositsRequest */ public APIlistDepositsRequest from(Long from) { @@ -639,7 +639,7 @@ public APIlistDepositsRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to Time range ending, default to current time. (optional) * @return APIlistDepositsRequest */ public APIlistDepositsRequest to(Long to) { @@ -659,7 +659,7 @@ public APIlistDepositsRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIlistDepositsRequest */ public APIlistDepositsRequest offset(Integer offset) { @@ -675,7 +675,7 @@ public APIlistDepositsRequest offset(Integer offset) { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -689,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. -
    */ public List execute() throws ApiException { @@ -704,7 +704,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -719,7 +719,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExceptio * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -728,13 +728,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callbac } /** - * Retrieve deposit records - * Record time range cannot exceed 30 days + * Retrieve deposit records. + * Record time range cannot exceed 30 days. * @return APIlistDepositsRequest * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public APIlistDepositsRequest listDeposits() { @@ -750,7 +750,7 @@ public APIlistDepositsRequest listDeposits() { * @http.response.details - +
    Status Code Description Response Headers
    200 Balance transferred -
    200 Balance transferred. -
    */ public okhttp3.Call transferCall(Transfer transfer, final ApiCallback _callback) throws ApiException { @@ -794,15 +794,15 @@ 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 + * Transfer between trading accounts. + * Transfer between different accounts. Currently support transfers between the following: 1. spot - margin 2. spot - futures(perpetual) 3. options * @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 Balance transferred. -
    */ public TransactionID transfer(Transfer transfer) throws ApiException { @@ -811,15 +811,15 @@ 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 + * Transfer between trading accounts. + * Transfer between different accounts. Currently support transfers between the following: 1. spot - margin 2. spot - futures(perpetual) 3. options * @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 Balance transferred. -
    */ public ApiResponse transferWithHttpInfo(Transfer transfer) throws ApiException { @@ -829,8 +829,8 @@ 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 + * Transfer between trading accounts. (asynchronously) + * Transfer between different accounts. Currently support transfers between the following: 1. spot - margin 2. spot - futures(perpetual) 3. options * @param transfer (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -838,7 +838,7 @@ public ApiResponse transferWithHttpInfo(Transfer transfer) throws * @http.response.details - +
    Status Code Description Response Headers
    200 Balance transferred -
    200 Balance transferred. -
    */ public okhttp3.Call transferAsync(Transfer transfer, final ApiCallback _callback) throws ApiException { @@ -939,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 Time range beginning, default to 7 days before current time. (optional) * @return APIlistSubAccountTransfersRequest */ public APIlistSubAccountTransfersRequest from(Long from) { @@ -949,7 +949,7 @@ public APIlistSubAccountTransfersRequest from(Long from) { /** * Set to - * @param to Time range ending, default to current time (optional) + * @param to Time range ending, default to current time. (optional) * @return APIlistSubAccountTransfersRequest */ public APIlistSubAccountTransfersRequest to(Long to) { @@ -959,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 to be returned in a single list. (optional, default to 100) * @return APIlistSubAccountTransfersRequest */ public APIlistSubAccountTransfersRequest limit(Integer limit) { @@ -969,7 +969,7 @@ public APIlistSubAccountTransfersRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIlistSubAccountTransfersRequest */ public APIlistSubAccountTransfersRequest offset(Integer offset) { @@ -985,7 +985,7 @@ public APIlistSubAccountTransfersRequest offset(Integer offset) { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -999,7 +999,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public List execute() throws ApiException { @@ -1014,7 +1014,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1029,7 +1029,7 @@ public ApiResponse> executeWithHttpInfo() thr * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1038,13 +1038,13 @@ public okhttp3.Call executeAsync(final ApiCallback Status Code Description Response Headers - 200 List retrieved - + 200 List retrieved. - */ public APIlistSubAccountTransfersRequest listSubAccountTransfers() { @@ -1060,7 +1060,7 @@ public APIlistSubAccountTransfersRequest listSubAccountTransfers() { * @http.response.details - +
    Status Code Description Response Headers
    200 Balance transferred -
    200 Balance transferred. -
    */ public okhttp3.Call transferWithSubAccountCall(SubAccountTransfer subAccountTransfer, final ApiCallback _callback) throws ApiException { @@ -1104,7 +1104,7 @@ private okhttp3.Call transferWithSubAccountValidateBeforeCall(SubAccountTransfer } /** - * Transfer between main and sub accounts + * Transfer between main and sub accounts. * Support transferring with sub user's spot or futures account. Note that only main user's spot account is used no matter which sub user's account is operated. * @param subAccountTransfer (required) * @return TransactionID @@ -1112,7 +1112,7 @@ private okhttp3.Call transferWithSubAccountValidateBeforeCall(SubAccountTransfer * @http.response.details - +
    Status Code Description Response Headers
    200 Balance transferred -
    200 Balance transferred. -
    */ public TransactionID transferWithSubAccount(SubAccountTransfer subAccountTransfer) throws ApiException { @@ -1121,7 +1121,7 @@ public TransactionID transferWithSubAccount(SubAccountTransfer subAccountTransfe } /** - * Transfer between main and sub accounts + * Transfer between main and sub accounts. * Support transferring with sub user's spot or futures account. Note that only main user's spot account is used no matter which sub user's account is operated. * @param subAccountTransfer (required) * @return ApiResponse<TransactionID> @@ -1129,7 +1129,7 @@ public TransactionID transferWithSubAccount(SubAccountTransfer subAccountTransfe * @http.response.details - +
    Status Code Description Response Headers
    200 Balance transferred -
    200 Balance transferred. -
    */ public ApiResponse transferWithSubAccountWithHttpInfo(SubAccountTransfer subAccountTransfer) throws ApiException { @@ -1139,7 +1139,7 @@ public ApiResponse transferWithSubAccountWithHttpInfo(SubAccountT } /** - * Transfer between main and sub accounts (asynchronously) + * 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. * @param subAccountTransfer (required) * @param _callback The callback to be executed when the API call finishes @@ -1148,7 +1148,7 @@ public ApiResponse transferWithSubAccountWithHttpInfo(SubAccountT * @http.response.details - +
    Status Code Description Response Headers
    200 Balance transferred -
    200 Balance transferred. -
    */ public okhttp3.Call transferWithSubAccountAsync(SubAccountTransfer subAccountTransfer, final ApiCallback _callback) throws ApiException { @@ -1167,7 +1167,7 @@ public okhttp3.Call transferWithSubAccountAsync(SubAccountTransfer subAccountTra * @http.response.details - +
    Status Code Description Response Headers
    200 Balance transferred -
    200 Balance transferred. -
    */ public okhttp3.Call subAccountToSubAccountCall(SubAccountToSubAccount subAccountToSubAccount, final ApiCallback _callback) throws ApiException { @@ -1211,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. + * 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 sub-account to initiate the transfer. * @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 Balance transferred. -
    */ public TransactionID subAccountToSubAccount(SubAccountToSubAccount subAccountToSubAccount) throws ApiException { @@ -1228,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. + * 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 sub-account to initiate the transfer. * @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 Balance transferred. -
    */ public ApiResponse subAccountToSubAccountWithHttpInfo(SubAccountToSubAccount subAccountToSubAccount) throws ApiException { @@ -1246,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. + * 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 sub-account to initiate the transfer. * @param subAccountToSubAccount (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1255,7 +1255,7 @@ public ApiResponse subAccountToSubAccountWithHttpInfo(SubAccountT * @http.response.details - +
    Status Code Description Response Headers
    200 Balance transferred -
    200 Balance transferred. -
    */ public okhttp3.Call subAccountToSubAccountAsync(SubAccountToSubAccount subAccountToSubAccount, final ApiCallback _callback) throws ApiException { @@ -1357,7 +1357,7 @@ public APIgetTransferOrderStatusRequest txId(String txId) { * @http.response.details - +
    Status Code Description Response Headers
    200 Transfer status obtained successfully -
    200 Transfer status obtained successfully. -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1371,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 obtained successfully. -
    */ public TransferOrderStatus execute() throws ApiException { @@ -1386,7 +1386,7 @@ public TransferOrderStatus execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Transfer status obtained successfully -
    200 Transfer status obtained successfully. -
    */ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -1401,7 +1401,7 @@ public ApiResponse executeWithHttpInfo() throws ApiExceptio * @http.response.details - +
    Status Code Description Response Headers
    200 Transfer status obtained successfully -
    200 Transfer status obtained successfully. -
    */ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -1410,13 +1410,13 @@ public okhttp3.Call executeAsync(final ApiCallback _callbac } /** - * Transfer status query + * Transfer status query. * Support querying transfer status based on user-defined client_order_id or tx_id returned by the transfer interface * @return APIgetTransferOrderStatusRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Transfer status obtained successfully -
    200 Transfer status obtained successfully. -
    */ public APIgetTransferOrderStatusRequest getTransferOrderStatus() { @@ -1484,7 +1484,7 @@ private APIlistWithdrawStatusRequest() { /** * Set currency - * @param currency Retrieve data of the specified currency (optional) + * @param currency Retrieve data of the specified currency. (optional) * @return APIlistWithdrawStatusRequest */ public APIlistWithdrawStatusRequest currency(String currency) { @@ -1500,7 +1500,7 @@ public APIlistWithdrawStatusRequest currency(String currency) { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1514,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. -
    */ public List execute() throws ApiException { @@ -1529,7 +1529,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1544,7 +1544,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcepti * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1553,13 +1553,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callba } /** - * Retrieve withdrawal status + * Retrieve withdrawal status. * * @return APIlistWithdrawStatusRequest * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public APIlistWithdrawStatusRequest listWithdrawStatus() { @@ -1643,7 +1643,7 @@ public APIlistSubAccountBalancesRequest subUid(String subUid) { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1657,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. -
    */ public List execute() throws ApiException { @@ -1672,7 +1672,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1687,7 +1687,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExce * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1696,13 +1696,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _cal } /** - * Retrieve sub account balances + * Retrieve sub account balances. * * @return APIlistSubAccountBalancesRequest * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public APIlistSubAccountBalancesRequest listSubAccountBalances() { @@ -1786,7 +1786,7 @@ public APIlistSubAccountMarginBalancesRequest subUid(String subUid) { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1800,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. -
    */ public List execute() throws ApiException { @@ -1815,7 +1815,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1830,7 +1830,7 @@ public ApiResponse> executeWithHttpInfo() throws A * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1839,13 +1839,13 @@ public okhttp3.Call executeAsync(final ApiCallback } /** - * Query sub accounts' margin balances + * Query sub accounts' margin balances. * * @return APIlistSubAccountMarginBalancesRequest * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public APIlistSubAccountMarginBalancesRequest listSubAccountMarginBalances() { @@ -1928,7 +1928,7 @@ public APIlistSubAccountFuturesBalancesRequest subUid(String subUid) { /** * Set settle - * @param settle Query only balances of specified settle currency (optional) + * @param settle Query only balances of specified settle currency. (optional) * @return APIlistSubAccountFuturesBalancesRequest */ public APIlistSubAccountFuturesBalancesRequest settle(String settle) { @@ -1944,7 +1944,7 @@ public APIlistSubAccountFuturesBalancesRequest settle(String settle) { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -1958,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. -
    */ public List execute() throws ApiException { @@ -1973,7 +1973,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -1988,7 +1988,7 @@ public ApiResponse> executeWithHttpInfo() throws * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -1997,13 +1997,13 @@ public okhttp3.Call executeAsync(final ApiCallback Status Code Description Response Headers - 200 List retrieved - + 200 List retrieved. - */ public APIlistSubAccountFuturesBalancesRequest listSubAccountFuturesBalances() { @@ -2087,7 +2087,7 @@ public APIlistSubAccountCrossMarginBalancesRequest subUid(String subUid) { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2101,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. -
    */ public List execute() throws ApiException { @@ -2116,7 +2116,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -2131,7 +2131,7 @@ public ApiResponse> executeWithHttpInfo() thr * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2140,13 +2140,13 @@ public okhttp3.Call executeAsync(final ApiCallback Status Code Description Response Headers - 200 List retrieved - + 200 List retrieved. - */ public APIlistSubAccountCrossMarginBalancesRequest listSubAccountCrossMarginBalances() { @@ -2235,7 +2235,7 @@ private APIlistSavedAddressRequest(String currency) { /** * Set chain - * @param chain Chain name (optional, default to "") + * @param chain Chain name. (optional, default to "") * @return APIlistSavedAddressRequest */ public APIlistSavedAddressRequest chain(String chain) { @@ -2245,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, 100 at most. (optional, default to "50") * @return APIlistSavedAddressRequest */ public APIlistSavedAddressRequest limit(String limit) { @@ -2255,7 +2255,7 @@ public APIlistSavedAddressRequest limit(String limit) { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistSavedAddressRequest */ public APIlistSavedAddressRequest page(Integer page) { @@ -2271,7 +2271,7 @@ public APIlistSavedAddressRequest page(Integer page) { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2285,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. -
    */ public List execute() throws ApiException { @@ -2300,7 +2300,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -2315,7 +2315,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -2324,14 +2324,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * Query saved address + * Query saved address. * - * @param currency Currency (required) + * @param currency Currency. (required) * @return APIlistSavedAddressRequest * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved -
    200 List retrieved. -
    */ public APIlistSavedAddressRequest listSavedAddress(String currency) { @@ -2430,7 +2430,7 @@ public APIgetTradeFeeRequest settle(String settle) { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2444,7 +2444,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public TradeFee execute() throws ApiException { @@ -2459,7 +2459,7 @@ public TradeFee execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -2474,7 +2474,7 @@ public ApiResponse executeWithHttpInfo() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -2483,13 +2483,13 @@ public okhttp3.Call executeAsync(final ApiCallback _callback) throws A } /** - * Retrieve personal trading fee + * Retrieve personal trading fee. * * @return APIgetTradeFeeRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved -
    200 Successfully retrieved. -
    */ public APIgetTradeFeeRequest getTradeFee() { @@ -2573,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 is successfully responded. -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2587,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 is successfully responded. -
    */ public TotalBalance execute() throws ApiException { @@ -2602,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 is successfully responded. -
    */ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -2617,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 is successfully responded. -
    */ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -2626,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 + * 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` /futures/{settle}/accounts` to query futures account balance * @return APIgetTotalBalanceRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Request is valid and is successfully responded -
    200 Request is valid and is successfully responded. -
    */ public APIgetTotalBalanceRequest getTotalBalance() { @@ -2647,7 +2647,7 @@ public APIgetTotalBalanceRequest getTotalBalance() { * @http.response.details - +
    Status Code Description Response Headers
    200 Success -
    200 Success. -
    */ public okhttp3.Call listSmallBalanceCall(final ApiCallback _callback) throws ApiException { @@ -2686,14 +2686,14 @@ private okhttp3.Call listSmallBalanceValidateBeforeCall(final ApiCallback _callb } /** - * List small balance + * List small balance. * * @return List<SmallBalance> * @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 Success. -
    */ public List listSmallBalance() throws ApiException { @@ -2702,14 +2702,14 @@ public List listSmallBalance() throws ApiException { } /** - * List small balance + * List small balance. * * @return ApiResponse<List<SmallBalance>> * @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 Success. -
    */ public ApiResponse> listSmallBalanceWithHttpInfo() throws ApiException { @@ -2719,7 +2719,7 @@ public ApiResponse> listSmallBalanceWithHttpInfo() throws Api } /** - * List small balance (asynchronously) + * List small balance. (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -2727,7 +2727,7 @@ public ApiResponse> listSmallBalanceWithHttpInfo() throws Api * @http.response.details - +
    Status Code Description Response Headers
    200 Success -
    200 Success. -
    */ public okhttp3.Call listSmallBalanceAsync(final ApiCallback> _callback) throws ApiException { @@ -2746,7 +2746,7 @@ public okhttp3.Call listSmallBalanceAsync(final ApiCallback> * @http.response.details - +
    Status Code Description Response Headers
    200 Success -
    200 Success. -
    */ public okhttp3.Call convertSmallBalanceCall(ConvertSmallBalance convertSmallBalance, final ApiCallback _callback) throws ApiException { @@ -2790,14 +2790,14 @@ private okhttp3.Call convertSmallBalanceValidateBeforeCall(ConvertSmallBalance c } /** - * Convert small balance + * Convert small balance. * * @param convertSmallBalance (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 Success -
    200 Success. -
    */ public void convertSmallBalance(ConvertSmallBalance convertSmallBalance) throws ApiException { @@ -2805,7 +2805,7 @@ public void convertSmallBalance(ConvertSmallBalance convertSmallBalance) throws } /** - * Convert small balance + * Convert small balance. * * @param convertSmallBalance (required) * @return ApiResponse<Void> @@ -2813,7 +2813,7 @@ public void convertSmallBalance(ConvertSmallBalance convertSmallBalance) throws * @http.response.details - +
    Status Code Description Response Headers
    200 Success -
    200 Success. -
    */ public ApiResponse convertSmallBalanceWithHttpInfo(ConvertSmallBalance convertSmallBalance) throws ApiException { @@ -2822,7 +2822,7 @@ public ApiResponse convertSmallBalanceWithHttpInfo(ConvertSmallBalance con } /** - * Convert small balance (asynchronously) + * Convert small balance. (asynchronously) * * @param convertSmallBalance (required) * @param _callback The callback to be executed when the API call finishes @@ -2831,7 +2831,7 @@ public ApiResponse convertSmallBalanceWithHttpInfo(ConvertSmallBalance con * @http.response.details - +
    Status Code Description Response Headers
    200 Success -
    200 Success. -
    */ public okhttp3.Call convertSmallBalanceAsync(ConvertSmallBalance convertSmallBalance, final ApiCallback _callback) throws ApiException { @@ -2911,7 +2911,7 @@ private APIlistSmallBalanceHistoryRequest() { /** * Set currency - * @param currency Currency (optional) + * @param currency Currency. (optional) * @return APIlistSmallBalanceHistoryRequest */ public APIlistSmallBalanceHistoryRequest currency(String currency) { @@ -2921,7 +2921,7 @@ public APIlistSmallBalanceHistoryRequest currency(String currency) { /** * Set page - * @param page Page number (optional, default to 1) + * @param page Page number. (optional, default to 1) * @return APIlistSmallBalanceHistoryRequest */ public APIlistSmallBalanceHistoryRequest page(Integer page) { @@ -2931,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 response items. Default: 100, minimum: 1, Maximum: 100. (optional, default to 100) * @return APIlistSmallBalanceHistoryRequest */ public APIlistSmallBalanceHistoryRequest limit(Integer limit) { @@ -2947,7 +2947,7 @@ public APIlistSmallBalanceHistoryRequest limit(Integer limit) { * @http.response.details - +
    Status Code Description Response Headers
    200 Success -
    200 Success. -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2961,7 +2961,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Success -
    200 Success. -
    */ public List execute() throws ApiException { @@ -2976,7 +2976,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Success -
    200 Success. -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -2991,7 +2991,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiEx * @http.response.details - +
    Status Code Description Response Headers
    200 Success -
    200 Success. -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -3000,13 +3000,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _c } /** - * List small balance history + * List small balance history. * * @return APIlistSmallBalanceHistoryRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Success -
    200 Success. -
    */ public APIlistSmallBalanceHistoryRequest listSmallBalanceHistory() { @@ -3099,7 +3099,7 @@ private APIlistPushOrdersRequest() { /** * Set id - * @param id Order ID (optional) + * @param id Order ID. (optional) * @return APIlistPushOrdersRequest */ public APIlistPushOrdersRequest id(Integer id) { @@ -3129,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 The maximum number of items returned in the list, the default value is 100. (optional, default to 100) * @return APIlistPushOrdersRequest */ public APIlistPushOrdersRequest limit(Integer limit) { @@ -3139,7 +3139,7 @@ public APIlistPushOrdersRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0 (optional, default to 0) + * @param offset List offset, starting from 0. (optional, default to 0) * @return APIlistPushOrdersRequest */ public APIlistPushOrdersRequest offset(Integer offset) { @@ -3165,7 +3165,7 @@ public APIlistPushOrdersRequest transactionType(String transactionType) { * @http.response.details - +
    Status Code Description Response Headers
    200 Success -
    200 Success. -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -3179,7 +3179,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Success -
    200 Success. -
    */ public List execute() throws ApiException { @@ -3194,7 +3194,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Success -
    200 Success. -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -3209,7 +3209,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException * @http.response.details - +
    Status Code Description Response Headers
    200 Success -
    200 Success. -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -3218,13 +3218,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * Retrieve the UID transfer history + * Retrieve the UID transfer history. * * @return APIlistPushOrdersRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Success -
    200 Success. -
    */ public APIlistPushOrdersRequest listPushOrders() { diff --git a/src/main/java/io/gate/gateapi/api/WithdrawalApi.java b/src/main/java/io/gate/gateapi/api/WithdrawalApi.java index a2cd529..e99f287 100644 --- a/src/main/java/io/gate/gateapi/api/WithdrawalApi.java +++ b/src/main/java/io/gate/gateapi/api/WithdrawalApi.java @@ -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 Withdraw request is accepted. Refer to withdrawal records for status. -
    */ public okhttp3.Call withdrawCall(LedgerRecord ledgerRecord, final ApiCallback _callback) throws ApiException { @@ -102,7 +102,7 @@ private okhttp3.Call withdrawValidateBeforeCall(LedgerRecord ledgerRecord, final } /** - * Withdraw + * Withdraw. * Withdrawals to Gate addresses do not incur transaction fees. * @param ledgerRecord (required) * @return LedgerRecord @@ -110,7 +110,7 @@ private okhttp3.Call withdrawValidateBeforeCall(LedgerRecord ledgerRecord, final * @http.response.details - +
    Status Code Description Response Headers
    200 Withdraw request is accepted. Refer to withdrawal records for status -
    200 Withdraw request is accepted. Refer to withdrawal records for status. -
    */ public LedgerRecord withdraw(LedgerRecord ledgerRecord) throws ApiException { @@ -119,7 +119,7 @@ public LedgerRecord withdraw(LedgerRecord ledgerRecord) throws ApiException { } /** - * Withdraw + * Withdraw. * Withdrawals to Gate addresses do not incur transaction fees. * @param ledgerRecord (required) * @return ApiResponse<LedgerRecord> @@ -127,7 +127,7 @@ public LedgerRecord withdraw(LedgerRecord ledgerRecord) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Withdraw request is accepted. Refer to withdrawal records for status -
    200 Withdraw request is accepted. Refer to withdrawal records for status. -
    */ public ApiResponse withdrawWithHttpInfo(LedgerRecord ledgerRecord) throws ApiException { @@ -137,7 +137,7 @@ public ApiResponse withdrawWithHttpInfo(LedgerRecord ledgerRecord) } /** - * Withdraw (asynchronously) + * Withdraw. (asynchronously) * Withdrawals to Gate addresses do not incur transaction fees. * @param ledgerRecord (required) * @param _callback The callback to be executed when the API call finishes @@ -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 Withdraw request is accepted. Refer to withdrawal records for status. -
    */ public okhttp3.Call withdrawAsync(LedgerRecord ledgerRecord, final ApiCallback _callback) throws ApiException { @@ -209,7 +209,7 @@ private okhttp3.Call withdrawPushOrderValidateBeforeCall(UidPushWithdrawal uidPu } /** - * UID transfer + * UID transfer. * Transfers between main spot accounts are allowed; however, both parties cannot be sub-accounts * @param uidPushWithdrawal (required) * @return UidPushWithdrawalResp @@ -226,7 +226,7 @@ public UidPushWithdrawalResp withdrawPushOrder(UidPushWithdrawal uidPushWithdraw } /** - * UID transfer + * UID transfer. * Transfers between main spot accounts are allowed; however, both parties cannot be sub-accounts * @param uidPushWithdrawal (required) * @return ApiResponse<UidPushWithdrawalResp> @@ -244,7 +244,7 @@ public ApiResponse withdrawPushOrderWithHttpInfo(UidPushW } /** - * UID transfer (asynchronously) + * UID transfer. (asynchronously) * Transfers between main spot accounts are allowed; however, both parties cannot be sub-accounts * @param uidPushWithdrawal (required) * @param _callback The callback to be executed when the API call finishes @@ -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 accepted. Refer to record status for the cancellation result. -
    */ public okhttp3.Call cancelWithdrawalCall(String withdrawalId, final ApiCallback _callback) throws ApiException { @@ -317,7 +317,7 @@ private okhttp3.Call cancelWithdrawalValidateBeforeCall(String withdrawalId, fin } /** - * Cancel withdrawal with specified ID + * Cancel withdrawal with specified ID. * * @param withdrawalId (required) * @return LedgerRecord @@ -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 accepted. Refer to record status for the cancellation result. -
    */ public LedgerRecord cancelWithdrawal(String withdrawalId) throws ApiException { @@ -334,7 +334,7 @@ public LedgerRecord cancelWithdrawal(String withdrawalId) throws ApiException { } /** - * Cancel withdrawal with specified ID + * Cancel withdrawal with specified ID. * * @param withdrawalId (required) * @return ApiResponse<LedgerRecord> @@ -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 accepted. Refer to record status for the cancellation result. -
    */ public ApiResponse cancelWithdrawalWithHttpInfo(String withdrawalId) throws ApiException { @@ -352,7 +352,7 @@ public ApiResponse cancelWithdrawalWithHttpInfo(String withdrawalI } /** - * Cancel withdrawal with specified ID (asynchronously) + * Cancel withdrawal with specified ID. (asynchronously) * * @param withdrawalId (required) * @param _callback The callback to be executed when the API call finishes @@ -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 accepted. Refer to record status for the cancellation result. -
    */ public okhttp3.Call cancelWithdrawalAsync(String withdrawalId, final ApiCallback _callback) throws ApiException { diff --git a/src/main/java/io/gate/gateapi/models/AccountBalance.java b/src/main/java/io/gate/gateapi/models/AccountBalance.java index 0f91b26..e187ebb 100644 --- a/src/main/java/io/gate/gateapi/models/AccountBalance.java +++ b/src/main/java/io/gate/gateapi/models/AccountBalance.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Total balances calculated with specified currency unit + * Total balances calculated with specified currency unit. */ public class AccountBalance { public static final String SERIALIZED_NAME_AMOUNT = "amount"; @@ -28,7 +28,7 @@ public class AccountBalance { private String amount; /** - * Currency + * Currency. */ @JsonAdapter(CurrencyEnum.Adapter.class) public enum CurrencyEnum { @@ -98,7 +98,7 @@ public AccountBalance amount(String amount) { } /** - * Account total balance amount + * Account total balance amount. * @return amount **/ @javax.annotation.Nullable @@ -118,7 +118,7 @@ public AccountBalance currency(CurrencyEnum currency) { } /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -158,7 +158,7 @@ public AccountBalance borrowed(String borrowed) { } /** - * Borrowed，this field will only appear in margin and cross_margin accounts + * Borrowed，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 91022fc..08b9d6d 100644 --- a/src/main/java/io/gate/gateapi/models/AccountDetail.java +++ b/src/main/java/io/gate/gateapi/models/AccountDetail.java @@ -23,7 +23,7 @@ import java.util.List; /** - * Account detail + * Account detail. */ 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 + * CurrencyPair whitelisting. * @return currencyPairs **/ @javax.annotation.Nullable @@ -114,7 +114,7 @@ public AccountDetail userId(Long userId) { } /** - * User ID + * User ID. * @return userId **/ @javax.annotation.Nullable @@ -134,7 +134,7 @@ public AccountDetail tier(Long tier) { } /** - * User VIP level + * User VIP level. * @return tier **/ @javax.annotation.Nullable @@ -174,7 +174,7 @@ public AccountDetail copyTradingRole(Integer copyTradingRole) { } /** - * User role: 0 - Normal user 1 - Copy trading leader 2 - Copy trading follower 3 - Both leader and follower + * User role: 0 - Normal user, 1 - Copy trading leader, 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 4c72e55..782f2ef 100644 --- a/src/main/java/io/gate/gateapi/models/AccountDetailKey.java +++ b/src/main/java/io/gate/gateapi/models/AccountDetailKey.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * API Key detail + * API Key detail. */ 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 account 2 - portfolio margin account. * @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 dfd34b0..69eb21d 100644 --- a/src/main/java/io/gate/gateapi/models/AccountRateLimit.java +++ b/src/main/java/io/gate/gateapi/models/AccountRateLimit.java @@ -67,7 +67,7 @@ public AccountRateLimit ratio(String ratio) { } /** - * Transaction rate + * Transaction rate. * @return ratio **/ @javax.annotation.Nullable @@ -87,7 +87,7 @@ public AccountRateLimit mainRatio(String mainRatio) { } /** - * Total transaction ratio of main account + * Total transaction ratio of main account. * @return mainRatio **/ @javax.annotation.Nullable @@ -107,7 +107,7 @@ public AccountRateLimit updatedAt(String updatedAt) { } /** - * Update time + * Update time. * @return updatedAt **/ @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 c6094a7..116146c 100644 --- a/src/main/java/io/gate/gateapi/models/AgencyCommission.java +++ b/src/main/java/io/gate/gateapi/models/AgencyCommission.java @@ -55,7 +55,7 @@ public AgencyCommission commissionTime(Long commissionTime) { } /** - * Commission Time. (unix timestamp) + * Commission Time. (unix timestamp). * @return commissionTime **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public AgencyCommission userId(Long userId) { } /** - * User ID + * User ID. * @return userId **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public AgencyCommission groupName(String groupName) { } /** - * Group name + * Group name. * @return groupName **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public AgencyCommission commissionAmount(String commissionAmount) { } /** - * Commission Amount + * Commission Amount. * @return commissionAmount **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public AgencyCommission commissionAsset(String commissionAsset) { } /** - * Commission Asset + * Commission Asset. * @return commissionAsset **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public AgencyCommission source(String source) { } /** - * Source. SPOT - SPOT Rebate, FUTURES - Futures Rebate + * Source. SPOT - SPOT Rebate, FUTURES - Futures Rebate. * @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 15d9482..5e76786 100644 --- a/src/main/java/io/gate/gateapi/models/AgencyCommissionHistory.java +++ b/src/main/java/io/gate/gateapi/models/AgencyCommissionHistory.java @@ -46,7 +46,7 @@ public AgencyCommissionHistory currencyPair(String currencyPair) { } /** - * Currency pair + * Currency pair. * @return currencyPair **/ @javax.annotation.Nullable @@ -66,7 +66,7 @@ public AgencyCommissionHistory total(Long total) { } /** - * Total + * Total. * @return total **/ @javax.annotation.Nullable @@ -94,7 +94,7 @@ public AgencyCommissionHistory addListItem(AgencyCommission listItem) { } /** - * List of comission history + * List of comission 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 f1e1888..2758e5d 100644 --- a/src/main/java/io/gate/gateapi/models/AgencyTransaction.java +++ b/src/main/java/io/gate/gateapi/models/AgencyTransaction.java @@ -67,7 +67,7 @@ public AgencyTransaction transactionTime(Long transactionTime) { } /** - * Transaction Time. (unix timestamp) + * Transaction Time. (unix timestamp). * @return transactionTime **/ @javax.annotation.Nullable @@ -87,7 +87,7 @@ public AgencyTransaction userId(Long userId) { } /** - * User ID + * User ID. * @return userId **/ @javax.annotation.Nullable @@ -107,7 +107,7 @@ public AgencyTransaction groupName(String groupName) { } /** - * Group name + * Group name. * @return groupName **/ @javax.annotation.Nullable @@ -127,7 +127,7 @@ public AgencyTransaction fee(String fee) { } /** - * Fee + * Fee. * @return fee **/ @javax.annotation.Nullable @@ -147,7 +147,7 @@ public AgencyTransaction feeAsset(String feeAsset) { } /** - * Fee currency + * Fee currency. * @return feeAsset **/ @javax.annotation.Nullable @@ -167,7 +167,7 @@ public AgencyTransaction currencyPair(String currencyPair) { } /** - * Currency pair + * Currency pair. * @return currencyPair **/ @javax.annotation.Nullable @@ -187,7 +187,7 @@ public AgencyTransaction amount(String amount) { } /** - * Commission Amount + * Commission Amount. * @return amount **/ @javax.annotation.Nullable @@ -207,7 +207,7 @@ public AgencyTransaction amountAsset(String amountAsset) { } /** - * Commission Asset + * Commission Asset. * @return amountAsset **/ @javax.annotation.Nullable @@ -227,7 +227,7 @@ public AgencyTransaction source(String source) { } /** - * Source. SPOT - SPOT Rebate, FUTURES - Futures Rebate + * Source. SPOT - SPOT Rebate, FUTURES - Futures Rebate. * @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 bee288f..369c28b 100644 --- a/src/main/java/io/gate/gateapi/models/AgencyTransactionHistory.java +++ b/src/main/java/io/gate/gateapi/models/AgencyTransactionHistory.java @@ -46,7 +46,7 @@ public AgencyTransactionHistory currencyPair(String currencyPair) { } /** - * Currency pair + * Currency pair. * @return currencyPair **/ @javax.annotation.Nullable @@ -66,7 +66,7 @@ public AgencyTransactionHistory total(Long total) { } /** - * Total + * Total. * @return total **/ @javax.annotation.Nullable @@ -94,7 +94,7 @@ public AgencyTransactionHistory addListItem(AgencyTransaction listItem) { } /** - * List of transaction history + * List of transaction history. * @return list **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/AutoRepaySetting.java b/src/main/java/io/gate/gateapi/models/AutoRepaySetting.java index cfd3c18..eac5592 100644 --- a/src/main/java/io/gate/gateapi/models/AutoRepaySetting.java +++ b/src/main/java/io/gate/gateapi/models/AutoRepaySetting.java @@ -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 ca04bf5..cae11a1 100644 --- a/src/main/java/io/gate/gateapi/models/BatchAmendItem.java +++ b/src/main/java/io/gate/gateapi/models/BatchAmendItem.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Order information that needs to be modified + * Order information that needs to be modified. */ public class BatchAmendItem { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; @@ -78,7 +78,7 @@ public BatchAmendItem currencyPair(String currencyPair) { } /** - * Currency pair + * Currency pair. * @return currencyPair **/ public String getCurrencyPair() { @@ -157,7 +157,7 @@ public BatchAmendItem amendText(String amendText) { } /** - * Custom info during amending order + * Custom info during amending order. * @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 d81e470..69a94fc 100644 --- a/src/main/java/io/gate/gateapi/models/BatchAmendOrderReq.java +++ b/src/main/java/io/gate/gateapi/models/BatchAmendOrderReq.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Modify contract order parameters + * Modify contract order parameters. */ public class BatchAmendOrderReq { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; @@ -51,7 +51,7 @@ public BatchAmendOrderReq orderId(Long orderId) { } /** - * Order id, order_id and text must contain at least one + * Order id, order_id and text must contain at least one. * @return orderId **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public BatchAmendOrderReq text(String text) { } /** - * User-defined order text, at least one of order_id and text must be passed + * User-defined order text, at least one of order_id and text must be passed. * @return text **/ @javax.annotation.Nullable @@ -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. + * The new order size, including the executed order size. - If it is less than or equal to the executed quantity, the order will be cancelled. - The new order direction must be consistent with the original one. - The size of the closing order cannot be modified. - For orders that only reduce positions, if the size is increased, positions may be kicked out. - If the price is not modified, reducing the size will not affect the depth of the queue, and increasing the size will place it at the end of the current price. * @return size **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public BatchAmendOrderReq amendText(String amendText) { } /** - * Custom info during amending order + * Custom info during amending order. * @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 4b829f1..fbabc3c 100644 --- a/src/main/java/io/gate/gateapi/models/BatchFuturesOrder.java +++ b/src/main/java/io/gate/gateapi/models/BatchFuturesOrder.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Futures order details + * Futures order details. */ public class BatchFuturesOrder { public static final String SERIALIZED_NAME_SUCCEEDED = "succeeded"; @@ -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 - 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 */ @JsonAdapter(FinishAsEnum.Adapter.class) public enum FinishAsEnum { @@ -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 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 { @@ -400,7 +400,7 @@ public BatchFuturesOrder succeeded(Boolean succeeded) { } /** - * Whether the batch of orders succeeded + * Whether the batch of orders succeeded. * @return succeeded **/ @javax.annotation.Nullable @@ -420,7 +420,7 @@ public BatchFuturesOrder label(String label) { } /** - * Error label, only exists if execution fails + * Error label, only exists if execution fails. * @return label **/ @javax.annotation.Nullable @@ -454,7 +454,7 @@ public void setDetail(String detail) { } /** - * Futures order ID + * Futures order ID. * @return id **/ @javax.annotation.Nullable @@ -464,7 +464,7 @@ public Long getId() { /** - * User ID + * User ID. * @return user **/ @javax.annotation.Nullable @@ -474,7 +474,7 @@ public Integer getUser() { /** - * Creation time of order + * Creation time of order. * @return createTime **/ @javax.annotation.Nullable @@ -484,7 +484,7 @@ public Double getCreateTime() { /** - * Order finished time. Not returned if order is open + * Order finished time. Not returned if order is open. * @return finishTime **/ @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 - 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 * @return finishAs **/ @javax.annotation.Nullable @@ -520,7 +520,7 @@ public BatchFuturesOrder contract(String contract) { } /** - * Futures contract + * Futures contract. * @return contract **/ @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. 0 for market order with `tif` set as `ioc`. * @return price **/ @javax.annotation.Nullable @@ -600,7 +600,7 @@ public BatchFuturesOrder close(Boolean close) { } /** - * Set as `true` to close the position, with `size` set to 0 + * Set as `true` to close the position, with `size` set to 0. * @return close **/ @javax.annotation.Nullable @@ -614,7 +614,7 @@ public void setClose(Boolean close) { } /** - * Is the order to close position + * Is the order to close position. * @return isClose **/ @javax.annotation.Nullable @@ -630,7 +630,7 @@ public BatchFuturesOrder reduceOnly(Boolean reduceOnly) { } /** - * Set as `true` to be reduce-only order + * Set as `true` to be reduce-only order. * @return reduceOnly **/ @javax.annotation.Nullable @@ -644,7 +644,7 @@ public void setReduceOnly(Boolean reduceOnly) { } /** - * Is the order reduce-only + * Is the order reduce-only. * @return isReduceOnly **/ @javax.annotation.Nullable @@ -654,7 +654,7 @@ public Boolean getIsReduceOnly() { /** - * Is the order for liquidation + * Is the order for liquidation. * @return isLiq **/ @javax.annotation.Nullable @@ -684,7 +684,7 @@ public void setTif(TifEnum tif) { } /** - * Size left to be traded + * Size left to be traded. * @return left **/ @javax.annotation.Nullable @@ -694,7 +694,7 @@ public Long getLeft() { /** - * Fill price of the order + * Fill price of the order. * @return fillPrice **/ @javax.annotation.Nullable @@ -724,7 +724,7 @@ public void setText(String text) { } /** - * Taker fee + * Taker fee. * @return tkfr **/ @javax.annotation.Nullable @@ -734,7 +734,7 @@ public String getTkfr() { /** - * Maker fee + * Maker fee. * @return mkfr **/ @javax.annotation.Nullable @@ -744,7 +744,7 @@ public String getMkfr() { /** - * Reference user ID + * Reference 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 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/BatchOrder.java b/src/main/java/io/gate/gateapi/models/BatchOrder.java index 2024a74..c693ca7 100644 --- a/src/main/java/io/gate/gateapi/models/BatchOrder.java +++ b/src/main/java/io/gate/gateapi/models/BatchOrder.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Batch order details + * Batch order details. */ public class BatchOrder { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; @@ -231,7 +231,7 @@ public AccountEnum read(final JsonReader jsonReader) throws IOException { private AccountEnum account = AccountEnum.SPOT; /** - * Buy or sell order + * 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 { @@ -528,7 +528,7 @@ public BatchOrder orderId(String orderId) { } /** - * Order ID + * Order ID. * @return orderId **/ @javax.annotation.Nullable @@ -548,7 +548,7 @@ public BatchOrder amendText(String amendText) { } /** - * The custom data that the user remarked when amending the order + * The custom data that the user remarked when amending the order. * @return amendText **/ @javax.annotation.Nullable @@ -588,7 +588,7 @@ public BatchOrder succeeded(Boolean succeeded) { } /** - * Whether the batch of orders succeeded + * Whether the batch of orders succeeded. * @return succeeded **/ @javax.annotation.Nullable @@ -608,7 +608,7 @@ public BatchOrder label(String label) { } /** - * Error label, if any, otherwise an empty string + * Error label, if any, otherwise an empty string. * @return label **/ @javax.annotation.Nullable @@ -628,7 +628,7 @@ public BatchOrder message(String message) { } /** - * Detailed error message, if any, otherwise an empty string + * Detailed error message, if any, otherwise an empty string. * @return message **/ @javax.annotation.Nullable @@ -642,7 +642,7 @@ public void setMessage(String message) { } /** - * Order ID + * Order ID. * @return id **/ @javax.annotation.Nullable @@ -652,7 +652,7 @@ public String getId() { /** - * Creation time of order + * Creation time of order. * @return createTime **/ @javax.annotation.Nullable @@ -662,7 +662,7 @@ public String getCreateTime() { /** - * Last modification time of order + * Last modification time of order. * @return updateTime **/ @javax.annotation.Nullable @@ -672,7 +672,7 @@ public String getUpdateTime() { /** - * Creation time of order (in milliseconds) + * Creation time of order (in milliseconds). * @return createTimeMs **/ @javax.annotation.Nullable @@ -682,7 +682,7 @@ public Long getCreateTimeMs() { /** - * Last modification time of order (in milliseconds) + * Last modification time of order (in milliseconds). * @return updateTimeMs **/ @javax.annotation.Nullable @@ -708,7 +708,7 @@ public BatchOrder currencyPair(String currencyPair) { } /** - * Currency pair + * Currency pair. * @return currencyPair **/ @javax.annotation.Nullable @@ -768,7 +768,7 @@ public BatchOrder side(SideEnum side) { } /** - * Buy or sell order + * Buy or sell order. * @return side **/ @javax.annotation.Nullable @@ -788,7 +788,7 @@ public BatchOrder amount(String amount) { } /** - * Trade amount + * Trade amount. * @return amount **/ @javax.annotation.Nullable @@ -808,7 +808,7 @@ public BatchOrder price(String price) { } /** - * Order price + * Order price. * @return price **/ @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 @@ -902,7 +902,7 @@ public void setAutoRepay(Boolean autoRepay) { } /** - * Amount left to fill + * Amount left to fill. * @return left **/ @javax.annotation.Nullable @@ -912,7 +912,7 @@ public String getLeft() { /** - * Amount traded to fill + * Amount traded to fill. * @return filledAmount **/ @javax.annotation.Nullable @@ -922,7 +922,7 @@ public String getFilledAmount() { /** - * Total filled in quote currency. Deprecated in favor of `filled_total` + * Total filled in quote currency. Deprecated in favor of `filled_total`. * @return fillPrice **/ @javax.annotation.Nullable @@ -932,7 +932,7 @@ public String getFillPrice() { /** - * Total filled in quote currency + * Total filled in quote currency. * @return filledTotal **/ @javax.annotation.Nullable @@ -942,7 +942,7 @@ public String getFilledTotal() { /** - * Average fill price + * Average fill price. * @return avgDealPrice **/ @javax.annotation.Nullable @@ -952,7 +952,7 @@ public String getAvgDealPrice() { /** - * Fee deducted + * Fee deducted. * @return fee **/ @javax.annotation.Nullable @@ -962,7 +962,7 @@ public String getFee() { /** - * Fee currency unit + * Fee currency unit. * @return feeCurrency **/ @javax.annotation.Nullable @@ -972,7 +972,7 @@ public String getFeeCurrency() { /** - * Points used to deduct fee + * Points used to deduct fee. * @return pointFee **/ @javax.annotation.Nullable @@ -982,7 +982,7 @@ public String getPointFee() { /** - * GT used to deduct fee + * GT used to deduct fee. * @return gtFee **/ @javax.annotation.Nullable @@ -992,7 +992,7 @@ public String getGtFee() { /** - * Whether GT fee discount is used + * Whether GT fee discount is used. * @return gtDiscount **/ @javax.annotation.Nullable @@ -1002,7 +1002,7 @@ public Boolean getGtDiscount() { /** - * Rebated fee + * Rebated fee. * @return rebatedFee **/ @javax.annotation.Nullable @@ -1012,7 +1012,7 @@ public String getRebatedFee() { /** - * Rebated fee currency unit + * Rebated fee currency unit. * @return rebatedFeeCurrency **/ @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 fb0666b..658a472 100644 --- a/src/main/java/io/gate/gateapi/models/BorrowCurrencyInfo.java +++ b/src/main/java/io/gate/gateapi/models/BorrowCurrencyInfo.java @@ -51,7 +51,7 @@ public BorrowCurrencyInfo currency(String currency) { } /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public BorrowCurrencyInfo indexPrice(String indexPrice) { } /** - * Currency Index Price + * Currency Index Price. * @return indexPrice **/ @javax.annotation.Nullable @@ -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 + * Value of left total repayments amount in 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 df596e3..90cd46d 100644 --- a/src/main/java/io/gate/gateapi/models/BrokerCommission.java +++ b/src/main/java/io/gate/gateapi/models/BrokerCommission.java @@ -42,7 +42,7 @@ public BrokerCommission total(Long total) { } /** - * Total + * Total. * @return total **/ @javax.annotation.Nullable @@ -70,7 +70,7 @@ public BrokerCommission addListItem(BrokerCommission1 listItem) { } /** - * List of comission history + * List of comission 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 bb61773..1448f51 100644 --- a/src/main/java/io/gate/gateapi/models/BrokerCommission1.java +++ b/src/main/java/io/gate/gateapi/models/BrokerCommission1.java @@ -64,6 +64,10 @@ public class BrokerCommission1 { @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) { @@ -72,7 +76,7 @@ public BrokerCommission1 commissionTime(Long commissionTime) { } /** - * Commission Time. (unix timestamp) + * Commission Time. (unix timestamp). * @return commissionTime **/ @javax.annotation.Nullable @@ -92,7 +96,7 @@ public BrokerCommission1 userId(Long userId) { } /** - * User ID + * User ID. * @return userId **/ @javax.annotation.Nullable @@ -112,7 +116,7 @@ public BrokerCommission1 groupName(String groupName) { } /** - * Group name + * Group name. * @return groupName **/ @javax.annotation.Nullable @@ -132,7 +136,7 @@ public BrokerCommission1 amount(String amount) { } /** - * The amount of commission rebates + * The amount of commission rebates. * @return amount **/ @javax.annotation.Nullable @@ -152,7 +156,7 @@ public BrokerCommission1 fee(String fee) { } /** - * Fee + * Fee. * @return fee **/ @javax.annotation.Nullable @@ -172,7 +176,7 @@ public BrokerCommission1 feeAsset(String feeAsset) { } /** - * Fee currency + * Fee currency. * @return feeAsset **/ @javax.annotation.Nullable @@ -192,7 +196,7 @@ public BrokerCommission1 rebateFee(String rebateFee) { } /** - * The income from rebates, converted to USDT + * The income from rebates, converted to USDT. * @return rebateFee **/ @javax.annotation.Nullable @@ -212,7 +216,7 @@ public BrokerCommission1 source(String source) { } /** - * Rebate Type: Spot、Futures、Options + * Rebate Type: Spot、Futures、Options.、Alpha * @return source **/ @javax.annotation.Nullable @@ -232,7 +236,7 @@ public BrokerCommission1 currencyPair(String currencyPair) { } /** - * Currency pair + * Currency pair. * @return currencyPair **/ @javax.annotation.Nullable @@ -264,6 +268,26 @@ public BrokerCommissionSubBrokerInfo getSubBrokerInfo() { public void setSubBrokerInfo(BrokerCommissionSubBrokerInfo subBrokerInfo) { this.subBrokerInfo = subBrokerInfo; } + + public BrokerCommission1 alphaContractAddr(String alphaContractAddr) { + + this.alphaContractAddr = alphaContractAddr; + return this; + } + + /** + * Alpha token 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) { @@ -282,12 +306,13 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.rebateFee, brokerCommission1.rebateFee) && Objects.equals(this.source, brokerCommission1.source) && Objects.equals(this.currencyPair, brokerCommission1.currencyPair) && - Objects.equals(this.subBrokerInfo, brokerCommission1.subBrokerInfo); + 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, subBrokerInfo); + return Objects.hash(commissionTime, userId, groupName, amount, fee, feeAsset, rebateFee, source, currencyPair, subBrokerInfo, alphaContractAddr); } @@ -305,6 +330,7 @@ public String toString() { 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 index aa2068f..b2ee074 100644 --- a/src/main/java/io/gate/gateapi/models/BrokerCommissionSubBrokerInfo.java +++ b/src/main/java/io/gate/gateapi/models/BrokerCommissionSubBrokerInfo.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * The sub broker info + * The sub broker info. */ public class BrokerCommissionSubBrokerInfo { public static final String SERIALIZED_NAME_USER_ID = "user_id"; @@ -47,7 +47,7 @@ public BrokerCommissionSubBrokerInfo userId(Long userId) { } /** - * The sub broker user ID + * The sub broker user ID. * @return userId **/ @javax.annotation.Nullable @@ -67,7 +67,7 @@ public BrokerCommissionSubBrokerInfo originalCommissionRate(String originalCommi } /** - * The sub broker original commission rate + * The sub broker original commission rate. * @return originalCommissionRate **/ @javax.annotation.Nullable @@ -87,7 +87,7 @@ public BrokerCommissionSubBrokerInfo relativeCommissionRate(String relativeCommi } /** - * The sub broker relative commission rate + * The sub broker relative commission rate. * @return relativeCommissionRate **/ @javax.annotation.Nullable @@ -107,7 +107,7 @@ public BrokerCommissionSubBrokerInfo commissionRate(String commissionRate) { } /** - * The sub broker actual commission rate + * The sub broker actual commission rate. * @return commissionRate **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/BrokerTransaction.java b/src/main/java/io/gate/gateapi/models/BrokerTransaction.java index 3832d56..dd5d82f 100644 --- a/src/main/java/io/gate/gateapi/models/BrokerTransaction.java +++ b/src/main/java/io/gate/gateapi/models/BrokerTransaction.java @@ -42,7 +42,7 @@ public BrokerTransaction total(Long total) { } /** - * Total + * Total. * @return total **/ @javax.annotation.Nullable @@ -70,7 +70,7 @@ public BrokerTransaction addListItem(BrokerTransaction1 listItem) { } /** - * List of transaction history + * List of transaction history. * @return list **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/BrokerTransaction1.java b/src/main/java/io/gate/gateapi/models/BrokerTransaction1.java index 130e5d5..8216825 100644 --- a/src/main/java/io/gate/gateapi/models/BrokerTransaction1.java +++ b/src/main/java/io/gate/gateapi/models/BrokerTransaction1.java @@ -60,6 +60,10 @@ public class BrokerTransaction1 { @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) { @@ -68,7 +72,7 @@ public BrokerTransaction1 transactionTime(Long transactionTime) { } /** - * Transaction Time. (unix timestamp) + * Transaction Time. (unix timestamp). * @return transactionTime **/ @javax.annotation.Nullable @@ -88,7 +92,7 @@ public BrokerTransaction1 userId(Long userId) { } /** - * User ID + * User ID. * @return userId **/ @javax.annotation.Nullable @@ -108,7 +112,7 @@ public BrokerTransaction1 groupName(String groupName) { } /** - * Group name + * Group name. * @return groupName **/ @javax.annotation.Nullable @@ -128,7 +132,7 @@ public BrokerTransaction1 fee(String fee) { } /** - * fee (usdt) + * fee (usdt). * @return fee **/ @javax.annotation.Nullable @@ -148,7 +152,7 @@ public BrokerTransaction1 currencyPair(String currencyPair) { } /** - * Currency pair + * Currency pair. * @return currencyPair **/ @javax.annotation.Nullable @@ -168,7 +172,7 @@ public BrokerTransaction1 amount(String amount) { } /** - * Commission Amount + * Commission Amount. * @return amount **/ @javax.annotation.Nullable @@ -188,7 +192,7 @@ public BrokerTransaction1 feeAsset(String feeAsset) { } /** - * Fee currency + * Fee currency. * @return feeAsset **/ @javax.annotation.Nullable @@ -208,7 +212,7 @@ public BrokerTransaction1 source(String source) { } /** - * Rebate Type: Spot、Futures、Options + * Rebate Type: Spot、Futures、Options.、Alpha * @return source **/ @javax.annotation.Nullable @@ -240,6 +244,26 @@ public BrokerCommissionSubBrokerInfo getSubBrokerInfo() { public void setSubBrokerInfo(BrokerCommissionSubBrokerInfo subBrokerInfo) { this.subBrokerInfo = subBrokerInfo; } + + public BrokerTransaction1 alphaContractAddr(String alphaContractAddr) { + + this.alphaContractAddr = alphaContractAddr; + return this; + } + + /** + * Alpha token 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) { @@ -257,12 +281,13 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.amount, brokerTransaction1.amount) && Objects.equals(this.feeAsset, brokerTransaction1.feeAsset) && Objects.equals(this.source, brokerTransaction1.source) && - Objects.equals(this.subBrokerInfo, brokerTransaction1.subBrokerInfo); + 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, subBrokerInfo); + return Objects.hash(transactionTime, userId, groupName, fee, currencyPair, amount, feeAsset, source, subBrokerInfo, alphaContractAddr); } @@ -279,6 +304,7 @@ public String toString() { 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 9b5249a..c781e8a 100644 --- a/src/main/java/io/gate/gateapi/models/CancelBatchOrder.java +++ b/src/main/java/io/gate/gateapi/models/CancelBatchOrder.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Info of order to be cancelled + * Info of order to be cancelled. */ public class CancelBatchOrder { public static final String SERIALIZED_NAME_CURRENCY_PAIR = "currency_pair"; @@ -47,7 +47,7 @@ public CancelBatchOrder currencyPair(String currencyPair) { } /** - * Order currency pair + * Order currency pair. * @return currencyPair **/ public String getCurrencyPair() { diff --git a/src/main/java/io/gate/gateapi/models/CancelOrderResult.java b/src/main/java/io/gate/gateapi/models/CancelOrderResult.java index 4d5c1cf..6f5c922 100644 --- a/src/main/java/io/gate/gateapi/models/CancelOrderResult.java +++ b/src/main/java/io/gate/gateapi/models/CancelOrderResult.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Order cancellation result + * Order cancellation result. */ public class CancelOrderResult { public static final String SERIALIZED_NAME_CURRENCY_PAIR = "currency_pair"; @@ -59,7 +59,7 @@ public CancelOrderResult currencyPair(String currencyPair) { } /** - * Order currency pair + * Order currency pair. * @return currencyPair **/ @javax.annotation.Nullable @@ -79,7 +79,7 @@ public CancelOrderResult id(String id) { } /** - * Order ID + * Order ID. * @return id **/ @javax.annotation.Nullable @@ -99,7 +99,7 @@ public CancelOrderResult text(String text) { } /** - * Custom order information + * Custom order information. * @return text **/ @javax.annotation.Nullable @@ -119,7 +119,7 @@ public CancelOrderResult succeeded(Boolean succeeded) { } /** - * Whether cancellation succeeded + * Whether cancellation succeeded. * @return succeeded **/ @javax.annotation.Nullable @@ -139,7 +139,7 @@ public CancelOrderResult label(String label) { } /** - * Error label when failed to cancel the order; emtpy if succeeded + * Error label when failed to cancel the order; emtpy if succeeded. * @return label **/ @javax.annotation.Nullable @@ -159,7 +159,7 @@ public CancelOrderResult message(String message) { } /** - * Error message when failed to cancel the order; empty if succeeded + * Error message when failed to cancel the order; empty if succeeded. * @return message **/ @javax.annotation.Nullable @@ -179,7 +179,7 @@ public CancelOrderResult account(String account) { } /** - * Default is empty (deprecated) + * Default is empty (deprecated). * @return account **/ @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 0379a7b..a2c0246 100644 --- a/src/main/java/io/gate/gateapi/models/CollateralAdjust.java +++ b/src/main/java/io/gate/gateapi/models/CollateralAdjust.java @@ -46,7 +46,7 @@ public CollateralAdjust orderId(Long orderId) { } /** - * Order ID + * Order ID. * @return orderId **/ public Long getOrderId() { @@ -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 66e547f..6d071c8 100644 --- a/src/main/java/io/gate/gateapi/models/CollateralAdjustRes.java +++ b/src/main/java/io/gate/gateapi/models/CollateralAdjustRes.java @@ -23,7 +23,7 @@ import java.util.List; /** - * Result of multi-collateral adjustment + * Result of multi-collateral adjustment. */ public class CollateralAdjustRes { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; @@ -42,7 +42,7 @@ public CollateralAdjustRes orderId(Long orderId) { } /** - * Order ID + * Order ID. * @return orderId **/ @javax.annotation.Nullable @@ -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 dd45664..26a51df 100644 --- a/src/main/java/io/gate/gateapi/models/CollateralAlign.java +++ b/src/main/java/io/gate/gateapi/models/CollateralAlign.java @@ -47,7 +47,7 @@ public CollateralAlign orderId(Long orderId) { } /** - * Order ID + * Order ID. * @return orderId **/ public Long getOrderId() { @@ -66,7 +66,7 @@ public CollateralAlign collateralCurrency(String collateralCurrency) { } /** - * Collateral + * Collateral. * @return collateralCurrency **/ public String getCollateralCurrency() { @@ -85,7 +85,7 @@ public CollateralAlign collateralAmount(String collateralAmount) { } /** - * Collateral amount + * Collateral amount. * @return collateralAmount **/ public String getCollateralAmount() { diff --git a/src/main/java/io/gate/gateapi/models/CollateralCurrency.java b/src/main/java/io/gate/gateapi/models/CollateralCurrency.java index b5cacc9..6151f12 100644 --- a/src/main/java/io/gate/gateapi/models/CollateralCurrency.java +++ b/src/main/java/io/gate/gateapi/models/CollateralCurrency.java @@ -39,7 +39,7 @@ public CollateralCurrency currency(String currency) { } /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public CollateralCurrency amount(String amount) { } /** - * Size + * Size. * @return amount **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CollateralCurrencyInfo.java b/src/main/java/io/gate/gateapi/models/CollateralCurrencyInfo.java index 8665cee..5a4878b 100644 --- a/src/main/java/io/gate/gateapi/models/CollateralCurrencyInfo.java +++ b/src/main/java/io/gate/gateapi/models/CollateralCurrencyInfo.java @@ -47,7 +47,7 @@ public CollateralCurrencyInfo currency(String currency) { } /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -67,7 +67,7 @@ public CollateralCurrencyInfo indexPrice(String indexPrice) { } /** - * Currency Index Price + * Currency Index Price. * @return indexPrice **/ @javax.annotation.Nullable @@ -87,7 +87,7 @@ public CollateralCurrencyInfo leftCollateral(String leftCollateral) { } /** - * Left Collateral Amount + * Left Collateral Amount. * @return leftCollateral **/ @javax.annotation.Nullable @@ -107,7 +107,7 @@ public CollateralCurrencyInfo leftCollateralUsdt(String leftCollateralUsdt) { } /** - * Value of left collateral amount in USDT + * Value of left collateral amount in 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 3bf4a34..6ac6830 100644 --- a/src/main/java/io/gate/gateapi/models/CollateralCurrencyRes.java +++ b/src/main/java/io/gate/gateapi/models/CollateralCurrencyRes.java @@ -51,7 +51,7 @@ public CollateralCurrencyRes succeeded(Boolean succeeded) { } /** - * Update success status + * Update success status. * @return succeeded **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public CollateralCurrencyRes currency(String currency) { } /** - * Currency + * Currency. * @return currency **/ @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 99356fb..1508a7f 100644 --- a/src/main/java/io/gate/gateapi/models/CollateralCurrentRate.java +++ b/src/main/java/io/gate/gateapi/models/CollateralCurrentRate.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Multi-currency pledge current interest rate + * Multi-currency pledge current interest rate. */ public class CollateralCurrentRate { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -39,7 +39,7 @@ public CollateralCurrentRate currency(String currency) { } /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public CollateralCurrentRate currentRate(String currentRate) { } /** - * Currency current interest rate + * Currency current interest rate. * @return currentRate **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CollateralFixRate.java b/src/main/java/io/gate/gateapi/models/CollateralFixRate.java index e0f725f..6e9c923 100644 --- a/src/main/java/io/gate/gateapi/models/CollateralFixRate.java +++ b/src/main/java/io/gate/gateapi/models/CollateralFixRate.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Multi-collateral fixed interest rate + * Multi-collateral fixed interest rate. */ public class CollateralFixRate { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -47,7 +47,7 @@ public CollateralFixRate currency(String currency) { } /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -67,7 +67,7 @@ public CollateralFixRate rate7d(String rate7d) { } /** - * Fixed interest rate for a lending period of 7 days + * Fixed interest rate for a lending period of 7 days. * @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 a lending period of 30 days. * @return rate30d **/ @javax.annotation.Nullable @@ -107,7 +107,7 @@ public CollateralFixRate updateTime(Long updateTime) { } /** - * Update time, timestamp, unit in seconds + * Update time, timestamp, unit 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 487c8f4..fff881f 100644 --- a/src/main/java/io/gate/gateapi/models/CollateralLoanCurrency.java +++ b/src/main/java/io/gate/gateapi/models/CollateralLoanCurrency.java @@ -22,7 +22,7 @@ import java.util.List; /** - * Supported borrowing and collateral currencies + * Supported borrowing and collateral currencies. */ public class CollateralLoanCurrency { public static final String SERIALIZED_NAME_LOAN_CURRENCY = "loan_currency"; @@ -41,7 +41,7 @@ public CollateralLoanCurrency loanCurrency(String loanCurrency) { } /** - * Borrowed currency + * Borrowed currency. * @return loanCurrency **/ @javax.annotation.Nullable @@ -69,7 +69,7 @@ public CollateralLoanCurrency addCollateralCurrencyItem(String collateralCurrenc } /** - * List of supported collateral currencies + * List of supported collateral currencies. * @return collateralCurrency **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CollateralLtv.java b/src/main/java/io/gate/gateapi/models/CollateralLtv.java index 13ff25d..e52660f 100644 --- a/src/main/java/io/gate/gateapi/models/CollateralLtv.java +++ b/src/main/java/io/gate/gateapi/models/CollateralLtv.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Collateral Ratio + * 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 + * The initial collateralization rate. * @return initLtv **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public CollateralLtv alertLtv(String alertLtv) { } /** - * Warning collateralization ratio + * Warning collateralization ratio. * @return alertLtv **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public CollateralLtv liquidateLtv(String liquidateLtv) { } /** - * The liquidation collateralization rate + * The 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 53b4e56..086b275 100644 --- a/src/main/java/io/gate/gateapi/models/CollateralOrder.java +++ b/src/main/java/io/gate/gateapi/models/CollateralOrder.java @@ -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"; @@ -95,7 +95,7 @@ public CollateralOrder orderId(Long orderId) { } /** - * Order ID + * Order ID. * @return orderId **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public CollateralOrder collateralCurrency(String collateralCurrency) { } /** - * Collateral + * Collateral. * @return collateralCurrency **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public CollateralOrder collateralAmount(String collateralAmount) { } /** - * Collateral amount + * Collateral amount. * @return collateralAmount **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public CollateralOrder borrowCurrency(String borrowCurrency) { } /** - * Borrowed currency + * Borrowed currency. * @return borrowCurrency **/ @javax.annotation.Nullable @@ -175,7 +175,7 @@ public CollateralOrder borrowAmount(String borrowAmount) { } /** - * Borrowing amount + * Borrowing amount. * @return borrowAmount **/ @javax.annotation.Nullable @@ -195,7 +195,7 @@ public CollateralOrder repaidAmount(String repaidAmount) { } /** - * Repaid amount + * Repaid amount. * @return repaidAmount **/ @javax.annotation.Nullable @@ -215,7 +215,7 @@ public CollateralOrder repaidPrincipal(String repaidPrincipal) { } /** - * Repaid principal + * Repaid principal. * @return repaidPrincipal **/ @javax.annotation.Nullable @@ -235,7 +235,7 @@ public CollateralOrder repaidInterest(String repaidInterest) { } /** - * Repaid interest + * Repaid interest. * @return repaidInterest **/ @javax.annotation.Nullable @@ -255,7 +255,7 @@ public CollateralOrder initLtv(String initLtv) { } /** - * The initial collateralization rate + * The initial collateralization rate. * @return initLtv **/ @javax.annotation.Nullable @@ -275,7 +275,7 @@ public CollateralOrder currentLtv(String currentLtv) { } /** - * The current collateralization rate + * The current collateralization rate. * @return currentLtv **/ @javax.annotation.Nullable @@ -295,7 +295,7 @@ public CollateralOrder liquidateLtv(String liquidateLtv) { } /** - * The liquidation collateralization rate + * The liquidation collateralization rate. * @return liquidateLtv **/ @javax.annotation.Nullable @@ -335,7 +335,7 @@ public CollateralOrder borrowTime(Long borrowTime) { } /** - * Borrowing time, timestamp in seconds + * Borrowing time, timestamp in seconds. * @return borrowTime **/ @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 ac67415..810c4d9 100644 --- a/src/main/java/io/gate/gateapi/models/CollateralRecord.java +++ b/src/main/java/io/gate/gateapi/models/CollateralRecord.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Collateral record + * Collateral record. */ public class CollateralRecord { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; @@ -71,7 +71,7 @@ public CollateralRecord orderId(Long orderId) { } /** - * Order ID + * Order ID. * @return orderId **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public CollateralRecord recordId(Long recordId) { } /** - * Collateral record ID + * Collateral record ID. * @return recordId **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public CollateralRecord borrowCurrency(String borrowCurrency) { } /** - * Borrowed currency + * Borrowed currency. * @return borrowCurrency **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public CollateralRecord borrowAmount(String borrowAmount) { } /** - * Borrowing amount + * Borrowing amount. * @return borrowAmount **/ @javax.annotation.Nullable @@ -151,7 +151,7 @@ public CollateralRecord collateralCurrency(String collateralCurrency) { } /** - * Collateral + * Collateral. * @return collateralCurrency **/ @javax.annotation.Nullable @@ -171,7 +171,7 @@ public CollateralRecord beforeCollateral(String beforeCollateral) { } /** - * The collateral amount before adjustment + * The collateral amount before adjustment. * @return beforeCollateral **/ @javax.annotation.Nullable @@ -191,7 +191,7 @@ public CollateralRecord afterCollateral(String afterCollateral) { } /** - * The collateral amount after adjustment + * The collateral amount after adjustment. * @return afterCollateral **/ @javax.annotation.Nullable @@ -211,7 +211,7 @@ public CollateralRecord beforeLtv(String beforeLtv) { } /** - * The collateral ratio before adjustment + * The collateral ratio before adjustment. * @return beforeLtv **/ @javax.annotation.Nullable @@ -231,7 +231,7 @@ public CollateralRecord afterLtv(String afterLtv) { } /** - * The collateral ratio after adjustment + * The collateral ratio after adjustment. * @return afterLtv **/ @javax.annotation.Nullable @@ -251,7 +251,7 @@ public CollateralRecord operateTime(Long operateTime) { } /** - * Timestamp of the operation, in seconds + * Timestamp of the operation, 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 6471f20..93aa8f3 100644 --- a/src/main/java/io/gate/gateapi/models/Contract.java +++ b/src/main/java/io/gate/gateapi/models/Contract.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Futures contract details + * Futures contract details. */ public class Contract { public static final String SERIALIZED_NAME_NAME = "name"; @@ -28,7 +28,7 @@ public class Contract { private String name; /** - * Futures contract type + * Futures contract type. */ @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 - based on internal trading, external index price */ @JsonAdapter(MarkTypeEnum.Adapter.class) public enum MarkTypeEnum { @@ -277,7 +277,7 @@ public Contract name(String name) { } /** - * Futures contract + * Futures contract. * @return name **/ @javax.annotation.Nullable @@ -297,7 +297,7 @@ public Contract type(TypeEnum type) { } /** - * Futures contract type + * Futures contract type. * @return type **/ @javax.annotation.Nullable @@ -317,7 +317,7 @@ public Contract quantoMultiplier(String quantoMultiplier) { } /** - * Multiplier used in converting from invoicing to settlement currency + * Multiplier used in converting from invoicing to settlement currency. * @return quantoMultiplier **/ @javax.annotation.Nullable @@ -337,7 +337,7 @@ public Contract leverageMin(String leverageMin) { } /** - * Minimum leverage + * Minimum leverage. * @return leverageMin **/ @javax.annotation.Nullable @@ -357,7 +357,7 @@ public Contract leverageMax(String leverageMax) { } /** - * Maximum leverage + * Maximum leverage. * @return leverageMax **/ @javax.annotation.Nullable @@ -377,7 +377,7 @@ public Contract maintenanceRate(String maintenanceRate) { } /** - * Maintenance rate of margin + * Maintenance rate of margin. * @return maintenanceRate **/ @javax.annotation.Nullable @@ -397,7 +397,7 @@ public Contract markType(MarkTypeEnum markType) { } /** - * Mark price type, internal - based on internal trading, index - based on external index price + * Mark price type, internal - based on internal trading, external index price * @return markType **/ @javax.annotation.Nullable @@ -417,7 +417,7 @@ public Contract markPrice(String markPrice) { } /** - * Current mark price + * Current mark price. * @return markPrice **/ @javax.annotation.Nullable @@ -437,7 +437,7 @@ public Contract indexPrice(String indexPrice) { } /** - * Current index price + * Current index price. * @return indexPrice **/ @javax.annotation.Nullable @@ -457,7 +457,7 @@ public Contract lastPrice(String lastPrice) { } /** - * Last trading price + * Last trading price. * @return lastPrice **/ @javax.annotation.Nullable @@ -477,7 +477,7 @@ public Contract makerFeeRate(String makerFeeRate) { } /** - * Maker fee rate, where negative means rebate + * Maker fee rate, where negative means rebate. * @return makerFeeRate **/ @javax.annotation.Nullable @@ -497,7 +497,7 @@ public Contract takerFeeRate(String takerFeeRate) { } /** - * Taker fee rate + * Taker fee rate. * @return takerFeeRate **/ @javax.annotation.Nullable @@ -517,7 +517,7 @@ public Contract orderPriceRound(String orderPriceRound) { } /** - * Minimum order price increment + * Minimum order price increment. * @return orderPriceRound **/ @javax.annotation.Nullable @@ -537,7 +537,7 @@ public Contract markPriceRound(String markPriceRound) { } /** - * Minimum mark price increment + * Minimum mark price increment. * @return markPriceRound **/ @javax.annotation.Nullable @@ -557,7 +557,7 @@ public Contract fundingRate(String fundingRate) { } /** - * Current funding rate + * Current funding rate. * @return fundingRate **/ @javax.annotation.Nullable @@ -577,7 +577,7 @@ public Contract fundingInterval(Integer fundingInterval) { } /** - * Funding application interval, unit in seconds + * Funding application interval, unit in seconds. * @return fundingInterval **/ @javax.annotation.Nullable @@ -597,7 +597,7 @@ public Contract fundingNextApply(Double fundingNextApply) { } /** - * Next funding time + * Next funding time. * @return fundingNextApply **/ @javax.annotation.Nullable @@ -617,7 +617,7 @@ public Contract riskLimitBase(String riskLimitBase) { } /** - * Risk limit base,deprecated + * Risk limit base,deprecated. * @return riskLimitBase **/ @javax.annotation.Nullable @@ -637,7 +637,7 @@ public Contract riskLimitStep(String riskLimitStep) { } /** - * Step of adjusting risk limit,deprecated + * Step of adjusting risk limit,deprecated. * @return riskLimitStep **/ @javax.annotation.Nullable @@ -677,7 +677,7 @@ public Contract orderSizeMin(Long orderSizeMin) { } /** - * Minimum order size the contract allowed + * Minimum order size the contract allowed. * @return orderSizeMin **/ @javax.annotation.Nullable @@ -697,7 +697,7 @@ public Contract orderSizeMax(Long orderSizeMax) { } /** - * Maximum order size the contract allowed + * Maximum order size the contract allowed. * @return orderSizeMax **/ @javax.annotation.Nullable @@ -737,7 +737,7 @@ public Contract refDiscountRate(String refDiscountRate) { } /** - * Referral fee rate discount + * Referral fee rate discount. * @return refDiscountRate **/ @javax.annotation.Nullable @@ -757,7 +757,7 @@ public Contract refRebateRate(String refRebateRate) { } /** - * Referrer commission rate + * Referrer commission rate. * @return refRebateRate **/ @javax.annotation.Nullable @@ -777,7 +777,7 @@ public Contract orderbookId(Long orderbookId) { } /** - * Current orderbook ID + * Current orderbook ID. * @return orderbookId **/ @javax.annotation.Nullable @@ -797,7 +797,7 @@ public Contract tradeId(Long tradeId) { } /** - * Current trade ID + * Current trade ID. * @return tradeId **/ @javax.annotation.Nullable @@ -817,7 +817,7 @@ public Contract tradeSize(Long tradeSize) { } /** - * Historical accumulated trade size + * Historical accumulated trade size. * @return tradeSize **/ @javax.annotation.Nullable @@ -837,7 +837,7 @@ public Contract positionSize(Long positionSize) { } /** - * Current total long position size + * Current total long position size. * @return positionSize **/ @javax.annotation.Nullable @@ -857,7 +857,7 @@ public Contract configChangeTime(Double configChangeTime) { } /** - * Last changed time of configuration + * Last changed time of configuration. * @return configChangeTime **/ @javax.annotation.Nullable @@ -877,7 +877,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 when position_size>0, it means the contract is in the offline transition period `in_delisting=true` contract is offline * @return inDelisting **/ @javax.annotation.Nullable @@ -897,7 +897,7 @@ public Contract ordersLimit(Integer ordersLimit) { } /** - * Maximum number of open orders + * Maximum number of open orders. * @return ordersLimit **/ @javax.annotation.Nullable @@ -917,7 +917,7 @@ public Contract enableBonus(Boolean enableBonus) { } /** - * Whether bouns is enabled + * Whether bouns is enabled. * @return enableBonus **/ @javax.annotation.Nullable @@ -937,7 +937,7 @@ public Contract enableCredit(Boolean enableCredit) { } /** - * Whether portfolio margin account is enabled + * Whether portfolio margin account is enabled. * @return enableCredit **/ @javax.annotation.Nullable @@ -957,7 +957,7 @@ public Contract createTime(Double createTime) { } /** - * Created time of the contract + * Created time of the contract. * @return createTime **/ @javax.annotation.Nullable @@ -997,7 +997,7 @@ public Contract status(String status) { } /** - * Contract Status Types include: prelaunch, trading, delisting, delisted + * Contract Status Types include: prelaunch, trading, delisting, delisted. * @return status **/ @javax.annotation.Nullable @@ -1017,7 +1017,7 @@ public Contract launchTime(Long launchTime) { } /** - * Contract expiry timestamp + * Contract expiry timestamp. * @return launchTime **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/ContractStat.java b/src/main/java/io/gate/gateapi/models/ContractStat.java index ee443b6..b679604 100644 --- a/src/main/java/io/gate/gateapi/models/ContractStat.java +++ b/src/main/java/io/gate/gateapi/models/ContractStat.java @@ -84,7 +84,7 @@ public ContractStat time(Long time) { } /** - * Stat timestamp + * Stat timestamp. * @return time **/ @javax.annotation.Nullable @@ -104,7 +104,7 @@ public ContractStat lsrTaker(BigDecimal lsrTaker) { } /** - * Long/short account number ratio + * Long/short account number ratio. * @return lsrTaker **/ @javax.annotation.Nullable @@ -124,7 +124,7 @@ public ContractStat lsrAccount(BigDecimal lsrAccount) { } /** - * Long/short taker size ratio + * Long/short taker size ratio. * @return lsrAccount **/ @javax.annotation.Nullable @@ -144,7 +144,7 @@ public ContractStat longLiqSize(Long longLiqSize) { } /** - * Long liquidation size + * Long liquidation size. * @return longLiqSize **/ @javax.annotation.Nullable @@ -164,7 +164,7 @@ public ContractStat longLiqAmount(Double longLiqAmount) { } /** - * Long liquidation amount(base currency) + * Long liquidation amount(base currency). * @return longLiqAmount **/ @javax.annotation.Nullable @@ -184,7 +184,7 @@ public ContractStat longLiqUsd(Double longLiqUsd) { } /** - * Long liquidation volume(quote currency) + * Long liquidation volume(quote currency). * @return longLiqUsd **/ @javax.annotation.Nullable @@ -204,7 +204,7 @@ public ContractStat shortLiqSize(Long shortLiqSize) { } /** - * Short liquidation size + * Short liquidation size. * @return shortLiqSize **/ @javax.annotation.Nullable @@ -224,7 +224,7 @@ public ContractStat shortLiqAmount(Double shortLiqAmount) { } /** - * Short liquidation amount(base currency) + * Short liquidation amount(base currency). * @return shortLiqAmount **/ @javax.annotation.Nullable @@ -244,7 +244,7 @@ public ContractStat shortLiqUsd(Double shortLiqUsd) { } /** - * Short liquidation volume(quote currency) + * Short liquidation volume(quote currency). * @return shortLiqUsd **/ @javax.annotation.Nullable @@ -264,7 +264,7 @@ public ContractStat openInterest(Long openInterest) { } /** - * Open interest size + * Open interest size. * @return openInterest **/ @javax.annotation.Nullable @@ -284,7 +284,7 @@ public ContractStat openInterestUsd(Double openInterestUsd) { } /** - * Open interest volume(quote currency) + * Open interest volume(quote currency). * @return openInterestUsd **/ @javax.annotation.Nullable @@ -304,7 +304,7 @@ public ContractStat topLsrAccount(Double topLsrAccount) { } /** - * Top trader long/short account ratio + * Top trader long/short account ratio. * @return topLsrAccount **/ @javax.annotation.Nullable @@ -324,7 +324,7 @@ public ContractStat topLsrSize(Double topLsrSize) { } /** - * Top trader long/short position ratio + * Top trader long/short position ratio. * @return topLsrSize **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/ConvertSmallBalance.java b/src/main/java/io/gate/gateapi/models/ConvertSmallBalance.java index 92e6720..d59305b 100644 --- a/src/main/java/io/gate/gateapi/models/ConvertSmallBalance.java +++ b/src/main/java/io/gate/gateapi/models/ConvertSmallBalance.java @@ -22,7 +22,7 @@ import java.util.List; /** - * Convert Small Balance + * Convert Small Balance. */ public class ConvertSmallBalance { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -49,7 +49,7 @@ public ConvertSmallBalance addCurrencyItem(String currencyItem) { } /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -69,7 +69,7 @@ public ConvertSmallBalance isAll(Boolean isAll) { } /** - * Whether to exchange all + * Whether to exchange 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 3076a62..fda8184 100644 --- a/src/main/java/io/gate/gateapi/models/CountdownCancelAllFuturesTask.java +++ b/src/main/java/io/gate/gateapi/models/CountdownCancelAllFuturesTask.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Countdown cancel task detail + * Countdown cancel task detail. */ public class CountdownCancelAllFuturesTask { public static final String SERIALIZED_NAME_TIMEOUT = "timeout"; @@ -58,7 +58,7 @@ public CountdownCancelAllFuturesTask contract(String contract) { } /** - * Futures contract + * Futures contract. * @return contract **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CountdownCancelAllOptionsTask.java b/src/main/java/io/gate/gateapi/models/CountdownCancelAllOptionsTask.java index 9dfc6d1..17456bf 100644 --- a/src/main/java/io/gate/gateapi/models/CountdownCancelAllOptionsTask.java +++ b/src/main/java/io/gate/gateapi/models/CountdownCancelAllOptionsTask.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Countdown cancel task detail + * Countdown cancel task detail. */ public class CountdownCancelAllOptionsTask { public static final String SERIALIZED_NAME_TIMEOUT = "timeout"; @@ -62,7 +62,7 @@ public CountdownCancelAllOptionsTask contract(String contract) { } /** - * Options contract name + * Options contract name. * @return contract **/ @javax.annotation.Nullable @@ -82,7 +82,7 @@ public CountdownCancelAllOptionsTask underlying(String underlying) { } /** - * Underlying + * Underlying. * @return underlying **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CountdownCancelAllSpotTask.java b/src/main/java/io/gate/gateapi/models/CountdownCancelAllSpotTask.java index a0fe012..91f6ddb 100644 --- a/src/main/java/io/gate/gateapi/models/CountdownCancelAllSpotTask.java +++ b/src/main/java/io/gate/gateapi/models/CountdownCancelAllSpotTask.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Countdown cancel task detail + * Countdown cancel task detail. */ public class CountdownCancelAllSpotTask { public static final String SERIALIZED_NAME_TIMEOUT = "timeout"; @@ -58,7 +58,7 @@ public CountdownCancelAllSpotTask currencyPair(String currencyPair) { } /** - * Currency pair + * Currency pair. * @return currencyPair **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CreateCollateralOrder.java b/src/main/java/io/gate/gateapi/models/CreateCollateralOrder.java index 0a18a59..835ccb2 100644 --- a/src/main/java/io/gate/gateapi/models/CreateCollateralOrder.java +++ b/src/main/java/io/gate/gateapi/models/CreateCollateralOrder.java @@ -47,7 +47,7 @@ public CreateCollateralOrder collateralAmount(String collateralAmount) { } /** - * Collateral amount + * Collateral amount. * @return collateralAmount **/ public String getCollateralAmount() { @@ -66,7 +66,7 @@ public CreateCollateralOrder collateralCurrency(String collateralCurrency) { } /** - * Collateral + * Collateral. * @return collateralCurrency **/ public String getCollateralCurrency() { @@ -85,7 +85,7 @@ public CreateCollateralOrder borrowAmount(String borrowAmount) { } /** - * Borrowing amount + * Borrowing amount. * @return borrowAmount **/ public String getBorrowAmount() { @@ -104,7 +104,7 @@ public CreateCollateralOrder borrowCurrency(String borrowCurrency) { } /** - * Borrowed currency + * Borrowed currency. * @return borrowCurrency **/ public String getBorrowCurrency() { diff --git a/src/main/java/io/gate/gateapi/models/CreateMultiCollateralOrder.java b/src/main/java/io/gate/gateapi/models/CreateMultiCollateralOrder.java index af99902..bc6d8d9 100644 --- a/src/main/java/io/gate/gateapi/models/CreateMultiCollateralOrder.java +++ b/src/main/java/io/gate/gateapi/models/CreateMultiCollateralOrder.java @@ -70,7 +70,7 @@ public CreateMultiCollateralOrder orderId(String orderId) { } /** - * Order ID + * Order ID. * @return orderId **/ @javax.annotation.Nullable @@ -90,7 +90,7 @@ public CreateMultiCollateralOrder orderType(String orderType) { } /** - * current - current, fixed - fixed, if not specified, default to current + * current - current, fixed - fixed, if not specified, default to current. * @return orderType **/ @javax.annotation.Nullable @@ -130,7 +130,7 @@ public CreateMultiCollateralOrder fixedRate(String fixedRate) { } /** - * Fixed interest rate, must be specified for fixed + * Fixed interest rate, must be specified for fixed. * @return fixedRate **/ @javax.annotation.Nullable @@ -150,7 +150,7 @@ public CreateMultiCollateralOrder autoRenew(Boolean autoRenew) { } /** - * Fixed interest rate, automatic renewal + * Fixed interest rate, automatic renewal. * @return autoRenew **/ @javax.annotation.Nullable @@ -170,7 +170,7 @@ public CreateMultiCollateralOrder autoRepay(Boolean autoRepay) { } /** - * Fixed interest rate, automatic repayment + * Fixed interest rate, automatic repayment. * @return autoRepay **/ @javax.annotation.Nullable @@ -190,7 +190,7 @@ public CreateMultiCollateralOrder borrowCurrency(String borrowCurrency) { } /** - * Borrowed currency + * Borrowed currency. * @return borrowCurrency **/ public String getBorrowCurrency() { @@ -209,7 +209,7 @@ public CreateMultiCollateralOrder borrowAmount(String borrowAmount) { } /** - * Borrowing amount + * Borrowing amount. * @return borrowAmount **/ public String getBorrowAmount() { @@ -236,7 +236,7 @@ public CreateMultiCollateralOrder addCollateralCurrenciesItem(CollateralCurrency } /** - * Collateral currency and amount + * Collateral currency and amount. * @return collateralCurrencies **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CreateUniLend.java b/src/main/java/io/gate/gateapi/models/CreateUniLend.java index d726278..31aff38 100644 --- a/src/main/java/io/gate/gateapi/models/CreateUniLend.java +++ b/src/main/java/io/gate/gateapi/models/CreateUniLend.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Lend or redeem + * Lend or redeem. */ 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 + * type: lend - lend, redeem - redeem. */ @JsonAdapter(TypeEnum.Adapter.class) public enum TypeEnum { @@ -94,7 +94,7 @@ public CreateUniLend currency(String currency) { } /** - * Currency name + * Currency name. * @return currency **/ public String getCurrency() { @@ -113,7 +113,7 @@ public CreateUniLend amount(String amount) { } /** - * The amount of currency could be lent + * The amount of currency could be lent. * @return amount **/ public String getAmount() { @@ -132,7 +132,7 @@ public CreateUniLend type(TypeEnum type) { } /** - * type: lend - lend, redeem - redeem + * type: lend - lend, redeem - redeem. * @return type **/ public TypeEnum getType() { diff --git a/src/main/java/io/gate/gateapi/models/CreateUniLoan.java b/src/main/java/io/gate/gateapi/models/CreateUniLoan.java index 26ddd1d..cf488ce 100644 --- a/src/main/java/io/gate/gateapi/models/CreateUniLoan.java +++ b/src/main/java/io/gate/gateapi/models/CreateUniLoan.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Borrow or repay + * Borrow or repay. */ public class CreateUniLoan { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -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 { @@ -98,7 +98,7 @@ public CreateUniLoan currency(String currency) { } /** - * Currency + * Currency. * @return currency **/ public String getCurrency() { @@ -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 + * The amount of lending or repaying. * @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. Repay operation only. If the value is `true`, the amount will be ignored and repaid in full. * @return repaidAll **/ @javax.annotation.Nullable @@ -175,7 +175,7 @@ public CreateUniLoan currencyPair(String currencyPair) { } /** - * Currency pair + * Currency pair. * @return currencyPair **/ public String getCurrencyPair() { diff --git a/src/main/java/io/gate/gateapi/models/CrossMarginBalance.java b/src/main/java/io/gate/gateapi/models/CrossMarginBalance.java index 6c928d1..0dcfe34 100644 --- a/src/main/java/io/gate/gateapi/models/CrossMarginBalance.java +++ b/src/main/java/io/gate/gateapi/models/CrossMarginBalance.java @@ -47,7 +47,7 @@ public CrossMarginBalance available(String available) { } /** - * Available amount + * Available amount. * @return available **/ @javax.annotation.Nullable @@ -67,7 +67,7 @@ public CrossMarginBalance freeze(String freeze) { } /** - * Locked amount + * Locked amount. * @return freeze **/ @javax.annotation.Nullable @@ -87,7 +87,7 @@ public CrossMarginBalance borrowed(String borrowed) { } /** - * Borrowed amount + * Borrowed amount. * @return borrowed **/ @javax.annotation.Nullable @@ -107,7 +107,7 @@ public CrossMarginBalance interest(String interest) { } /** - * Unpaid interests + * Unpaid interests. * @return interest **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CrossMarginLoan.java b/src/main/java/io/gate/gateapi/models/CrossMarginLoan.java index 1fee149..8eb7a8f 100644 --- a/src/main/java/io/gate/gateapi/models/CrossMarginLoan.java +++ b/src/main/java/io/gate/gateapi/models/CrossMarginLoan.java @@ -114,7 +114,7 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { /** - * Loan record ID + * Loan record ID. * @return id **/ @javax.annotation.Nullable @@ -124,7 +124,7 @@ public String getId() { /** - * Creation timestamp, in milliseconds + * Creation timestamp, in milliseconds. * @return createTime **/ @javax.annotation.Nullable @@ -134,7 +134,7 @@ public Long getCreateTime() { /** - * Update timestamp, in milliseconds + * Update timestamp, in milliseconds. * @return updateTime **/ @javax.annotation.Nullable @@ -150,7 +150,7 @@ public CrossMarginLoan currency(String currency) { } /** - * Currency name + * Currency name. * @return currency **/ public String getCurrency() { @@ -169,7 +169,7 @@ public CrossMarginLoan amount(String amount) { } /** - * Borrowed amount + * Borrowed amount. * @return amount **/ public String getAmount() { @@ -188,7 +188,7 @@ public CrossMarginLoan text(String text) { } /** - * User defined custom ID + * User defined custom ID. * @return text **/ @javax.annotation.Nullable @@ -212,7 +212,7 @@ public StatusEnum getStatus() { /** - * Repaid amount + * Repaid amount. * @return repaid **/ @javax.annotation.Nullable @@ -222,7 +222,7 @@ public String getRepaid() { /** - * Repaid interest + * Repaid interest. * @return repaidInterest **/ @javax.annotation.Nullable @@ -232,7 +232,7 @@ public String getRepaidInterest() { /** - * Outstanding interest yet to be paid + * Outstanding interest yet to be paid. * @return unpaidInterest **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CrossMarginRepayment.java b/src/main/java/io/gate/gateapi/models/CrossMarginRepayment.java index 26e19e0..3d15608 100644 --- a/src/main/java/io/gate/gateapi/models/CrossMarginRepayment.java +++ b/src/main/java/io/gate/gateapi/models/CrossMarginRepayment.java @@ -59,7 +59,7 @@ public CrossMarginRepayment id(String id) { } /** - * Loan record ID + * Loan record ID. * @return id **/ @javax.annotation.Nullable @@ -79,7 +79,7 @@ public CrossMarginRepayment createTime(Long createTime) { } /** - * Repayment time + * Repayment time. * @return createTime **/ @javax.annotation.Nullable @@ -99,7 +99,7 @@ public CrossMarginRepayment loanId(String loanId) { } /** - * Loan record ID + * Loan record ID. * @return loanId **/ @javax.annotation.Nullable @@ -119,7 +119,7 @@ public CrossMarginRepayment currency(String currency) { } /** - * Currency name + * Currency name. * @return currency **/ @javax.annotation.Nullable @@ -139,7 +139,7 @@ public CrossMarginRepayment principal(String principal) { } /** - * Repaid principal + * Repaid principal. * @return principal **/ @javax.annotation.Nullable @@ -159,7 +159,7 @@ public CrossMarginRepayment interest(String interest) { } /** - * Repaid interest + * Repaid interest. * @return interest **/ @javax.annotation.Nullable @@ -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/Currency.java b/src/main/java/io/gate/gateapi/models/Currency.java index b154495..d464bb5 100644 --- a/src/main/java/io/gate/gateapi/models/Currency.java +++ b/src/main/java/io/gate/gateapi/models/Currency.java @@ -74,7 +74,7 @@ public Currency currency(String currency) { } /** - * Currency symbol + * Currency symbol. * @return currency **/ @javax.annotation.Nullable @@ -94,7 +94,7 @@ public Currency name(String name) { } /** - * Currency name + * Currency name. * @return name **/ @javax.annotation.Nullable @@ -114,7 +114,7 @@ public Currency delisted(Boolean delisted) { } /** - * Whether currency is de-listed + * Whether currency is de-listed. * @return delisted **/ @javax.annotation.Nullable @@ -134,7 +134,7 @@ public Currency withdrawDisabled(Boolean withdrawDisabled) { } /** - * Whether currency's withdrawal is disabled (deprecated) + * Whether currency's withdrawal is disabled (deprecated). * @return withdrawDisabled **/ @javax.annotation.Nullable @@ -154,7 +154,7 @@ public Currency withdrawDelayed(Boolean withdrawDelayed) { } /** - * Whether currency's withdrawal is delayed (deprecated) + * Whether currency's withdrawal is delayed (deprecated). * @return withdrawDelayed **/ @javax.annotation.Nullable @@ -174,7 +174,7 @@ public Currency depositDisabled(Boolean depositDisabled) { } /** - * Whether currency's deposit is disabled (deprecated) + * Whether currency's deposit is disabled (deprecated). * @return depositDisabled **/ @javax.annotation.Nullable @@ -194,7 +194,7 @@ public Currency tradeDisabled(Boolean tradeDisabled) { } /** - * Whether currency's trading is disabled + * Whether currency's trading is disabled. * @return tradeDisabled **/ @javax.annotation.Nullable @@ -234,7 +234,7 @@ public Currency chain(String chain) { } /** - * The main chain corresponding to the coin + * The main chain corresponding to the coin. * @return chain **/ @javax.annotation.Nullable @@ -262,7 +262,7 @@ public Currency addChainsItem(SpotCurrencyChain chainsItem) { } /** - * All links corresponding to coins + * All links corresponding to coins. * @return chains **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CurrencyChain.java b/src/main/java/io/gate/gateapi/models/CurrencyChain.java index 5c948f2..1a3f6f0 100644 --- a/src/main/java/io/gate/gateapi/models/CurrencyChain.java +++ b/src/main/java/io/gate/gateapi/models/CurrencyChain.java @@ -63,7 +63,7 @@ public CurrencyChain chain(String chain) { } /** - * Chain name + * Chain name. * @return chain **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public CurrencyChain nameCn(String nameCn) { } /** - * Chain name in Chinese + * Chain name in Chinese. * @return nameCn **/ @javax.annotation.Nullable @@ -103,7 +103,7 @@ public CurrencyChain nameEn(String nameEn) { } /** - * Chain name in English + * Chain name in English. * @return nameEn **/ @javax.annotation.Nullable @@ -143,7 +143,7 @@ public CurrencyChain isDisabled(Integer isDisabled) { } /** - * If it is disabled. 0 means NOT being disabled + * If it is disabled. 0 means NOT being disabled. * @return isDisabled **/ @javax.annotation.Nullable @@ -163,7 +163,7 @@ public CurrencyChain isDepositDisabled(Integer isDepositDisabled) { } /** - * Is deposit disabled. 0 means not + * Is deposit disabled. 0 means not. * @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. * @return isWithdrawDisabled **/ @javax.annotation.Nullable @@ -203,7 +203,7 @@ public CurrencyChain decimal(String decimal) { } /** - * Withdrawal precision + * Withdrawal precision. * @return decimal **/ @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 9520175..2f21c8e 100644 --- a/src/main/java/io/gate/gateapi/models/CurrencyPair.java +++ b/src/main/java/io/gate/gateapi/models/CurrencyPair.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Spot currency pair + * Spot currency pair. */ public class CurrencyPair { public static final String SERIALIZED_NAME_ID = "id"; @@ -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 + * How currency pair can be traded - untradable: cannot be bought or sold - buyable: can be bought - sellable: can be sold - tradable: sold */ @JsonAdapter(TradeStatusEnum.Adapter.class) public enum TradeStatusEnum { @@ -158,7 +158,7 @@ public CurrencyPair id(String id) { } /** - * Currency pair + * Currency pair. * @return id **/ @javax.annotation.Nullable @@ -178,7 +178,7 @@ public CurrencyPair base(String base) { } /** - * Base currency + * Base currency. * @return base **/ @javax.annotation.Nullable @@ -198,7 +198,7 @@ public CurrencyPair baseName(String baseName) { } /** - * Transaction currency name + * Transaction currency name. * @return baseName **/ @javax.annotation.Nullable @@ -218,7 +218,7 @@ public CurrencyPair quote(String quote) { } /** - * Quote currency + * Quote currency. * @return quote **/ @javax.annotation.Nullable @@ -238,7 +238,7 @@ public CurrencyPair quoteName(String quoteName) { } /** - * Name of the denominated currency + * Name of the denominated currency. * @return quoteName **/ @javax.annotation.Nullable @@ -258,7 +258,7 @@ public CurrencyPair fee(String fee) { } /** - * Trading fee + * Trading fee. * @return fee **/ @javax.annotation.Nullable @@ -278,7 +278,7 @@ public CurrencyPair minBaseAmount(String minBaseAmount) { } /** - * Minimum amount of base currency to trade, `null` means no limit + * Minimum amount of base currency to trade, `null` means no limit. * @return minBaseAmount **/ @javax.annotation.Nullable @@ -298,7 +298,7 @@ public CurrencyPair minQuoteAmount(String minQuoteAmount) { } /** - * Minimum amount of quote currency to trade, `null` means no limit + * Minimum amount of quote currency to trade, `null` means no limit. * @return minQuoteAmount **/ @javax.annotation.Nullable @@ -318,7 +318,7 @@ public CurrencyPair maxBaseAmount(String maxBaseAmount) { } /** - * Maximum amount of base currency to trade, `null` means no limit + * Maximum amount of base currency to trade, `null` means no limit. * @return maxBaseAmount **/ @javax.annotation.Nullable @@ -338,7 +338,7 @@ public CurrencyPair maxQuoteAmount(String maxQuoteAmount) { } /** - * Maximum amount of quote currency to trade, `null` means no limit + * Maximum amount of quote currency to trade, `null` means no limit. * @return maxQuoteAmount **/ @javax.annotation.Nullable @@ -358,7 +358,7 @@ public CurrencyPair amountPrecision(Integer amountPrecision) { } /** - * Amount scale + * Amount scale. * @return amountPrecision **/ @javax.annotation.Nullable @@ -378,7 +378,7 @@ public CurrencyPair precision(Integer precision) { } /** - * Price scale + * Price scale. * @return precision **/ @javax.annotation.Nullable @@ -398,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 + * How currency pair can be traded - untradable: cannot be bought or sold - buyable: can be bought - sellable: can be sold - tradable: sold * @return tradeStatus **/ @javax.annotation.Nullable @@ -418,7 +418,7 @@ public CurrencyPair sellStart(Long sellStart) { } /** - * Sell start unix timestamp in seconds + * Sell start unix timestamp in seconds. * @return sellStart **/ @javax.annotation.Nullable @@ -438,7 +438,7 @@ public CurrencyPair buyStart(Long buyStart) { } /** - * Buy start unix timestamp in seconds + * Buy start unix timestamp in seconds. * @return buyStart **/ @javax.annotation.Nullable @@ -458,7 +458,7 @@ public CurrencyPair delistingTime(Long delistingTime) { } /** - * Expected time to remove the shelves, Unix timestamp in seconds + * Expected time to remove the shelves, Unix timestamp in seconds. * @return delistingTime **/ @javax.annotation.Nullable @@ -478,7 +478,7 @@ public CurrencyPair type(String type) { } /** - * Trading pair type, normal: normal, premarket: pre-market + * Trading pair type, normal: normal, premarket: pre-market. * @return type **/ @javax.annotation.Nullable @@ -498,7 +498,7 @@ public CurrencyPair tradeUrl(String tradeUrl) { } /** - * Transaction link + * Transaction link. * @return tradeUrl **/ @javax.annotation.Nullable @@ -518,7 +518,7 @@ public CurrencyPair stTag(Boolean stTag) { } /** - * Whether the trading pair is in ST risk assessment, false - No, true - Yes + * Whether the trading pair is in ST risk assessment, false - No, true - Yes. * @return stTag **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CurrencyQuota.java b/src/main/java/io/gate/gateapi/models/CurrencyQuota.java index a5557ee..83874cb 100644 --- a/src/main/java/io/gate/gateapi/models/CurrencyQuota.java +++ b/src/main/java/io/gate/gateapi/models/CurrencyQuota.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Currency Quota + * Currency Quota. */ public class CurrencyQuota { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -51,7 +51,7 @@ public CurrencyQuota currency(String currency) { } /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public CurrencyQuota indexPrice(String indexPrice) { } /** - * Currency Index Price + * Currency Index Price. * @return indexPrice **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public CurrencyQuota minQuota(String minQuota) { } /** - * Minimum borrowing/collateral quota for the currency + * Minimum borrowing/collateral quota 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 limit for the currency. * @return leftQuota **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public CurrencyQuota leftQuoteUsdt(String leftQuoteUsdt) { } /** - * Remaining currency limit converted to USDT + * Remaining currency limit converted to USDT. * @return leftQuoteUsdt **/ @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 0dc55bd..fe583fe 100644 --- a/src/main/java/io/gate/gateapi/models/DebitFee.java +++ b/src/main/java/io/gate/gateapi/models/DebitFee.java @@ -35,7 +35,7 @@ public DebitFee enabled(Boolean enabled) { } /** - * Whether GT fee discount is used + * Whether GT fee discount is used. * @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 9427705..60ef32f 100644 --- a/src/main/java/io/gate/gateapi/models/DeliveryCandlestick.java +++ b/src/main/java/io/gate/gateapi/models/DeliveryCandlestick.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * data point in every timestamp + * data point in every timestamp. */ public class DeliveryCandlestick { public static final String SERIALIZED_NAME_T = "t"; @@ -55,7 +55,7 @@ public DeliveryCandlestick t(Double t) { } /** - * Unix timestamp in seconds + * Unix timestamp in seconds. * @return t **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public DeliveryCandlestick v(Long v) { } /** - * size volume (contract size). Only returned if `contract` is not prefixed + * size volume (contract size). Only returned if `contract` is not prefixed. * @return v **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public DeliveryCandlestick c(String c) { } /** - * Close price (quote currency) + * Close price (quote currency). * @return c **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public DeliveryCandlestick h(String h) { } /** - * Highest price (quote currency) + * Highest price (quote currency). * @return h **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public DeliveryCandlestick l(String l) { } /** - * Lowest price (quote currency) + * Lowest price (quote currency). * @return l **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public DeliveryCandlestick o(String o) { } /** - * Open price (quote currency) + * Open price (quote currency). * @return o **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/DeliveryContract.java b/src/main/java/io/gate/gateapi/models/DeliveryContract.java index 8602204..b34021c 100644 --- a/src/main/java/io/gate/gateapi/models/DeliveryContract.java +++ b/src/main/java/io/gate/gateapi/models/DeliveryContract.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Futures contract details + * Futures contract details. */ public class DeliveryContract { public static final String SERIALIZED_NAME_NAME = "name"; @@ -32,7 +32,7 @@ public class DeliveryContract { private String underlying; /** - * Cycle type, e.g. WEEKLY, QUARTERLY + * Cycle type, e.g. WEEKLY, QUARTERLY. */ @JsonAdapter(CycleEnum.Adapter.class) public enum CycleEnum { @@ -87,7 +87,7 @@ public CycleEnum read(final JsonReader jsonReader) throws IOException { private CycleEnum cycle; /** - * Futures contract type + * Futures contract type. */ @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 - based on internal trading, external index price */ @JsonAdapter(MarkTypeEnum.Adapter.class) public enum MarkTypeEnum { @@ -328,7 +328,7 @@ public DeliveryContract name(String name) { } /** - * Futures contract + * Futures contract. * @return name **/ @javax.annotation.Nullable @@ -348,7 +348,7 @@ public DeliveryContract underlying(String underlying) { } /** - * Underlying + * Underlying. * @return underlying **/ @javax.annotation.Nullable @@ -368,7 +368,7 @@ public DeliveryContract cycle(CycleEnum cycle) { } /** - * Cycle type, e.g. WEEKLY, QUARTERLY + * Cycle type, e.g. WEEKLY, QUARTERLY. * @return cycle **/ @javax.annotation.Nullable @@ -388,7 +388,7 @@ public DeliveryContract type(TypeEnum type) { } /** - * Futures contract type + * Futures contract type. * @return type **/ @javax.annotation.Nullable @@ -408,7 +408,7 @@ public DeliveryContract quantoMultiplier(String quantoMultiplier) { } /** - * Multiplier used in converting from invoicing to settlement currency + * Multiplier used in converting from invoicing to settlement currency. * @return quantoMultiplier **/ @javax.annotation.Nullable @@ -428,7 +428,7 @@ public DeliveryContract leverageMin(String leverageMin) { } /** - * Minimum leverage + * Minimum leverage. * @return leverageMin **/ @javax.annotation.Nullable @@ -448,7 +448,7 @@ public DeliveryContract leverageMax(String leverageMax) { } /** - * Maximum leverage + * Maximum leverage. * @return leverageMax **/ @javax.annotation.Nullable @@ -468,7 +468,7 @@ public DeliveryContract maintenanceRate(String maintenanceRate) { } /** - * Maintenance rate of margin + * Maintenance rate of margin. * @return maintenanceRate **/ @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 - based on internal trading, external index price * @return markType **/ @javax.annotation.Nullable @@ -508,7 +508,7 @@ public DeliveryContract markPrice(String markPrice) { } /** - * Current mark price + * Current mark price. * @return markPrice **/ @javax.annotation.Nullable @@ -528,7 +528,7 @@ public DeliveryContract indexPrice(String indexPrice) { } /** - * Current index price + * Current index price. * @return indexPrice **/ @javax.annotation.Nullable @@ -548,7 +548,7 @@ public DeliveryContract lastPrice(String lastPrice) { } /** - * Last trading price + * Last trading price. * @return lastPrice **/ @javax.annotation.Nullable @@ -568,7 +568,7 @@ public DeliveryContract makerFeeRate(String makerFeeRate) { } /** - * Maker fee rate, where negative means rebate + * Maker fee rate, where negative means rebate. * @return makerFeeRate **/ @javax.annotation.Nullable @@ -588,7 +588,7 @@ public DeliveryContract takerFeeRate(String takerFeeRate) { } /** - * Taker fee rate + * Taker fee rate. * @return takerFeeRate **/ @javax.annotation.Nullable @@ -608,7 +608,7 @@ public DeliveryContract orderPriceRound(String orderPriceRound) { } /** - * Minimum order price increment + * Minimum order price increment. * @return orderPriceRound **/ @javax.annotation.Nullable @@ -628,7 +628,7 @@ public DeliveryContract markPriceRound(String markPriceRound) { } /** - * Minimum mark price increment + * Minimum mark price increment. * @return markPriceRound **/ @javax.annotation.Nullable @@ -648,7 +648,7 @@ public DeliveryContract basisRate(String basisRate) { } /** - * Fair basis rate + * Fair basis rate. * @return basisRate **/ @javax.annotation.Nullable @@ -668,7 +668,7 @@ public DeliveryContract basisValue(String basisValue) { } /** - * Fair basis value + * Fair basis value. * @return basisValue **/ @javax.annotation.Nullable @@ -688,7 +688,7 @@ public DeliveryContract basisImpactValue(String basisImpactValue) { } /** - * Funding used for calculating impact bid, ask price + * Funding used for calculating impact bid, ask price. * @return basisImpactValue **/ @javax.annotation.Nullable @@ -708,7 +708,7 @@ public DeliveryContract settlePrice(String settlePrice) { } /** - * Settle price + * Settle price. * @return settlePrice **/ @javax.annotation.Nullable @@ -728,7 +728,7 @@ public DeliveryContract settlePriceInterval(Integer settlePriceInterval) { } /** - * Settle price update interval + * Settle price update interval. * @return settlePriceInterval **/ @javax.annotation.Nullable @@ -748,7 +748,7 @@ public DeliveryContract settlePriceDuration(Integer settlePriceDuration) { } /** - * Settle price update duration in seconds + * Settle price update duration in seconds. * @return settlePriceDuration **/ @javax.annotation.Nullable @@ -768,7 +768,7 @@ public DeliveryContract expireTime(Long expireTime) { } /** - * Contract expiry timestamp + * Contract expiry timestamp. * @return expireTime **/ @javax.annotation.Nullable @@ -788,7 +788,7 @@ public DeliveryContract riskLimitBase(String riskLimitBase) { } /** - * Risk limit base + * Risk limit base. * @return riskLimitBase **/ @javax.annotation.Nullable @@ -808,7 +808,7 @@ public DeliveryContract riskLimitStep(String riskLimitStep) { } /** - * Step of adjusting risk limit + * Step of adjusting risk limit. * @return riskLimitStep **/ @javax.annotation.Nullable @@ -828,7 +828,7 @@ public DeliveryContract riskLimitMax(String riskLimitMax) { } /** - * Maximum risk limit the contract allowed + * Maximum risk limit the contract allowed. * @return riskLimitMax **/ @javax.annotation.Nullable @@ -848,7 +848,7 @@ public DeliveryContract orderSizeMin(Long orderSizeMin) { } /** - * Minimum order size the contract allowed + * Minimum order size the contract allowed. * @return orderSizeMin **/ @javax.annotation.Nullable @@ -868,7 +868,7 @@ public DeliveryContract orderSizeMax(Long orderSizeMax) { } /** - * Maximum order size the contract allowed + * Maximum order size the contract allowed. * @return orderSizeMax **/ @javax.annotation.Nullable @@ -908,7 +908,7 @@ public DeliveryContract refDiscountRate(String refDiscountRate) { } /** - * Referral fee rate discount + * Referral fee rate discount. * @return refDiscountRate **/ @javax.annotation.Nullable @@ -928,7 +928,7 @@ public DeliveryContract refRebateRate(String refRebateRate) { } /** - * Referrer commission rate + * Referrer commission rate. * @return refRebateRate **/ @javax.annotation.Nullable @@ -948,7 +948,7 @@ public DeliveryContract orderbookId(Long orderbookId) { } /** - * Current orderbook ID + * Current orderbook ID. * @return orderbookId **/ @javax.annotation.Nullable @@ -968,7 +968,7 @@ public DeliveryContract tradeId(Long tradeId) { } /** - * Current trade ID + * Current trade ID. * @return tradeId **/ @javax.annotation.Nullable @@ -988,7 +988,7 @@ public DeliveryContract tradeSize(Long tradeSize) { } /** - * Historical accumulated trade size + * Historical accumulated trade size. * @return tradeSize **/ @javax.annotation.Nullable @@ -1008,7 +1008,7 @@ public DeliveryContract positionSize(Long positionSize) { } /** - * Current total long position size + * Current total long position size. * @return positionSize **/ @javax.annotation.Nullable @@ -1028,7 +1028,7 @@ public DeliveryContract configChangeTime(Double configChangeTime) { } /** - * Last changed time of configuration + * Last changed time of configuration. * @return configChangeTime **/ @javax.annotation.Nullable @@ -1048,7 +1048,7 @@ public DeliveryContract inDelisting(Boolean inDelisting) { } /** - * Contract is delisting + * Contract is delisting. * @return inDelisting **/ @javax.annotation.Nullable @@ -1068,7 +1068,7 @@ public DeliveryContract ordersLimit(Integer ordersLimit) { } /** - * Maximum number of open orders + * Maximum number of open 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 767816d..5303f22 100644 --- a/src/main/java/io/gate/gateapi/models/DeliverySettlement.java +++ b/src/main/java/io/gate/gateapi/models/DeliverySettlement.java @@ -61,7 +61,7 @@ public class DeliverySettlement { /** - * Liquidation time + * Liquidation time. * @return time **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public Long getTime() { /** - * Futures contract + * Futures contract. * @return contract **/ @javax.annotation.Nullable @@ -81,7 +81,7 @@ public String getContract() { /** - * Position leverage + * Position leverage. * @return leverage **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public String getLeverage() { /** - * Position size + * Position size. * @return size **/ @javax.annotation.Nullable @@ -101,7 +101,7 @@ public Long getSize() { /** - * Position margin + * Position margin. * @return margin **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public String getMargin() { /** - * Average entry price + * Average entry price. * @return entryPrice **/ @javax.annotation.Nullable @@ -121,7 +121,7 @@ public String getEntryPrice() { /** - * Settled price + * Settled price. * @return settlePrice **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public String getSettlePrice() { /** - * Profit + * Profit. * @return profit **/ @javax.annotation.Nullable @@ -141,7 +141,7 @@ public String getProfit() { /** - * Fee deducted + * Fee deducted. * @return fee **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/DeliveryTicker.java b/src/main/java/io/gate/gateapi/models/DeliveryTicker.java index b876fb8..9c5b761 100644 --- a/src/main/java/io/gate/gateapi/models/DeliveryTicker.java +++ b/src/main/java/io/gate/gateapi/models/DeliveryTicker.java @@ -123,7 +123,7 @@ public DeliveryTicker contract(String contract) { } /** - * Futures contract + * Futures contract. * @return contract **/ @javax.annotation.Nullable @@ -143,7 +143,7 @@ public DeliveryTicker last(String last) { } /** - * Last trading price + * Last trading price. * @return last **/ @javax.annotation.Nullable @@ -183,7 +183,7 @@ public DeliveryTicker totalSize(String totalSize) { } /** - * Contract total size + * Contract total size. * @return totalSize **/ @javax.annotation.Nullable @@ -203,7 +203,7 @@ public DeliveryTicker low24h(String low24h) { } /** - * Lowest trading price in recent 24h + * Lowest trading price in recent 24h. * @return low24h **/ @javax.annotation.Nullable @@ -223,7 +223,7 @@ public DeliveryTicker high24h(String high24h) { } /** - * Highest trading price in recent 24h + * Highest trading price in recent 24h. * @return high24h **/ @javax.annotation.Nullable @@ -243,7 +243,7 @@ public DeliveryTicker volume24h(String volume24h) { } /** - * Trade size in recent 24h + * Trade size in recent 24h. * @return volume24h **/ @javax.annotation.Nullable @@ -303,7 +303,7 @@ public DeliveryTicker volume24hBase(String volume24hBase) { } /** - * Trade volume in recent 24h, in base currency + * Trade volume in recent 24h, 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 + * Trade volume in recent 24h, 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 + * Trade volume in recent 24h, in settle currency. * @return volume24hSettle **/ @javax.annotation.Nullable @@ -363,7 +363,7 @@ public DeliveryTicker markPrice(String markPrice) { } /** - * Recent mark price + * Recent mark price. * @return markPrice **/ @javax.annotation.Nullable @@ -383,7 +383,7 @@ public DeliveryTicker fundingRate(String fundingRate) { } /** - * Funding rate + * Funding rate. * @return fundingRate **/ @javax.annotation.Nullable @@ -403,7 +403,7 @@ public DeliveryTicker fundingRateIndicative(String fundingRateIndicative) { } /** - * Indicative Funding rate in next period. (deprecated. use `funding_rate`) + * Indicative Funding rate in next period. (deprecated. use `funding_rate`). * @return fundingRateIndicative **/ @javax.annotation.Nullable @@ -423,7 +423,7 @@ public DeliveryTicker indexPrice(String indexPrice) { } /** - * Index price + * Index price. * @return indexPrice **/ @javax.annotation.Nullable @@ -463,7 +463,7 @@ public DeliveryTicker basisRate(String basisRate) { } /** - * Basis rate + * Basis rate. * @return basisRate **/ @javax.annotation.Nullable @@ -483,7 +483,7 @@ public DeliveryTicker basisValue(String basisValue) { } /** - * Basis value + * Basis value. * @return basisValue **/ @javax.annotation.Nullable @@ -503,7 +503,7 @@ public DeliveryTicker lowestAsk(String lowestAsk) { } /** - * Recent lowest ask + * Recent lowest ask. * @return lowestAsk **/ @javax.annotation.Nullable @@ -523,7 +523,7 @@ public DeliveryTicker lowestSize(String lowestSize) { } /** - * The latest seller's lowest price order quantity + * The latest seller's lowest price order quantity. * @return lowestSize **/ @javax.annotation.Nullable @@ -543,7 +543,7 @@ public DeliveryTicker highestBid(String highestBid) { } /** - * Recent highest bid + * Recent highest bid. * @return highestBid **/ @javax.annotation.Nullable @@ -563,7 +563,7 @@ public DeliveryTicker highestSize(String highestSize) { } /** - * The latest buyer's highest price order volume + * The latest buyer's highest price order volume. * @return highestSize **/ @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 25040ef..eb8c2d6 100644 --- a/src/main/java/io/gate/gateapi/models/DepositAddress.java +++ b/src/main/java/io/gate/gateapi/models/DepositAddress.java @@ -46,7 +46,7 @@ public DepositAddress currency(String currency) { } /** - * Currency detail + * Currency detail. * @return currency **/ public String getCurrency() { @@ -65,7 +65,7 @@ public DepositAddress address(String address) { } /** - * Deposit address + * Deposit address. * @return address **/ public String getAddress() { diff --git a/src/main/java/io/gate/gateapi/models/DepositRecord.java b/src/main/java/io/gate/gateapi/models/DepositRecord.java index 1bfb60e..99c3b4f 100644 --- a/src/main/java/io/gate/gateapi/models/DepositRecord.java +++ b/src/main/java/io/gate/gateapi/models/DepositRecord.java @@ -65,7 +65,7 @@ public class DepositRecord { /** - * Record ID + * Record ID. * @return id **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public String getId() { /** - * Hash record of the withdrawal + * Hash record of the withdrawal. * @return txid **/ @javax.annotation.Nullable @@ -105,7 +105,7 @@ public void setWithdrawOrderId(String withdrawOrderId) { } /** - * Operation time + * Operation time. * @return timestamp **/ @javax.annotation.Nullable @@ -121,7 +121,7 @@ public DepositRecord amount(String amount) { } /** - * Currency amount + * Currency amount. * @return amount **/ public String getAmount() { @@ -140,7 +140,7 @@ public DepositRecord currency(String currency) { } /** - * Currency name + * Currency name. * @return currency **/ public String getCurrency() { @@ -159,7 +159,7 @@ public DepositRecord address(String address) { } /** - * Withdrawal address. Required for withdrawals + * Withdrawal address. Required for withdrawals. * @return address **/ @javax.annotation.Nullable @@ -179,7 +179,7 @@ public DepositRecord memo(String memo) { } /** - * Additional remarks with regards to the withdrawal + * Additional remarks with regards to the withdrawal. * @return memo **/ @javax.annotation.Nullable @@ -209,7 +209,7 @@ public DepositRecord chain(String chain) { } /** - * Name of the chain used in withdrawals + * Name of the chain used in withdrawals. * @return chain **/ public String getChain() { diff --git a/src/main/java/io/gate/gateapi/models/DualGetOrders.java b/src/main/java/io/gate/gateapi/models/DualGetOrders.java index 67c2b85..ee253ee 100644 --- a/src/main/java/io/gate/gateapi/models/DualGetOrders.java +++ b/src/main/java/io/gate/gateapi/models/DualGetOrders.java @@ -99,7 +99,7 @@ public DualGetOrders id(Integer id) { } /** - * Order ID + * Order ID. * @return id **/ @javax.annotation.Nullable @@ -119,7 +119,7 @@ public DualGetOrders planId(Integer planId) { } /** - * Plan ID + * Plan ID. * @return planId **/ @javax.annotation.Nullable @@ -139,7 +139,7 @@ public DualGetOrders copies(String copies) { } /** - * Copies + * Copies. * @return copies **/ @javax.annotation.Nullable @@ -159,7 +159,7 @@ public DualGetOrders investAmount(String investAmount) { } /** - * Investment Amount + * Investment Amount. * @return investAmount **/ @javax.annotation.Nullable @@ -179,7 +179,7 @@ public DualGetOrders settlementAmount(String settlementAmount) { } /** - * Settlement Amount + * Settlement Amount. * @return settlementAmount **/ @javax.annotation.Nullable @@ -199,7 +199,7 @@ public DualGetOrders createTime(Integer createTime) { } /** - * Creation time + * Creation time. * @return createTime **/ @javax.annotation.Nullable @@ -219,7 +219,7 @@ public DualGetOrders completeTime(Integer completeTime) { } /** - * Completion Time + * Completion Time. * @return completeTime **/ @javax.annotation.Nullable @@ -259,7 +259,7 @@ public DualGetOrders investCurrency(String investCurrency) { } /** - * Investment Currency + * Investment Currency. * @return investCurrency **/ @javax.annotation.Nullable @@ -279,7 +279,7 @@ public DualGetOrders exerciseCurrency(String exerciseCurrency) { } /** - * Strike Currency + * Strike Currency. * @return exerciseCurrency **/ @javax.annotation.Nullable @@ -299,7 +299,7 @@ public DualGetOrders exercisePrice(String exercisePrice) { } /** - * Strike price + * Strike price. * @return exercisePrice **/ @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 + * Settle currency. * @return settlementCurrency **/ @javax.annotation.Nullable @@ -359,7 +359,7 @@ public DualGetOrders apyDisplay(String apyDisplay) { } /** - * APY + * APY. * @return apyDisplay **/ @javax.annotation.Nullable @@ -379,7 +379,7 @@ public DualGetOrders apySettlement(String apySettlement) { } /** - * Settlement APY + * Settlement APY. * @return apySettlement **/ @javax.annotation.Nullable @@ -399,7 +399,7 @@ public DualGetOrders deliveryTime(Integer deliveryTime) { } /** - * Settlement time + * Settlement time. * @return deliveryTime **/ @javax.annotation.Nullable @@ -419,7 +419,7 @@ public DualGetOrders text(String text) { } /** - * Custom order information + * Custom order information. * @return text **/ @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 9616642..5e645c1 100644 --- a/src/main/java/io/gate/gateapi/models/DualGetPlans.java +++ b/src/main/java/io/gate/gateapi/models/DualGetPlans.java @@ -83,7 +83,7 @@ public DualGetPlans id(Integer id) { } /** - * Plan ID + * Plan ID. * @return id **/ @javax.annotation.Nullable @@ -103,7 +103,7 @@ public DualGetPlans instrumentName(String instrumentName) { } /** - * Instrument Name + * Instrument Name. * @return instrumentName **/ @javax.annotation.Nullable @@ -123,7 +123,7 @@ public DualGetPlans investCurrency(String investCurrency) { } /** - * Investment Currency + * Investment Currency. * @return investCurrency **/ @javax.annotation.Nullable @@ -143,7 +143,7 @@ public DualGetPlans exerciseCurrency(String exerciseCurrency) { } /** - * Strike Currency + * Strike Currency. * @return exerciseCurrency **/ @javax.annotation.Nullable @@ -163,7 +163,7 @@ public DualGetPlans exercisePrice(Double exercisePrice) { } /** - * Strike price + * Strike price. * @return exercisePrice **/ @javax.annotation.Nullable @@ -183,7 +183,7 @@ public DualGetPlans deliveryTime(Integer deliveryTime) { } /** - * Settlement time + * Settlement time. * @return deliveryTime **/ @javax.annotation.Nullable @@ -203,7 +203,7 @@ public DualGetPlans minCopies(Integer minCopies) { } /** - * Minimum Copies + * Minimum Copies. * @return minCopies **/ @javax.annotation.Nullable @@ -223,7 +223,7 @@ public DualGetPlans maxCopies(Integer maxCopies) { } /** - * Maximum Copies + * Maximum Copies. * @return maxCopies **/ @javax.annotation.Nullable @@ -243,7 +243,7 @@ public DualGetPlans perValue(String perValue) { } /** - * Per Unit Value + * Per Unit Value. * @return perValue **/ @javax.annotation.Nullable @@ -263,7 +263,7 @@ public DualGetPlans apyDisplay(String apyDisplay) { } /** - * APY + * APY. * @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 + * Finished time. * @return endTime **/ @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 81ee348..73a3e21 100644 --- a/src/main/java/io/gate/gateapi/models/Eth2RateList.java +++ b/src/main/java/io/gate/gateapi/models/Eth2RateList.java @@ -43,7 +43,7 @@ public Eth2RateList dateTime(Long dateTime) { } /** - * Date and Time Stamp + * Date and Time Stamp. * @return dateTime **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public Eth2RateList date(String date) { } /** - * Date + * Date. * @return date **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public Eth2RateList rate(String rate) { } /** - * percentage + * percentage. * @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 2c9829a..2b00696 100644 --- a/src/main/java/io/gate/gateapi/models/Eth2Swap.java +++ b/src/main/java/io/gate/gateapi/models/Eth2Swap.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * ETH2 Staking + * ETH2 Staking. */ 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 + * 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 index 71f57e5..dff91bd 100644 --- a/src/main/java/io/gate/gateapi/models/FindCoin.java +++ b/src/main/java/io/gate/gateapi/models/FindCoin.java @@ -39,7 +39,7 @@ public FindCoin coin(String coin) { } /** - * Currency + * Currency. * @return coin **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public FindCoin cointype(String cointype) { } /** - * Coin Type swap-Voucher lock-Locked + * Coin Type swap-Voucher lock-Locked. * @return cointype **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FlashSwapCurrencyPair.java b/src/main/java/io/gate/gateapi/models/FlashSwapCurrencyPair.java index 97e2d62..c5e5f1f 100644 --- a/src/main/java/io/gate/gateapi/models/FlashSwapCurrencyPair.java +++ b/src/main/java/io/gate/gateapi/models/FlashSwapCurrencyPair.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * List all supported currencies in flash swap + * List all supported currencies in flash swap. */ public class FlashSwapCurrencyPair { public static final String SERIALIZED_NAME_CURRENCY_PAIR = "currency_pair"; @@ -63,7 +63,7 @@ public String getCurrencyPair() { /** - * The currency to be sold + * The currency to be sold. * @return sellCurrency **/ @javax.annotation.Nullable @@ -73,7 +73,7 @@ public String getSellCurrency() { /** - * The currency to be bought + * The currency to be bought. * @return buyCurrency **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public String getBuyCurrency() { /** - * The minimum quantity required for selling + * The minimum quantity required for selling. * @return sellMinAmount **/ @javax.annotation.Nullable @@ -93,7 +93,7 @@ public String getSellMinAmount() { /** - * The maximum quantity allowed for selling + * The maximum quantity allowed for selling. * @return sellMaxAmount **/ @javax.annotation.Nullable @@ -103,7 +103,7 @@ public String getSellMaxAmount() { /** - * The minimum quantity required for buying + * The minimum quantity required for buying. * @return buyMinAmount **/ @javax.annotation.Nullable @@ -113,7 +113,7 @@ public String getBuyMinAmount() { /** - * The maximum quantity allowed for buying + * The maximum quantity allowed for buying. * @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 58d6fb8..cf63289 100644 --- a/src/main/java/io/gate/gateapi/models/FlashSwapOrder.java +++ b/src/main/java/io/gate/gateapi/models/FlashSwapOrder.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Flash swap order + * Flash swap order. */ public class FlashSwapOrder { public static final String SERIALIZED_NAME_ID = "id"; @@ -61,7 +61,7 @@ public class FlashSwapOrder { /** - * Flash swap order ID + * Flash swap order ID. * @return id **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public Long getId() { /** - * Creation time of order (in milliseconds) + * Creation time of order (in milliseconds). * @return createTime **/ @javax.annotation.Nullable @@ -81,7 +81,7 @@ public Long getCreateTime() { /** - * User ID + * User ID. * @return userId **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public Long getUserId() { /** - * Currency to sell + * Currency to sell. * @return sellCurrency **/ @javax.annotation.Nullable @@ -101,7 +101,7 @@ public String getSellCurrency() { /** - * Amount to sell + * Amount to sell. * @return sellAmount **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public String getSellAmount() { /** - * Currency to buy + * Currency to buy. * @return buyCurrency **/ @javax.annotation.Nullable @@ -121,7 +121,7 @@ public String getBuyCurrency() { /** - * Amount to buy + * Amount to buy. * @return buyAmount **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public String getBuyAmount() { /** - * Price + * Price. * @return price **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FlashSwapOrderPreview.java b/src/main/java/io/gate/gateapi/models/FlashSwapOrderPreview.java index f583d01..fa0a671 100644 --- a/src/main/java/io/gate/gateapi/models/FlashSwapOrderPreview.java +++ b/src/main/java/io/gate/gateapi/models/FlashSwapOrderPreview.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Initiate a flash swap order preview + * Initiate a flash swap order preview. */ public class FlashSwapOrderPreview { public static final String SERIALIZED_NAME_PREVIEW_ID = "preview_id"; @@ -55,7 +55,7 @@ public FlashSwapOrderPreview previewId(String previewId) { } /** - * Preview result ID + * Preview result ID. * @return previewId **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public FlashSwapOrderPreview sellAmount(String sellAmount) { } /** - * Amount to sell + * Amount to sell. * @return sellAmount **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public FlashSwapOrderPreview buyAmount(String buyAmount) { } /** - * Amount to buy + * Amount to buy. * @return buyAmount **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public FlashSwapOrderPreview price(String price) { } /** - * Price + * Price. * @return price **/ @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 b11b809..f4f477a 100644 --- a/src/main/java/io/gate/gateapi/models/FlashSwapOrderRequest.java +++ b/src/main/java/io/gate/gateapi/models/FlashSwapOrderRequest.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Parameters of flash swap order creation + * Parameters of flash swap order creation. */ public class FlashSwapOrderRequest { public static final String SERIALIZED_NAME_PREVIEW_ID = "preview_id"; @@ -51,7 +51,7 @@ public FlashSwapOrderRequest previewId(String previewId) { } /** - * Preview result ID + * Preview result ID. * @return previewId **/ public String getPreviewId() { @@ -89,7 +89,7 @@ public FlashSwapOrderRequest sellAmount(String sellAmount) { } /** - * Amount to sell (based on the preview result) + * Amount to sell (based on the preview result). * @return sellAmount **/ public String getSellAmount() { @@ -127,7 +127,7 @@ public FlashSwapOrderRequest buyAmount(String buyAmount) { } /** - * Amount to buy (based on the preview result) + * Amount to buy (based on the preview result). * @return buyAmount **/ public String getBuyAmount() { diff --git a/src/main/java/io/gate/gateapi/models/FlashSwapPreviewRequest.java b/src/main/java/io/gate/gateapi/models/FlashSwapPreviewRequest.java index e7f9fcd..9999cd4 100644 --- a/src/main/java/io/gate/gateapi/models/FlashSwapPreviewRequest.java +++ b/src/main/java/io/gate/gateapi/models/FlashSwapPreviewRequest.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Parameters of flash swap order creation + * Parameters of flash swap order creation. */ public class FlashSwapPreviewRequest { public static final String SERIALIZED_NAME_SELL_CURRENCY = "sell_currency"; diff --git a/src/main/java/io/gate/gateapi/models/FundingAccount.java b/src/main/java/io/gate/gateapi/models/FundingAccount.java index 54d7cae..af0a1c8 100644 --- a/src/main/java/io/gate/gateapi/models/FundingAccount.java +++ b/src/main/java/io/gate/gateapi/models/FundingAccount.java @@ -51,7 +51,7 @@ public FundingAccount currency(String currency) { } /** - * Currency name + * Currency name. * @return currency **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public FundingAccount available(String available) { } /** - * Available assets to lend, which is identical to spot account `available` + * Available assets to lend, which is identical to spot account `available`. * @return available **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public FundingAccount locked(String locked) { } /** - * Locked amount. i.e. amount in `open` loans + * Locked amount. i.e. amount in `open` loans. * @return locked **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public FundingAccount lent(String lent) { } /** - * Outstanding loan amount yet to be repaid + * Outstanding loan amount yet to be repaid. * @return lent **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public FundingAccount totalLent(String totalLent) { } /** - * Amount used for lending. total_lent = lent + locked + * Amount used for lending. total_lent = lent + locked. * @return totalLent **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FundingRateRecord.java b/src/main/java/io/gate/gateapi/models/FundingRateRecord.java index efcfbce..bd701b1 100644 --- a/src/main/java/io/gate/gateapi/models/FundingRateRecord.java +++ b/src/main/java/io/gate/gateapi/models/FundingRateRecord.java @@ -39,7 +39,7 @@ public FundingRateRecord t(Long t) { } /** - * Unix timestamp in seconds + * Unix timestamp in seconds. * @return t **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public FundingRateRecord r(String r) { } /** - * Funding rate + * Funding rate. * @return r **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FutureCancelOrderResult.java b/src/main/java/io/gate/gateapi/models/FutureCancelOrderResult.java index c8a86b6..b9a5fa8 100644 --- a/src/main/java/io/gate/gateapi/models/FutureCancelOrderResult.java +++ b/src/main/java/io/gate/gateapi/models/FutureCancelOrderResult.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Order cancellation result + * Order cancellation result. */ public class FutureCancelOrderResult { public static final String SERIALIZED_NAME_ID = "id"; @@ -47,7 +47,7 @@ public FutureCancelOrderResult id(String id) { } /** - * Order ID + * Order ID. * @return id **/ @javax.annotation.Nullable @@ -67,7 +67,7 @@ public FutureCancelOrderResult userId(Long userId) { } /** - * User ID + * User ID. * @return userId **/ @javax.annotation.Nullable @@ -87,7 +87,7 @@ public FutureCancelOrderResult succeeded(Boolean succeeded) { } /** - * Whether cancellation succeeded + * Whether cancellation succeeded. * @return succeeded **/ @javax.annotation.Nullable @@ -107,7 +107,7 @@ public FutureCancelOrderResult message(String message) { } /** - * Error message when failed to cancel the order; empty if succeeded + * Error message when failed to cancel the order; empty if succeeded. * @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 ea4a6c2..2e71819 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesAccount.java +++ b/src/main/java/io/gate/gateapi/models/FuturesAccount.java @@ -156,7 +156,7 @@ public FuturesAccount unrealisedPnl(String unrealisedPnl) { } /** - * Unrealized PNL + * Unrealized PNL. * @return unrealisedPnl **/ @javax.annotation.Nullable @@ -176,7 +176,7 @@ public FuturesAccount positionMargin(String positionMargin) { } /** - * Position margin + * Position margin. * @return positionMargin **/ @javax.annotation.Nullable @@ -196,7 +196,7 @@ public FuturesAccount orderMargin(String orderMargin) { } /** - * Order margin of unfinished orders + * Order margin of unfinished orders. * @return orderMargin **/ @javax.annotation.Nullable @@ -216,7 +216,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) + * The available balance for transferring or trading(including bonus. Bonus can't be withdrawn. The transfer amount needs to deduct the bonus) * @return available **/ @javax.annotation.Nullable @@ -236,7 +236,7 @@ public FuturesAccount point(String point) { } /** - * POINT amount + * POINT amount. * @return point **/ @javax.annotation.Nullable @@ -256,7 +256,7 @@ public FuturesAccount currency(String currency) { } /** - * Settle currency + * Settle currency. * @return currency **/ @javax.annotation.Nullable @@ -276,7 +276,7 @@ public FuturesAccount inDualMode(Boolean inDualMode) { } /** - * Whether dual mode is enabled + * Whether dual mode is enabled. * @return inDualMode **/ @javax.annotation.Nullable @@ -296,7 +296,7 @@ public FuturesAccount enableCredit(Boolean enableCredit) { } /** - * Whether portfolio margin account mode is enabled + * Whether portfolio margin account mode is enabled. * @return enableCredit **/ @javax.annotation.Nullable @@ -316,7 +316,7 @@ public FuturesAccount positionInitialMargin(String positionInitialMargin) { } /** - * Initial margin position, applicable to the portfolio margin account model + * Initial margin position, applicable to the portfolio margin account model. * @return positionInitialMargin **/ @javax.annotation.Nullable @@ -356,7 +356,7 @@ public FuturesAccount bonus(String bonus) { } /** - * Perpetual Contract Bonus + * Perpetual Contract Bonus. * @return bonus **/ @javax.annotation.Nullable @@ -376,7 +376,7 @@ public FuturesAccount enableEvolvedClassic(Boolean enableEvolvedClassic) { } /** - * Classic account margin mode, true-new mode, false-old mode + * Classic account margin mode, true-new mode, false-old mode. * @return enableEvolvedClassic **/ @javax.annotation.Nullable @@ -496,7 +496,7 @@ public FuturesAccount crossMarginBalance(String crossMarginBalance) { } /** - * Full margin balance, suitable for the new classic account margin model + * Full margin balance, suitable for the new classic account margin model. * @return crossMarginBalance **/ @javax.annotation.Nullable @@ -556,7 +556,7 @@ public FuturesAccount isolatedPositionMargin(String isolatedPositionMargin) { } /** - * Ware -position margin, suitable for the new classic account margin model + * Ware -position margin, suitable for the new classic account margin model. * @return isolatedPositionMargin **/ @javax.annotation.Nullable @@ -576,7 +576,7 @@ public FuturesAccount enableNewDualMode(Boolean enableNewDualMode) { } /** - * Whether to open a new two-way position mode + * Whether to open a new two-way position mode. * @return enableNewDualMode **/ @javax.annotation.Nullable @@ -616,7 +616,7 @@ public FuturesAccount enableTieredMm(Boolean enableTieredMm) { } /** - * Whether to enable tiered maintenance margin calculation + * Whether to enable tiered maintenance margin calculation. * @return enableTieredMm **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesAccountBook.java b/src/main/java/io/gate/gateapi/models/FuturesAccountBook.java index df14ba7..a77c950 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesAccountBook.java +++ b/src/main/java/io/gate/gateapi/models/FuturesAccountBook.java @@ -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 + * Changing Type： - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: point_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction */ @JsonAdapter(TypeEnum.Adapter.class) public enum TypeEnum { @@ -124,7 +124,7 @@ public FuturesAccountBook time(Double time) { } /** - * Change time + * Change time. * @return time **/ @javax.annotation.Nullable @@ -144,7 +144,7 @@ public FuturesAccountBook change(String change) { } /** - * Change amount + * Change amount. * @return change **/ @javax.annotation.Nullable @@ -164,7 +164,7 @@ public FuturesAccountBook balance(String balance) { } /** - * Balance after change + * Balance after change. * @return balance **/ @javax.annotation.Nullable @@ -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 + * Changing Type： - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: point_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction * @return type **/ @javax.annotation.Nullable @@ -204,7 +204,7 @@ public FuturesAccountBook text(String text) { } /** - * Comment + * Comment. * @return text **/ @javax.annotation.Nullable @@ -244,7 +244,7 @@ public FuturesAccountBook tradeId(String tradeId) { } /** - * trade id + * trade id. * @return tradeId **/ @javax.annotation.Nullable @@ -264,7 +264,7 @@ public FuturesAccountBook id(String id) { } /** - * Account change record 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 77d2d4b..745c1fb 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesAccountHistory.java +++ b/src/main/java/io/gate/gateapi/models/FuturesAccountHistory.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Statistical data + * Statistical data. */ public class FuturesAccountHistory { public static final String SERIALIZED_NAME_DNW = "dnw"; @@ -71,7 +71,7 @@ public FuturesAccountHistory dnw(String dnw) { } /** - * total amount of deposit and withdraw + * total amount of deposit and withdraw. * @return dnw **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public FuturesAccountHistory pnl(String pnl) { } /** - * total amount of trading profit and loss + * total amount of trading profit and loss. * @return pnl **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public FuturesAccountHistory fee(String fee) { } /** - * total amount of fee + * total amount of fee. * @return fee **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public FuturesAccountHistory refr(String refr) { } /** - * total amount of referrer rebates + * total amount of referrer rebates. * @return refr **/ @javax.annotation.Nullable @@ -151,7 +151,7 @@ public FuturesAccountHistory fund(String fund) { } /** - * total amount of funding costs + * total amount of funding costs. * @return fund **/ @javax.annotation.Nullable @@ -171,7 +171,7 @@ public FuturesAccountHistory pointDnw(String pointDnw) { } /** - * total amount of point deposit and withdraw + * total amount of point deposit and withdraw. * @return pointDnw **/ @javax.annotation.Nullable @@ -191,7 +191,7 @@ public FuturesAccountHistory pointFee(String pointFee) { } /** - * total amount of point fee + * total amount of point fee. * @return pointFee **/ @javax.annotation.Nullable @@ -211,7 +211,7 @@ public FuturesAccountHistory pointRefr(String pointRefr) { } /** - * total amount of referrer rebates of point fee + * total amount of referrer rebates of point fee. * @return pointRefr **/ @javax.annotation.Nullable @@ -231,7 +231,7 @@ public FuturesAccountHistory bonusDnw(String bonusDnw) { } /** - * total amount of perpetual contract bonus transfer + * total amount of perpetual contract bonus transfer. * @return bonusDnw **/ @javax.annotation.Nullable @@ -251,7 +251,7 @@ public FuturesAccountHistory bonusOffset(String bonusOffset) { } /** - * total amount of perpetual contract bonus deduction + * total amount of perpetual contract bonus deduction. * @return bonusOffset **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesAutoDeleverage.java b/src/main/java/io/gate/gateapi/models/FuturesAutoDeleverage.java index e3686f8..aefca70 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesAutoDeleverage.java +++ b/src/main/java/io/gate/gateapi/models/FuturesAutoDeleverage.java @@ -65,7 +65,7 @@ public class FuturesAutoDeleverage { /** - * Automatic deleveraging time + * Automatic deleveraging time. * @return time **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public Long getTime() { /** - * User ID + * User ID. * @return user **/ @javax.annotation.Nullable @@ -85,7 +85,7 @@ public Long getUser() { /** - * Order ID. Order IDs before 2023-02-20 are null + * Order ID. Order IDs before 2023-02-20 are null. * @return orderId **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public Long getOrderId() { /** - * Futures contract + * Futures contract. * @return contract **/ @javax.annotation.Nullable @@ -105,7 +105,7 @@ public String getContract() { /** - * Position leverage + * Position leverage. * @return leverage **/ @javax.annotation.Nullable @@ -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 @@ -125,7 +125,7 @@ public String getCrossLeverageLimit() { /** - * Average entry price + * Average entry price. * @return entryPrice **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public String getEntryPrice() { /** - * Average fill price + * Average fill price. * @return fillPrice **/ @javax.annotation.Nullable @@ -145,7 +145,7 @@ public String getFillPrice() { /** - * Trading size + * Trading size. * @return tradeSize **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public Long getTradeSize() { /** - * Positions after auto-deleveraging + * Positions after auto-deleveraging. * @return positionSize **/ @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 2e6420d..75fc5d6 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesBatchAmendOrderRequest.java +++ b/src/main/java/io/gate/gateapi/models/FuturesBatchAmendOrderRequest.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Modify contract order parameters + * Modify contract order parameters. */ public class FuturesBatchAmendOrderRequest { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; @@ -51,7 +51,7 @@ public FuturesBatchAmendOrderRequest orderId(Long orderId) { } /** - * Order id, order_id and text must contain at least one + * Order id, order_id and text must contain at least one. * @return orderId **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public FuturesBatchAmendOrderRequest text(String text) { } /** - * User-defined order text, at least one of order_id and text must be passed + * User-defined order text, at least one of order_id and text must be passed. * @return text **/ @javax.annotation.Nullable @@ -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. + * The new order size, including the executed order size. - If it is less than or equal to the executed quantity, the order will be cancelled. - The new order direction must be consistent with the original one. - The size of the closing order cannot be modified. - For orders that only reduce positions, if the size is increased, positions may be kicked out. - If the price is not modified, reducing the size will not affect the depth of the queue, and increasing the size will place it at the end of the current price. * @return size **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public FuturesBatchAmendOrderRequest amendText(String amendText) { } /** - * Custom info during amending order + * Custom info during amending order. * @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 7be10dd..a8258a7 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesCandlestick.java +++ b/src/main/java/io/gate/gateapi/models/FuturesCandlestick.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * data point in every timestamp + * data point in every timestamp. */ public class FuturesCandlestick { public static final String SERIALIZED_NAME_T = "t"; @@ -59,7 +59,7 @@ public FuturesCandlestick t(Double t) { } /** - * Unix timestamp in seconds + * Unix timestamp in seconds. * @return t **/ @javax.annotation.Nullable @@ -79,7 +79,7 @@ public FuturesCandlestick v(Long v) { } /** - * size volume (contract size). Only returned if `contract` is not prefixed + * size volume (contract size). Only returned if `contract` is not prefixed. * @return v **/ @javax.annotation.Nullable @@ -99,7 +99,7 @@ public FuturesCandlestick c(String c) { } /** - * Close price (quote currency) + * Close price (quote currency). * @return c **/ @javax.annotation.Nullable @@ -119,7 +119,7 @@ public FuturesCandlestick h(String h) { } /** - * Highest price (quote currency) + * Highest price (quote currency). * @return h **/ @javax.annotation.Nullable @@ -139,7 +139,7 @@ public FuturesCandlestick l(String l) { } /** - * Lowest price (quote currency) + * Lowest price (quote currency). * @return l **/ @javax.annotation.Nullable @@ -159,7 +159,7 @@ public FuturesCandlestick o(String o) { } /** - * Open price (quote currency) + * Open price (quote currency). * @return o **/ @javax.annotation.Nullable @@ -179,7 +179,7 @@ public FuturesCandlestick sum(String sum) { } /** - * Trading volume (unit: Quote currency) + * Trading volume (unit: Quote currency). * @return sum **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesFee.java b/src/main/java/io/gate/gateapi/models/FuturesFee.java index 07db3cf..134860f 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesFee.java +++ b/src/main/java/io/gate/gateapi/models/FuturesFee.java @@ -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"; @@ -33,7 +33,7 @@ public class FuturesFee { /** - * Taker fee + * Taker fee. * @return takerFee **/ @javax.annotation.Nullable @@ -43,7 +43,7 @@ public String getTakerFee() { /** - * maker fee + * maker fee. * @return makerFee **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesIndexConstituents.java b/src/main/java/io/gate/gateapi/models/FuturesIndexConstituents.java index 807a889..186bb5c 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesIndexConstituents.java +++ b/src/main/java/io/gate/gateapi/models/FuturesIndexConstituents.java @@ -36,7 +36,7 @@ public class FuturesIndexConstituents { /** - * Index name + * Index name. * @return index **/ @javax.annotation.Nullable @@ -46,7 +46,7 @@ public String getIndex() { /** - * Constituents + * Constituents. * @return constituents **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesInitialOrder.java b/src/main/java/io/gate/gateapi/models/FuturesInitialOrder.java index e98cabb..877ef5e 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesInitialOrder.java +++ b/src/main/java/io/gate/gateapi/models/FuturesInitialOrder.java @@ -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 order currently only supports ioc mode mode - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled */ @JsonAdapter(TifEnum.Adapter.class) public enum TifEnum { @@ -118,7 +118,7 @@ public FuturesInitialOrder contract(String contract) { } /** - * Futures contract + * Futures contract. * @return contract **/ public String getContract() { @@ -157,7 +157,7 @@ public FuturesInitialOrder price(String price) { } /** - * Order price. Set to 0 to use market price + * Order price. Set to 0 to use market price. * @return price **/ public String getPrice() { @@ -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 order currently only supports ioc mode mode - gtc: GoodTillCancelled - ioc: ImmediateOrCancelled * @return tif **/ @javax.annotation.Nullable @@ -270,7 +270,7 @@ public void setAutoSize(String autoSize) { } /** - * Is the order reduce-only + * Is the order reduce-only. * @return isReduceOnly **/ @javax.annotation.Nullable @@ -280,7 +280,7 @@ public Boolean getIsReduceOnly() { /** - * Is the order to close position + * Is the order to close position. * @return isClose **/ @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 93d15c8..093d3f5 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesLimitRiskTiers.java +++ b/src/main/java/io/gate/gateapi/models/FuturesLimitRiskTiers.java @@ -59,7 +59,7 @@ public FuturesLimitRiskTiers tier(Integer tier) { } /** - * Tier + * Tier. * @return tier **/ @javax.annotation.Nullable @@ -79,7 +79,7 @@ public FuturesLimitRiskTiers riskLimit(String riskLimit) { } /** - * Position risk limit + * Position risk limit. * @return riskLimit **/ @javax.annotation.Nullable @@ -99,7 +99,7 @@ public FuturesLimitRiskTiers initialRate(String initialRate) { } /** - * Initial margin rate + * Initial margin rate. * @return initialRate **/ @javax.annotation.Nullable @@ -119,7 +119,7 @@ public FuturesLimitRiskTiers maintenanceRate(String maintenanceRate) { } /** - * Maintenance margin rate + * Maintenance margin rate. * @return maintenanceRate **/ @javax.annotation.Nullable @@ -139,7 +139,7 @@ public FuturesLimitRiskTiers leverageMax(String leverageMax) { } /** - * Maximum leverage + * Maximum leverage. * @return leverageMax **/ @javax.annotation.Nullable @@ -159,7 +159,7 @@ public FuturesLimitRiskTiers contract(String contract) { } /** - * Markets, visible only during market pagination requests + * Markets, visible only during market pagination requests. * @return contract **/ @javax.annotation.Nullable @@ -179,7 +179,7 @@ public FuturesLimitRiskTiers deduction(String deduction) { } /** - * Maintenance margin quick calculation deduction + * Maintenance margin quick calculation deduction. * @return deduction **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesLiqOrder.java b/src/main/java/io/gate/gateapi/models/FuturesLiqOrder.java index f88d3f6..7eb3974 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesLiqOrder.java +++ b/src/main/java/io/gate/gateapi/models/FuturesLiqOrder.java @@ -53,7 +53,7 @@ public class FuturesLiqOrder { /** - * Liquidation time + * Liquidation time. * @return time **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public Long getTime() { /** - * Futures contract + * Futures contract. * @return contract **/ @javax.annotation.Nullable @@ -73,7 +73,7 @@ public String getContract() { /** - * User position size + * User position size. * @return size **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public Long getSize() { /** - * Number of forced liquidation orders + * Number of forced liquidation orders. * @return orderSize **/ @javax.annotation.Nullable @@ -93,7 +93,7 @@ public Long getOrderSize() { /** - * Liquidation order price + * Liquidation order price. * @return orderPrice **/ @javax.annotation.Nullable @@ -103,7 +103,7 @@ public String getOrderPrice() { /** - * Liquidation order average taker price + * Liquidation order average taker price. * @return fillPrice **/ @javax.annotation.Nullable @@ -113,7 +113,7 @@ public String getFillPrice() { /** - * System liquidation order maker size + * System liquidation order maker size. * @return left **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesLiquidate.java b/src/main/java/io/gate/gateapi/models/FuturesLiquidate.java index bb32e8a..ff6e9fe 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesLiquidate.java +++ b/src/main/java/io/gate/gateapi/models/FuturesLiquidate.java @@ -73,7 +73,7 @@ public class FuturesLiquidate { /** - * Liquidation time + * Liquidation time. * @return time **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public Long getTime() { /** - * Futures contract + * Futures contract. * @return contract **/ @javax.annotation.Nullable @@ -103,7 +103,7 @@ public String getLeverage() { /** - * Position size + * Position size. * @return size **/ @javax.annotation.Nullable @@ -163,7 +163,7 @@ public Long getOrderId() { /** - * Liquidation order price + * Liquidation order price. * @return orderPrice **/ @javax.annotation.Nullable @@ -173,7 +173,7 @@ public String getOrderPrice() { /** - * Liquidation order average taker price + * Liquidation order average taker price. * @return fillPrice **/ @javax.annotation.Nullable @@ -183,7 +183,7 @@ public String getFillPrice() { /** - * Liquidation order maker size + * Liquidation order maker size. * @return left **/ @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 1bea1e3..9d83897 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesOrder.java +++ b/src/main/java/io/gate/gateapi/models/FuturesOrder.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Futures order details + * Futures order details. */ public class FuturesOrder { public static final String SERIALIZED_NAME_ID = "id"; @@ -40,7 +40,7 @@ public class FuturesOrder { 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 - 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 */ @JsonAdapter(FinishAsEnum.Adapter.class) public enum FinishAsEnum { @@ -326,7 +326,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 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 { @@ -384,13 +384,9 @@ 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; - /** - * Futures order ID + * Futures order ID. * @return id **/ @javax.annotation.Nullable @@ -400,7 +396,7 @@ public Long getId() { /** - * User ID + * User ID. * @return user **/ @javax.annotation.Nullable @@ -410,7 +406,7 @@ public Integer getUser() { /** - * Creation time of order + * Creation time of order. * @return createTime **/ @javax.annotation.Nullable @@ -420,7 +416,7 @@ public Double getCreateTime() { /** - * Order finished time. Not returned if order is open + * Order finished time. Not returned if order is open. * @return finishTime **/ @javax.annotation.Nullable @@ -430,7 +426,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 - 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 * @return finishAs **/ @javax.annotation.Nullable @@ -456,7 +452,7 @@ public FuturesOrder contract(String contract) { } /** - * Futures contract + * Futures contract. * @return contract **/ public String getContract() { @@ -514,7 +510,7 @@ public FuturesOrder price(String price) { } /** - * Order price. 0 for market order with `tif` set as `ioc` + * Order price. 0 for market order with `tif` set as `ioc`. * @return price **/ @javax.annotation.Nullable @@ -534,7 +530,7 @@ public FuturesOrder close(Boolean close) { } /** - * Set as `true` to close the position, with `size` set to 0 + * Set as `true` to close the position, with `size` set to 0. * @return close **/ @javax.annotation.Nullable @@ -548,7 +544,7 @@ public void setClose(Boolean close) { } /** - * Is the order to close position + * Is the order to close position. * @return isClose **/ @javax.annotation.Nullable @@ -564,7 +560,7 @@ public FuturesOrder reduceOnly(Boolean reduceOnly) { } /** - * Set as `true` to be reduce-only order + * Set as `true` to be reduce-only order. * @return reduceOnly **/ @javax.annotation.Nullable @@ -578,7 +574,7 @@ public void setReduceOnly(Boolean reduceOnly) { } /** - * Is the order reduce-only + * Is the order reduce-only. * @return isReduceOnly **/ @javax.annotation.Nullable @@ -588,7 +584,7 @@ public Boolean getIsReduceOnly() { /** - * Is the order for liquidation + * Is the order for liquidation. * @return isLiq **/ @javax.annotation.Nullable @@ -618,7 +614,7 @@ public void setTif(TifEnum tif) { } /** - * Size left to be traded + * Size left to be traded. * @return left **/ @javax.annotation.Nullable @@ -628,7 +624,7 @@ public Long getLeft() { /** - * Fill price of the order + * Fill price of the order. * @return fillPrice **/ @javax.annotation.Nullable @@ -644,7 +640,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 + * Order custom information, users can use this field to set a custom ID, and the user-defined field must meet the following conditions: 1. Must start with `t-` 2. If `t-` is not calculated, the length cannot exceed 28 bytes 3. The input content can only contain numbers, letters, underscores (_), midscores (-) or dots (.) In addition to user-defined information, the following are internal reserved fields that identifies the source of the order: - web: web page - api: API call - app: mobile terminal - auto_deleveraging: Automatic position reduction - liquidation: Liquidation under the classic account’s old liquidation mode - liq-x: new liquidation mode (isolated, cross margin one-way mode, non-hedging part of cross margin hedge mode) b. Liquidation under isolated margin in unified account single currency margin mode - hedge-liq-x: Liquidation under the new liquidation mode of the classic account hedge mode, the cross margin hedged part undergoes liquidation, meaning both long and short positions are liquidated simultaneously. - pm_liquidate: Unified account multi-currency margin mode liquidation - comb_margin_liquidate: Unified account portfolio margin mode liquidation - scm_liquidate: Unified account single currency margin mode liquidation - insurance: insurance * @return text **/ @javax.annotation.Nullable @@ -658,7 +654,7 @@ public void setText(String text) { } /** - * Taker fee + * Taker fee. * @return tkfr **/ @javax.annotation.Nullable @@ -668,7 +664,7 @@ public String getTkfr() { /** - * Maker fee + * Maker fee. * @return mkfr **/ @javax.annotation.Nullable @@ -678,7 +674,7 @@ public String getMkfr() { /** - * Reference user ID + * Reference user ID. * @return refu **/ @javax.annotation.Nullable @@ -724,7 +720,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 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 @@ -738,7 +734,7 @@ public void setStpAct(StpActEnum stpAct) { } /** - * The custom data that the user remarked when amending the order + * The custom data that the user remarked when amending the order. * @return amendText **/ @javax.annotation.Nullable @@ -746,16 +742,6 @@ public String getAmendText() { return amendText; } - - /** - * Additional information - * @return bizInfo - **/ - @javax.annotation.Nullable - public String getBizInfo() { - return bizInfo; - } - @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -790,13 +776,12 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.autoSize, futuresOrder.autoSize) && 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.amendText, futuresOrder.amendText); } @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, finishTime, finishAs, status, contract, size, iceberg, price, close, isClose, reduceOnly, isReduceOnly, isLiq, tif, left, fillPrice, text, tkfr, mkfr, refu, autoSize, stpId, stpAct, amendText); } @@ -830,7 +815,6 @@ 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("}"); 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 f95efa8..e77611f 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesOrderAmendment.java +++ b/src/main/java/io/gate/gateapi/models/FuturesOrderAmendment.java @@ -35,14 +35,6 @@ 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 FuturesOrderAmendment size(Long size) { @@ -91,7 +83,7 @@ public FuturesOrderAmendment amendText(String amendText) { } /** - * Custom info during amending order + * Custom info during amending order. * @return amendText **/ @javax.annotation.Nullable @@ -103,46 +95,6 @@ public String getAmendText() { 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) { - - this.bbo = bbo; - return this; - } - - /** - * Users are able to modify the offer price manually. - * @return bbo - **/ - @javax.annotation.Nullable - public String getBbo() { - return bbo; - } - - - public void setBbo(String bbo) { - this.bbo = bbo; - } @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -154,14 +106,12 @@ public boolean equals(java.lang.Object o) { FuturesOrderAmendment futuresOrderAmendment = (FuturesOrderAmendment) 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.amendText, futuresOrderAmendment.amendText); } @Override public int hashCode() { - return Objects.hash(size, price, amendText, bizInfo, bbo); + return Objects.hash(size, price, amendText); } @@ -172,8 +122,6 @@ 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("}"); 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 9cf150d..d4680d5 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesOrderBook.java +++ b/src/main/java/io/gate/gateapi/models/FuturesOrderBook.java @@ -74,7 +74,7 @@ public FuturesOrderBook current(Double current) { } /** - * Response data generation timestamp + * Response data generation timestamp. * @return current **/ @javax.annotation.Nullable @@ -94,7 +94,7 @@ public FuturesOrderBook update(Double update) { } /** - * Order book changed timestamp + * Order book changed timestamp. * @return update **/ @javax.annotation.Nullable @@ -119,7 +119,7 @@ public FuturesOrderBook addAsksItem(FuturesOrderBookItem asksItem) { } /** - * Asks order depth + * Asks order depth. * @return asks **/ public List getAsks() { @@ -143,7 +143,7 @@ public FuturesOrderBook addBidsItem(FuturesOrderBookItem bidsItem) { } /** - * Bids order depth + * Bids order 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 fcd05e0..90eabec 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesOrderBookItem.java +++ b/src/main/java/io/gate/gateapi/models/FuturesOrderBookItem.java @@ -39,7 +39,7 @@ public FuturesOrderBookItem p(String p) { } /** - * Price (quote currency) + * Price (quote currency). * @return p **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public FuturesOrderBookItem s(Long s) { } /** - * Size + * Size. * @return s **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesPositionCrossMode.java b/src/main/java/io/gate/gateapi/models/FuturesPositionCrossMode.java index 317af9d..97f00c8 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesPositionCrossMode.java +++ b/src/main/java/io/gate/gateapi/models/FuturesPositionCrossMode.java @@ -39,7 +39,7 @@ public FuturesPositionCrossMode mode(String mode) { } /** - * Full position-by-position model, ISOLATED-by-position, CROSS-full position + * Full position-by-position model, ISOLATED-by-position, CROSS-full position. * @return mode **/ public String getMode() { @@ -58,7 +58,7 @@ public FuturesPositionCrossMode contract(String contract) { } /** - * Contract Market + * Contract Market. * @return contract **/ public String getContract() { diff --git a/src/main/java/io/gate/gateapi/models/FuturesPremiumIndex.java b/src/main/java/io/gate/gateapi/models/FuturesPremiumIndex.java index caa4419..78542ad 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesPremiumIndex.java +++ b/src/main/java/io/gate/gateapi/models/FuturesPremiumIndex.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * data point in every timestamp + * data point in every timestamp. */ public class FuturesPremiumIndex { public static final String SERIALIZED_NAME_T = "t"; @@ -51,7 +51,7 @@ public FuturesPremiumIndex t(Double t) { } /** - * Unix timestamp in seconds + * Unix timestamp in seconds. * @return t **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public FuturesPremiumIndex c(String c) { } /** - * Close price + * Close price. * @return c **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public FuturesPremiumIndex h(String h) { } /** - * Highest price + * Highest price. * @return h **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public FuturesPremiumIndex l(String l) { } /** - * Lowest price` + * Lowest price`. * @return l **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public FuturesPremiumIndex o(String o) { } /** - * Open price + * Open price. * @return o **/ @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 fb02e7d..da15a80 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesPriceTrigger.java +++ b/src/main/java/io/gate/gateapi/models/FuturesPriceTrigger.java @@ -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 + * Price type. 0 - latest deal 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: Indicates that the price calculated based on `strategy_type` and `price_type` is greater than or equal to `Trigger.Price` Trigger, while Trigger.Price must > last_price - based on `strategy_type` and `price_type` is less than or equal to `Trigger.Price` Trigger, and Trigger.Price must < last_price */ @JsonAdapter(RuleEnum.Adapter.class) public enum RuleEnum { @@ -214,7 +214,7 @@ public FuturesPriceTrigger priceType(PriceTypeEnum priceType) { } /** - * Price type. 0 - latest deal price, 1 - mark price, 2 - index price + * Price type. 0 - latest deal 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 + * Value of price on price triggered, or price gap on price gap triggered. * @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: Indicates that the price calculated based on `strategy_type` and `price_type` is greater than or equal to `Trigger.Price` Trigger, while Trigger.Price must > last_price - based on `strategy_type` and `price_type` is less than or equal to `Trigger.Price` Trigger, and Trigger.Price must < last_price * @return rule **/ @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 a179ecd..13eee5d 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesPriceTriggeredOrder.java +++ b/src/main/java/io/gate/gateapi/models/FuturesPriceTriggeredOrder.java @@ -22,7 +22,7 @@ import java.io.IOException; /** - * Futures order details + * Futures 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 + * Auto order status - `open`: order is active - `finished`: order is finished - `inactive`: order is not active, only for close-long-order or close-short-order - `invalid`: order is close-short-order */ @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 + * How order is finished. */ @JsonAdapter(FinishAsEnum.Adapter.class) public enum FinishAsEnum { @@ -215,7 +215,7 @@ public void setTrigger(FuturesPriceTrigger trigger) { } /** - * Auto order ID + * Auto order ID. * @return id **/ @javax.annotation.Nullable @@ -225,7 +225,7 @@ public Long getId() { /** - * User ID + * User ID. * @return user **/ @javax.annotation.Nullable @@ -235,7 +235,7 @@ public Integer getUser() { /** - * Creation time + * Creation time. * @return createTime **/ @javax.annotation.Nullable @@ -245,7 +245,7 @@ public Double getCreateTime() { /** - * Finished time + * Finished 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 newly created order on condition triggered. * @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 + * Auto order status - `open`: order is active - `finished`: order is finished - `inactive`: order is not active, only for close-long-order or close-short-order - `invalid`: order is close-short-order * @return status **/ @javax.annotation.Nullable @@ -275,7 +275,7 @@ public StatusEnum getStatus() { /** - * How order is finished + * How order is finished. * @return finishAs **/ @javax.annotation.Nullable @@ -285,7 +285,7 @@ public FinishAsEnum getFinishAs() { /** - * Additional remarks on how the order was finished + * Additional remarks on how the order was finished. * @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 stop-profit and stop-loss, including: - `close-long-order`: Entrusting order stop profit and stop loss, flat long position - `close-short-order`: loss, short position - `close-long-position`: Position stop-profit stop loss, used to close long positions - `close-short-position`: Position stop-profit stop loss, used to close all short positions - `plan-close-long-position`: Position plan take profit and stop loss, used to close long positions in all or part of long positions - `plan-close-short-position`: Position plan stop-profit and stop loss, used to close all short positions or partially close short positions The two types of entrusted order stop-profit and stop-loss are read-only and cannot be passed in through requests * @return orderType **/ @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 index 112578b..2d8ad4a 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesRiskLimitTier.java +++ b/src/main/java/io/gate/gateapi/models/FuturesRiskLimitTier.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Information for each tier of the risk limit ladder + * Information for each tier of the risk limit ladder. */ public class FuturesRiskLimitTier { public static final String SERIALIZED_NAME_TIER = "tier"; @@ -55,7 +55,7 @@ public FuturesRiskLimitTier tier(Integer tier) { } /** - * Tier + * Tier. * @return tier **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public FuturesRiskLimitTier riskLimit(String riskLimit) { } /** - * Position risk limit + * Position risk limit. * @return riskLimit **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public FuturesRiskLimitTier initialRate(String initialRate) { } /** - * Initial margin rate + * Initial margin rate. * @return initialRate **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public FuturesRiskLimitTier maintenanceRate(String maintenanceRate) { } /** - * Maintenance margin rate + * Maintenance margin rate. * @return maintenanceRate **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public FuturesRiskLimitTier leverageMax(String leverageMax) { } /** - * Maximum leverage + * Maximum leverage. * @return leverageMax **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public FuturesRiskLimitTier deduction(String deduction) { } /** - * Maintenance margin quick calculation deduction + * Maintenance margin quick calculation deduction. * @return deduction **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesTicker.java b/src/main/java/io/gate/gateapi/models/FuturesTicker.java index 6861704..74cd510 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesTicker.java +++ b/src/main/java/io/gate/gateapi/models/FuturesTicker.java @@ -115,7 +115,7 @@ public FuturesTicker contract(String contract) { } /** - * Futures contract + * Futures contract. * @return contract **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public FuturesTicker last(String last) { } /** - * Last trading price + * Last trading price. * @return last **/ @javax.annotation.Nullable @@ -175,7 +175,7 @@ public FuturesTicker totalSize(String totalSize) { } /** - * Contract total size + * Contract total size. * @return totalSize **/ @javax.annotation.Nullable @@ -195,7 +195,7 @@ public FuturesTicker low24h(String low24h) { } /** - * Lowest trading price in recent 24h + * Lowest trading price in recent 24h. * @return low24h **/ @javax.annotation.Nullable @@ -215,7 +215,7 @@ public FuturesTicker high24h(String high24h) { } /** - * Highest trading price in recent 24h + * Highest trading price in recent 24h. * @return high24h **/ @javax.annotation.Nullable @@ -235,7 +235,7 @@ public FuturesTicker volume24h(String volume24h) { } /** - * Trade size in recent 24h + * Trade size in recent 24h. * @return volume24h **/ @javax.annotation.Nullable @@ -295,7 +295,7 @@ public FuturesTicker volume24hBase(String volume24hBase) { } /** - * Trade volume in recent 24h, in base currency + * Trade volume in recent 24h, in base currency. * @return volume24hBase **/ @javax.annotation.Nullable @@ -315,7 +315,7 @@ public FuturesTicker volume24hQuote(String volume24hQuote) { } /** - * Trade volume in recent 24h, in quote currency + * Trade volume in recent 24h, in quote currency. * @return volume24hQuote **/ @javax.annotation.Nullable @@ -335,7 +335,7 @@ public FuturesTicker volume24hSettle(String volume24hSettle) { } /** - * Trade volume in recent 24h, in settle currency + * Trade volume in recent 24h, in settle currency. * @return volume24hSettle **/ @javax.annotation.Nullable @@ -355,7 +355,7 @@ public FuturesTicker markPrice(String markPrice) { } /** - * Recent mark price + * Recent mark price. * @return markPrice **/ @javax.annotation.Nullable @@ -375,7 +375,7 @@ public FuturesTicker fundingRate(String fundingRate) { } /** - * Funding rate + * Funding rate. * @return fundingRate **/ @javax.annotation.Nullable @@ -395,7 +395,7 @@ public FuturesTicker fundingRateIndicative(String fundingRateIndicative) { } /** - * Indicative Funding rate in next period. (deprecated. use `funding_rate`) + * Indicative Funding rate in next period. (deprecated. use `funding_rate`). * @return fundingRateIndicative **/ @javax.annotation.Nullable @@ -415,7 +415,7 @@ public FuturesTicker indexPrice(String indexPrice) { } /** - * Index price + * Index price. * @return indexPrice **/ @javax.annotation.Nullable @@ -455,7 +455,7 @@ public FuturesTicker lowestAsk(String lowestAsk) { } /** - * Recent lowest ask + * Recent lowest ask. * @return lowestAsk **/ @javax.annotation.Nullable @@ -475,7 +475,7 @@ public FuturesTicker lowestSize(String lowestSize) { } /** - * The latest seller's lowest price order quantity + * The latest seller's lowest price order quantity. * @return lowestSize **/ @javax.annotation.Nullable @@ -495,7 +495,7 @@ public FuturesTicker highestBid(String highestBid) { } /** - * Recent highest bid + * Recent highest bid. * @return highestBid **/ @javax.annotation.Nullable @@ -515,7 +515,7 @@ public FuturesTicker highestSize(String highestSize) { } /** - * The latest buyer's highest price order volume + * The latest buyer's highest price order volume. * @return highestSize **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesTrade.java b/src/main/java/io/gate/gateapi/models/FuturesTrade.java index dc55f5c..bb5f6da 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesTrade.java +++ b/src/main/java/io/gate/gateapi/models/FuturesTrade.java @@ -59,7 +59,7 @@ public FuturesTrade id(Long id) { } /** - * Trade ID + * Trade ID. * @return id **/ @javax.annotation.Nullable @@ -79,7 +79,7 @@ public FuturesTrade createTime(Double createTime) { } /** - * Trading time + * Trading time. * @return createTime **/ @javax.annotation.Nullable @@ -119,7 +119,7 @@ public FuturesTrade contract(String contract) { } /** - * Futures contract + * Futures contract. * @return contract **/ @javax.annotation.Nullable @@ -139,7 +139,7 @@ public FuturesTrade size(Long size) { } /** - * Trading size + * Trading size. * @return size **/ @javax.annotation.Nullable @@ -159,7 +159,7 @@ public FuturesTrade price(String price) { } /** - * Trading price (quote currency) + * Trading 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 internal trade. Internal trade refers to the takeover of liquidation orders by the insurance fund and ADL users. Since it is not a normal matching on the market depth, the transaction price may deviate, and it will not be recorded in the K-line. an internal trade, this field will not be returned. * @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 ab72f27..036c948 100644 --- a/src/main/java/io/gate/gateapi/models/IndexConstituent.java +++ b/src/main/java/io/gate/gateapi/models/IndexConstituent.java @@ -41,7 +41,7 @@ public IndexConstituent exchange(String exchange) { } /** - * Exchange + * Exchange. * @return exchange **/ @javax.annotation.Nullable @@ -69,7 +69,7 @@ public IndexConstituent addSymbolsItem(String symbolsItem) { } /** - * Symbol list + * Symbol list. * @return symbols **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/InlineResponse2001.java b/src/main/java/io/gate/gateapi/models/InlineResponse2001.java index 769a1fa..c286e53 100644 --- a/src/main/java/io/gate/gateapi/models/InlineResponse2001.java +++ b/src/main/java/io/gate/gateapi/models/InlineResponse2001.java @@ -59,7 +59,7 @@ public InlineResponse2001 estRate(String estRate) { } /** - * Unconverted percentage + * Unconverted percentage. * @return estRate **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/InsuranceRecord.java b/src/main/java/io/gate/gateapi/models/InsuranceRecord.java index 279f215..61e7ec5 100644 --- a/src/main/java/io/gate/gateapi/models/InsuranceRecord.java +++ b/src/main/java/io/gate/gateapi/models/InsuranceRecord.java @@ -39,7 +39,7 @@ public InsuranceRecord t(Long t) { } /** - * Unix timestamp in seconds + * Unix timestamp in seconds. * @return t **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public InsuranceRecord b(String b) { } /** - * Insurance balance + * Insurance balance. * @return b **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/LedgerRecord.java b/src/main/java/io/gate/gateapi/models/LedgerRecord.java index 95231e0..2ac93ba 100644 --- a/src/main/java/io/gate/gateapi/models/LedgerRecord.java +++ b/src/main/java/io/gate/gateapi/models/LedgerRecord.java @@ -73,7 +73,7 @@ public class LedgerRecord { /** - * Record ID + * Record ID. * @return id **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public String getId() { /** - * Hash record of the withdrawal + * Hash record of the withdrawal. * @return txid **/ @javax.annotation.Nullable @@ -113,7 +113,7 @@ public void setWithdrawOrderId(String withdrawOrderId) { } /** - * Operation time + * Operation time. * @return timestamp **/ @javax.annotation.Nullable @@ -129,7 +129,7 @@ public LedgerRecord amount(String amount) { } /** - * Currency amount + * Currency amount. * @return amount **/ public String getAmount() { @@ -148,7 +148,7 @@ public LedgerRecord currency(String currency) { } /** - * Currency name + * Currency name. * @return currency **/ public String getCurrency() { @@ -167,7 +167,7 @@ public LedgerRecord address(String address) { } /** - * Withdrawal address. Required for withdrawals + * Withdrawal address. Required for withdrawals. * @return address **/ @javax.annotation.Nullable @@ -187,7 +187,7 @@ public LedgerRecord memo(String memo) { } /** - * Additional remarks with regards to the withdrawal + * Additional remarks with regards to the withdrawal. * @return memo **/ @javax.annotation.Nullable @@ -257,7 +257,7 @@ public LedgerRecord chain(String chain) { } /** - * Name of the chain used in withdrawals + * Name of the chain used in withdrawals. * @return chain **/ public String getChain() { diff --git a/src/main/java/io/gate/gateapi/models/LiquidateOrder.java b/src/main/java/io/gate/gateapi/models/LiquidateOrder.java index d0d5e12..b5515fc 100644 --- a/src/main/java/io/gate/gateapi/models/LiquidateOrder.java +++ b/src/main/java/io/gate/gateapi/models/LiquidateOrder.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Liquidate Order detail + * Liquidate Order detail. */ public class LiquidateOrder { public static final String SERIALIZED_NAME_TEXT = "text"; @@ -71,7 +71,7 @@ public LiquidateOrder currencyPair(String currencyPair) { } /** - * Currency pair + * Currency pair. * @return currencyPair **/ public String getCurrencyPair() { @@ -90,7 +90,7 @@ public LiquidateOrder amount(String amount) { } /** - * Trade amount + * Trade amount. * @return amount **/ public String getAmount() { @@ -109,7 +109,7 @@ public LiquidateOrder price(String price) { } /** - * Order price + * Order price. * @return price **/ public String getPrice() { diff --git a/src/main/java/io/gate/gateapi/models/MarginAccount.java b/src/main/java/io/gate/gateapi/models/MarginAccount.java index a5b953d..ff64872 100644 --- a/src/main/java/io/gate/gateapi/models/MarginAccount.java +++ b/src/main/java/io/gate/gateapi/models/MarginAccount.java @@ -64,7 +64,7 @@ public MarginAccount currencyPair(String currencyPair) { } /** - * Currency pair + * Currency pair. * @return currencyPair **/ @javax.annotation.Nullable @@ -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 market not activated * @return accountType **/ @javax.annotation.Nullable @@ -104,7 +104,7 @@ public MarginAccount leverage(String leverage) { } /** - * User current market leverage multiple + * User current market leverage multiple. * @return leverage **/ @javax.annotation.Nullable @@ -124,7 +124,7 @@ public MarginAccount locked(Boolean locked) { } /** - * Whether account is locked + * Whether account is locked. * @return locked **/ @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 34179b4..215c2a2 100644 --- a/src/main/java/io/gate/gateapi/models/MarginAccountBook.java +++ b/src/main/java/io/gate/gateapi/models/MarginAccountBook.java @@ -63,7 +63,7 @@ public MarginAccountBook id(String id) { } /** - * Balance change record ID + * Balance change record ID. * @return id **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public MarginAccountBook time(String time) { } /** - * Balance changed timestamp + * Balance changed timestamp. * @return time **/ @javax.annotation.Nullable @@ -103,7 +103,7 @@ public MarginAccountBook timeMs(Long timeMs) { } /** - * The timestamp of the change (in milliseconds) + * The timestamp of the change (in milliseconds). * @return timeMs **/ @javax.annotation.Nullable @@ -123,7 +123,7 @@ public MarginAccountBook currency(String currency) { } /** - * Currency changed + * Currency changed. * @return currency **/ @javax.annotation.Nullable @@ -143,7 +143,7 @@ public MarginAccountBook currencyPair(String currencyPair) { } /** - * Account currency pair + * Account currency pair. * @return currencyPair **/ @javax.annotation.Nullable @@ -163,7 +163,7 @@ public MarginAccountBook change(String change) { } /** - * Amount changed. Positive value means transferring in, while negative out + * Amount changed. Positive value means transferring in, while negative out. * @return change **/ @javax.annotation.Nullable @@ -183,7 +183,7 @@ public MarginAccountBook balance(String balance) { } /** - * Balance after change + * Balance after change. * @return balance **/ @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 b51cd76..aae616f 100644 --- a/src/main/java/io/gate/gateapi/models/MarginAccountCurrency.java +++ b/src/main/java/io/gate/gateapi/models/MarginAccountCurrency.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Account currency details + * Account currency details. */ public class MarginAccountCurrency { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -51,7 +51,7 @@ public MarginAccountCurrency currency(String currency) { } /** - * Currency name + * Currency name. * @return currency **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public MarginAccountCurrency locked(String locked) { } /** - * Locked amount, used in margin trading + * Locked amount, used in margin trading. * @return locked **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public MarginAccountCurrency borrowed(String borrowed) { } /** - * Borrowed amount + * Borrowed amount. * @return borrowed **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public MarginAccountCurrency interest(String interest) { } /** - * Unpaid interests + * Unpaid interests. * @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 116356d..225c2f5 100644 --- a/src/main/java/io/gate/gateapi/models/MarginLeverageTier.java +++ b/src/main/java/io/gate/gateapi/models/MarginLeverageTier.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Market gradient information + * Market gradient information. */ public class MarginLeverageTier { public static final String SERIALIZED_NAME_UPPER_LIMIT = "upper_limit"; @@ -43,7 +43,7 @@ public MarginLeverageTier upperLimit(String upperLimit) { } /** - * Maximum loan limit + * Maximum loan limit. * @return upperLimit **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public MarginLeverageTier mmr(String mmr) { } /** - * Maintenance margin rate + * Maintenance margin rate. * @return mmr **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public MarginLeverageTier leverage(String leverage) { } /** - * Maximum leverage multiple + * Maximum leverage multiple. * @return leverage **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MarginMarketLeverage.java b/src/main/java/io/gate/gateapi/models/MarginMarketLeverage.java index 74cdb60..abd5b69 100644 --- a/src/main/java/io/gate/gateapi/models/MarginMarketLeverage.java +++ b/src/main/java/io/gate/gateapi/models/MarginMarketLeverage.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Market leverage settings + * Market leverage settings. */ public class MarginMarketLeverage { public static final String SERIALIZED_NAME_CURRENCY_PAIR = "currency_pair"; @@ -39,7 +39,7 @@ public MarginMarketLeverage currencyPair(String currencyPair) { } /** - * Currency pair + * Currency pair. * @return currencyPair **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public MarginMarketLeverage leverage(String leverage) { } /** - * Position leverage + * Position leverage. * @return leverage **/ public String getLeverage() { diff --git a/src/main/java/io/gate/gateapi/models/MarginTiers.java b/src/main/java/io/gate/gateapi/models/MarginTiers.java index 590adca..08fc7fd 100644 --- a/src/main/java/io/gate/gateapi/models/MarginTiers.java +++ b/src/main/java/io/gate/gateapi/models/MarginTiers.java @@ -51,7 +51,7 @@ public MarginTiers tier(String tier) { } /** - * Tier + * Tier. * @return tier **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public MarginTiers marginRate(String marginRate) { } /** - * Discount + * Discount. * @return marginRate **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public MarginTiers lowerLimit(String lowerLimit) { } /** - * Lower limit + * Lower limit. * @return lowerLimit **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public MarginTiers upperLimit(String upperLimit) { } /** - * Upper limit, \"\" indicates greater than (the last tier) + * Upper limit, \"\" indicates greater than (the last tier). * @return upperLimit **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public MarginTiers leverage(String leverage) { } /** - * Position leverage + * Position leverage. * @return leverage **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MarginTransferable.java b/src/main/java/io/gate/gateapi/models/MarginTransferable.java index 821da0a..6badb24 100644 --- a/src/main/java/io/gate/gateapi/models/MarginTransferable.java +++ b/src/main/java/io/gate/gateapi/models/MarginTransferable.java @@ -43,7 +43,7 @@ public MarginTransferable currency(String currency) { } /** - * Currency detail + * Currency detail. * @return currency **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public MarginTransferable currencyPair(String currencyPair) { } /** - * Currency pair + * Currency pair. * @return currencyPair **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public MarginTransferable amount(String amount) { } /** - * Max transferable amount + * Max transferable amount. * @return amount **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MaxUniBorrowable.java b/src/main/java/io/gate/gateapi/models/MaxUniBorrowable.java index 76a1cc4..b4fb683 100644 --- a/src/main/java/io/gate/gateapi/models/MaxUniBorrowable.java +++ b/src/main/java/io/gate/gateapi/models/MaxUniBorrowable.java @@ -37,7 +37,7 @@ public class MaxUniBorrowable { /** - * Currency + * Currency. * @return currency **/ public String getCurrency() { @@ -46,7 +46,7 @@ public String getCurrency() { /** - * Currency pair + * Currency pair. * @return currencyPair **/ @javax.annotation.Nullable @@ -56,7 +56,7 @@ public String getCurrencyPair() { /** - * Maximum borrowable + * Maximum borrowable. * @return borrowable **/ public String getBorrowable() { diff --git a/src/main/java/io/gate/gateapi/models/MockFuturesOrder.java b/src/main/java/io/gate/gateapi/models/MockFuturesOrder.java index ce7be6a..eb2bd49 100644 --- a/src/main/java/io/gate/gateapi/models/MockFuturesOrder.java +++ b/src/main/java/io/gate/gateapi/models/MockFuturesOrder.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Futures order + * Futures order. */ public class MockFuturesOrder { public static final String SERIALIZED_NAME_CONTRACT = "contract"; @@ -81,7 +81,7 @@ public MockFuturesOrder left(String left) { } /** - * Unfilled contract quantity, involved in actual calculation + * Unfilled contract quantity, involved in actual calculation. * @return left **/ public String getLeft() { diff --git a/src/main/java/io/gate/gateapi/models/MockFuturesPosition.java b/src/main/java/io/gate/gateapi/models/MockFuturesPosition.java index 83eae2a..5805cb2 100644 --- a/src/main/java/io/gate/gateapi/models/MockFuturesPosition.java +++ b/src/main/java/io/gate/gateapi/models/MockFuturesPosition.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Futures positions + * Futures positions. */ public class MockFuturesPosition { public static final String SERIALIZED_NAME_CONTRACT = "contract"; diff --git a/src/main/java/io/gate/gateapi/models/MockMarginResult.java b/src/main/java/io/gate/gateapi/models/MockMarginResult.java index c21fb61..6430ad1 100644 --- a/src/main/java/io/gate/gateapi/models/MockMarginResult.java +++ b/src/main/java/io/gate/gateapi/models/MockMarginResult.java @@ -23,7 +23,7 @@ import java.util.List; /** - * Margin result + * Margin result. */ public class MockMarginResult { public static final String SERIALIZED_NAME_TYPE = "type"; @@ -62,7 +62,7 @@ public MockMarginResult type(String type) { } /** - * Position combination type `original_position` - Original position `long_delta_original_position` - Positive delta + Original position `short_delta_original_position` - Negative delta + Original position + * Position combination type `original_position` - Original position `long_delta_original_position` - Positive delta + Original position `short_delta_original_position` position * @return type **/ @javax.annotation.Nullable @@ -90,7 +90,7 @@ public MockMarginResult addProfitLossRangesItem(ProfitLossRange profitLossRanges } /** - * The results of 33 pressure scenarios for MR1 + * The results of 3 pressure scenarios for MR1. * @return profitLossRanges **/ @javax.annotation.Nullable @@ -130,7 +130,7 @@ public MockMarginResult mr1(String mr1) { } /** - * Stress testing + * Stress testing. * @return mr1 **/ @javax.annotation.Nullable @@ -150,7 +150,7 @@ public MockMarginResult mr2(String mr2) { } /** - * Basis spread risk + * Basis spread risk. * @return mr2 **/ @javax.annotation.Nullable @@ -170,7 +170,7 @@ public MockMarginResult mr3(String mr3) { } /** - * Volatility spread risk + * Volatility spread risk. * @return mr3 **/ @javax.annotation.Nullable @@ -190,7 +190,7 @@ public MockMarginResult mr4(String mr4) { } /** - * Option short risk + * Option short risk. * @return mr4 **/ @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 e5b3bee..87dd16d 100644 --- a/src/main/java/io/gate/gateapi/models/MockOptionsOrder.java +++ b/src/main/java/io/gate/gateapi/models/MockOptionsOrder.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Option orders + * Option orders. */ public class MockOptionsOrder { public static final String SERIALIZED_NAME_OPTIONS_NAME = "options_name"; @@ -62,7 +62,7 @@ public MockOptionsOrder size(String size) { } /** - * Initial order quantity, not involved in actual calculation + * Initial order quantity, not involved in actual calculation. * @return size **/ public String getSize() { @@ -81,7 +81,7 @@ public MockOptionsOrder left(String left) { } /** - * Unfilled contract quantity, involved in actual calculation + * Unfilled contract quantity, involved in actual calculation. * @return left **/ public String getLeft() { diff --git a/src/main/java/io/gate/gateapi/models/MockOptionsPosition.java b/src/main/java/io/gate/gateapi/models/MockOptionsPosition.java index 4492d43..dcf2a44 100644 --- a/src/main/java/io/gate/gateapi/models/MockOptionsPosition.java +++ b/src/main/java/io/gate/gateapi/models/MockOptionsPosition.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Options positions + * Options positions. */ public class MockOptionsPosition { public static final String SERIALIZED_NAME_OPTIONS_NAME = "options_name"; diff --git a/src/main/java/io/gate/gateapi/models/MockRiskUnit.java b/src/main/java/io/gate/gateapi/models/MockRiskUnit.java index ca19c36..afa5aa8 100644 --- a/src/main/java/io/gate/gateapi/models/MockRiskUnit.java +++ b/src/main/java/io/gate/gateapi/models/MockRiskUnit.java @@ -23,7 +23,7 @@ import java.util.List; /** - * Risk unit + * Risk unit. */ public class MockRiskUnit { public static final String SERIALIZED_NAME_SYMBOL = "symbol"; @@ -70,7 +70,7 @@ public MockRiskUnit symbol(String symbol) { } /** - * Risk unit name + * Risk unit name. * @return symbol **/ @javax.annotation.Nullable @@ -90,7 +90,7 @@ public MockRiskUnit spotInUse(String spotInUse) { } /** - * Spot usage + * Spot usage. * @return spotInUse **/ @javax.annotation.Nullable @@ -110,7 +110,7 @@ public MockRiskUnit maintainMargin(String maintainMargin) { } /** - * Maintenance margin + * Maintenance margin. * @return maintainMargin **/ @javax.annotation.Nullable @@ -130,7 +130,7 @@ public MockRiskUnit initialMargin(String initialMargin) { } /** - * Initial margin + * Initial margin. * @return initialMargin **/ @javax.annotation.Nullable @@ -158,7 +158,7 @@ public MockRiskUnit addMarginResultItem(MockMarginResult marginResultItem) { } /** - * Margin result + * Margin result. * @return marginResult **/ @javax.annotation.Nullable @@ -178,7 +178,7 @@ public MockRiskUnit delta(String delta) { } /** - * Total Delta of risk unit + * Total Delta of risk unit. * @return delta **/ @javax.annotation.Nullable @@ -198,7 +198,7 @@ public MockRiskUnit gamma(String gamma) { } /** - * Total Gamma of risk unit + * Total Gamma of risk unit. * @return gamma **/ @javax.annotation.Nullable @@ -218,7 +218,7 @@ public MockRiskUnit theta(String theta) { } /** - * Total Theta of risk unit + * Total Theta of risk unit. * @return theta **/ @javax.annotation.Nullable @@ -238,7 +238,7 @@ public MockRiskUnit vega(String vega) { } /** - * Total Vega of risk unit + * Total Vega of risk unit. * @return vega **/ @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 f4cb635..1bbd03b 100644 --- a/src/main/java/io/gate/gateapi/models/MockSpotBalance.java +++ b/src/main/java/io/gate/gateapi/models/MockSpotBalance.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Spot + * Spot. */ public class MockSpotBalance { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -39,7 +39,7 @@ public MockSpotBalance currency(String currency) { } /** - * Currency name + * Currency name. * @return currency **/ public String getCurrency() { diff --git a/src/main/java/io/gate/gateapi/models/MockSpotOrder.java b/src/main/java/io/gate/gateapi/models/MockSpotOrder.java index 5e73f3b..095a9e1 100644 --- a/src/main/java/io/gate/gateapi/models/MockSpotOrder.java +++ b/src/main/java/io/gate/gateapi/models/MockSpotOrder.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Spot orders + * Spot orders. */ public class MockSpotOrder { public static final String SERIALIZED_NAME_CURRENCY_PAIRS = "currency_pairs"; @@ -51,7 +51,7 @@ public MockSpotOrder currencyPairs(String currencyPairs) { } /** - * Currency pair + * Currency pair. * @return currencyPairs **/ public String getCurrencyPairs() { @@ -70,7 +70,7 @@ public MockSpotOrder orderPrice(String orderPrice) { } /** - * Price + * Price. * @return orderPrice **/ public String getOrderPrice() { diff --git a/src/main/java/io/gate/gateapi/models/MultiChainAddressItem.java b/src/main/java/io/gate/gateapi/models/MultiChainAddressItem.java index 4f35aa0..7134c4c 100644 --- a/src/main/java/io/gate/gateapi/models/MultiChainAddressItem.java +++ b/src/main/java/io/gate/gateapi/models/MultiChainAddressItem.java @@ -51,7 +51,7 @@ public MultiChainAddressItem chain(String chain) { } /** - * Name of the chain + * Name of the chain. * @return chain **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public MultiChainAddressItem address(String address) { } /** - * Deposit address + * Deposit address. * @return address **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public MultiChainAddressItem paymentId(String paymentId) { } /** - * Notes that some currencies required(e.g., Tag, Memo) when depositing + * Notes that some currencies required(e.g., Tag, Memo) when depositing. * @return paymentId **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public MultiChainAddressItem paymentName(String paymentName) { } /** - * Note type, `Tag` or `Memo` + * Note type, `Tag` or `Memo`. * @return paymentName **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MultiCollateralCurrency.java b/src/main/java/io/gate/gateapi/models/MultiCollateralCurrency.java index 92c07ec..f851561 100644 --- a/src/main/java/io/gate/gateapi/models/MultiCollateralCurrency.java +++ b/src/main/java/io/gate/gateapi/models/MultiCollateralCurrency.java @@ -51,7 +51,7 @@ public MultiCollateralCurrency addLoanCurrenciesItem(MultiLoanItem loanCurrencie } /** - * List of supported borrowing currencies + * List of supported borrowing currencies. * @return loanCurrencies **/ @javax.annotation.Nullable @@ -79,7 +79,7 @@ public MultiCollateralCurrency addCollateralCurrenciesItem(MultiCollateralItem c } /** - * List of supported collateral currencies + * List of supported collateral currencies. * @return collateralCurrencies **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MultiCollateralItem.java b/src/main/java/io/gate/gateapi/models/MultiCollateralItem.java index 455aca4..cb05a72 100644 --- a/src/main/java/io/gate/gateapi/models/MultiCollateralItem.java +++ b/src/main/java/io/gate/gateapi/models/MultiCollateralItem.java @@ -43,7 +43,7 @@ public MultiCollateralItem currency(String currency) { } /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public MultiCollateralItem indexPrice(String indexPrice) { } /** - * Currency Index Price + * Currency Index Price. * @return indexPrice **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public MultiCollateralItem discount(String discount) { } /** - * Discount + * Discount. * @return discount **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MultiCollateralOrder.java b/src/main/java/io/gate/gateapi/models/MultiCollateralOrder.java index 23eabae..5d433f6 100644 --- a/src/main/java/io/gate/gateapi/models/MultiCollateralOrder.java +++ b/src/main/java/io/gate/gateapi/models/MultiCollateralOrder.java @@ -24,7 +24,7 @@ import java.util.List; /** - * Multi-Collateral Order + * Multi-Collateral Order. */ public class MultiCollateralOrder { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; @@ -91,7 +91,7 @@ public MultiCollateralOrder orderId(String orderId) { } /** - * Order ID + * Order ID. * @return orderId **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public MultiCollateralOrder orderType(String orderType) { } /** - * current - current, fixed - fixed + * current - current, fixed - fixed. * @return orderType **/ @javax.annotation.Nullable @@ -151,7 +151,7 @@ public MultiCollateralOrder fixedRate(String fixedRate) { } /** - * Fixed interest rate + * Fixed interest rate. * @return fixedRate **/ @javax.annotation.Nullable @@ -191,7 +191,7 @@ public MultiCollateralOrder autoRenew(Boolean autoRenew) { } /** - * Fixed interest rate, automatic renewal + * Fixed interest rate, automatic renewal. * @return autoRenew **/ @javax.annotation.Nullable @@ -211,7 +211,7 @@ public MultiCollateralOrder autoRepay(Boolean autoRepay) { } /** - * Fixed interest rate, automatic repayment + * Fixed interest rate, automatic repayment. * @return autoRepay **/ @javax.annotation.Nullable @@ -231,7 +231,7 @@ public MultiCollateralOrder currentLtv(String currentLtv) { } /** - * The current collateralization rate + * The current collateralization rate. * @return currentLtv **/ @javax.annotation.Nullable @@ -271,7 +271,7 @@ public MultiCollateralOrder borrowTime(Long borrowTime) { } /** - * Borrowing time, timestamp in seconds + * Borrowing time, timestamp in seconds. * @return borrowTime **/ @javax.annotation.Nullable @@ -291,7 +291,7 @@ public MultiCollateralOrder totalLeftRepayUsdt(String totalLeftRepayUsdt) { } /** - * Value of Left repay amount converted in USDT + * Value of Left repay amount converted in USDT. * @return totalLeftRepayUsdt **/ @javax.annotation.Nullable @@ -311,7 +311,7 @@ public MultiCollateralOrder totalLeftCollateralUsdt(String totalLeftCollateralUs } /** - * Value of Collateral amount in USDT + * Value of Collateral amount in USDT. * @return totalLeftCollateralUsdt **/ @javax.annotation.Nullable @@ -339,7 +339,7 @@ public MultiCollateralOrder addBorrowCurrenciesItem(BorrowCurrencyInfo borrowCur } /** - * Borrowing Currency List + * Borrowing Currency List. * @return borrowCurrencies **/ @javax.annotation.Nullable @@ -367,7 +367,7 @@ public MultiCollateralOrder addCollateralCurrenciesItem(CollateralCurrencyInfo c } /** - * Collateral Currency List + * Collateral Currency List. * @return collateralCurrencies **/ @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 e7d78c4..86ad0f7 100644 --- a/src/main/java/io/gate/gateapi/models/MultiCollateralRecord.java +++ b/src/main/java/io/gate/gateapi/models/MultiCollateralRecord.java @@ -62,7 +62,7 @@ public MultiCollateralRecord orderId(Long orderId) { } /** - * Order ID + * Order ID. * @return orderId **/ @javax.annotation.Nullable @@ -82,7 +82,7 @@ public MultiCollateralRecord recordId(Long recordId) { } /** - * Collateral record ID + * Collateral record ID. * @return recordId **/ @javax.annotation.Nullable @@ -102,7 +102,7 @@ public MultiCollateralRecord beforeLtv(String beforeLtv) { } /** - * The collateral ratio before adjustment + * The collateral ratio before adjustment. * @return beforeLtv **/ @javax.annotation.Nullable @@ -122,7 +122,7 @@ public MultiCollateralRecord afterLtv(String afterLtv) { } /** - * The collateral ratio before adjustment + * The collateral ratio before adjustment. * @return afterLtv **/ @javax.annotation.Nullable @@ -170,7 +170,7 @@ public MultiCollateralRecord addBorrowCurrenciesItem(MultiCollateralRecordCurren } /** - * Borrowing Currency List + * Borrowing Currency List. * @return borrowCurrencies **/ @javax.annotation.Nullable @@ -198,7 +198,7 @@ public MultiCollateralRecord addCollateralCurrenciesItem(MultiCollateralRecordCu } /** - * Collateral Currency List + * Collateral Currency List. * @return collateralCurrencies **/ @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 d447698..1679f4c 100644 --- a/src/main/java/io/gate/gateapi/models/MultiCollateralRecordCurrency.java +++ b/src/main/java/io/gate/gateapi/models/MultiCollateralRecordCurrency.java @@ -55,7 +55,7 @@ public MultiCollateralRecordCurrency currency(String currency) { } /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public MultiCollateralRecordCurrency indexPrice(String indexPrice) { } /** - * Currency Index Price + * Currency Index Price. * @return indexPrice **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public MultiCollateralRecordCurrency beforeAmount(String beforeAmount) { } /** - * Amount before the operation + * Amount before the operation. * @return beforeAmount **/ @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 7e00610..ddf1773 100644 --- a/src/main/java/io/gate/gateapi/models/MultiLoanItem.java +++ b/src/main/java/io/gate/gateapi/models/MultiLoanItem.java @@ -39,7 +39,7 @@ public MultiLoanItem currency(String currency) { } /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public MultiLoanItem price(String price) { } /** - * Latest price of the currency + * Latest price of the currency. * @return price **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MultiLoanRepayItem.java b/src/main/java/io/gate/gateapi/models/MultiLoanRepayItem.java index 1bdb0d2..6aa5dc2 100644 --- a/src/main/java/io/gate/gateapi/models/MultiLoanRepayItem.java +++ b/src/main/java/io/gate/gateapi/models/MultiLoanRepayItem.java @@ -43,7 +43,7 @@ public MultiLoanRepayItem currency(String currency) { } /** - * Repayment currency + * Repayment currency. * @return currency **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public MultiLoanRepayItem amount(String amount) { } /** - * Size + * Size. * @return amount **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MultiRepayRecord.java b/src/main/java/io/gate/gateapi/models/MultiRepayRecord.java index b84d275..3e85841 100644 --- a/src/main/java/io/gate/gateapi/models/MultiRepayRecord.java +++ b/src/main/java/io/gate/gateapi/models/MultiRepayRecord.java @@ -26,7 +26,7 @@ import java.util.List; /** - * Mult Repay Record + * Mult Repay Record. */ public class MultiRepayRecord { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; @@ -85,7 +85,7 @@ public MultiRepayRecord orderId(Long orderId) { } /** - * Order ID + * Order ID. * @return orderId **/ @javax.annotation.Nullable @@ -105,7 +105,7 @@ public MultiRepayRecord recordId(Long recordId) { } /** - * Repayment record ID + * Repayment record ID. * @return recordId **/ @javax.annotation.Nullable @@ -125,7 +125,7 @@ public MultiRepayRecord initLtv(String initLtv) { } /** - * The initial collateralization rate + * The initial collateralization rate. * @return initLtv **/ @javax.annotation.Nullable @@ -145,7 +145,7 @@ public MultiRepayRecord beforeLtv(String beforeLtv) { } /** - * Ltv before the operation + * Ltv before the operation. * @return beforeLtv **/ @javax.annotation.Nullable @@ -165,7 +165,7 @@ public MultiRepayRecord afterLtv(String afterLtv) { } /** - * Ltv after the operation + * Ltv after the operation. * @return afterLtv **/ @javax.annotation.Nullable @@ -233,7 +233,7 @@ public MultiRepayRecord addBorrowCurrenciesItem(RepayRecordCurrency borrowCurren } /** - * List of borrowing information + * List of borrowing information. * @return borrowCurrencies **/ @javax.annotation.Nullable @@ -261,7 +261,7 @@ public MultiRepayRecord addCollateralCurrenciesItem(RepayRecordCurrency collater } /** - * List of collateral information + * List of collateral information. * @return collateralCurrencies **/ @javax.annotation.Nullable @@ -289,7 +289,7 @@ public MultiRepayRecord addRepaidCurrenciesItem(RepayRecordRepaidCurrency repaid } /** - * Repay Currency List + * Repay Currency List. * @return repaidCurrencies **/ @javax.annotation.Nullable @@ -317,7 +317,7 @@ public MultiRepayRecord addTotalInterestListItem(RepayRecordTotalInterest totalI } /** - * Total Interest List + * Total Interest List. * @return totalInterestList **/ @javax.annotation.Nullable @@ -345,7 +345,7 @@ public MultiRepayRecord addLeftRepayInterestListItem(RepayRecordLeftInterest lef } /** - * List of left repay interest + * List of left repay interest. * @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 b7652ba..9039643 100644 --- a/src/main/java/io/gate/gateapi/models/MultiRepayResp.java +++ b/src/main/java/io/gate/gateapi/models/MultiRepayResp.java @@ -23,7 +23,7 @@ import java.util.List; /** - * Repay Multi-Collateral Loan + * Repay Multi-Collateral Loan. */ public class MultiRepayResp { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; @@ -42,7 +42,7 @@ public MultiRepayResp orderId(Long orderId) { } /** - * Order ID + * Order ID. * @return orderId **/ @javax.annotation.Nullable @@ -70,7 +70,7 @@ public MultiRepayResp addRepaidCurrenciesItem(RepayCurrencyRes repaidCurrenciesI } /** - * Repay Currency List + * Repay Currency List. * @return repaidCurrencies **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MyFuturesTrade.java b/src/main/java/io/gate/gateapi/models/MyFuturesTrade.java index ec8d73a..da1d49e 100644 --- a/src/main/java/io/gate/gateapi/models/MyFuturesTrade.java +++ b/src/main/java/io/gate/gateapi/models/MyFuturesTrade.java @@ -52,7 +52,7 @@ public class MyFuturesTrade { private String price; /** - * Trade role. Available values are `taker` and `maker` + * Trade role. Available values are `taker` and `maker`. */ @JsonAdapter(RoleEnum.Adapter.class) public enum RoleEnum { @@ -122,7 +122,7 @@ public MyFuturesTrade id(Long id) { } /** - * Trade ID + * Trade ID. * @return id **/ @javax.annotation.Nullable @@ -142,7 +142,7 @@ public MyFuturesTrade createTime(Double createTime) { } /** - * Trading time + * Trading time. * @return createTime **/ @javax.annotation.Nullable @@ -162,7 +162,7 @@ public MyFuturesTrade contract(String contract) { } /** - * Futures contract + * Futures contract. * @return contract **/ @javax.annotation.Nullable @@ -182,7 +182,7 @@ public MyFuturesTrade orderId(String orderId) { } /** - * Order ID related + * Order ID related. * @return orderId **/ @javax.annotation.Nullable @@ -202,7 +202,7 @@ public MyFuturesTrade size(Long size) { } /** - * Trading size + * Trading size. * @return size **/ @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 > 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 * @return closeSize **/ @javax.annotation.Nullable @@ -242,7 +242,7 @@ public MyFuturesTrade price(String price) { } /** - * Trading price + * Trading 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. Available values are `taker` and `maker`. * @return role **/ @javax.annotation.Nullable @@ -282,7 +282,7 @@ public MyFuturesTrade text(String text) { } /** - * User defined information + * User defined information. * @return text **/ @javax.annotation.Nullable @@ -302,7 +302,7 @@ public MyFuturesTrade fee(String fee) { } /** - * Fee deducted + * Fee deducted. * @return fee **/ @javax.annotation.Nullable @@ -322,7 +322,7 @@ public MyFuturesTrade pointFee(String pointFee) { } /** - * Points used to deduct fee + * Points used to deduct 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 d337129..44b7594 100644 --- a/src/main/java/io/gate/gateapi/models/MyFuturesTradeTimeRange.java +++ b/src/main/java/io/gate/gateapi/models/MyFuturesTradeTimeRange.java @@ -52,7 +52,7 @@ public class MyFuturesTradeTimeRange { private String price; /** - * Trade role. Available values are `taker` and `maker` + * Trade role. Available values are `taker` and `maker`. */ @JsonAdapter(RoleEnum.Adapter.class) public enum RoleEnum { @@ -122,7 +122,7 @@ public MyFuturesTradeTimeRange tradeId(String tradeId) { } /** - * Trade ID + * Trade ID. * @return tradeId **/ @javax.annotation.Nullable @@ -142,7 +142,7 @@ public MyFuturesTradeTimeRange createTime(Double createTime) { } /** - * Trading time + * Trading time. * @return createTime **/ @javax.annotation.Nullable @@ -162,7 +162,7 @@ public MyFuturesTradeTimeRange contract(String contract) { } /** - * Futures contract + * Futures contract. * @return contract **/ @javax.annotation.Nullable @@ -182,7 +182,7 @@ public MyFuturesTradeTimeRange orderId(String orderId) { } /** - * Order ID related + * Order ID related. * @return orderId **/ @javax.annotation.Nullable @@ -202,7 +202,7 @@ public MyFuturesTradeTimeRange size(Long size) { } /** - * Trading size + * Trading size. * @return size **/ @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 > 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 * @return closeSize **/ @javax.annotation.Nullable @@ -242,7 +242,7 @@ public MyFuturesTradeTimeRange price(String price) { } /** - * Trading price + * Trading 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. Available values are `taker` and `maker`. * @return role **/ @javax.annotation.Nullable @@ -282,7 +282,7 @@ public MyFuturesTradeTimeRange text(String text) { } /** - * User defined information + * User defined information. * @return text **/ @javax.annotation.Nullable @@ -302,7 +302,7 @@ public MyFuturesTradeTimeRange fee(String fee) { } /** - * Fee deducted + * Fee deducted. * @return fee **/ @javax.annotation.Nullable @@ -322,7 +322,7 @@ public MyFuturesTradeTimeRange pointFee(String pointFee) { } /** - * Points used to deduct fee + * Points used to deduct 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 c37978c..90ff0de 100644 --- a/src/main/java/io/gate/gateapi/models/OpenOrders.java +++ b/src/main/java/io/gate/gateapi/models/OpenOrders.java @@ -46,7 +46,7 @@ public OpenOrders currencyPair(String currencyPair) { } /** - * Currency pair + * Currency pair. * @return currencyPair **/ @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 de1f983..ac20ea2 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsAccount.java +++ b/src/main/java/io/gate/gateapi/models/OptionsAccount.java @@ -156,7 +156,7 @@ public OptionsAccount user(Long user) { } /** - * User ID + * User ID. * @return user **/ @javax.annotation.Nullable @@ -176,7 +176,7 @@ public OptionsAccount total(String total) { } /** - * Account balance + * Account balance. * @return total **/ @javax.annotation.Nullable @@ -216,7 +216,7 @@ public OptionsAccount equity(String equity) { } /** - * Account equity, the sum of account balance and position value + * Account equity, the sum of account balance and position value. * @return equity **/ @javax.annotation.Nullable @@ -236,7 +236,7 @@ public OptionsAccount shortEnabled(Boolean shortEnabled) { } /** - * If the account is allowed to short + * If the account is allowed to short. * @return shortEnabled **/ @javax.annotation.Nullable @@ -256,7 +256,7 @@ public OptionsAccount mmpEnabled(Boolean mmpEnabled) { } /** - * Whether to enable MMP + * Whether to enable MMP. * @return mmpEnabled **/ @javax.annotation.Nullable @@ -276,7 +276,7 @@ public OptionsAccount liqTriggered(Boolean liqTriggered) { } /** - * Whether to trigger position liquidation + * Whether to trigger position liquidation. * @return liqTriggered **/ @javax.annotation.Nullable @@ -316,7 +316,7 @@ public OptionsAccount unrealisedPnl(String unrealisedPnl) { } /** - * Unrealized PNL + * Unrealized PNL. * @return unrealisedPnl **/ @javax.annotation.Nullable @@ -336,7 +336,7 @@ public OptionsAccount initMargin(String initMargin) { } /** - * Initial position margin + * Initial position margin. * @return initMargin **/ @javax.annotation.Nullable @@ -356,7 +356,7 @@ public OptionsAccount maintMargin(String maintMargin) { } /** - * Position maintenance margin + * Position maintenance margin. * @return maintMargin **/ @javax.annotation.Nullable @@ -376,7 +376,7 @@ public OptionsAccount orderMargin(String orderMargin) { } /** - * Order margin of unfinished orders + * Order margin of unfinished orders. * @return orderMargin **/ @javax.annotation.Nullable @@ -396,7 +396,7 @@ public OptionsAccount askOrderMargin(String askOrderMargin) { } /** - * Margin for outstanding sell orders + * Margin for outstanding sell orders. * @return askOrderMargin **/ @javax.annotation.Nullable @@ -416,7 +416,7 @@ public OptionsAccount bidOrderMargin(String bidOrderMargin) { } /** - * Margin for outstanding buy orders + * Margin for outstanding buy orders. * @return bidOrderMargin **/ @javax.annotation.Nullable @@ -436,7 +436,7 @@ public OptionsAccount available(String available) { } /** - * Available balance to transfer out or trade + * Available balance to transfer out or trade. * @return available **/ @javax.annotation.Nullable @@ -456,7 +456,7 @@ public OptionsAccount point(String point) { } /** - * POINT amount + * POINT amount. * @return point **/ @javax.annotation.Nullable @@ -476,7 +476,7 @@ public OptionsAccount currency(String currency) { } /** - * Settle currency + * Settle currency. * @return currency **/ @javax.annotation.Nullable @@ -496,7 +496,7 @@ public OptionsAccount ordersLimit(Integer ordersLimit) { } /** - * Maximum number of outstanding orders + * Maximum number of outstanding orders. * @return ordersLimit **/ @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 9d9e226..e5ef05f 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsAccountBook.java +++ b/src/main/java/io/gate/gateapi/models/OptionsAccountBook.java @@ -51,7 +51,7 @@ public OptionsAccountBook time(Double time) { } /** - * Change time + * Change time. * @return time **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public OptionsAccountBook change(String change) { } /** - * Amount changed (USDT) + * Amount changed (USDT). * @return change **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public OptionsAccountBook balance(String balance) { } /** - * Account total balance after change (USDT) + * Account total balance after change (USDT). * @return balance **/ @javax.annotation.Nullable @@ -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 + * custom text. * @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 179b6cd..9e1affd 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsCandlestick.java +++ b/src/main/java/io/gate/gateapi/models/OptionsCandlestick.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * data point in every timestamp + * data point in every timestamp. */ public class OptionsCandlestick { public static final String SERIALIZED_NAME_T = "t"; @@ -55,7 +55,7 @@ public OptionsCandlestick t(Double t) { } /** - * Unix timestamp in seconds + * Unix timestamp in seconds. * @return t **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public OptionsCandlestick v(Long v) { } /** - * size volume (contract size). Only returned if `contract` is not prefixed + * size volume (contract size). Only returned if `contract` is not prefixed. * @return v **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public OptionsCandlestick c(String c) { } /** - * Close price (quote currency, unit: underlying corresponding option price) + * Close price (quote currency, unit: underlying corresponding option price). * @return c **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public OptionsCandlestick l(String l) { } /** - * Lowest price (quote currency, unit: underlying corresponding option price) + * Lowest price (quote currency, unit: underlying corresponding option price). * @return l **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public OptionsCandlestick o(String o) { } /** - * Open price (quote currency, unit: underlying corresponding option price) + * Open price (quote currency, unit: underlying corresponding option price). * @return o **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/OptionsContract.java b/src/main/java/io/gate/gateapi/models/OptionsContract.java index 8a893a7..d60d67f 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsContract.java +++ b/src/main/java/io/gate/gateapi/models/OptionsContract.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Options contract detail + * Options contract detail. */ public class OptionsContract { public static final String SERIALIZED_NAME_NAME = "name"; @@ -131,7 +131,7 @@ public OptionsContract name(String name) { } /** - * Options contract name + * Options contract name. * @return name **/ @javax.annotation.Nullable @@ -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 + * Creation time. * @return createTime **/ @javax.annotation.Nullable @@ -191,7 +191,7 @@ public OptionsContract expirationTime(Double expirationTime) { } /** - * Expiration time + * Expiration time. * @return expirationTime **/ @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, while `false` is put options. * @return isCall **/ @javax.annotation.Nullable @@ -231,7 +231,7 @@ public OptionsContract multiplier(String multiplier) { } /** - * Multiplier used in converting from invoicing to settlement currency + * Multiplier used in converting from invoicing to settlement currency. * @return multiplier **/ @javax.annotation.Nullable @@ -251,7 +251,7 @@ public OptionsContract underlying(String underlying) { } /** - * Underlying + * Underlying. * @return underlying **/ @javax.annotation.Nullable @@ -271,7 +271,7 @@ public OptionsContract underlyingPrice(String underlyingPrice) { } /** - * Underlying price (quote currency) + * Underlying price (quote currency). * @return underlyingPrice **/ @javax.annotation.Nullable @@ -291,7 +291,7 @@ public OptionsContract lastPrice(String lastPrice) { } /** - * Last trading price + * Last trading price. * @return lastPrice **/ @javax.annotation.Nullable @@ -311,7 +311,7 @@ public OptionsContract markPrice(String markPrice) { } /** - * Current mark price (quote currency) + * Current mark price (quote currency). * @return markPrice **/ @javax.annotation.Nullable @@ -331,7 +331,7 @@ public OptionsContract indexPrice(String indexPrice) { } /** - * Current index price (quote currency) + * Current index price (quote currency). * @return indexPrice **/ @javax.annotation.Nullable @@ -351,7 +351,7 @@ public OptionsContract makerFeeRate(String makerFeeRate) { } /** - * Maker fee rate, where negative means rebate + * Maker fee rate, where negative means rebate. * @return makerFeeRate **/ @javax.annotation.Nullable @@ -371,7 +371,7 @@ public OptionsContract takerFeeRate(String takerFeeRate) { } /** - * Taker fee rate + * Taker fee rate. * @return takerFeeRate **/ @javax.annotation.Nullable @@ -391,7 +391,7 @@ public OptionsContract orderPriceRound(String orderPriceRound) { } /** - * Minimum order price increment + * Minimum order price increment. * @return orderPriceRound **/ @javax.annotation.Nullable @@ -411,7 +411,7 @@ public OptionsContract markPriceRound(String markPriceRound) { } /** - * Minimum mark price increment + * Minimum mark price increment. * @return markPriceRound **/ @javax.annotation.Nullable @@ -431,7 +431,7 @@ public OptionsContract orderSizeMin(Long orderSizeMin) { } /** - * Minimum order size the contract allowed + * Minimum order size the contract allowed. * @return orderSizeMin **/ @javax.annotation.Nullable @@ -451,7 +451,7 @@ public OptionsContract orderSizeMax(Long orderSizeMax) { } /** - * Maximum order size the contract allowed + * Maximum order size the contract allowed. * @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 + * Referral fee rate discount. * @return refDiscountRate **/ @javax.annotation.Nullable @@ -511,7 +511,7 @@ public OptionsContract refRebateRate(String refRebateRate) { } /** - * Referrer commission rate + * Referrer commission rate. * @return refRebateRate **/ @javax.annotation.Nullable @@ -531,7 +531,7 @@ public OptionsContract orderbookId(Long orderbookId) { } /** - * Current orderbook ID + * Current orderbook ID. * @return orderbookId **/ @javax.annotation.Nullable @@ -551,7 +551,7 @@ public OptionsContract tradeId(Long tradeId) { } /** - * Current trade ID + * Current trade ID. * @return tradeId **/ @javax.annotation.Nullable @@ -571,7 +571,7 @@ public OptionsContract tradeSize(Long tradeSize) { } /** - * Historical accumulated trade size + * Historical accumulated trade size. * @return tradeSize **/ @javax.annotation.Nullable @@ -591,7 +591,7 @@ public OptionsContract positionSize(Long positionSize) { } /** - * Current total long position size + * Current total long position size. * @return positionSize **/ @javax.annotation.Nullable @@ -611,7 +611,7 @@ public OptionsContract ordersLimit(Integer ordersLimit) { } /** - * Maximum number of open orders + * Maximum number of open 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 3419fa1..6e54d69 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsMMP.java +++ b/src/main/java/io/gate/gateapi/models/OptionsMMP.java @@ -59,7 +59,7 @@ public OptionsMMP underlying(String underlying) { } /** - * Underlying + * Underlying. * @return underlying **/ public String getUnderlying() { @@ -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 disabling MMP. * @return window **/ public Integer getWindow() { @@ -116,7 +116,7 @@ public OptionsMMP qtyLimit(String qtyLimit) { } /** - * Trading volume upper limit (positive number, up to 2 decimal places) + * Trading volume upper limit (positive number, up to 2 decimal places). * @return qtyLimit **/ public String getQtyLimit() { @@ -135,7 +135,7 @@ public OptionsMMP deltaLimit(String deltaLimit) { } /** - * Upper limit of net delta value (positive number, up to 2 decimal places) + * Upper limit of net delta value (positive number, up to 2 decimal places). * @return deltaLimit **/ public String getDeltaLimit() { @@ -148,7 +148,7 @@ public void setDeltaLimit(String deltaLimit) { } /** - * Trigger freeze time (milliseconds), 0 means no freeze is triggered + * Trigger freeze time (milliseconds), 0 means no freeze is triggered. * @return triggerTimeMs **/ @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 ca4a6d9..8a883ed 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsMMPReset.java +++ b/src/main/java/io/gate/gateapi/models/OptionsMMPReset.java @@ -59,7 +59,7 @@ public OptionsMMPReset underlying(String underlying) { } /** - * Underlying + * Underlying. * @return underlying **/ public String getUnderlying() { @@ -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 disabling MMP. * @return window **/ @javax.annotation.Nullable @@ -92,7 +92,7 @@ public Integer getFrozenPeriod() { /** - * Trading volume upper limit (positive number, up to 2 decimal places) + * Trading volume upper limit (positive number, up to 2 decimal places). * @return qtyLimit **/ @javax.annotation.Nullable @@ -102,7 +102,7 @@ public String getQtyLimit() { /** - * Upper limit of net delta value (positive number, up to 2 decimal places) + * Upper limit of net delta value (positive number, up to 2 decimal places). * @return deltaLimit **/ @javax.annotation.Nullable @@ -112,7 +112,7 @@ public String getDeltaLimit() { /** - * Trigger freeze time (milliseconds), 0 means no freeze is triggered + * Trigger freeze time (milliseconds), 0 means no freeze is triggered. * @return triggerTimeMs **/ @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 cb9ac29..b04b1f7 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsMySettlements.java +++ b/src/main/java/io/gate/gateapi/models/OptionsMySettlements.java @@ -67,7 +67,7 @@ public OptionsMySettlements time(Double time) { } /** - * Settlement time + * Settlement time. * @return time **/ @javax.annotation.Nullable @@ -87,7 +87,7 @@ public OptionsMySettlements underlying(String underlying) { } /** - * Underlying + * Underlying. * @return underlying **/ @javax.annotation.Nullable @@ -107,7 +107,7 @@ public OptionsMySettlements contract(String contract) { } /** - * Options contract name + * Options contract name. * @return contract **/ @javax.annotation.Nullable @@ -127,7 +127,7 @@ public OptionsMySettlements strikePrice(String strikePrice) { } /** - * Strike price (quote currency) + * Strike price (quote currency). * @return strikePrice **/ @javax.annotation.Nullable @@ -147,7 +147,7 @@ public OptionsMySettlements settlePrice(String settlePrice) { } /** - * Settlement price (quote currency) + * Settlement price (quote currency). * @return settlePrice **/ @javax.annotation.Nullable @@ -167,7 +167,7 @@ public OptionsMySettlements size(Long size) { } /** - * Size + * Size. * @return size **/ @javax.annotation.Nullable @@ -187,7 +187,7 @@ public OptionsMySettlements settleProfit(String settleProfit) { } /** - * Settlement profit (quote currency) + * Settlement profit (quote currency). * @return settleProfit **/ @javax.annotation.Nullable @@ -207,7 +207,7 @@ public OptionsMySettlements fee(String fee) { } /** - * Fee (quote currency) + * Fee (quote currency). * @return fee **/ @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 a98b4a8..ab38327 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsMyTrade.java +++ b/src/main/java/io/gate/gateapi/models/OptionsMyTrade.java @@ -52,7 +52,7 @@ public class OptionsMyTrade { private String underlyingPrice; /** - * Trade role. Available values are `taker` and `maker` + * Trade role. Available values are `taker` and `maker`. */ @JsonAdapter(RoleEnum.Adapter.class) public enum RoleEnum { @@ -110,7 +110,7 @@ public OptionsMyTrade id(Long id) { } /** - * Trade ID + * Trade ID. * @return id **/ @javax.annotation.Nullable @@ -130,7 +130,7 @@ public OptionsMyTrade createTime(Double createTime) { } /** - * Trading time + * Trading time. * @return createTime **/ @javax.annotation.Nullable @@ -150,7 +150,7 @@ public OptionsMyTrade contract(String contract) { } /** - * Options contract name + * Options contract name. * @return contract **/ @javax.annotation.Nullable @@ -170,7 +170,7 @@ public OptionsMyTrade orderId(Integer orderId) { } /** - * Order ID related + * Order ID related. * @return orderId **/ @javax.annotation.Nullable @@ -190,7 +190,7 @@ public OptionsMyTrade size(Long size) { } /** - * Trading size + * Trading size. * @return size **/ @javax.annotation.Nullable @@ -210,7 +210,7 @@ public OptionsMyTrade price(String price) { } /** - * Trading price (quote currency) + * Trading price (quote currency). * @return price **/ @javax.annotation.Nullable @@ -230,7 +230,7 @@ public OptionsMyTrade underlyingPrice(String underlyingPrice) { } /** - * Underlying price (quote currency) + * Underlying price (quote currency). * @return underlyingPrice **/ @javax.annotation.Nullable @@ -250,7 +250,7 @@ public OptionsMyTrade role(RoleEnum role) { } /** - * Trade role. Available values are `taker` and `maker` + * Trade role. Available values are `taker` and `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 853f5ab..f2128e6 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsOrder.java +++ b/src/main/java/io/gate/gateapi/models/OptionsOrder.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Options order detail + * Options order detail. */ 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 + * Ending method, including: - filled: fully completed - canceled: user canceled - liquidated: forced liquidation cancellation - ioc: Not fully filled immediately because tif is set to ioc - auto_deleveraged: automatic deleveraging cancel - reduce_only: Increased position is cancelled, or the position is closed - position_closed: Because the position was closed, the pending order was canceled - reduce_out: Only reduce the excluded pending orders that are not easy to be filled - mmp_cancelled: MMP canceled */ @JsonAdapter(FinishAsEnum.Adapter.class) public enum FinishAsEnum { @@ -282,7 +282,7 @@ public TifEnum read(final JsonReader jsonReader) throws IOException { /** - * Options order ID + * Options order ID. * @return id **/ @javax.annotation.Nullable @@ -292,7 +292,7 @@ public Long getId() { /** - * User ID + * User ID. * @return user **/ @javax.annotation.Nullable @@ -302,7 +302,7 @@ public Integer getUser() { /** - * Creation time of order + * Creation time of order. * @return createTime **/ @javax.annotation.Nullable @@ -312,7 +312,7 @@ public Double getCreateTime() { /** - * Order finished time. Not returned if order is open + * Order finished time. Not returned if order is open. * @return finishTime **/ @javax.annotation.Nullable @@ -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 + * Ending method, including: - filled: fully completed - canceled: user canceled - liquidated: forced liquidation cancellation - ioc: Not fully filled immediately because tif is set to ioc - auto_deleveraged: automatic deleveraging cancel - reduce_only: Increased position is cancelled, or the position is closed - position_closed: Because the position was closed, the pending order was canceled - reduce_out: Only reduce the excluded pending orders that are not easy to be filled - mmp_cancelled: MMP canceled * @return finishAs **/ @javax.annotation.Nullable @@ -348,7 +348,7 @@ public OptionsOrder contract(String contract) { } /** - * Contract name + * Contract name. * @return contract **/ public String getContract() { @@ -406,7 +406,7 @@ public OptionsOrder price(String price) { } /** - * Order price. 0 for market order with `tif` set as `ioc` (USDT) + * Order price. 0 for market order with `tif` set as `ioc` (USDT). * @return price **/ @javax.annotation.Nullable @@ -426,7 +426,7 @@ public OptionsOrder close(Boolean close) { } /** - * Set as `true` to close the position, with `size` set to 0 + * Set as `true` to close the position, with `size` set to 0. * @return close **/ @javax.annotation.Nullable @@ -440,7 +440,7 @@ public void setClose(Boolean close) { } /** - * Is the order to close position + * Is the order to close position. * @return isClose **/ @javax.annotation.Nullable @@ -456,7 +456,7 @@ public OptionsOrder reduceOnly(Boolean reduceOnly) { } /** - * Set as `true` to be reduce-only order + * Set as `true` to be reduce-only order. * @return reduceOnly **/ @javax.annotation.Nullable @@ -470,7 +470,7 @@ public void setReduceOnly(Boolean reduceOnly) { } /** - * Is the order reduce-only + * Is the order reduce-only. * @return isReduceOnly **/ @javax.annotation.Nullable @@ -480,7 +480,7 @@ public Boolean getIsReduceOnly() { /** - * Is the order for liquidation + * Is the order for liquidation. * @return isLiq **/ @javax.annotation.Nullable @@ -496,7 +496,7 @@ public OptionsOrder mmp(Boolean mmp) { } /** - * When set to true, delegate to MMP + * When set to true, delegate to MMP. * @return mmp **/ @javax.annotation.Nullable @@ -540,7 +540,7 @@ public void setTif(TifEnum tif) { } /** - * Size left to be traded + * Size left to be traded. * @return left **/ @javax.annotation.Nullable @@ -550,7 +550,7 @@ public Long getLeft() { /** - * Fill price of the order + * Fill price of the order. * @return fillPrice **/ @javax.annotation.Nullable @@ -580,7 +580,7 @@ public void setText(String text) { } /** - * Taker fee + * Taker fee. * @return tkfr **/ @javax.annotation.Nullable @@ -590,7 +590,7 @@ public String getTkfr() { /** - * Maker fee + * Maker fee. * @return mkfr **/ @javax.annotation.Nullable @@ -600,7 +600,7 @@ public String getMkfr() { /** - * Reference user ID + * Reference user ID. * @return refu **/ @javax.annotation.Nullable @@ -610,7 +610,7 @@ public Integer getRefu() { /** - * Referrer rebate + * Referrer rebate. * @return refr **/ @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 fcb2059..cee393e 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsPosition.java +++ b/src/main/java/io/gate/gateapi/models/OptionsPosition.java @@ -21,7 +21,7 @@ import java.io.IOException; /** - * Options position information + * Options position information. */ public class OptionsPosition { public static final String SERIALIZED_NAME_USER = "user"; @@ -90,7 +90,7 @@ public class OptionsPosition { /** - * User ID + * User ID. * @return user **/ @javax.annotation.Nullable @@ -100,7 +100,7 @@ public Integer getUser() { /** - * Underlying + * Underlying. * @return underlying **/ @javax.annotation.Nullable @@ -110,7 +110,7 @@ public String getUnderlying() { /** - * Underlying price (quote currency) + * Underlying price (quote currency). * @return underlyingPrice **/ @javax.annotation.Nullable @@ -120,7 +120,7 @@ public String getUnderlyingPrice() { /** - * Options contract name + * Options contract name. * @return contract **/ @javax.annotation.Nullable @@ -130,7 +130,7 @@ public String getContract() { /** - * Position size (contract size) + * Position size (contract size). * @return size **/ @javax.annotation.Nullable @@ -140,7 +140,7 @@ public Long getSize() { /** - * Entry size (quote currency) + * Entry size (quote currency). * @return entryPrice **/ @javax.annotation.Nullable @@ -150,7 +150,7 @@ public String getEntryPrice() { /** - * Current mark price (quote currency) + * Current mark price (quote currency). * @return markPrice **/ @javax.annotation.Nullable @@ -160,7 +160,7 @@ public String getMarkPrice() { /** - * Implied volatility + * Implied volatility. * @return markIv **/ @javax.annotation.Nullable @@ -170,7 +170,7 @@ public String getMarkIv() { /** - * Realized PNL + * Realized PNL. * @return realisedPnl **/ @javax.annotation.Nullable @@ -180,7 +180,7 @@ public String getRealisedPnl() { /** - * Unrealized PNL + * Unrealized PNL. * @return unrealisedPnl **/ @javax.annotation.Nullable @@ -190,7 +190,7 @@ public String getUnrealisedPnl() { /** - * Current open orders + * Current open orders. * @return pendingOrders **/ @javax.annotation.Nullable @@ -220,7 +220,7 @@ public void setCloseOrder(OptionsPositionCloseOrder closeOrder) { } /** - * Delta + * Delta. * @return delta **/ @javax.annotation.Nullable @@ -230,7 +230,7 @@ public String getDelta() { /** - * Gamma + * Gamma. * @return gamma **/ @javax.annotation.Nullable @@ -240,7 +240,7 @@ public String getGamma() { /** - * Vega + * Vega. * @return vega **/ @javax.annotation.Nullable @@ -250,7 +250,7 @@ public String getVega() { /** - * Theta + * 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 1c8490c..b8e3147 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsPositionClose.java +++ b/src/main/java/io/gate/gateapi/models/OptionsPositionClose.java @@ -32,7 +32,7 @@ public class OptionsPositionClose { private String contract; /** - * Position side, long or short + * Position side, long or short. */ @JsonAdapter(SideEnum.Adapter.class) public enum SideEnum { @@ -96,7 +96,7 @@ public SideEnum read(final JsonReader jsonReader) throws IOException { /** - * Position close time + * Position close time. * @return time **/ @javax.annotation.Nullable @@ -106,7 +106,7 @@ public Double getTime() { /** - * Options contract name + * Options contract name. * @return contract **/ @javax.annotation.Nullable @@ -116,7 +116,7 @@ public String getContract() { /** - * Position side, long or short + * Position side, long or short. * @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 + * Text of close order. * @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 654a850..e9162c5 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsPositionCloseOrder.java +++ b/src/main/java/io/gate/gateapi/models/OptionsPositionCloseOrder.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Current close order if any, or `null` + * Current close order if any, or `null`. */ public class OptionsPositionCloseOrder { public static final String SERIALIZED_NAME_ID = "id"; @@ -43,7 +43,7 @@ public OptionsPositionCloseOrder id(Long id) { } /** - * Close order ID + * Close order ID. * @return id **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public OptionsPositionCloseOrder price(String price) { } /** - * Close order price （quote currency) + * Close order price （quote currency). * @return price **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public OptionsPositionCloseOrder isLiq(Boolean isLiq) { } /** - * Is the close order from liquidation + * Is the close order 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 f430a10..476532a 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsSettlement.java +++ b/src/main/java/io/gate/gateapi/models/OptionsSettlement.java @@ -55,7 +55,7 @@ public OptionsSettlement time(Double time) { } /** - * Last changed time of configuration + * Last changed time of configuration. * @return time **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public OptionsSettlement contract(String contract) { } /** - * Options contract name + * Options contract name. * @return contract **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public OptionsSettlement profit(String profit) { } /** - * Settlement profit per size (quote currency) + * Settlement profit per size (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 size (quote currency). * @return fee **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public OptionsSettlement strikePrice(String strikePrice) { } /** - * Strike price (quote currency) + * Strike price (quote currency). * @return strikePrice **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public OptionsSettlement settlePrice(String settlePrice) { } /** - * Settlement price (quote currency) + * Settlement price (quote currency). * @return settlePrice **/ @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 0244623..2f3a904 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsTicker.java +++ b/src/main/java/io/gate/gateapi/models/OptionsTicker.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Options contract detail + * Options contract detail. */ public class OptionsTicker { public static final String SERIALIZED_NAME_NAME = "name"; @@ -103,7 +103,7 @@ public OptionsTicker name(String name) { } /** - * Options contract name + * Options contract name. * @return name **/ @javax.annotation.Nullable @@ -123,7 +123,7 @@ public OptionsTicker lastPrice(String lastPrice) { } /** - * Last trading price (quote currency) + * Last trading price (quote currency). * @return lastPrice **/ @javax.annotation.Nullable @@ -143,7 +143,7 @@ public OptionsTicker markPrice(String markPrice) { } /** - * Current mark price (quote currency) + * Current mark price (quote currency). * @return markPrice **/ @javax.annotation.Nullable @@ -163,7 +163,7 @@ public OptionsTicker indexPrice(String indexPrice) { } /** - * Current index price (quote currency) + * Current index price (quote currency). * @return indexPrice **/ @javax.annotation.Nullable @@ -183,7 +183,7 @@ public OptionsTicker ask1Size(Long ask1Size) { } /** - * Best ask size + * Best ask size. * @return ask1Size **/ @javax.annotation.Nullable @@ -203,7 +203,7 @@ public OptionsTicker ask1Price(String ask1Price) { } /** - * Best ask price + * Best ask price. * @return ask1Price **/ @javax.annotation.Nullable @@ -223,7 +223,7 @@ public OptionsTicker bid1Size(Long bid1Size) { } /** - * Best bid size + * Best bid size. * @return bid1Size **/ @javax.annotation.Nullable @@ -243,7 +243,7 @@ public OptionsTicker bid1Price(String bid1Price) { } /** - * Best bid price + * Best bid price. * @return bid1Price **/ @javax.annotation.Nullable @@ -263,7 +263,7 @@ public OptionsTicker positionSize(Long positionSize) { } /** - * Current total long position size + * Current total long position size. * @return positionSize **/ @javax.annotation.Nullable @@ -283,7 +283,7 @@ public OptionsTicker markIv(String markIv) { } /** - * Implied volatility + * Implied volatility. * @return markIv **/ @javax.annotation.Nullable @@ -303,7 +303,7 @@ public OptionsTicker bidIv(String bidIv) { } /** - * Bid side implied volatility + * Bid side implied volatility. * @return bidIv **/ @javax.annotation.Nullable @@ -323,7 +323,7 @@ public OptionsTicker askIv(String askIv) { } /** - * Ask side implied volatility + * Ask side implied volatility. * @return askIv **/ @javax.annotation.Nullable @@ -343,7 +343,7 @@ public OptionsTicker leverage(String leverage) { } /** - * Current leverage. Formula: underlying_price / mark_price * delta + * Current leverage. Formula: underlying_price / mark_price * delta. * @return leverage **/ @javax.annotation.Nullable @@ -363,7 +363,7 @@ public OptionsTicker delta(String delta) { } /** - * Delta + * Delta. * @return delta **/ @javax.annotation.Nullable @@ -383,7 +383,7 @@ public OptionsTicker gamma(String gamma) { } /** - * Gamma + * Gamma. * @return gamma **/ @javax.annotation.Nullable @@ -403,7 +403,7 @@ public OptionsTicker vega(String vega) { } /** - * Vega + * Vega. * @return vega **/ @javax.annotation.Nullable @@ -423,7 +423,7 @@ public OptionsTicker theta(String theta) { } /** - * Theta + * Theta. * @return theta **/ @javax.annotation.Nullable @@ -443,7 +443,7 @@ public OptionsTicker rho(String rho) { } /** - * Rho + * Rho. * @return rho **/ @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 2da3a34..7dc0b15 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsUnderlying.java +++ b/src/main/java/io/gate/gateapi/models/OptionsUnderlying.java @@ -39,7 +39,7 @@ public OptionsUnderlying name(String name) { } /** - * Underlying name + * Underlying name. * @return name **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public OptionsUnderlying indexPrice(String indexPrice) { } /** - * Spot index price (quote currency) + * Spot index price (quote currency). * @return indexPrice **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/OptionsUnderlyingTicker.java b/src/main/java/io/gate/gateapi/models/OptionsUnderlyingTicker.java index 868d17c..d819cc8 100644 --- a/src/main/java/io/gate/gateapi/models/OptionsUnderlyingTicker.java +++ b/src/main/java/io/gate/gateapi/models/OptionsUnderlyingTicker.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Options underlying detail + * Options underlying detail. */ public class OptionsUnderlyingTicker { public static final String SERIALIZED_NAME_TRADE_PUT = "trade_put"; @@ -43,7 +43,7 @@ public OptionsUnderlyingTicker tradePut(Long tradePut) { } /** - * Total put options trades amount in last 24h + * Total put options trades amount in last 24h. * @return tradePut **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public OptionsUnderlyingTicker tradeCall(Long tradeCall) { } /** - * Total call options trades amount in last 24h + * Total call options trades amount in last 24h. * @return tradeCall **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public OptionsUnderlyingTicker indexPrice(String indexPrice) { } /** - * Index price (quote currency) + * Index price (quote currency). * @return indexPrice **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/Order.java b/src/main/java/io/gate/gateapi/models/Order.java index 08b9eec..3b5d0f1 100644 --- a/src/main/java/io/gate/gateapi/models/Order.java +++ b/src/main/java/io/gate/gateapi/models/Order.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Spot order details + * Spot order details. */ public class Order { public static final String SERIALIZED_NAME_ID = "id"; @@ -164,7 +164,7 @@ public TypeEnum read(final JsonReader jsonReader) throws IOException { private String account = "spot"; /** - * Buy or sell order + * 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 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 { @@ -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 { @@ -481,7 +481,7 @@ public FinishAsEnum read(final JsonReader jsonReader) throws IOException { /** - * Order ID + * Order ID. * @return id **/ @javax.annotation.Nullable @@ -511,7 +511,7 @@ public void setText(String text) { } /** - * The custom data that the user remarked when amending the order + * The custom data that the user remarked when amending the order. * @return amendText **/ @javax.annotation.Nullable @@ -521,7 +521,7 @@ public String getAmendText() { /** - * Creation time of order + * Creation time of order. * @return createTime **/ @javax.annotation.Nullable @@ -531,7 +531,7 @@ public String getCreateTime() { /** - * Last modification time of order + * Last modification time of order. * @return updateTime **/ @javax.annotation.Nullable @@ -541,7 +541,7 @@ public String getUpdateTime() { /** - * Creation time of order (in milliseconds) + * Creation time of order (in milliseconds). * @return createTimeMs **/ @javax.annotation.Nullable @@ -551,7 +551,7 @@ public Long getCreateTimeMs() { /** - * Last modification time of order (in milliseconds) + * Last modification time of order (in milliseconds). * @return updateTimeMs **/ @javax.annotation.Nullable @@ -577,7 +577,7 @@ public Order currencyPair(String currencyPair) { } /** - * Currency pair + * Currency pair. * @return currencyPair **/ public String getCurrencyPair() { @@ -636,7 +636,7 @@ public Order side(SideEnum side) { } /** - * Buy or sell order + * 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` + * When `type` is limit, it refers to base currency. For instance, `BTC_USDT` means `BTC` When different currency according to `side` - `side` : `buy` means quote currency, `BTC_USDT` means `USDT` - `side` : `sell` means base currency，`BTC_USDT` means `BTC` * @return amount **/ public String getAmount() { @@ -674,7 +674,7 @@ public Order price(String price) { } /** - * Price can't be empty when `type`= `limit` + * Price can't be empty 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 @@ -768,7 +768,7 @@ public void setAutoRepay(Boolean autoRepay) { } /** - * Amount left to fill + * Amount left to fill. * @return left **/ @javax.annotation.Nullable @@ -778,7 +778,7 @@ public String getLeft() { /** - * Amount traded to fill + * Amount traded to fill. * @return filledAmount **/ @javax.annotation.Nullable @@ -788,7 +788,7 @@ public String getFilledAmount() { /** - * Total filled in quote currency. Deprecated in favor of `filled_total` + * Total filled in quote currency. Deprecated in favor of `filled_total`. * @return fillPrice **/ @javax.annotation.Nullable @@ -798,7 +798,7 @@ public String getFillPrice() { /** - * Total filled in quote currency + * Total filled in quote currency. * @return filledTotal **/ @javax.annotation.Nullable @@ -808,7 +808,7 @@ public String getFilledTotal() { /** - * Average fill price + * Average fill price. * @return avgDealPrice **/ @javax.annotation.Nullable @@ -818,7 +818,7 @@ public String getAvgDealPrice() { /** - * Fee deducted + * Fee deducted. * @return fee **/ @javax.annotation.Nullable @@ -828,7 +828,7 @@ public String getFee() { /** - * Fee currency unit + * Fee currency unit. * @return feeCurrency **/ @javax.annotation.Nullable @@ -838,7 +838,7 @@ public String getFeeCurrency() { /** - * Points used to deduct fee + * Points used to deduct fee. * @return pointFee **/ @javax.annotation.Nullable @@ -848,7 +848,7 @@ public String getPointFee() { /** - * GT used to deduct fee + * GT used to deduct fee. * @return gtFee **/ @javax.annotation.Nullable @@ -858,7 +858,7 @@ public String getGtFee() { /** - * GT used to deduct maker fee + * GT used to deduct maker fee. * @return gtMakerFee **/ @javax.annotation.Nullable @@ -868,7 +868,7 @@ public String getGtMakerFee() { /** - * GT used to deduct taker fee + * GT 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 discount is used. * @return gtDiscount **/ @javax.annotation.Nullable @@ -888,7 +888,7 @@ public Boolean getGtDiscount() { /** - * Rebated fee + * Rebated fee. * @return rebatedFee **/ @javax.annotation.Nullable @@ -898,7 +898,7 @@ public String getRebatedFee() { /** - * Rebated fee currency unit + * Rebated fee currency unit. * @return rebatedFeeCurrency **/ @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 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 @@ -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 be0900d..afee3fb 100644 --- a/src/main/java/io/gate/gateapi/models/OrderBook.java +++ b/src/main/java/io/gate/gateapi/models/OrderBook.java @@ -73,7 +73,7 @@ public OrderBook current(Long current) { } /** - * The timestamp of the response data being generated (in milliseconds) + * The timestamp of the response data being generated (in milliseconds). * @return current **/ @javax.annotation.Nullable @@ -93,7 +93,7 @@ public OrderBook update(Long update) { } /** - * The timestamp of when the orderbook last changed (in milliseconds) + * The timestamp of when the orderbook last changed (in milliseconds). * @return update **/ @javax.annotation.Nullable @@ -118,7 +118,7 @@ public OrderBook addAsksItem(List asksItem) { } /** - * Asks order depth + * Asks order depth. * @return asks **/ public List> getAsks() { @@ -142,7 +142,7 @@ public OrderBook addBidsItem(List bidsItem) { } /** - * Bids order depth + * Bids order 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 221f113..fa72c0b 100644 --- a/src/main/java/io/gate/gateapi/models/OrderCancel.java +++ b/src/main/java/io/gate/gateapi/models/OrderCancel.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Spot order details + * Spot order details. */ public class OrderCancel { public static final String SERIALIZED_NAME_ID = "id"; @@ -176,7 +176,7 @@ public TypeEnum read(final JsonReader jsonReader) throws IOException { private String account = "spot"; /** - * Buy or sell order + * 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 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 { @@ -479,7 +479,7 @@ public FinishAsEnum read(final JsonReader jsonReader) throws IOException { /** - * Order ID + * Order ID. * @return id **/ @javax.annotation.Nullable @@ -509,7 +509,7 @@ public void setText(String text) { } /** - * The custom data that the user remarked when amending the order + * The custom data that the user remarked when amending the order. * @return amendText **/ @javax.annotation.Nullable @@ -525,7 +525,7 @@ public OrderCancel succeeded(Boolean succeeded) { } /** - * Whether the batch of orders succeeded + * Whether the batch of orders succeeded. * @return succeeded **/ @javax.annotation.Nullable @@ -545,7 +545,7 @@ public OrderCancel label(String label) { } /** - * Error label, if any, otherwise an empty string + * Error label, if any, otherwise an empty string. * @return label **/ @javax.annotation.Nullable @@ -565,7 +565,7 @@ public OrderCancel message(String message) { } /** - * Detailed error message, if any, otherwise an empty string + * Detailed error message, if any, otherwise an empty string. * @return message **/ @javax.annotation.Nullable @@ -579,7 +579,7 @@ public void setMessage(String message) { } /** - * Creation time of order + * Creation time of order. * @return createTime **/ @javax.annotation.Nullable @@ -589,7 +589,7 @@ public String getCreateTime() { /** - * Last modification time of order + * Last modification time of order. * @return updateTime **/ @javax.annotation.Nullable @@ -599,7 +599,7 @@ public String getUpdateTime() { /** - * Creation time of order (in milliseconds) + * Creation time of order (in milliseconds). * @return createTimeMs **/ @javax.annotation.Nullable @@ -609,7 +609,7 @@ public Long getCreateTimeMs() { /** - * Last modification time of order (in milliseconds) + * Last modification time of order (in milliseconds). * @return updateTimeMs **/ @javax.annotation.Nullable @@ -635,7 +635,7 @@ public OrderCancel currencyPair(String currencyPair) { } /** - * Currency pair + * Currency pair. * @return currencyPair **/ public String getCurrencyPair() { @@ -694,7 +694,7 @@ public OrderCancel side(SideEnum side) { } /** - * Buy or sell order + * 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` + * When `type` is limit, it refers to base currency. For instance, `BTC_USDT` means `BTC` When different currency according to `side` - `side` : `buy` means quote currency, `BTC_USDT` means `USDT` - `side` : `sell` means base currency，`BTC_USDT` means `BTC` * @return amount **/ public String getAmount() { @@ -732,7 +732,7 @@ public OrderCancel price(String price) { } /** - * Price can't be empty when `type`= `limit` + * Price can't be empty 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 @@ -826,7 +826,7 @@ public void setAutoRepay(Boolean autoRepay) { } /** - * Amount left to fill + * Amount left to fill. * @return left **/ @javax.annotation.Nullable @@ -836,7 +836,7 @@ public String getLeft() { /** - * Amount traded to fill + * Amount traded to fill. * @return filledAmount **/ @javax.annotation.Nullable @@ -846,7 +846,7 @@ public String getFilledAmount() { /** - * Total filled in quote currency. Deprecated in favor of `filled_total` + * Total filled in quote currency. Deprecated in favor of `filled_total`. * @return fillPrice **/ @javax.annotation.Nullable @@ -856,7 +856,7 @@ public String getFillPrice() { /** - * Total filled in quote currency + * Total filled in quote currency. * @return filledTotal **/ @javax.annotation.Nullable @@ -866,7 +866,7 @@ public String getFilledTotal() { /** - * Average fill price + * Average fill price. * @return avgDealPrice **/ @javax.annotation.Nullable @@ -876,7 +876,7 @@ public String getAvgDealPrice() { /** - * Fee deducted + * Fee deducted. * @return fee **/ @javax.annotation.Nullable @@ -886,7 +886,7 @@ public String getFee() { /** - * Fee currency unit + * Fee currency unit. * @return feeCurrency **/ @javax.annotation.Nullable @@ -896,7 +896,7 @@ public String getFeeCurrency() { /** - * Points used to deduct fee + * Points used to deduct fee. * @return pointFee **/ @javax.annotation.Nullable @@ -906,7 +906,7 @@ public String getPointFee() { /** - * GT used to deduct fee + * GT used to deduct fee. * @return gtFee **/ @javax.annotation.Nullable @@ -916,7 +916,7 @@ public String getGtFee() { /** - * GT used to deduct maker fee + * GT used to deduct maker fee. * @return gtMakerFee **/ @javax.annotation.Nullable @@ -926,7 +926,7 @@ public String getGtMakerFee() { /** - * GT used to deduct taker fee + * GT 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 discount is used. * @return gtDiscount **/ @javax.annotation.Nullable @@ -946,7 +946,7 @@ public Boolean getGtDiscount() { /** - * Rebated fee + * Rebated fee. * @return rebatedFee **/ @javax.annotation.Nullable @@ -956,7 +956,7 @@ public String getRebatedFee() { /** - * Rebated fee currency unit + * Rebated fee currency unit. * @return rebatedFeeCurrency **/ @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 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/OrderPatch.java b/src/main/java/io/gate/gateapi/models/OrderPatch.java index 65e8e59..70b77cb 100644 --- a/src/main/java/io/gate/gateapi/models/OrderPatch.java +++ b/src/main/java/io/gate/gateapi/models/OrderPatch.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Spot order details + * Spot order details. */ public class OrderPatch { public static final String SERIALIZED_NAME_CURRENCY_PAIR = "currency_pair"; @@ -55,7 +55,7 @@ public OrderPatch currencyPair(String currencyPair) { } /** - * Currency pair + * Currency pair. * @return currencyPair **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public OrderPatch amount(String amount) { } /** - * Trading Quantity. Either amountor pricemust be specified + * Trading Quantity. Either amountor pricemust be specified. * @return amount **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public OrderPatch price(String price) { } /** - * Trading Price. Either amountor pricemust be specified + * Trading Price. Either amountor pricemust be specified. * @return price **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public OrderPatch amendText(String amendText) { } /** - * Custom info during amending order + * Custom info during amending order. * @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 ae07031..ba682bb 100644 --- a/src/main/java/io/gate/gateapi/models/OrderResp.java +++ b/src/main/java/io/gate/gateapi/models/OrderResp.java @@ -35,7 +35,7 @@ public OrderResp orderId(Long orderId) { } /** - * Order ID + * Order ID. * @return orderId **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/PartnerCommissionHistory.java b/src/main/java/io/gate/gateapi/models/PartnerCommissionHistory.java index c245306..f6b60df 100644 --- a/src/main/java/io/gate/gateapi/models/PartnerCommissionHistory.java +++ b/src/main/java/io/gate/gateapi/models/PartnerCommissionHistory.java @@ -42,7 +42,7 @@ public PartnerCommissionHistory total(Long total) { } /** - * Total + * Total. * @return total **/ @javax.annotation.Nullable @@ -70,7 +70,7 @@ public PartnerCommissionHistory addListItem(AgencyCommission listItem) { } /** - * List of comission history + * List of comission 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 7eb90eb..699fc3c 100644 --- a/src/main/java/io/gate/gateapi/models/PartnerSub.java +++ b/src/main/java/io/gate/gateapi/models/PartnerSub.java @@ -43,7 +43,7 @@ public PartnerSub userId(Long userId) { } /** - * User ID + * User ID. * @return userId **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public PartnerSub userJoinTime(Long userJoinTime) { } /** - * The time when the user joined the system, in seconds Unix timestamp + * The time when the user joined the system, in seconds Unix timestamp. * @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 Customer 3-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 7685254..943ab12 100644 --- a/src/main/java/io/gate/gateapi/models/PartnerSubList.java +++ b/src/main/java/io/gate/gateapi/models/PartnerSubList.java @@ -42,7 +42,7 @@ public PartnerSubList total(Long total) { } /** - * Total + * Total. * @return total **/ @javax.annotation.Nullable @@ -70,7 +70,7 @@ public PartnerSubList addListItem(PartnerSub listItem) { } /** - * Subordinate list + * Subordinate list. * @return list **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/PartnerTransactionHistory.java b/src/main/java/io/gate/gateapi/models/PartnerTransactionHistory.java index fa25c06..38e7c73 100644 --- a/src/main/java/io/gate/gateapi/models/PartnerTransactionHistory.java +++ b/src/main/java/io/gate/gateapi/models/PartnerTransactionHistory.java @@ -42,7 +42,7 @@ public PartnerTransactionHistory total(Long total) { } /** - * Total + * Total. * @return total **/ @javax.annotation.Nullable @@ -70,7 +70,7 @@ public PartnerTransactionHistory addListItem(AgencyTransaction listItem) { } /** - * List of transaction history + * List of transaction history. * @return list **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/PatchUniLend.java b/src/main/java/io/gate/gateapi/models/PatchUniLend.java index 41ab038..13edc4f 100644 --- a/src/main/java/io/gate/gateapi/models/PatchUniLend.java +++ b/src/main/java/io/gate/gateapi/models/PatchUniLend.java @@ -39,7 +39,7 @@ public PatchUniLend currency(String currency) { } /** - * Currency name + * Currency name. * @return currency **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public PatchUniLend minRate(String minRate) { } /** - * Minimum interest rate + * Minimum interest rate. * @return minRate **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/PlaceDualInvestmentOrder.java b/src/main/java/io/gate/gateapi/models/PlaceDualInvestmentOrder.java index a3a9863..00fe401 100644 --- a/src/main/java/io/gate/gateapi/models/PlaceDualInvestmentOrder.java +++ b/src/main/java/io/gate/gateapi/models/PlaceDualInvestmentOrder.java @@ -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 + * Plan 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 the copies field. * @return amount **/ public String getAmount() { diff --git a/src/main/java/io/gate/gateapi/models/Position.java b/src/main/java/io/gate/gateapi/models/Position.java index 2125e5e..1859472 100644 --- a/src/main/java/io/gate/gateapi/models/Position.java +++ b/src/main/java/io/gate/gateapi/models/Position.java @@ -21,7 +21,7 @@ import java.io.IOException; /** - * Futures position details + * Futures position details. */ public class Position { public static final String SERIALIZED_NAME_USER = "user"; @@ -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`: dual mode is not enabled- `dual_long`: long position in dual mode- `dual_short`: mode */ @JsonAdapter(ModeEnum.Adapter.class) public enum ModeEnum { @@ -207,7 +207,7 @@ public ModeEnum read(final JsonReader jsonReader) throws IOException { /** - * User ID + * User ID. * @return user **/ @javax.annotation.Nullable @@ -217,7 +217,7 @@ public Long getUser() { /** - * Futures contract + * Futures contract. * @return contract **/ @javax.annotation.Nullable @@ -227,7 +227,7 @@ public String getContract() { /** - * Position size + * Position size. * @return size **/ @javax.annotation.Nullable @@ -263,7 +263,7 @@ public Position riskLimit(String riskLimit) { } /** - * Position risk limit + * Position risk limit. * @return riskLimit **/ @javax.annotation.Nullable @@ -277,7 +277,7 @@ public void setRiskLimit(String riskLimit) { } /** - * Maximum leverage under current risk limit + * Maximum leverage under current risk limit. * @return leverageMax **/ @javax.annotation.Nullable @@ -287,7 +287,7 @@ public String getLeverageMax() { /** - * Maintenance rate under current risk limit + * Maintenance rate under current risk limit. * @return maintenanceRate **/ @javax.annotation.Nullable @@ -297,7 +297,7 @@ public String getMaintenanceRate() { /** - * Position value calculated in settlement currency + * Position value calculated in settlement currency. * @return value **/ @javax.annotation.Nullable @@ -313,7 +313,7 @@ public Position margin(String margin) { } /** - * Position margin + * Position margin. * @return margin **/ @javax.annotation.Nullable @@ -327,7 +327,7 @@ public void setMargin(String margin) { } /** - * Entry price + * Entry price. * @return entryPrice **/ @javax.annotation.Nullable @@ -337,7 +337,7 @@ public String getEntryPrice() { /** - * Liquidation price + * Liquidation price. * @return liqPrice **/ @javax.annotation.Nullable @@ -347,7 +347,7 @@ public String getLiqPrice() { /** - * Current mark price + * Current mark price. * @return markPrice **/ @javax.annotation.Nullable @@ -377,7 +377,7 @@ public String getMaintenanceMargin() { /** - * Unrealized PNL + * Unrealized PNL. * @return unrealisedPnl **/ @javax.annotation.Nullable @@ -387,7 +387,7 @@ public String getUnrealisedPnl() { /** - * Realized PNL + * Realized PNL. * @return realisedPnl **/ @javax.annotation.Nullable @@ -397,7 +397,7 @@ public String getRealisedPnl() { /** - * Realized PNL - Position P/L + * Realized PNL - Position P/L. * @return pnlPnl **/ @javax.annotation.Nullable @@ -407,7 +407,7 @@ public String getPnlPnl() { /** - * Realized PNL - Funding Fees + * Realized PNL - Funding Fees. * @return pnlFund **/ @javax.annotation.Nullable @@ -417,7 +417,7 @@ public String getPnlFund() { /** - * Realized PNL - Transaction Fees + * Realized PNL - Transaction Fees. * @return pnlFee **/ @javax.annotation.Nullable @@ -427,7 +427,7 @@ public String getPnlFee() { /** - * History realized PNL + * History realized PNL. * @return historyPnl **/ @javax.annotation.Nullable @@ -437,7 +437,7 @@ public String getHistoryPnl() { /** - * PNL of last position close + * PNL of last position close. * @return lastClosePnl **/ @javax.annotation.Nullable @@ -447,7 +447,7 @@ public String getLastClosePnl() { /** - * Realized POINT PNL + * Realized POINT PNL. * @return realisedPoint **/ @javax.annotation.Nullable @@ -457,7 +457,7 @@ public String getRealisedPoint() { /** - * History realized POINT PNL + * History realized POINT PNL. * @return historyPoint **/ @javax.annotation.Nullable @@ -477,7 +477,7 @@ public Integer getAdlRanking() { /** - * Current open orders + * Current open orders. * @return pendingOrders **/ @javax.annotation.Nullable @@ -513,7 +513,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`: dual mode is not enabled- `dual_long`: long position in dual mode- `dual_short`: mode * @return mode **/ @javax.annotation.Nullable @@ -533,7 +533,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 @@ -547,7 +547,7 @@ public void setCrossLeverageLimit(String crossLeverageLimit) { } /** - * Last update time + * Last update time. * @return updateTime **/ @javax.annotation.Nullable @@ -573,7 +573,7 @@ public Position openTime(Long openTime) { } /** - * First Open Time + * First Open Time. * @return openTime **/ @javax.annotation.Nullable @@ -587,7 +587,7 @@ public void setOpenTime(Long openTime) { } /** - * Risk limit table ID + * Risk limit table ID. * @return riskLimitTable **/ @javax.annotation.Nullable @@ -597,7 +597,7 @@ public String getRiskLimitTable() { /** - * Average maintenance margin rate + * Average maintenance margin rate. * @return averageMaintenanceRate **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/PositionClose.java b/src/main/java/io/gate/gateapi/models/PositionClose.java index 503fa77..37564f6 100644 --- a/src/main/java/io/gate/gateapi/models/PositionClose.java +++ b/src/main/java/io/gate/gateapi/models/PositionClose.java @@ -32,7 +32,7 @@ public class PositionClose { private String contract; /** - * Position side, long or short + * Position side, long or short. */ @JsonAdapter(SideEnum.Adapter.class) public enum SideEnum { @@ -124,7 +124,7 @@ public SideEnum read(final JsonReader jsonReader) throws IOException { /** - * Position close time + * Position close time. * @return time **/ @javax.annotation.Nullable @@ -134,7 +134,7 @@ public Double getTime() { /** - * Futures contract + * Futures contract. * @return contract **/ @javax.annotation.Nullable @@ -144,7 +144,7 @@ public String getContract() { /** - * Position side, long or short + * Position side, long or short. * @return side **/ @javax.annotation.Nullable @@ -154,7 +154,7 @@ public SideEnum getSide() { /** - * PNL + * PNL. * @return pnl **/ @javax.annotation.Nullable @@ -164,7 +164,7 @@ public String getPnl() { /** - * PNL - Position P/L + * PNL - Position P/L. * @return pnlPnl **/ @javax.annotation.Nullable @@ -174,7 +174,7 @@ public String getPnlPnl() { /** - * PNL - Funding Fees + * PNL - Funding Fees. * @return pnlFund **/ @javax.annotation.Nullable @@ -184,7 +184,7 @@ public String getPnlFund() { /** - * PNL - Transaction Fees + * PNL - Transaction Fees. * @return pnlFee **/ @javax.annotation.Nullable @@ -194,7 +194,7 @@ public String getPnlFee() { /** - * Text of close order + * Text of close order. * @return text **/ @javax.annotation.Nullable @@ -204,7 +204,7 @@ public String getText() { /** - * Max Trade Size + * Max Trade Size. * @return maxSize **/ @javax.annotation.Nullable @@ -214,7 +214,7 @@ public String getMaxSize() { /** - * Cumulative closed position volume + * Cumulative closed position volume. * @return accumSize **/ @javax.annotation.Nullable @@ -224,7 +224,7 @@ public String getAccumSize() { /** - * First Open Time + * First Open Time. * @return firstOpenTime **/ @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 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 opening average price; when closing 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 9c90a8e..9a6bd77 100644 --- a/src/main/java/io/gate/gateapi/models/PositionCloseOrder.java +++ b/src/main/java/io/gate/gateapi/models/PositionCloseOrder.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Current close order if any, or `null` + * Current close order if any, or `null`. */ public class PositionCloseOrder { public static final String SERIALIZED_NAME_ID = "id"; @@ -43,7 +43,7 @@ public PositionCloseOrder id(Long id) { } /** - * Close order ID + * Close order ID. * @return id **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public PositionCloseOrder price(String price) { } /** - * Close order price + * Close order price. * @return price **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public PositionCloseOrder isLiq(Boolean isLiq) { } /** - * Is the close order from liquidation + * Is the close order 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 a18746d..5d76911 100644 --- a/src/main/java/io/gate/gateapi/models/ProfitLossRange.java +++ b/src/main/java/io/gate/gateapi/models/ProfitLossRange.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Profit and loss range + * Profit and loss range. */ public class ProfitLossRange { public static final String SERIALIZED_NAME_PRICE_PERCENTAGE = "price_percentage"; @@ -43,7 +43,7 @@ public ProfitLossRange pricePercentage(String pricePercentage) { } /** - * Percentage change in price + * Percentage change in price. * @return pricePercentage **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public ProfitLossRange impliedVolatilityPercentage(String impliedVolatilityPerce } /** - * Percentage change in implied volatility + * Percentage change in implied volatility. * @return impliedVolatilityPercentage **/ @javax.annotation.Nullable @@ -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 0c91b5f..02941d6 100644 --- a/src/main/java/io/gate/gateapi/models/RebateUserInfo.java +++ b/src/main/java/io/gate/gateapi/models/RebateUserInfo.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Retrieve user rebate information + * Retrieve user rebate information. */ public class RebateUserInfo { public static final String SERIALIZED_NAME_INVITE_UID = "invite_uid"; @@ -35,7 +35,7 @@ public RebateUserInfo inviteUid(Long inviteUid) { } /** - * My inviter's UID + * My inviter's UID. * @return inviteUid **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/RepayCurrencyRes.java b/src/main/java/io/gate/gateapi/models/RepayCurrencyRes.java index 4d14d77..5385583 100644 --- a/src/main/java/io/gate/gateapi/models/RepayCurrencyRes.java +++ b/src/main/java/io/gate/gateapi/models/RepayCurrencyRes.java @@ -55,7 +55,7 @@ public RepayCurrencyRes succeeded(Boolean succeeded) { } /** - * Has the repayment been successful + * Has the repayment been successful. * @return succeeded **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public RepayCurrencyRes currency(String currency) { } /** - * Repayment currency + * Repayment currency. * @return currency **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public RepayCurrencyRes repaidPrincipal(String repaidPrincipal) { } /** - * Principal + * Principal. * @return repaidPrincipal **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public RepayCurrencyRes repaidInterest(String repaidInterest) { } /** - * Principal + * Principal. * @return repaidInterest **/ @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 ed676a4..5c63727 100644 --- a/src/main/java/io/gate/gateapi/models/RepayLoan.java +++ b/src/main/java/io/gate/gateapi/models/RepayLoan.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Repay + * Repay. */ public class RepayLoan { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; @@ -43,7 +43,7 @@ public RepayLoan orderId(Long orderId) { } /** - * Order ID + * Order ID. * @return orderId **/ public Long getOrderId() { @@ -62,7 +62,7 @@ public RepayLoan repayAmount(String repayAmount) { } /** - * Repayment amount, it is mandatory when making partial repayments + * Repayment amount, it is mandatory when making partial repayments. * @return repayAmount **/ public String getRepayAmount() { @@ -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 c0b3133..5b1bb99 100644 --- a/src/main/java/io/gate/gateapi/models/RepayMultiLoan.java +++ b/src/main/java/io/gate/gateapi/models/RepayMultiLoan.java @@ -23,7 +23,7 @@ import java.util.List; /** - * Repay Multi-Collateral Loan + * Repay Multi-Collateral Loan. */ public class RepayMultiLoan { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; @@ -42,7 +42,7 @@ public RepayMultiLoan orderId(Long orderId) { } /** - * Order ID + * Order ID. * @return orderId **/ public Long getOrderId() { @@ -66,7 +66,7 @@ public RepayMultiLoan addRepayItemsItem(MultiLoanRepayItem repayItemsItem) { } /** - * Repay Currency Item + * Repay Currency Item. * @return repayItems **/ public List getRepayItems() { diff --git a/src/main/java/io/gate/gateapi/models/RepayRecord.java b/src/main/java/io/gate/gateapi/models/RepayRecord.java index 072e49e..7ed1f3c 100644 --- a/src/main/java/io/gate/gateapi/models/RepayRecord.java +++ b/src/main/java/io/gate/gateapi/models/RepayRecord.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Repayment record + * Repayment record. */ public class RepayRecord { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; @@ -83,7 +83,7 @@ public RepayRecord orderId(Long orderId) { } /** - * Order ID + * Order ID. * @return orderId **/ @javax.annotation.Nullable @@ -103,7 +103,7 @@ public RepayRecord recordId(Long recordId) { } /** - * Repayment record ID + * Repayment record ID. * @return recordId **/ @javax.annotation.Nullable @@ -123,7 +123,7 @@ public RepayRecord repaidAmount(String repaidAmount) { } /** - * Repayment amount + * Repayment amount. * @return repaidAmount **/ @javax.annotation.Nullable @@ -143,7 +143,7 @@ public RepayRecord borrowCurrency(String borrowCurrency) { } /** - * Borrowed currency + * Borrowed currency. * @return borrowCurrency **/ @javax.annotation.Nullable @@ -163,7 +163,7 @@ public RepayRecord collateralCurrency(String collateralCurrency) { } /** - * Collateral + * Collateral. * @return collateralCurrency **/ @javax.annotation.Nullable @@ -183,7 +183,7 @@ public RepayRecord initLtv(String initLtv) { } /** - * The initial collateralization rate + * The initial collateralization rate. * @return initLtv **/ @javax.annotation.Nullable @@ -203,7 +203,7 @@ public RepayRecord borrowTime(Long borrowTime) { } /** - * Borrowing time, timestamp + * Borrowing time, timestamp. * @return borrowTime **/ @javax.annotation.Nullable @@ -223,7 +223,7 @@ public RepayRecord repayTime(Long repayTime) { } /** - * Repayment time, timestamp + * Repayment time, timestamp. * @return repayTime **/ @javax.annotation.Nullable @@ -243,7 +243,7 @@ public RepayRecord totalInterest(String totalInterest) { } /** - * Total interest + * Total interest. * @return totalInterest **/ @javax.annotation.Nullable @@ -263,7 +263,7 @@ public RepayRecord beforeLeftPrincipal(String beforeLeftPrincipal) { } /** - * Principal to be repaid before repayment + * Principal to be repaid before repayment. * @return beforeLeftPrincipal **/ @javax.annotation.Nullable @@ -283,7 +283,7 @@ public RepayRecord afterLeftPrincipal(String afterLeftPrincipal) { } /** - * Principal to be repaid after repayment + * Principal to be repaid after repayment. * @return afterLeftPrincipal **/ @javax.annotation.Nullable @@ -303,7 +303,7 @@ public RepayRecord beforeLeftCollateral(String beforeLeftCollateral) { } /** - * Collateral quantity before repayment + * Collateral quantity before repayment. * @return beforeLeftCollateral **/ @javax.annotation.Nullable @@ -323,7 +323,7 @@ public RepayRecord afterLeftCollateral(String afterLeftCollateral) { } /** - * Collateral quantity after repayment + * Collateral quantity 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 6d09a2a..d0038a1 100644 --- a/src/main/java/io/gate/gateapi/models/RepayRecordCurrency.java +++ b/src/main/java/io/gate/gateapi/models/RepayRecordCurrency.java @@ -55,7 +55,7 @@ public RepayRecordCurrency currency(String currency) { } /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public RepayRecordCurrency indexPrice(String indexPrice) { } /** - * Currency Index Price + * Currency Index Price. * @return indexPrice **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public RepayRecordCurrency beforeAmount(String beforeAmount) { } /** - * Amount before the operation + * Amount before the operation. * @return beforeAmount **/ @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 9d8e4ae..c8c8445 100644 --- a/src/main/java/io/gate/gateapi/models/RepayRecordLeftInterest.java +++ b/src/main/java/io/gate/gateapi/models/RepayRecordLeftInterest.java @@ -55,7 +55,7 @@ public RepayRecordLeftInterest currency(String currency) { } /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public RepayRecordLeftInterest indexPrice(String indexPrice) { } /** - * Currency Index Price + * Currency Index Price. * @return indexPrice **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public RepayRecordLeftInterest beforeAmount(String beforeAmount) { } /** - * Interest amount before repayment + * Interest amount before repayment. * @return beforeAmount **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public RepayRecordLeftInterest beforeAmountUsdt(String beforeAmountUsdt) { } /** - * Converted value of interest before repayment in USDT + * Converted value of interest before repayment in USDT. * @return beforeAmountUsdt **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public RepayRecordLeftInterest afterAmount(String afterAmount) { } /** - * Interest amount after repayment + * Interest amount after repayment. * @return afterAmount **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public RepayRecordLeftInterest afterAmountUsdt(String afterAmountUsdt) { } /** - * Converted value of interest after repayment in USDT + * Converted value of interest after repayment in USDT. * @return afterAmountUsdt **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/RepayRecordRepaidCurrency.java b/src/main/java/io/gate/gateapi/models/RepayRecordRepaidCurrency.java index a82df33..e5c7976 100644 --- a/src/main/java/io/gate/gateapi/models/RepayRecordRepaidCurrency.java +++ b/src/main/java/io/gate/gateapi/models/RepayRecordRepaidCurrency.java @@ -55,7 +55,7 @@ public RepayRecordRepaidCurrency currency(String currency) { } /** - * Repayment currency + * Repayment currency. * @return currency **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public RepayRecordRepaidCurrency indexPrice(String indexPrice) { } /** - * Currency Index Price + * Currency Index Price. * @return indexPrice **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public RepayRecordRepaidCurrency repaidAmount(String repaidAmount) { } /** - * Repayment amount + * Repayment amount. * @return repaidAmount **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public RepayRecordRepaidCurrency repaidPrincipal(String repaidPrincipal) { } /** - * Principal + * Principal. * @return repaidPrincipal **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public RepayRecordRepaidCurrency repaidInterest(String repaidInterest) { } /** - * Interest + * Interest. * @return repaidInterest **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public RepayRecordRepaidCurrency repaidAmountUsdt(String repaidAmountUsdt) { } /** - * Value of the repayment amount in USDT + * Value of the repayment amount in 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 4ff0f10..c94dc51 100644 --- a/src/main/java/io/gate/gateapi/models/RepayRecordTotalInterest.java +++ b/src/main/java/io/gate/gateapi/models/RepayRecordTotalInterest.java @@ -47,7 +47,7 @@ public RepayRecordTotalInterest currency(String currency) { } /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -67,7 +67,7 @@ public RepayRecordTotalInterest indexPrice(String indexPrice) { } /** - * Currency Index Price + * Currency Index Price. * @return indexPrice **/ @javax.annotation.Nullable @@ -87,7 +87,7 @@ public RepayRecordTotalInterest amount(String amount) { } /** - * Interest Amount + * Interest Amount. * @return amount **/ @javax.annotation.Nullable @@ -107,7 +107,7 @@ public RepayRecordTotalInterest amountUsdt(String amountUsdt) { } /** - * Interest amount converted to USDT + * Interest amount converted to USDT. * @return amountUsdt **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/RepayResp.java b/src/main/java/io/gate/gateapi/models/RepayResp.java index 863ae74..5f8cc37 100644 --- a/src/main/java/io/gate/gateapi/models/RepayResp.java +++ b/src/main/java/io/gate/gateapi/models/RepayResp.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Repay + * Repay. */ public class RepayResp { public static final String SERIALIZED_NAME_REPAID_PRINCIPAL = "repaid_principal"; @@ -39,7 +39,7 @@ public RepayResp repaidPrincipal(String repaidPrincipal) { } /** - * Principal + * Principal. * @return repaidPrincipal **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public RepayResp repaidInterest(String repaidInterest) { } /** - * Interest + * Interest. * @return repaidInterest **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/RiskUnits.java b/src/main/java/io/gate/gateapi/models/RiskUnits.java index a2a1b1f..de5c9de 100644 --- a/src/main/java/io/gate/gateapi/models/RiskUnits.java +++ b/src/main/java/io/gate/gateapi/models/RiskUnits.java @@ -63,7 +63,7 @@ public RiskUnits symbol(String symbol) { } /** - * Risk unit flag + * Risk unit flag. * @return symbol **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public RiskUnits spotInUse(String spotInUse) { } /** - * Spot hedging utilization + * Spot hedging utilization. * @return spotInUse **/ @javax.annotation.Nullable @@ -103,7 +103,7 @@ public RiskUnits maintainMargin(String maintainMargin) { } /** - * Maintenance margin for risk unit + * Maintenance margin for risk unit. * @return maintainMargin **/ @javax.annotation.Nullable @@ -123,7 +123,7 @@ public RiskUnits initialMargin(String initialMargin) { } /** - * Initial margin for risk unit + * Initial margin for risk unit. * @return initialMargin **/ @javax.annotation.Nullable @@ -143,7 +143,7 @@ public RiskUnits delta(String delta) { } /** - * Total Delta of risk unit + * Total Delta of risk unit. * @return delta **/ @javax.annotation.Nullable @@ -163,7 +163,7 @@ public RiskUnits gamma(String gamma) { } /** - * Total Gamma of risk unit + * Total Gamma of risk unit. * @return gamma **/ @javax.annotation.Nullable @@ -183,7 +183,7 @@ public RiskUnits theta(String theta) { } /** - * Total Theta of risk unit + * Total Theta of risk unit. * @return theta **/ @javax.annotation.Nullable @@ -203,7 +203,7 @@ public RiskUnits vega(String vega) { } /** - * Total Vega of risk unit + * Total Vega of risk unit. * @return vega **/ @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 494efd2..7bb776a 100644 --- a/src/main/java/io/gate/gateapi/models/SavedAddress.java +++ b/src/main/java/io/gate/gateapi/models/SavedAddress.java @@ -55,7 +55,7 @@ public SavedAddress currency(String currency) { } /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public SavedAddress chain(String chain) { } /** - * Chain name + * Chain name. * @return chain **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public SavedAddress address(String address) { } /** - * Address + * Address. * @return address **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public SavedAddress name(String name) { } /** - * Name + * Name. * @return name **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public SavedAddress tag(String tag) { } /** - * Tag + * Tag. * @return tag **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public SavedAddress verified(String verified) { } /** - * Whether to pass the verification 0-unverified, 1-verified + * Whether to pass the verification 0-unverified, 1-verified. * @return verified **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SmallBalance.java b/src/main/java/io/gate/gateapi/models/SmallBalance.java index 343a114..b8733a6 100644 --- a/src/main/java/io/gate/gateapi/models/SmallBalance.java +++ b/src/main/java/io/gate/gateapi/models/SmallBalance.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Convert Small Balance + * Convert Small Balance. */ public class SmallBalance { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -47,7 +47,7 @@ public SmallBalance currency(String currency) { } /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -67,7 +67,7 @@ public SmallBalance availableBalance(String availableBalance) { } /** - * Available balance + * Available balance. * @return availableBalance **/ @javax.annotation.Nullable @@ -87,7 +87,7 @@ public SmallBalance estimatedAsBtc(String estimatedAsBtc) { } /** - * Estimated as BTC + * Estimated as BTC. * @return estimatedAsBtc **/ @javax.annotation.Nullable @@ -107,7 +107,7 @@ public SmallBalance convertibleToGt(String convertibleToGt) { } /** - * Estimated conversion to GT + * Estimated conversion to GT. * @return convertibleToGt **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SmallBalanceHistory.java b/src/main/java/io/gate/gateapi/models/SmallBalanceHistory.java index c1f8392..772517f 100644 --- a/src/main/java/io/gate/gateapi/models/SmallBalanceHistory.java +++ b/src/main/java/io/gate/gateapi/models/SmallBalanceHistory.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Convert Small Balance + * Convert Small Balance. */ public class SmallBalanceHistory { public static final String SERIALIZED_NAME_ID = "id"; @@ -45,7 +45,7 @@ public class SmallBalanceHistory { /** - * Order ID + * Order ID. * @return id **/ @javax.annotation.Nullable @@ -55,7 +55,7 @@ public String getId() { /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -65,7 +65,7 @@ public String getCurrency() { /** - * amount + * amount. * @return amount **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public String getAmount() { /** - * GT amount + * GT amount. * @return gtAmount **/ @javax.annotation.Nullable @@ -85,7 +85,7 @@ public String getGtAmount() { /** - * Exchange time (in seconds) + * Exchange time (in seconds). * @return createTime **/ @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 67c67b3..5e6b965 100644 --- a/src/main/java/io/gate/gateapi/models/SpotAccount.java +++ b/src/main/java/io/gate/gateapi/models/SpotAccount.java @@ -47,7 +47,7 @@ public SpotAccount currency(String currency) { } /** - * Currency detail + * Currency detail. * @return currency **/ @javax.annotation.Nullable @@ -67,7 +67,7 @@ public SpotAccount available(String available) { } /** - * Available amount + * Available amount. * @return available **/ @javax.annotation.Nullable @@ -87,7 +87,7 @@ public SpotAccount locked(String locked) { } /** - * Locked amount, used in trading + * Locked amount, used in trading. * @return locked **/ @javax.annotation.Nullable @@ -107,7 +107,7 @@ public SpotAccount updateId(Long updateId) { } /** - * Version number + * Version number. * @return updateId **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SpotAccountBook.java b/src/main/java/io/gate/gateapi/models/SpotAccountBook.java index db932e6..e6b0c5e 100644 --- a/src/main/java/io/gate/gateapi/models/SpotAccountBook.java +++ b/src/main/java/io/gate/gateapi/models/SpotAccountBook.java @@ -63,7 +63,7 @@ public SpotAccountBook id(String id) { } /** - * Balance change record ID + * Balance change record ID. * @return id **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public SpotAccountBook time(Long time) { } /** - * The timestamp of the change (in milliseconds) + * The timestamp of the change (in milliseconds). * @return time **/ @javax.annotation.Nullable @@ -103,7 +103,7 @@ public SpotAccountBook currency(String currency) { } /** - * Currency changed + * Currency changed. * @return currency **/ @javax.annotation.Nullable @@ -123,7 +123,7 @@ public SpotAccountBook change(String change) { } /** - * Amount changed. Positive value means transferring in, while negative out + * Amount changed. Positive value means transferring in, while negative out. * @return change **/ @javax.annotation.Nullable @@ -143,7 +143,7 @@ public SpotAccountBook balance(String balance) { } /** - * Balance after change + * Balance after change. * @return balance **/ @javax.annotation.Nullable @@ -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 @@ -183,7 +183,7 @@ public SpotAccountBook code(String code) { } /** - * Account change code, see [Asset Record Code] (Asset Record Code) + * Account change code, see [Asset Record Code] (Asset Record Code). * @return code **/ @javax.annotation.Nullable @@ -203,7 +203,7 @@ public SpotAccountBook text(String text) { } /** - * Additional information + * Additional information. * @return text **/ @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 e0f6c2c..9c3def3 100644 --- a/src/main/java/io/gate/gateapi/models/SpotCurrencyChain.java +++ b/src/main/java/io/gate/gateapi/models/SpotCurrencyChain.java @@ -51,7 +51,7 @@ public SpotCurrencyChain name(String name) { } /** - * Chain name + * Chain name. * @return name **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public SpotCurrencyChain addr(String addr) { } /** - * token address + * token address. * @return addr **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public SpotCurrencyChain withdrawDisabled(Boolean withdrawDisabled) { } /** - * Whether currency's withdrawal is disabled + * Whether currency's withdrawal is disabled. * @return withdrawDisabled **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public SpotCurrencyChain withdrawDelayed(Boolean withdrawDelayed) { } /** - * Whether currency's withdrawal is delayed + * Whether currency's withdrawal is delayed. * @return withdrawDelayed **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public SpotCurrencyChain depositDisabled(Boolean depositDisabled) { } /** - * Whether currency's deposit is disabled + * Whether currency's deposit is disabled. * @return depositDisabled **/ @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 c919c84..c7b862c 100644 --- a/src/main/java/io/gate/gateapi/models/SpotFee.java +++ b/src/main/java/io/gate/gateapi/models/SpotFee.java @@ -71,7 +71,7 @@ public SpotFee userId(Long userId) { } /** - * User ID + * User ID. * @return userId **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public SpotFee takerFee(String takerFee) { } /** - * taker fee rate + * taker fee rate. * @return takerFee **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public SpotFee makerFee(String makerFee) { } /** - * maker fee rate + * maker fee rate. * @return makerFee **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public SpotFee gtDiscount(Boolean gtDiscount) { } /** - * If GT deduction is enabled + * If GT deduction is enabled. * @return gtDiscount **/ @javax.annotation.Nullable @@ -191,7 +191,7 @@ public SpotFee loanFee(String loanFee) { } /** - * Loan fee rate of margin lending + * Loan fee rate of margin lending. * @return loanFee **/ @javax.annotation.Nullable @@ -211,7 +211,7 @@ public SpotFee pointType(String pointType) { } /** - * Point type. 0 - Initial version. 1 - new version since 202009 + * Point type. 0 - Initial version. 1 - new version since 202009. * @return pointType **/ @javax.annotation.Nullable @@ -231,7 +231,7 @@ public SpotFee currencyPair(String currencyPair) { } /** - * Currency pair + * Currency pair. * @return currencyPair **/ @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 f4fd1cd..9d37499 100644 --- a/src/main/java/io/gate/gateapi/models/SpotInsuranceHistory.java +++ b/src/main/java/io/gate/gateapi/models/SpotInsuranceHistory.java @@ -43,7 +43,7 @@ public SpotInsuranceHistory currency(String currency) { } /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public SpotInsuranceHistory balance(String balance) { } /** - * balance + * balance. * @return balance **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public SpotInsuranceHistory time(Long time) { } /** - * Creation time, timestamp, milliseconds + * Creation time, timestamp, milliseconds. * @return time **/ @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 b6109c5..dad7bda 100644 --- a/src/main/java/io/gate/gateapi/models/SpotPricePutOrder.java +++ b/src/main/java/io/gate/gateapi/models/SpotPricePutOrder.java @@ -296,7 +296,7 @@ public SpotPricePutOrder price(String price) { } /** - * Order price + * Order price. * @return price **/ public String getPrice() { @@ -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` + * When `type` is limit, it refers to base currency. For instance, `BTC_USDT` means `BTC` When different currency according to `side` - `side` : `buy` means quote currency, `BTC_USDT` means `USDT` - `side` : `sell` means base currency，`BTC_USDT` means `BTC` * @return amount **/ public String getAmount() { @@ -373,7 +373,7 @@ public SpotPricePutOrder autoBorrow(Boolean autoBorrow) { } /** - * Whether to borrow coins automatically + * Whether to borrow coins automatically. * @return autoBorrow **/ @javax.annotation.Nullable @@ -393,7 +393,7 @@ public SpotPricePutOrder autoRepay(Boolean autoRepay) { } /** - * Whether to repay the loan automatically + * Whether to repay the loan automatically. * @return autoRepay **/ @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 3efb211..5b7c001 100644 --- a/src/main/java/io/gate/gateapi/models/SpotPriceTrigger.java +++ b/src/main/java/io/gate/gateapi/models/SpotPriceTrigger.java @@ -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 larger than or equal to `price` field - `<=`: or equal to `price` field */ @JsonAdapter(RuleEnum.Adapter.class) public enum RuleEnum { @@ -90,7 +90,7 @@ public SpotPriceTrigger price(String price) { } /** - * Trigger price + * Trigger price. * @return price **/ public String getPrice() { @@ -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 larger than or equal to `price` field - `<=`: or equal to `price` field * @return rule **/ public RuleEnum getRule() { diff --git a/src/main/java/io/gate/gateapi/models/SpotPriceTriggeredOrder.java b/src/main/java/io/gate/gateapi/models/SpotPriceTriggeredOrder.java index 3b8c726..c49e6fe 100644 --- a/src/main/java/io/gate/gateapi/models/SpotPriceTriggeredOrder.java +++ b/src/main/java/io/gate/gateapi/models/SpotPriceTriggeredOrder.java @@ -22,7 +22,7 @@ import java.io.IOException; /** - * Spot order detail + * Spot order detail. */ public class SpotPriceTriggeredOrder { public static final String SERIALIZED_NAME_TRIGGER = "trigger"; @@ -105,7 +105,7 @@ public void setPut(SpotPricePutOrder put) { } /** - * Auto order ID + * Auto order ID. * @return id **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public Long getId() { /** - * User ID + * User ID. * @return user **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public SpotPriceTriggeredOrder market(String market) { } /** - * Currency pair + * Currency pair. * @return market **/ public String getMarket() { @@ -144,7 +144,7 @@ public void setMarket(String market) { } /** - * Creation time + * Creation time. * @return ctime **/ @javax.annotation.Nullable @@ -154,7 +154,7 @@ public Long getCtime() { /** - * Finished time + * Finished 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 newly created order on condition triggered. * @return firedOrderId **/ @javax.annotation.Nullable @@ -184,7 +184,7 @@ public String getStatus() { /** - * Additional remarks on how the order was finished + * Additional remarks on how the order was finished. * @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 a3ea160..2c0d872 100644 --- a/src/main/java/io/gate/gateapi/models/StpGroup.java +++ b/src/main/java/io/gate/gateapi/models/StpGroup.java @@ -47,7 +47,7 @@ public StpGroup id(Long id) { } /** - * STP Group ID + * STP Group ID. * @return id **/ @javax.annotation.Nullable @@ -67,7 +67,7 @@ public StpGroup name(String name) { } /** - * STP Group name + * STP Group name. * @return name **/ public String getName() { @@ -86,7 +86,7 @@ public StpGroup creatorId(Long creatorId) { } /** - * Creator ID + * Creator ID. * @return creatorId **/ @javax.annotation.Nullable @@ -106,7 +106,7 @@ public StpGroup createTime(Long createTime) { } /** - * Creation time + * Creation 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 37e72f6..7c84e2e 100644 --- a/src/main/java/io/gate/gateapi/models/StpGroupUser.java +++ b/src/main/java/io/gate/gateapi/models/StpGroupUser.java @@ -43,7 +43,7 @@ public StpGroupUser userId(Long userId) { } /** - * User ID + * User ID. * @return userId **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public StpGroupUser stpId(Long stpId) { } /** - * STP Group ID + * STP Group ID. * @return stpId **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public StpGroupUser createTime(Long createTime) { } /** - * Creation time + * Creation 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 805e515..5d73048 100644 --- a/src/main/java/io/gate/gateapi/models/StructuredBuy.java +++ b/src/main/java/io/gate/gateapi/models/StructuredBuy.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Dual Investment Purchase + * Dual Investment Purchase. */ public class StructuredBuy { public static final String SERIALIZED_NAME_PID = "pid"; @@ -39,7 +39,7 @@ public StructuredBuy pid(String pid) { } /** - * Plan ID + * Plan ID. * @return pid **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public StructuredBuy amount(String amount) { } /** - * Purchase Amount + * Purchase Amount. * @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 54dbf73..8845cdc 100644 --- a/src/main/java/io/gate/gateapi/models/StructuredGetProjectList.java +++ b/src/main/java/io/gate/gateapi/models/StructuredGetProjectList.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Structured Products + * Structured Products. */ public class StructuredGetProjectList { public static final String SERIALIZED_NAME_ID = "id"; @@ -79,7 +79,7 @@ public StructuredGetProjectList id(Integer id) { } /** - * Plan ID + * Plan ID. * @return id **/ @javax.annotation.Nullable @@ -119,7 +119,7 @@ public StructuredGetProjectList nameEn(String nameEn) { } /** - * name + * name. * @return nameEn **/ @javax.annotation.Nullable @@ -139,7 +139,7 @@ public StructuredGetProjectList investmentCoin(String investmentCoin) { } /** - * Investment Currency + * Investment Currency. * @return investmentCoin **/ @javax.annotation.Nullable @@ -159,7 +159,7 @@ public StructuredGetProjectList investmentPeriod(String investmentPeriod) { } /** - * Investment term + * Investment term. * @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 + * Watch 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 + * Finished 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 a1d15a1..3e7de01 100644 --- a/src/main/java/io/gate/gateapi/models/StructuredOrderList.java +++ b/src/main/java/io/gate/gateapi/models/StructuredOrderList.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Structured order + * Structured order. */ public class StructuredOrderList { public static final String SERIALIZED_NAME_ID = "id"; @@ -59,7 +59,7 @@ public StructuredOrderList id(Integer id) { } /** - * Order ID + * Order ID. * @return id **/ @javax.annotation.Nullable @@ -79,7 +79,7 @@ public StructuredOrderList pid(String pid) { } /** - * Plan ID + * Plan ID. * @return pid **/ @javax.annotation.Nullable @@ -99,7 +99,7 @@ public StructuredOrderList lockCoin(String lockCoin) { } /** - * Locked coin + * Locked coin. * @return lockCoin **/ @javax.annotation.Nullable @@ -119,7 +119,7 @@ public StructuredOrderList amount(String amount) { } /** - * Locked amount + * Locked amount. * @return amount **/ @javax.annotation.Nullable @@ -159,7 +159,7 @@ public StructuredOrderList income(String income) { } /** - * Income + * Income. * @return income **/ @javax.annotation.Nullable @@ -179,7 +179,7 @@ public StructuredOrderList createTime(Integer createTime) { } /** - * Created time + * Created time. * @return createTime **/ @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 5e9be9d..05df56b 100644 --- a/src/main/java/io/gate/gateapi/models/SubAccount.java +++ b/src/main/java/io/gate/gateapi/models/SubAccount.java @@ -63,7 +63,7 @@ public SubAccount remark(String remark) { } /** - * custom text + * custom text. * @return remark **/ @javax.annotation.Nullable @@ -102,7 +102,7 @@ public SubAccount password(String password) { } /** - * The sub-account's password. (Default: the same as main account's password) + * The sub-account's password. (Default: the same as main account's password). * @return password **/ @javax.annotation.Nullable @@ -136,7 +136,7 @@ public void setEmail(String email) { } /** - * State: 1-normal, 2-locked\" + * State: 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 - sub-account, 3 - cross margin account. * @return type **/ @javax.annotation.Nullable @@ -156,7 +156,7 @@ public Integer getType() { /** - * The user id of the sub-account + * The user id of the sub-account. * @return userId **/ @javax.annotation.Nullable @@ -166,7 +166,7 @@ public Long getUserId() { /** - * Created time + * Created time. * @return createTime **/ @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 772ef07..5815ad6 100644 --- a/src/main/java/io/gate/gateapi/models/SubAccountBalance.java +++ b/src/main/java/io/gate/gateapi/models/SubAccountBalance.java @@ -42,7 +42,7 @@ public SubAccountBalance uid(String uid) { } /** - * User ID + * User ID. * @return uid **/ @javax.annotation.Nullable @@ -70,7 +70,7 @@ public SubAccountBalance putAvailableItem(String key, String availableItem) { } /** - * Available balances of currencies + * Available balances of currencies. * @return available **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SubAccountCrossMarginBalance.java b/src/main/java/io/gate/gateapi/models/SubAccountCrossMarginBalance.java index bf2e802..7dea4d6 100644 --- a/src/main/java/io/gate/gateapi/models/SubAccountCrossMarginBalance.java +++ b/src/main/java/io/gate/gateapi/models/SubAccountCrossMarginBalance.java @@ -40,7 +40,7 @@ public SubAccountCrossMarginBalance uid(String uid) { } /** - * User ID + * User ID. * @return uid **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SubAccountFuturesBalance.java b/src/main/java/io/gate/gateapi/models/SubAccountFuturesBalance.java index 5734972..828a918 100644 --- a/src/main/java/io/gate/gateapi/models/SubAccountFuturesBalance.java +++ b/src/main/java/io/gate/gateapi/models/SubAccountFuturesBalance.java @@ -43,7 +43,7 @@ public SubAccountFuturesBalance uid(String uid) { } /** - * User ID + * User ID. * @return uid **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public SubAccountFuturesBalance putAvailableItem(String key, FuturesAccount avai } /** - * Futures account balances + * Futures account balances. * @return available **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SubAccountKey.java b/src/main/java/io/gate/gateapi/models/SubAccountKey.java index 06c494c..f95e5bd 100644 --- a/src/main/java/io/gate/gateapi/models/SubAccountKey.java +++ b/src/main/java/io/gate/gateapi/models/SubAccountKey.java @@ -68,7 +68,7 @@ public class SubAccountKey { /** - * User ID + * User ID. * @return userId **/ @javax.annotation.Nullable @@ -84,7 +84,7 @@ public SubAccountKey mode(Integer mode) { } /** - * Mode: 1 - classic 2 - portfolio account + * Mode: 1 - classic 2 - portfolio account. * @return mode **/ @javax.annotation.Nullable @@ -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 white list (list will be removed if no value is passed). * @return ipWhitelist **/ @javax.annotation.Nullable @@ -174,7 +174,7 @@ public void setIpWhitelist(List ipWhitelist) { } /** - * API Key + * API Key. * @return key **/ @javax.annotation.Nullable @@ -184,7 +184,7 @@ public String getKey() { /** - * State 1 - normal 2 - locked 3 - frozen + * State 1 - normal 2 - locked 3 - frozen. * @return state **/ @javax.annotation.Nullable @@ -194,7 +194,7 @@ public Integer getState() { /** - * Creation time + * Creation 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 f223648..0515e84 100644 --- a/src/main/java/io/gate/gateapi/models/SubAccountKeyPerms.java +++ b/src/main/java/io/gate/gateapi/models/SubAccountKeyPerms.java @@ -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 d524570..d2b0318 100644 --- a/src/main/java/io/gate/gateapi/models/SubAccountMarginBalance.java +++ b/src/main/java/io/gate/gateapi/models/SubAccountMarginBalance.java @@ -42,7 +42,7 @@ public SubAccountMarginBalance uid(String uid) { } /** - * User ID + * User ID. * @return uid **/ @javax.annotation.Nullable @@ -70,7 +70,7 @@ public SubAccountMarginBalance addAvailableItem(MarginAccount availableItem) { } /** - * Margin account balances + * Margin account balances. * @return available **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SubAccountToSubAccount.java b/src/main/java/io/gate/gateapi/models/SubAccountToSubAccount.java index c95e985..81692e6 100644 --- a/src/main/java/io/gate/gateapi/models/SubAccountToSubAccount.java +++ b/src/main/java/io/gate/gateapi/models/SubAccountToSubAccount.java @@ -59,7 +59,7 @@ public SubAccountToSubAccount currency(String currency) { } /** - * Transfer currency name + * Transfer currency name. * @return currency **/ public String getCurrency() { @@ -98,7 +98,7 @@ public SubAccountToSubAccount subAccountFrom(String subAccountFrom) { } /** - * Transfer from the user id of the sub-account + * Transfer from the user id of the sub-account. * @return subAccountFrom **/ public String getSubAccountFrom() { @@ -136,7 +136,7 @@ public SubAccountToSubAccount subAccountTo(String subAccountTo) { } /** - * Transfer to the user id of the sub-account + * Transfer to the user id of the sub-account. * @return subAccountTo **/ public String getSubAccountTo() { @@ -174,7 +174,7 @@ public SubAccountToSubAccount amount(String amount) { } /** - * Transfer amount + * Transfer amount. * @return amount **/ public String getAmount() { diff --git a/src/main/java/io/gate/gateapi/models/SubAccountTransfer.java b/src/main/java/io/gate/gateapi/models/SubAccountTransfer.java index a2b3a66..cabf82c 100644 --- a/src/main/java/io/gate/gateapi/models/SubAccountTransfer.java +++ b/src/main/java/io/gate/gateapi/models/SubAccountTransfer.java @@ -55,7 +55,7 @@ public SubAccountTransfer subAccount(String subAccount) { } /** - * Sub account user ID + * Sub account user ID. * @return subAccount **/ public String getSubAccount() { @@ -94,7 +94,7 @@ public SubAccountTransfer currency(String currency) { } /** - * Transfer currency name + * Transfer currency name. * @return currency **/ public String getCurrency() { @@ -113,7 +113,7 @@ public SubAccountTransfer amount(String amount) { } /** - * Transfer amount + * Transfer amount. * @return amount **/ public String getAmount() { diff --git a/src/main/java/io/gate/gateapi/models/SubAccountTransferRecordItem.java b/src/main/java/io/gate/gateapi/models/SubAccountTransferRecordItem.java index c5f3cd5..d9ca1ba 100644 --- a/src/main/java/io/gate/gateapi/models/SubAccountTransferRecordItem.java +++ b/src/main/java/io/gate/gateapi/models/SubAccountTransferRecordItem.java @@ -65,7 +65,7 @@ public class SubAccountTransferRecordItem { /** - * Transfer timestamp + * Transfer timestamp. * @return timest **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public String getTimest() { /** - * Main account user ID + * Main account user ID. * @return uid **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public SubAccountTransferRecordItem subAccount(String subAccount) { } /** - * Sub account user ID + * Sub account user ID. * @return subAccount **/ public String getSubAccount() { @@ -130,7 +130,7 @@ public SubAccountTransferRecordItem currency(String currency) { } /** - * Transfer currency name + * Transfer currency name. * @return currency **/ public String getCurrency() { @@ -149,7 +149,7 @@ public SubAccountTransferRecordItem amount(String amount) { } /** - * Transfer amount + * Transfer amount. * @return amount **/ public String getAmount() { @@ -181,7 +181,7 @@ public void setDirection(String direction) { } /** - * Where the operation is initiated from + * Where the operation is initiated from. * @return source **/ @javax.annotation.Nullable @@ -217,7 +217,7 @@ public SubAccountTransferRecordItem status(String status) { } /** - * Sub-account transfer record status, currently only success + * Sub-account transfer record status, currently only success. * @return status **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SubCrossMarginAccount.java b/src/main/java/io/gate/gateapi/models/SubCrossMarginAccount.java index 0d1fae3..7ef52c3 100644 --- a/src/main/java/io/gate/gateapi/models/SubCrossMarginAccount.java +++ b/src/main/java/io/gate/gateapi/models/SubCrossMarginAccount.java @@ -119,7 +119,7 @@ public SubCrossMarginAccount locked(Boolean locked) { } /** - * Whether account is locked + * Whether account is locked. * @return locked **/ @javax.annotation.Nullable @@ -207,7 +207,7 @@ public SubCrossMarginAccount borrowedNet(String borrowedNet) { } /** - * Total borrowed value in USDT * borrowed factor + * Total borrowed value in USDT * borrowed factor. * @return borrowedNet **/ @javax.annotation.Nullable @@ -227,7 +227,7 @@ public SubCrossMarginAccount net(String net) { } /** - * Total net assets in USDT + * Total net assets in USDT. * @return net **/ @javax.annotation.Nullable @@ -247,7 +247,7 @@ public SubCrossMarginAccount leverage(String leverage) { } /** - * Position leverage + * Position leverage. * @return leverage **/ @javax.annotation.Nullable @@ -307,7 +307,7 @@ public SubCrossMarginAccount totalInitialMargin(String totalInitialMargin) { } /** - * Total initial margin + * Total initial margin. * @return totalInitialMargin **/ @javax.annotation.Nullable @@ -327,7 +327,7 @@ public SubCrossMarginAccount totalMarginBalance(String totalMarginBalance) { } /** - * Total margin balance + * Total margin balance. * @return totalMarginBalance **/ @javax.annotation.Nullable @@ -347,7 +347,7 @@ public SubCrossMarginAccount totalMaintenanceMargin(String totalMaintenanceMargi } /** - * Total maintenance margin + * Total maintenance margin. * @return totalMaintenanceMargin **/ @javax.annotation.Nullable @@ -367,7 +367,7 @@ public SubCrossMarginAccount totalInitialMarginRate(String totalInitialMarginRat } /** - * Total initial margin rate + * Total initial margin rate. * @return totalInitialMarginRate **/ @javax.annotation.Nullable @@ -387,7 +387,7 @@ public SubCrossMarginAccount totalMaintenanceMarginRate(String totalMaintenanceM } /** - * Total maintenance margin rate + * Total maintenance margin rate. * @return totalMaintenanceMarginRate **/ @javax.annotation.Nullable @@ -407,7 +407,7 @@ public SubCrossMarginAccount totalAvailableMargin(String totalAvailableMargin) { } /** - * Total available margin + * Total available margin. * @return totalAvailableMargin **/ @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 e061467..0ee26b3 100644 --- a/src/main/java/io/gate/gateapi/models/SubUserMode.java +++ b/src/main/java/io/gate/gateapi/models/SubUserMode.java @@ -43,7 +43,7 @@ public SubUserMode userId(Long userId) { } /** - * User ID + * User ID. * @return userId **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public SubUserMode isUnified(Boolean isUnified) { } /** - * Is it a unified account? + * Is it a unified account?. * @return isUnified **/ @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 index 4cfa8c2..a598058 100644 --- a/src/main/java/io/gate/gateapi/models/SwapCoin.java +++ b/src/main/java/io/gate/gateapi/models/SwapCoin.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Blockchain Mining + * Blockchain Mining. */ public class SwapCoin { public static final String SERIALIZED_NAME_COIN = "coin"; @@ -47,7 +47,7 @@ public SwapCoin coin(String coin) { } /** - * Currency + * Currency. * @return coin **/ public String getCoin() { @@ -66,7 +66,7 @@ public SwapCoin side(String side) { } /** - * 0 - Stake 1 - Redeem + * 0 - Stake 1 - Redeem. * @return side **/ public String getSide() { @@ -85,7 +85,7 @@ public SwapCoin amount(String amount) { } /** - * Size + * Size. * @return amount **/ public String getAmount() { @@ -104,7 +104,7 @@ public SwapCoin pid(Integer pid) { } /** - * DeFi-type Mining Protocol Identifier + * DeFi-type Mining Protocol Identifier. * @return pid **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SwapCoinStruct.java b/src/main/java/io/gate/gateapi/models/SwapCoinStruct.java index 7846671..0eaa806 100644 --- a/src/main/java/io/gate/gateapi/models/SwapCoinStruct.java +++ b/src/main/java/io/gate/gateapi/models/SwapCoinStruct.java @@ -27,6 +27,10 @@ public class SwapCoinStruct { @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; @@ -39,6 +43,10 @@ public class SwapCoinStruct { @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; @@ -47,18 +55,34 @@ public class SwapCoinStruct { @SerializedName(SERIALIZED_NAME_EXCHANGE_RATE) private String exchangeRate; - public static final String SERIALIZED_NAME_PID = "pid"; - @SerializedName(SERIALIZED_NAME_PID) - private Integer pid; + public static final String SERIALIZED_NAME_EXCHANGE_AMOUNT = "exchange_amount"; + @SerializedName(SERIALIZED_NAME_EXCHANGE_AMOUNT) + private String exchangeAmount; - public static final String SERIALIZED_NAME_STATUS = "status"; - @SerializedName(SERIALIZED_NAME_STATUS) - private Integer status; + 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) { @@ -67,7 +91,7 @@ public SwapCoinStruct id(Integer id) { } /** - * Order ID + * Order ID. * @return id **/ @javax.annotation.Nullable @@ -80,6 +104,26 @@ public void setId(Integer id) { this.id = id; } + public SwapCoinStruct pid(Integer pid) { + + this.pid = pid; + return this; + } + + /** + * Plan 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; @@ -87,7 +131,7 @@ public SwapCoinStruct uid(Integer uid) { } /** - * User ID + * User ID. * @return uid **/ @javax.annotation.Nullable @@ -107,7 +151,7 @@ public SwapCoinStruct coin(String coin) { } /** - * Currency + * Currency. * @return coin **/ @javax.annotation.Nullable @@ -127,7 +171,7 @@ public SwapCoinStruct type(Integer type) { } /** - * Type: 0-Lock, 1-Certificate + * 类型 0-质押 1-赎回 * @return type **/ @javax.annotation.Nullable @@ -140,6 +184,26 @@ public void setType(Integer type) { this.type = type; } + public SwapCoinStruct subtype(String subtype) { + + this.subtype = subtype; + return this; + } + + /** + * 子类型 + * @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; @@ -147,7 +211,7 @@ public SwapCoinStruct amount(String amount) { } /** - * Amount + * Amount. * @return amount **/ @javax.annotation.Nullable @@ -167,7 +231,7 @@ public SwapCoinStruct exchangeRate(String exchangeRate) { } /** - * Exchange Ratio + * Exchange Ratio. * @return exchangeRate **/ @javax.annotation.Nullable @@ -180,44 +244,44 @@ public void setExchangeRate(String exchangeRate) { this.exchangeRate = exchangeRate; } - public SwapCoinStruct pid(Integer pid) { + public SwapCoinStruct exchangeAmount(String exchangeAmount) { - this.pid = pid; + this.exchangeAmount = exchangeAmount; return this; } /** - * Plan ID - * @return pid + * 兑换金额 + * @return exchangeAmount **/ @javax.annotation.Nullable - public Integer getPid() { - return pid; + public String getExchangeAmount() { + return exchangeAmount; } - public void setPid(Integer pid) { - this.pid = pid; + public void setExchangeAmount(String exchangeAmount) { + this.exchangeAmount = exchangeAmount; } - public SwapCoinStruct status(Integer status) { + public SwapCoinStruct updateStamp(Integer updateStamp) { - this.status = status; + this.updateStamp = updateStamp; return this; } /** - * status 1-success - * @return status + * 更新时间戳 + * @return updateStamp **/ @javax.annotation.Nullable - public Integer getStatus() { - return status; + public Integer getUpdateStamp() { + return updateStamp; } - public void setStatus(Integer status) { - this.status = status; + public void setUpdateStamp(Integer updateStamp) { + this.updateStamp = updateStamp; } public SwapCoinStruct createStamp(Integer createStamp) { @@ -227,7 +291,7 @@ public SwapCoinStruct createStamp(Integer createStamp) { } /** - * Transaction timestamp + * Transaction timestamp. * @return createStamp **/ @javax.annotation.Nullable @@ -239,6 +303,86 @@ public Integer getCreateStamp() { 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协议类型 + * @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; + } + + /** + * 参考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 source. + * @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) { @@ -249,19 +393,25 @@ public boolean equals(java.lang.Object o) { } 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.pid, swapCoinStruct.pid) && + 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.createStamp, swapCoinStruct.createStamp); + 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, uid, coin, type, amount, exchangeRate, pid, status, createStamp); + return Objects.hash(id, pid, uid, coin, type, subtype, amount, exchangeRate, exchangeAmount, updateStamp, createStamp, status, protocolType, clientOrderId, source); } @@ -270,14 +420,20 @@ 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(" pid: ").append(toIndentedString(pid)).append("\n"); - sb.append(" status: ").append(toIndentedString(status)).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(); } diff --git a/src/main/java/io/gate/gateapi/models/SystemTime.java b/src/main/java/io/gate/gateapi/models/SystemTime.java index 5f8207e..0a69c9c 100644 --- a/src/main/java/io/gate/gateapi/models/SystemTime.java +++ b/src/main/java/io/gate/gateapi/models/SystemTime.java @@ -35,7 +35,7 @@ public SystemTime serverTime(Long serverTime) { } /** - * Server current time(ms) + * Server current time(ms). * @return serverTime **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/Ticker.java b/src/main/java/io/gate/gateapi/models/Ticker.java index a8165c3..a553185 100644 --- a/src/main/java/io/gate/gateapi/models/Ticker.java +++ b/src/main/java/io/gate/gateapi/models/Ticker.java @@ -99,7 +99,7 @@ public Ticker currencyPair(String currencyPair) { } /** - * Currency pair + * Currency pair. * @return currencyPair **/ @javax.annotation.Nullable @@ -119,7 +119,7 @@ public Ticker last(String last) { } /** - * Last trading price + * Last trading price. * @return last **/ @javax.annotation.Nullable @@ -139,7 +139,7 @@ public Ticker lowestAsk(String lowestAsk) { } /** - * Recent lowest ask + * Recent lowest ask. * @return lowestAsk **/ @javax.annotation.Nullable @@ -179,7 +179,7 @@ public Ticker highestBid(String highestBid) { } /** - * Recent highest bid + * Recent highest bid. * @return highestBid **/ @javax.annotation.Nullable @@ -219,7 +219,7 @@ public Ticker changePercentage(String changePercentage) { } /** - * Change percentage in the last 24h + * Change percentage in the last 24h. * @return changePercentage **/ @javax.annotation.Nullable @@ -239,7 +239,7 @@ public Ticker changeUtc0(String changeUtc0) { } /** - * utc0 timezone, the percentage change in the last 24 hours + * utc0 timezone, the percentage change in the last 24 hours. * @return changeUtc0 **/ @javax.annotation.Nullable @@ -259,7 +259,7 @@ public Ticker changeUtc8(String changeUtc8) { } /** - * utc8 timezone, the percentage change in the last 24 hours + * utc8 timezone, the percentage change in the last 24 hours. * @return changeUtc8 **/ @javax.annotation.Nullable @@ -279,7 +279,7 @@ public Ticker baseVolume(String baseVolume) { } /** - * Base currency trade volume in the last 24h + * Base currency trade 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 trade volume in the last 24h. * @return quoteVolume **/ @javax.annotation.Nullable @@ -319,7 +319,7 @@ public Ticker high24h(String high24h) { } /** - * Highest price in 24h + * Highest price in 24h. * @return high24h **/ @javax.annotation.Nullable @@ -339,7 +339,7 @@ public Ticker low24h(String low24h) { } /** - * Lowest price in 24h + * Lowest price in 24h. * @return low24h **/ @javax.annotation.Nullable @@ -359,7 +359,7 @@ public Ticker etfNetValue(String etfNetValue) { } /** - * ETF net value + * ETF net value. * @return etfNetValue **/ @javax.annotation.Nullable @@ -379,7 +379,7 @@ public Ticker etfPreNetValue(String etfPreNetValue) { } /** - * ETF previous net value at re-balancing time + * ETF previous net value at re-balancing time. * @return etfPreNetValue **/ @javax.annotation.Nullable @@ -399,7 +399,7 @@ public Ticker etfPreTimestamp(Long etfPreTimestamp) { } /** - * ETF previous re-balancing time + * ETF previous re-balancing time. * @return etfPreTimestamp **/ @javax.annotation.Nullable @@ -419,7 +419,7 @@ public Ticker etfLeverage(String etfLeverage) { } /** - * ETF current leverage + * ETF current leverage. * @return etfLeverage **/ @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 cd59862..ef60cc9 100644 --- a/src/main/java/io/gate/gateapi/models/TotalBalance.java +++ b/src/main/java/io/gate/gateapi/models/TotalBalance.java @@ -24,7 +24,7 @@ import java.util.Map; /** - * User's balance in all accounts + * User's balance in all accounts. */ public class TotalBalance { public static final String SERIALIZED_NAME_TOTAL = "total"; diff --git a/src/main/java/io/gate/gateapi/models/Trade.java b/src/main/java/io/gate/gateapi/models/Trade.java index 569b919..191493c 100644 --- a/src/main/java/io/gate/gateapi/models/Trade.java +++ b/src/main/java/io/gate/gateapi/models/Trade.java @@ -40,7 +40,7 @@ public class Trade { private String currencyPair; /** - * Buy or sell order + * 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. No value in public endpoints. */ @JsonAdapter(RoleEnum.Adapter.class) public enum RoleEnum { @@ -189,7 +189,7 @@ public Trade id(String id) { } /** - * Trade ID + * Trade ID. * @return id **/ @javax.annotation.Nullable @@ -209,7 +209,7 @@ public Trade createTime(String createTime) { } /** - * Trading time + * Trading time. * @return createTime **/ @javax.annotation.Nullable @@ -229,7 +229,7 @@ public Trade createTimeMs(String createTimeMs) { } /** - * Trading time, with millisecond precision + * Trading time, with millisecond precision. * @return createTimeMs **/ @javax.annotation.Nullable @@ -249,7 +249,7 @@ public Trade currencyPair(String currencyPair) { } /** - * Currency pair + * Currency pair. * @return currencyPair **/ @javax.annotation.Nullable @@ -269,7 +269,7 @@ public Trade side(SideEnum side) { } /** - * Buy or sell order + * 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. No value in public endpoints. * @return role **/ @javax.annotation.Nullable @@ -309,7 +309,7 @@ public Trade amount(String amount) { } /** - * Trade amount + * Trade amount. * @return amount **/ @javax.annotation.Nullable @@ -329,7 +329,7 @@ public Trade price(String price) { } /** - * Order price + * Order price. * @return price **/ @javax.annotation.Nullable @@ -349,7 +349,7 @@ public Trade orderId(String orderId) { } /** - * Related order ID. No value in public endpoints + * Related order ID. No value 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. No value 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. No value 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. No value 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. No value in public endpoints. * @return gtFee **/ @javax.annotation.Nullable @@ -449,7 +449,7 @@ public Trade amendText(String amendText) { } /** - * The custom data that the user remarked when amending the order + * The custom data that the user remarked when amending the order. * @return amendText **/ @javax.annotation.Nullable @@ -489,7 +489,7 @@ public Trade text(String text) { } /** - * User defined information. No value in public endpoints + * User defined information. No value 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 a1e8fa4..987234e 100644 --- a/src/main/java/io/gate/gateapi/models/TradeFee.java +++ b/src/main/java/io/gate/gateapi/models/TradeFee.java @@ -83,7 +83,7 @@ public TradeFee userId(Long userId) { } /** - * User ID + * User ID. * @return userId **/ @javax.annotation.Nullable @@ -103,7 +103,7 @@ public TradeFee takerFee(String takerFee) { } /** - * taker fee rate + * taker fee rate. * @return takerFee **/ @javax.annotation.Nullable @@ -123,7 +123,7 @@ public TradeFee makerFee(String makerFee) { } /** - * maker fee rate + * maker fee rate. * @return makerFee **/ @javax.annotation.Nullable @@ -143,7 +143,7 @@ public TradeFee gtDiscount(Boolean gtDiscount) { } /** - * If GT deduction is enabled + * If GT deduction is enabled. * @return gtDiscount **/ @javax.annotation.Nullable @@ -203,7 +203,7 @@ public TradeFee loanFee(String loanFee) { } /** - * Loan fee rate of margin lending + * Loan fee rate of margin lending. * @return loanFee **/ @javax.annotation.Nullable @@ -223,7 +223,7 @@ public TradeFee pointType(String pointType) { } /** - * Point type. 0 - Initial version. 1 - new version since 202009 + * Point type. 0 - Initial version. 1 - new version since 202009. * @return pointType **/ @javax.annotation.Nullable @@ -243,7 +243,7 @@ public TradeFee futuresTakerFee(String futuresTakerFee) { } /** - * Futures trading taker fee + * Futures trading taker fee. * @return futuresTakerFee **/ @javax.annotation.Nullable @@ -263,7 +263,7 @@ public TradeFee futuresMakerFee(String futuresMakerFee) { } /** - * Future trading maker fee + * Future trading maker fee. * @return futuresMakerFee **/ @javax.annotation.Nullable @@ -283,7 +283,7 @@ public TradeFee deliveryTakerFee(String deliveryTakerFee) { } /** - * Delivery trading taker fee + * Delivery trading taker fee. * @return deliveryTakerFee **/ @javax.annotation.Nullable @@ -303,7 +303,7 @@ public TradeFee deliveryMakerFee(String deliveryMakerFee) { } /** - * Delivery trading maker fee + * Delivery trading maker fee. * @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 5ad4564..db9c877 100644 --- a/src/main/java/io/gate/gateapi/models/TransactionID.java +++ b/src/main/java/io/gate/gateapi/models/TransactionID.java @@ -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 9582794..07e0ddc 100644 --- a/src/main/java/io/gate/gateapi/models/Transfer.java +++ b/src/main/java/io/gate/gateapi/models/Transfer.java @@ -28,7 +28,7 @@ public class Transfer { private String currency; /** - * Account to transfer from + * Account to transfer from. */ @JsonAdapter(FromEnum.Adapter.class) public enum FromEnum { @@ -85,7 +85,7 @@ public FromEnum read(final JsonReader jsonReader) throws IOException { private FromEnum from; /** - * Account to transfer to + * Account to transfer to. */ @JsonAdapter(ToEnum.Adapter.class) public enum ToEnum { @@ -180,7 +180,7 @@ public Transfer from(FromEnum from) { } /** - * Account to transfer from + * Account to transfer from. * @return from **/ public FromEnum getFrom() { @@ -199,7 +199,7 @@ public Transfer to(ToEnum to) { } /** - * Account to transfer to + * Account to transfer to. * @return to **/ public ToEnum getTo() { @@ -218,7 +218,7 @@ public Transfer amount(String amount) { } /** - * Transfer amount + * Transfer amount. * @return amount **/ public String getAmount() { @@ -237,7 +237,7 @@ public Transfer currencyPair(String currencyPair) { } /** - * Margin currency pair. Required if transfer from or to margin account + * Margin currency pair. Required if transfer from or to margin account. * @return currencyPair **/ @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 9d9680d..6efc026 100644 --- a/src/main/java/io/gate/gateapi/models/TransferOrderStatus.java +++ b/src/main/java/io/gate/gateapi/models/TransferOrderStatus.java @@ -39,7 +39,7 @@ public TransferOrderStatus txId(String txId) { } /** - * Order id + * Order id. * @return txId **/ @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 84f7207..b75eebe 100644 --- a/src/main/java/io/gate/gateapi/models/TransferablesResult.java +++ b/src/main/java/io/gate/gateapi/models/TransferablesResult.java @@ -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 can be transferred up to a maximum of results. */ public class TransferablesResult { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -39,7 +39,7 @@ public TransferablesResult currency(String currency) { } /** - * Currency detail + * Currency detail. * @return currency **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public TransferablesResult amount(String amount) { } /** - * The maximum amount that can be transferred out + * The maximum amount that can be transferred out. * @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 a0934e0..cd2ec24 100644 --- a/src/main/java/io/gate/gateapi/models/TriggerOrderResponse.java +++ b/src/main/java/io/gate/gateapi/models/TriggerOrderResponse.java @@ -35,7 +35,7 @@ public TriggerOrderResponse id(Long id) { } /** - * Auto order ID + * Auto order ID. * @return id **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/TriggerTime.java b/src/main/java/io/gate/gateapi/models/TriggerTime.java index b625684..e8d7db0 100644 --- a/src/main/java/io/gate/gateapi/models/TriggerTime.java +++ b/src/main/java/io/gate/gateapi/models/TriggerTime.java @@ -35,7 +35,7 @@ public TriggerTime triggerTime(Long triggerTime) { } /** - * Timestamp of the end of the countdown, in milliseconds + * Timestamp of the end of the countdown, 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 058a437..1bbec95 100644 --- a/src/main/java/io/gate/gateapi/models/UidPushOrder.java +++ b/src/main/java/io/gate/gateapi/models/UidPushOrder.java @@ -67,7 +67,7 @@ public UidPushOrder id(Long id) { } /** - * Order ID + * Order ID. * @return id **/ @javax.annotation.Nullable @@ -87,7 +87,7 @@ public UidPushOrder pushUid(Long pushUid) { } /** - * Initiator User ID + * Initiator User ID. * @return pushUid **/ @javax.annotation.Nullable @@ -107,7 +107,7 @@ public UidPushOrder receiveUid(Long receiveUid) { } /** - * Recipient User ID + * Recipient User ID. * @return receiveUid **/ @javax.annotation.Nullable @@ -127,7 +127,7 @@ public UidPushOrder currency(String currency) { } /** - * Currency name + * Currency name. * @return currency **/ @javax.annotation.Nullable @@ -147,7 +147,7 @@ public UidPushOrder amount(String amount) { } /** - * Transfer amount + * Transfer amount. * @return amount **/ @javax.annotation.Nullable @@ -167,7 +167,7 @@ public UidPushOrder createTime(Long createTime) { } /** - * Creation time + * Creation time. * @return createTime **/ @javax.annotation.Nullable @@ -207,7 +207,7 @@ public UidPushOrder message(String message) { } /** - * PENDING Reason Tips + * PENDING Reason Tips. * @return message **/ @javax.annotation.Nullable @@ -227,7 +227,7 @@ public UidPushOrder transactionType(String transactionType) { } /** - * Order Type + * Order Type. * @return transactionType **/ @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 b1544ab..e7ef645 100644 --- a/src/main/java/io/gate/gateapi/models/UidPushWithdrawal.java +++ b/src/main/java/io/gate/gateapi/models/UidPushWithdrawal.java @@ -43,7 +43,7 @@ public UidPushWithdrawal receiveUid(Long receiveUid) { } /** - * Recipient UID + * Recipient UID. * @return receiveUid **/ public Long getReceiveUid() { @@ -62,7 +62,7 @@ public UidPushWithdrawal currency(String currency) { } /** - * Currency name + * Currency name. * @return currency **/ public String getCurrency() { @@ -81,7 +81,7 @@ public UidPushWithdrawal amount(String amount) { } /** - * Transfer amount + * Transfer amount. * @return amount **/ public String getAmount() { diff --git a/src/main/java/io/gate/gateapi/models/UidPushWithdrawalResp.java b/src/main/java/io/gate/gateapi/models/UidPushWithdrawalResp.java index 6e94cde..920aea1 100644 --- a/src/main/java/io/gate/gateapi/models/UidPushWithdrawalResp.java +++ b/src/main/java/io/gate/gateapi/models/UidPushWithdrawalResp.java @@ -35,7 +35,7 @@ public UidPushWithdrawalResp id(Long id) { } /** - * Order ID + * Order ID. * @return id **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UniCurrency.java b/src/main/java/io/gate/gateapi/models/UniCurrency.java index 15aa39f..e95deaa 100644 --- a/src/main/java/io/gate/gateapi/models/UniCurrency.java +++ b/src/main/java/io/gate/gateapi/models/UniCurrency.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Currency detail + * Currency detail. */ public class UniCurrency { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -45,7 +45,7 @@ public class UniCurrency { /** - * Currency name + * Currency name. * @return currency **/ @javax.annotation.Nullable @@ -65,7 +65,7 @@ public String getMinLendAmount() { /** - * The total maximum lending amount, in USDT + * The total maximum lending amount, in USDT. * @return maxLendAmount **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public String getMaxLendAmount() { /** - * Maximum rate (Hourly) + * Maximum rate (Hourly). * @return maxRate **/ @javax.annotation.Nullable @@ -85,7 +85,7 @@ public String getMaxRate() { /** - * Minimum rate (Hourly) + * Minimum rate (Hourly). * @return minRate **/ @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 ef03eca..c086800 100644 --- a/src/main/java/io/gate/gateapi/models/UniCurrencyInterest.java +++ b/src/main/java/io/gate/gateapi/models/UniCurrencyInterest.java @@ -33,7 +33,7 @@ public class UniCurrencyInterest { /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -43,7 +43,7 @@ public String getCurrency() { /** - * Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment 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 bf3dd9b..d4a37c7 100644 --- a/src/main/java/io/gate/gateapi/models/UniCurrencyPair.java +++ b/src/main/java/io/gate/gateapi/models/UniCurrencyPair.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Currency pair of the loan + * Currency pair of the loan. */ public class UniCurrencyPair { public static final String SERIALIZED_NAME_CURRENCY_PAIR = "currency_pair"; @@ -41,7 +41,7 @@ public class UniCurrencyPair { /** - * Currency pair + * Currency pair. * @return currencyPair **/ @javax.annotation.Nullable @@ -51,7 +51,7 @@ public String getCurrencyPair() { /** - * Minimum borrow amount of base currency + * Minimum borrow amount of base currency. * @return baseMinBorrowAmount **/ @javax.annotation.Nullable @@ -61,7 +61,7 @@ public String getBaseMinBorrowAmount() { /** - * Minimum borrow amount of quote currency + * Minimum borrow amount of quote currency. * @return quoteMinBorrowAmount **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public String getQuoteMinBorrowAmount() { /** - * Position leverage + * Position leverage. * @return leverage **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UniInterestRecord.java b/src/main/java/io/gate/gateapi/models/UniInterestRecord.java index d064144..dda7b28 100644 --- a/src/main/java/io/gate/gateapi/models/UniInterestRecord.java +++ b/src/main/java/io/gate/gateapi/models/UniInterestRecord.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Interest Record + * Interest Record. */ public class UniInterestRecord { public static final String SERIALIZED_NAME_STATUS = "status"; @@ -49,7 +49,7 @@ public class UniInterestRecord { /** - * Status: 0 - fail, 1 - success + * Status: 0 - fail, 1 - success. * @return status **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public Integer getStatus() { /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -69,7 +69,7 @@ public String getCurrency() { /** - * Actual Rate + * Actual Rate. * @return actualRate **/ @javax.annotation.Nullable @@ -79,7 +79,7 @@ public String getActualRate() { /** - * Interest + * Interest. * @return interest **/ @javax.annotation.Nullable @@ -89,7 +89,7 @@ public String getInterest() { /** - * Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment Interest reinvestment + * Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment * @return interestStatus **/ @javax.annotation.Nullable @@ -99,7 +99,7 @@ public String getInterestStatus() { /** - * Created time + * Created time. * @return createTime **/ @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 48fb708..36b25ae 100644 --- a/src/main/java/io/gate/gateapi/models/UniLend.java +++ b/src/main/java/io/gate/gateapi/models/UniLend.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Loan record + * Loan record. */ public class UniLend { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -65,7 +65,7 @@ public class UniLend { /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public String getCurrency() { /** - * Current amount + * Current amount. * @return currentAmount **/ @javax.annotation.Nullable @@ -85,7 +85,7 @@ public String getCurrentAmount() { /** - * Total amount + * Total 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 + * Frozen amount. * @return frozenAmount **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public String getFrozenAmount() { /** - * Minimum interest rate + * Minimum interest rate. * @return minRate **/ @javax.annotation.Nullable @@ -125,7 +125,7 @@ public String getMinRate() { /** - * Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment 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 + * Amount not reinvested. * @return reinvestLeftAmount **/ @javax.annotation.Nullable @@ -145,7 +145,7 @@ public String getReinvestLeftAmount() { /** - * Created time of the lending order + * Created time of the lending order. * @return createTime **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public Long getCreateTime() { /** - * Upated time of the lending order + * Upated time of the lending order. * @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 e9fdcdf..eb5bd4a 100644 --- a/src/main/java/io/gate/gateapi/models/UniLendInterest.java +++ b/src/main/java/io/gate/gateapi/models/UniLendInterest.java @@ -33,7 +33,7 @@ public class UniLendInterest { /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -43,7 +43,7 @@ public String getCurrency() { /** - * Interest + * Interest. * @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 d82035f..9dcf431 100644 --- a/src/main/java/io/gate/gateapi/models/UniLendRecord.java +++ b/src/main/java/io/gate/gateapi/models/UniLendRecord.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Interest Record + * Interest Record. */ public class UniLendRecord { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -53,7 +53,7 @@ public class UniLendRecord { /** - * Currency name + * Currency name. * @return currency **/ @javax.annotation.Nullable @@ -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 + * Last wallet amount. * @return lastWalletAmount **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public String getLastWalletAmount() { /** - * Last lent amount + * Last lent amount. * @return lastLentAmount **/ @javax.annotation.Nullable @@ -93,7 +93,7 @@ public String getLastLentAmount() { /** - * Last frozen amount + * Last 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 @@ -113,7 +113,7 @@ public String getType() { /** - * Created time + * Created time. * @return createTime **/ @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 6890f3b..8b36e17 100644 --- a/src/main/java/io/gate/gateapi/models/UniLoan.java +++ b/src/main/java/io/gate/gateapi/models/UniLoan.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Loan + * Loan. */ public class UniLoan { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -49,7 +49,7 @@ public class UniLoan { /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public String getCurrency() { /** - * Currency pair + * Currency pair. * @return currencyPair **/ @javax.annotation.Nullable @@ -69,7 +69,7 @@ public String getCurrencyPair() { /** - * amount + * amount. * @return amount **/ @javax.annotation.Nullable @@ -79,7 +79,7 @@ public String getAmount() { /** - * Loan type, platform - platform, margin - margin + * Loan type, platform - platform, margin - margin. * @return type **/ @javax.annotation.Nullable @@ -89,7 +89,7 @@ public String getType() { /** - * Created time + * Created time. * @return createTime **/ @javax.annotation.Nullable @@ -99,7 +99,7 @@ public Long getCreateTime() { /** - * Updated time + * Updated 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 e3c7e33..7191b13 100644 --- a/src/main/java/io/gate/gateapi/models/UniLoanInterestRecord.java +++ b/src/main/java/io/gate/gateapi/models/UniLoanInterestRecord.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Interest record + * Interest record. */ public class UniLoanInterestRecord { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -53,7 +53,7 @@ public class UniLoanInterestRecord { /** - * Currency name + * Currency name. * @return currency **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public String getCurrency() { /** - * Currency pair + * Currency pair. * @return currencyPair **/ @javax.annotation.Nullable @@ -73,7 +73,7 @@ public String getCurrencyPair() { /** - * Actual rate + * Actual rate. * @return actualRate **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public String getActualRate() { /** - * Interest + * Interest. * @return interest **/ @javax.annotation.Nullable @@ -93,7 +93,7 @@ public String getInterest() { /** - * Status: 0 - fail, 1 - success + * Status: 0 - fail, 1 - success. * @return status **/ @javax.annotation.Nullable @@ -103,7 +103,7 @@ public Integer getStatus() { /** - * Type, platform - platform，margin - margin + * Type, platform - platform，margin - margin. * @return type **/ @javax.annotation.Nullable @@ -113,7 +113,7 @@ public String getType() { /** - * Created time + * Created time. * @return createTime **/ @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 453053e..e4257db 100644 --- a/src/main/java/io/gate/gateapi/models/UniLoanRecord.java +++ b/src/main/java/io/gate/gateapi/models/UniLoanRecord.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Loan records + * Loan 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 @@ -55,7 +55,7 @@ public String getType() { /** - * Currency pair + * Currency pair. * @return currencyPair **/ @javax.annotation.Nullable @@ -65,7 +65,7 @@ public String getCurrencyPair() { /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public String getCurrency() { /** - * The amount of lending or repaying + * The amount of lending or repaying. * @return amount **/ @javax.annotation.Nullable @@ -85,7 +85,7 @@ public String getAmount() { /** - * Created time + * Created time. * @return createTime **/ @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 e7732b8..896cf66 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedAccount.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedAccount.java @@ -115,7 +115,7 @@ public UnifiedAccount userId(Long userId) { } /** - * User ID + * User ID. * @return userId **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public UnifiedAccount refreshTime(Long refreshTime) { } /** - * Time of the most recent refresh + * Time of the most recent refresh. * @return refreshTime **/ @javax.annotation.Nullable @@ -203,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 deprecated, replaced by unified_account_total) * @return total **/ @javax.annotation.Nullable @@ -417,7 +417,7 @@ public void setUnifiedAccountTotalEquity(String unifiedAccountTotalEquity) { } /** - * Actual leverage, valid in cross-currency margin/combined margin mode + * Actual leverage, valid in cross-currency margin/combined margin mode. * @return leverage **/ @javax.annotation.Nullable @@ -473,7 +473,7 @@ public UnifiedAccount useFunding(Boolean useFunding) { } /** - * Whether to use funds as margin + * Whether to use funds as margin. * @return useFunding **/ @javax.annotation.Nullable @@ -493,7 +493,7 @@ public UnifiedAccount isAllCollateral(Boolean isAllCollateral) { } /** - * Whether all currencies are used as margin, true - All currencies are used as margin, false - No + * Whether all currencies are used as margin, true - false - No * @return isAllCollateral **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedBalance.java b/src/main/java/io/gate/gateapi/models/UnifiedBalance.java index a50a929..b5526bf 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedBalance.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedBalance.java @@ -231,7 +231,7 @@ public UnifiedBalance totalFreeze(String totalFreeze) { } /** - * Total occupancy (discarded, to be offline field) + * Total occupancy (discarded, to be offline field). * @return totalFreeze **/ @javax.annotation.Nullable @@ -291,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 @@ -311,7 +311,7 @@ public UnifiedBalance fundingVersion(String fundingVersion) { } /** - * Funding version + * Funding version. * @return fundingVersion **/ @javax.annotation.Nullable @@ -491,7 +491,7 @@ public UnifiedBalance enabledCollateral(Boolean enabledCollateral) { } /** - * Currency enabled as margin: true - Enabled, false - Disabled + * Currency enabled as margin: true - Enabled, false - Disabled. * @return enabledCollateral **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedBorrowable.java b/src/main/java/io/gate/gateapi/models/UnifiedBorrowable.java index d70976a..3e81d7d 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedBorrowable.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedBorrowable.java @@ -39,7 +39,7 @@ public UnifiedBorrowable currency(String currency) { } /** - * Currency detail + * Currency detail. * @return currency **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public UnifiedBorrowable amount(String amount) { } /** - * Max borrowable amount + * Max borrowable amount. * @return amount **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedBorrowable1.java b/src/main/java/io/gate/gateapi/models/UnifiedBorrowable1.java index 0b7fa8b..6d19a38 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedBorrowable1.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedBorrowable1.java @@ -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 can be borrowed up to a maximum of results. */ public class UnifiedBorrowable1 { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -39,7 +39,7 @@ public UnifiedBorrowable1 currency(String currency) { } /** - * Currency detail + * Currency detail. * @return currency **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public UnifiedBorrowable1 amount(String amount) { } /** - * The maximum amount to borrow + * The maximum amount to borrow. * @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 index 1afdae5..44a80c3 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedCollateralReq.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedCollateralReq.java @@ -26,7 +26,7 @@ */ public class UnifiedCollateralReq { /** - * User-set collateral mode0(all)-All currencies used as collateral, 1(custom)-Custom currencies used as collateral; when collateral_type is 0(all), the enable_list and disable_list parameters are invalid + * User-set collateral mode0(all)-All currencies used as collateral, collateral; when collateral_type is 0(all), the enable_list and disable_list parameters are invalid */ @JsonAdapter(CollateralTypeEnum.Adapter.class) public enum CollateralTypeEnum { @@ -92,7 +92,7 @@ public UnifiedCollateralReq collateralType(CollateralTypeEnum collateralType) { } /** - * User-set collateral mode0(all)-All currencies used as collateral, 1(custom)-Custom currencies used as collateral; when collateral_type is 0(all), the enable_list and disable_list parameters are invalid + * User-set collateral mode0(all)-All currencies used as collateral, collateral; when collateral_type is 0(all), the enable_list and disable_list parameters are invalid * @return collateralType **/ @javax.annotation.Nullable @@ -148,7 +148,7 @@ public UnifiedCollateralReq addDisableListItem(String disableListItem) { } /** - * Cancellation list, indicating the logic of cancellation + * Cancellation list, indicating the logic of cancellation. * @return disableList **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedCollateralRes.java b/src/main/java/io/gate/gateapi/models/UnifiedCollateralRes.java index d7c0434..21e3bc5 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedCollateralRes.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedCollateralRes.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Return of unified account collateral mode settings + * Return of unified account collateral mode settings. */ public class UnifiedCollateralRes { public static final String SERIALIZED_NAME_IS_SUCCESS = "is_success"; @@ -35,7 +35,7 @@ public UnifiedCollateralRes isSuccess(Boolean isSuccess) { } /** - * Whether the setting was successful + * Whether the setting was successful. * @return isSuccess **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedCurrency.java b/src/main/java/io/gate/gateapi/models/UnifiedCurrency.java index 7317c5e..8bb5c96 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedCurrency.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedCurrency.java @@ -55,7 +55,7 @@ public UnifiedCurrency name(String name) { } /** - * Currency name + * Currency name. * @return name **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public UnifiedCurrency prec(String prec) { } /** - * Currency precision + * Currency precision. * @return prec **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public UnifiedCurrency minBorrowAmount(String minBorrowAmount) { } /** - * The minimum debit limit is the unit of currency + * The minimum debit limit is the unit of currency. * @return minBorrowAmount **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public UnifiedCurrency userMaxBorrowAmount(String userMaxBorrowAmount) { } /** - * The minimum debit limit is the unit of currency + * The minimum debit limit is the unit of currency. * @return userMaxBorrowAmount **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public UnifiedCurrency totalMaxBorrowAmount(String totalMaxBorrowAmount) { } /** - * The maximum debit limit for the platform is USDT + * The maximum debit limit for the platform is USDT. * @return totalMaxBorrowAmount **/ @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 a0281af..41867e9 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedDiscount.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedDiscount.java @@ -23,7 +23,7 @@ import java.util.List; /** - * Currency discount tiers + * Currency discount tiers. */ public class UnifiedDiscount { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -42,7 +42,7 @@ public UnifiedDiscount currency(String currency) { } /** - * Currency name + * Currency name. * @return currency **/ @javax.annotation.Nullable @@ -70,7 +70,7 @@ public UnifiedDiscount addDiscountTiersItem(UnifiedDiscountTiers discountTiersIt } /** - * Tiered discount + * Tiered discount. * @return discountTiers **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedDiscountTiers.java b/src/main/java/io/gate/gateapi/models/UnifiedDiscountTiers.java index 09c7e04..0e4b408 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedDiscountTiers.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedDiscountTiers.java @@ -51,7 +51,7 @@ public UnifiedDiscountTiers tier(String tier) { } /** - * Tier + * Tier. * @return tier **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public UnifiedDiscountTiers discount(String discount) { } /** - * Discount + * Discount. * @return discount **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public UnifiedDiscountTiers lowerLimit(String lowerLimit) { } /** - * Lower limit + * Lower limit. * @return lowerLimit **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public UnifiedDiscountTiers upperLimit(String upperLimit) { } /** - * Upper limit,＋ indicates positive infinity + * Upper limit,＋ indicates positive infinity. * @return upperLimit **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public UnifiedDiscountTiers leverage(String leverage) { } /** - * Position leverage + * Position leverage. * @return leverage **/ @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 a59956a..4e9d126 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedHistoryLoanRate.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedHistoryLoanRate.java @@ -50,7 +50,7 @@ public UnifiedHistoryLoanRate currency(String currency) { } /** - * Currency name + * Currency name. * @return currency **/ @javax.annotation.Nullable @@ -70,7 +70,7 @@ public UnifiedHistoryLoanRate tier(String tier) { } /** - * The VIP level of the floating rate required + * The VIP level of the floating rate required. * @return tier **/ @javax.annotation.Nullable @@ -90,7 +90,7 @@ public UnifiedHistoryLoanRate tierUpRate(String tierUpRate) { } /** - * VIP level corresponding floating rate + * VIP level corresponding floating rate. * @return tierUpRate **/ @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 28dbb42..01accfc 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedHistoryLoanRateRates.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedHistoryLoanRateRates.java @@ -39,7 +39,7 @@ public UnifiedHistoryLoanRateRates time(Long time) { } /** - * The hourly timestamp corresponding to the interest rate, in milliseconds + * The hourly timestamp corresponding to the 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 rates 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 38d4150..f4f858e 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedLeverageConfig.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedLeverageConfig.java @@ -59,7 +59,7 @@ public UnifiedLeverageConfig currentLeverage(String currentLeverage) { } /** - * Current leverage ratio + * Current leverage ratio. * @return currentLeverage **/ @javax.annotation.Nullable @@ -79,7 +79,7 @@ public UnifiedLeverageConfig minLeverage(String minLeverage) { } /** - * Minimum adjustable leverage ratio + * Minimum adjustable leverage ratio. * @return minLeverage **/ @javax.annotation.Nullable @@ -99,7 +99,7 @@ public UnifiedLeverageConfig maxLeverage(String maxLeverage) { } /** - * Maximum adjustable leverage ratio + * Maximum adjustable leverage ratio. * @return maxLeverage **/ @javax.annotation.Nullable @@ -119,7 +119,7 @@ public UnifiedLeverageConfig debit(String debit) { } /** - * Current liabilities + * Current liabilities. * @return debit **/ @javax.annotation.Nullable @@ -139,7 +139,7 @@ public UnifiedLeverageConfig availableMargin(String availableMargin) { } /** - * Available Margin + * Available Margin. * @return availableMargin **/ @javax.annotation.Nullable @@ -159,7 +159,7 @@ public UnifiedLeverageConfig borrowable(String borrowable) { } /** - * The current leverage you can choose is + * The current leverage you can choose is. * @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 + * The maximum amount of margin that can be borrowed and the be borrowed, 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 f4b5817..86189da 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedLeverageSetting.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedLeverageSetting.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Loan currency leverage + * Loan currency leverage. */ public class UnifiedLeverageSetting { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -39,7 +39,7 @@ public UnifiedLeverageSetting currency(String currency) { } /** - * Currency name + * Currency name. * @return currency **/ public String getCurrency() { @@ -58,7 +58,7 @@ public UnifiedLeverageSetting leverage(String leverage) { } /** - * multiple + * multiple. * @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 1f28921..fc03332 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedLoan.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedLoan.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Borrow or repay + * Borrow or repay. */ public class UnifiedLoan { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -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 { @@ -98,7 +98,7 @@ public UnifiedLoan currency(String currency) { } /** - * Currency + * Currency. * @return currency **/ public String getCurrency() { @@ -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 + * The amount of lending or repaying. * @return amount **/ public String getAmount() { @@ -175,7 +175,7 @@ public UnifiedLoan text(String text) { } /** - * User defined custom ID + * User defined custom ID. * @return text **/ @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 2f97a11..873c2bc 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedLoanRecord.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedLoanRecord.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Loan records + * Loan 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 after withdrawal, different_currencies_repayment - Different currency repayment * @return repaymentType **/ @javax.annotation.Nullable @@ -107,7 +107,7 @@ public void setBorrowType(String borrowType) { } /** - * Currency pair + * Currency pair. * @return currencyPair **/ @javax.annotation.Nullable @@ -117,7 +117,7 @@ public String getCurrencyPair() { /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -127,7 +127,7 @@ public String getCurrency() { /** - * The amount of lending or repaying + * The amount of lending or repaying. * @return amount **/ @javax.annotation.Nullable @@ -137,7 +137,7 @@ public String getAmount() { /** - * Created time + * Created time. * @return createTime **/ @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 ed25f06..64b929c 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedLoanResult.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedLoanResult.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Unified account loan and repayment response results + * Unified account loan and repayment response results. */ 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 015d27f..89eb941 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedMarginTiers.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedMarginTiers.java @@ -23,7 +23,7 @@ import java.util.List; /** - * Unified margin tiers + * Unified margin tiers. */ public class UnifiedMarginTiers { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -42,7 +42,7 @@ public UnifiedMarginTiers currency(String currency) { } /** - * Currency name + * Currency name. * @return currency **/ @javax.annotation.Nullable @@ -70,7 +70,7 @@ public UnifiedMarginTiers addMarginTiersItem(MarginTiers marginTiersItem) { } /** - * Margin tiers + * Margin tiers. * @return marginTiers **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedPortfolioInput.java b/src/main/java/io/gate/gateapi/models/UnifiedPortfolioInput.java index 66559e0..64ebfb5 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedPortfolioInput.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedPortfolioInput.java @@ -75,7 +75,7 @@ public UnifiedPortfolioInput addSpotBalancesItem(MockSpotBalance spotBalancesIte } /** - * Spot + * Spot. * @return spotBalances **/ @javax.annotation.Nullable @@ -103,7 +103,7 @@ public UnifiedPortfolioInput addSpotOrdersItem(MockSpotOrder spotOrdersItem) { } /** - * Spot orders + * Spot orders. * @return spotOrders **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public UnifiedPortfolioInput addFuturesPositionsItem(MockFuturesPosition futures } /** - * Futures positions + * Futures positions. * @return futuresPositions **/ @javax.annotation.Nullable @@ -159,7 +159,7 @@ public UnifiedPortfolioInput addFuturesOrdersItem(MockFuturesOrder futuresOrders } /** - * Futures order + * Futures order. * @return futuresOrders **/ @javax.annotation.Nullable @@ -187,7 +187,7 @@ public UnifiedPortfolioInput addOptionsPositionsItem(MockOptionsPosition options } /** - * Options positions + * Options positions. * @return optionsPositions **/ @javax.annotation.Nullable @@ -215,7 +215,7 @@ public UnifiedPortfolioInput addOptionsOrdersItem(MockOptionsOrder optionsOrders } /** - * Option orders + * Option orders. * @return optionsOrders **/ @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 97ef36c..fbf2ab6 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedPortfolioOutput.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedPortfolioOutput.java @@ -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, orders. * @return initialMarginTotal **/ @javax.annotation.Nullable @@ -90,7 +90,7 @@ public UnifiedPortfolioOutput calculateTime(Long calculateTime) { } /** - * Calculate time + * Calculate time. * @return calculateTime **/ @javax.annotation.Nullable @@ -118,7 +118,7 @@ public UnifiedPortfolioOutput addRiskUnitItem(MockRiskUnit riskUnitItem) { } /** - * Risk unit + * Risk unit. * @return riskUnit **/ @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 21e504e..b5c6320 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedRiskUnits.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedRiskUnits.java @@ -46,7 +46,7 @@ public UnifiedRiskUnits userId(Long userId) { } /** - * User ID + * User ID. * @return userId **/ @javax.annotation.Nullable @@ -94,7 +94,7 @@ public UnifiedRiskUnits addRiskUnitsItem(RiskUnits riskUnitsItem) { } /** - * Risk unit + * Risk unit. * @return riskUnits **/ @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 af82037..6655095 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedSettings.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedSettings.java @@ -67,7 +67,7 @@ public UnifiedSettings spotHedge(Boolean spotHedge) { } /** - * Spot hedging switch. + * Spot hedging switch. * @return spotHedge **/ @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 54bf80c..d38a906 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedTransferable.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedTransferable.java @@ -39,7 +39,7 @@ public UnifiedTransferable currency(String currency) { } /** - * Currency detail + * Currency detail. * @return currency **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public UnifiedTransferable amount(String amount) { } /** - * The maximum amount that can be transferred out + * The maximum amount that can be transferred out. * @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 b198af4..9e75ca7 100644 --- a/src/main/java/io/gate/gateapi/models/UserLtvInfo.java +++ b/src/main/java/io/gate/gateapi/models/UserLtvInfo.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * User's currency statistics data + * User's currency statistics data. */ public class UserLtvInfo { public static final String SERIALIZED_NAME_COLLATERAL_CURRENCY = "collateral_currency"; @@ -59,7 +59,7 @@ public UserLtvInfo collateralCurrency(String collateralCurrency) { } /** - * Collateral + * Collateral. * @return collateralCurrency **/ @javax.annotation.Nullable @@ -79,7 +79,7 @@ public UserLtvInfo borrowCurrency(String borrowCurrency) { } /** - * Borrowed currency + * Borrowed currency. * @return borrowCurrency **/ @javax.annotation.Nullable @@ -99,7 +99,7 @@ public UserLtvInfo initLtv(String initLtv) { } /** - * The initial collateralization rate + * The initial collateralization rate. * @return initLtv **/ @javax.annotation.Nullable @@ -119,7 +119,7 @@ public UserLtvInfo alertLtv(String alertLtv) { } /** - * Warning collateralization ratio + * Warning collateralization ratio. * @return alertLtv **/ @javax.annotation.Nullable @@ -139,7 +139,7 @@ public UserLtvInfo liquidateLtv(String liquidateLtv) { } /** - * The liquidation collateralization rate + * The liquidation collateralization rate. * @return liquidateLtv **/ @javax.annotation.Nullable @@ -159,7 +159,7 @@ public UserLtvInfo minBorrowAmount(String minBorrowAmount) { } /** - * Minimum borrowable amount for the loan currency + * Minimum borrowable amount for the loan currency. * @return minBorrowAmount **/ @javax.annotation.Nullable @@ -179,7 +179,7 @@ public UserLtvInfo leftBorrowableAmount(String leftBorrowableAmount) { } /** - * Remaining borrowable amount for the loan currency + * Remaining borrowable amount for the loan currency. * @return leftBorrowableAmount **/ @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 0a204ec..bcbafaf 100644 --- a/src/main/java/io/gate/gateapi/models/UserSub.java +++ b/src/main/java/io/gate/gateapi/models/UserSub.java @@ -47,7 +47,7 @@ public UserSub uid(Long uid) { } /** - * User ID + * User ID. * @return uid **/ @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 the system 1-direct subordinate agent 2-indirect subordinate agent 3-direct customer 4-indirect direct customer 5-ordinary user) * @return type **/ @javax.annotation.Nullable @@ -107,7 +107,7 @@ public UserSub refUid(Long refUid) { } /** - * Inviter user ID + * Inviter user ID. * @return refUid **/ @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 0207b90..462eff3 100644 --- a/src/main/java/io/gate/gateapi/models/UserSubRelation.java +++ b/src/main/java/io/gate/gateapi/models/UserSubRelation.java @@ -46,7 +46,7 @@ public UserSubRelation addListItem(UserSub listItem) { } /** - * Subordinate relationship list + * Subordinate relationship list. * @return list **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UserTotalAmount.java b/src/main/java/io/gate/gateapi/models/UserTotalAmount.java index 68944ff..a1978a7 100644 --- a/src/main/java/io/gate/gateapi/models/UserTotalAmount.java +++ b/src/main/java/io/gate/gateapi/models/UserTotalAmount.java @@ -20,7 +20,7 @@ import java.io.IOException; /** - * Total borrowed amount and pledged collateral amount by the user + * Total borrowed amount and pledged collateral amount by the user. */ 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, calculated 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, calculated 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 1a60abf..1aca77d 100644 --- a/src/main/java/io/gate/gateapi/models/WithdrawStatus.java +++ b/src/main/java/io/gate/gateapi/models/WithdrawStatus.java @@ -82,7 +82,7 @@ public WithdrawStatus currency(String currency) { } /** - * Currency + * Currency. * @return currency **/ @javax.annotation.Nullable @@ -102,7 +102,7 @@ public WithdrawStatus name(String name) { } /** - * Currency name + * Currency name. * @return name **/ @javax.annotation.Nullable @@ -122,7 +122,7 @@ public WithdrawStatus nameCn(String nameCn) { } /** - * Currency Chinese name + * Currency Chinese name. * @return nameCn **/ @javax.annotation.Nullable @@ -142,7 +142,7 @@ public WithdrawStatus deposit(String deposit) { } /** - * Deposits fee + * Deposits fee. * @return deposit **/ @javax.annotation.Nullable @@ -162,7 +162,7 @@ public WithdrawStatus withdrawPercent(String withdrawPercent) { } /** - * Withdrawal fee rate percentage + * Withdrawal fee rate percentage. * @return withdrawPercent **/ @javax.annotation.Nullable @@ -182,7 +182,7 @@ public WithdrawStatus withdrawFix(String withdrawFix) { } /** - * Fixed withdrawal fee + * Fixed withdrawal fee. * @return withdrawFix **/ @javax.annotation.Nullable @@ -202,7 +202,7 @@ public WithdrawStatus withdrawDayLimit(String withdrawDayLimit) { } /** - * Daily allowed withdrawal amount + * Daily allowed withdrawal amount. * @return withdrawDayLimit **/ @javax.annotation.Nullable @@ -222,7 +222,7 @@ public WithdrawStatus withdrawAmountMini(String withdrawAmountMini) { } /** - * Minimum withdrawal amount + * Minimum withdrawal amount. * @return withdrawAmountMini **/ @javax.annotation.Nullable @@ -242,7 +242,7 @@ public WithdrawStatus withdrawDayLimitRemain(String withdrawDayLimitRemain) { } /** - * Daily withdrawal amount left + * Daily withdrawal amount left. * @return withdrawDayLimitRemain **/ @javax.annotation.Nullable @@ -262,7 +262,7 @@ public WithdrawStatus withdrawEachtimeLimit(String withdrawEachtimeLimit) { } /** - * Maximum amount for each withdrawal + * Maximum amount for each withdrawal. * @return withdrawEachtimeLimit **/ @javax.annotation.Nullable @@ -290,7 +290,7 @@ public WithdrawStatus putWithdrawFixOnChainsItem(String key, String withdrawFixO } /** - * Fixed withdrawal fee on multiple chains + * Fixed withdrawal fee on multiple chains. * @return withdrawFixOnChains **/ @javax.annotation.Nullable @@ -318,7 +318,7 @@ public WithdrawStatus putWithdrawPercentOnChainsItem(String key, String withdraw } /** - * Percentage withdrawal fee on multiple chains + * Percentage withdrawal fee on multiple chains. * @return withdrawPercentOnChains **/ @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 37b843d..bc5c87e 100644 --- a/src/main/java/io/gate/gateapi/models/WithdrawalRecord.java +++ b/src/main/java/io/gate/gateapi/models/WithdrawalRecord.java @@ -81,7 +81,7 @@ public class WithdrawalRecord { /** - * Record ID + * Record ID. * @return id **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public String getId() { /** - * Hash record of the withdrawal + * Hash record of the withdrawal. * @return txid **/ @javax.annotation.Nullable @@ -101,7 +101,7 @@ public String getTxid() { /** - * Block Number + * Block Number. * @return blockNumber **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public void setWithdrawOrderId(String withdrawOrderId) { } /** - * Operation time + * Operation time. * @return timestamp **/ @javax.annotation.Nullable @@ -147,7 +147,7 @@ public WithdrawalRecord amount(String amount) { } /** - * Currency amount + * Currency amount. * @return amount **/ public String getAmount() { @@ -160,7 +160,7 @@ public void setAmount(String amount) { } /** - * fee + * fee. * @return fee **/ @javax.annotation.Nullable @@ -176,7 +176,7 @@ public WithdrawalRecord currency(String currency) { } /** - * Currency name + * Currency name. * @return currency **/ public String getCurrency() { @@ -195,7 +195,7 @@ public WithdrawalRecord address(String address) { } /** - * Withdrawal address + * Withdrawal address. * @return address **/ @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 + * 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 * @return timestamp2 **/ @javax.annotation.Nullable @@ -255,7 +255,7 @@ public WithdrawalRecord memo(String memo) { } /** - * Additional remarks with regards to the withdrawal + * Additional remarks with regards to the withdrawal. * @return memo **/ @javax.annotation.Nullable @@ -285,7 +285,7 @@ public WithdrawalRecord chain(String chain) { } /** - * Name of the chain used in withdrawals + * Name of the chain used in withdrawals. * @return chain **/ public String getChain() { From 265be7f9b0c52467a1ff4e9662988b1b717ad319 Mon Sep 17 00:00:00 2001 From: gateio Date: Thu, 24 Jul 2025 09:27:59 +0000 Subject: [PATCH 11/14] update to v6.103.0 --- README.md | 12 +- build.gradle | 2 +- build.sbt | 2 +- docs/FuturesApi.md | 101 ++++++- docs/InlineObject.md | 10 + pom.xml | 2 +- src/main/java/io/gate/gateapi/ApiClient.java | 2 +- .../java/io/gate/gateapi/api/FuturesApi.java | 256 ++++++++++++++++-- .../io/gate/gateapi/models/InlineObject.java | 113 ++++++++ 9 files changed, 461 insertions(+), 39 deletions(-) create mode 100644 docs/InlineObject.md create mode 100644 src/main/java/io/gate/gateapi/models/InlineObject.java diff --git a/README.md b/README.md index b4f2253..1b94cad 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ Gate API -- API version: v4.102.6 -- SDK version: 6.102.6 +- API version: v4.103.0 +- SDK version: 6.103.0 Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces @@ -53,7 +53,7 @@ Add this dependency to your project's POM: io.gate gate-api - 6.102.6 + 6.103.0 compile ``` @@ -63,7 +63,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.102.6" +compile "io.gate:gate-api:6.103.0" ``` ### Others @@ -76,7 +76,7 @@ mvn clean package Then manually install the following JARs: -* `target/gate-api-6.102.6.jar` +* `target/gate-api-6.103.0.jar` * `target/lib/*.jar` To install the API client library to your local Maven repository, simply execute: @@ -235,6 +235,7 @@ Class | Method | HTTP request | Description *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* | [**updateDualCompPositionCrossMode**](docs/FuturesApi.md#updateDualCompPositionCrossMode) | **POST** /futures/{settle}/dual_comp/positions/cross_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. @@ -520,6 +521,7 @@ Class | Method | HTTP request | Description - [FuturesTicker](docs/FuturesTicker.md) - [FuturesTrade](docs/FuturesTrade.md) - [IndexConstituent](docs/IndexConstituent.md) + - [InlineObject](docs/InlineObject.md) - [InlineResponse200](docs/InlineResponse200.md) - [InlineResponse2001](docs/InlineResponse2001.md) - [InsuranceRecord](docs/InsuranceRecord.md) diff --git a/build.gradle b/build.gradle index 8def177..83eef29 100644 --- a/build.gradle +++ b/build.gradle @@ -3,7 +3,7 @@ apply plugin: 'eclipse' apply plugin: 'java' group = 'io.gate' -version = '6.102.6' +version = '6.103.0' buildscript { repositories { diff --git a/build.sbt b/build.sbt index bca1e62..33a5aae 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.102.6", + version := "6.103.0", scalaVersion := "2.11.4", scalacOptions ++= Seq("-feature"), javacOptions in compile ++= Seq("-Xlint:deprecation"), diff --git a/docs/FuturesApi.md b/docs/FuturesApi.md index 2d80b58..eb72557 100644 --- a/docs/FuturesApi.md +++ b/docs/FuturesApi.md @@ -24,6 +24,7 @@ Method | HTTP request | Description [**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. +[**updateDualCompPositionCrossMode**](FuturesApi.md#updateDualCompPositionCrossMode) | **POST** /futures/{settle}/dual_comp/positions/cross_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. @@ -382,7 +383,7 @@ public class Example { 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 | Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision specified 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. 1 natual month, not 30 days + 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. 1 natual month, not 30 days try { List result = apiInstance.listFuturesCandlesticks(settle, contract) .from(from) @@ -413,7 +414,7 @@ Name | Type | Description | Notes **from** | **Long**| Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified | [optional] **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 specified | [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. 1 natual month, not 30 days | [optional] [default to "5m"] + **interval** | **String**| Interval time between data points. Note that `1w` means natual week(Mon-Sun), while `7d` means every 7d since unix 0. 1 natual month, not 30 days | [optional] [default to 5m] [enum: 10s, 1m, 5m, 15m, 30m, 1h, 4h, 8h, 1d, 7d] ### Return type @@ -463,7 +464,7 @@ public class Example { 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 | Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision specified 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. + String interval = "5m"; // String | Interval time between data points. try { List result = apiInstance.listFuturesPremiumIndex(settle, contract) .from(from) @@ -494,7 +495,7 @@ Name | Type | Description | Notes **from** | **Long**| Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified | [optional] **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 specified | [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"] + **interval** | **String**| Interval time between data points. | [optional] [default to 5m] [enum: 10s, 1m, 5m, 15m, 30m, 1h, 4h, 8h, 1d, 7d] ### Return type @@ -1545,6 +1546,76 @@ Name | Type | Description | Notes |-------------|-------------|------------------| **200** | Position information. | - | + +# **updateDualCompPositionCrossMode** +> List<Position> updateDualCompPositionCrossMode(settle, inlineObject) + +双仓模式下切换全逐仓模式 + +### 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** | Successfully retrieved. | - | + # **updatePositionRiskLimit** > Position updatePositionRiskLimit(settle, contract, riskLimit) @@ -2856,7 +2927,7 @@ Name | Type | Description | Notes # **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. @@ -2884,11 +2955,17 @@ public class Example { 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 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 a 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); @@ -2912,6 +2989,9 @@ 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] + **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 a liquidation timestamp. | [optional] [default to 0] ### Return type @@ -2934,7 +3014,7 @@ Name | Type | Description | Notes # **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. @@ -2962,11 +3042,17 @@ public class Example { 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 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 an 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); @@ -2990,6 +3076,9 @@ 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] + **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 an auto-deleveraging timestamp. | [optional] [default to 0] ### Return type diff --git a/docs/InlineObject.md b/docs/InlineObject.md new file mode 100644 index 0000000..351bc7f --- /dev/null +++ b/docs/InlineObject.md @@ -0,0 +1,10 @@ + +# InlineObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mode** | **String** | Full position-by-position model, ISOLATED-by-position, CROSS-full position. | +**contract** | **String** | Contract Market. | + diff --git a/pom.xml b/pom.xml index 151864f..a087715 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ gate-api jar gate-api - 6.102.6 + 6.103.0 https://github.com/gateio/gateapi-java.git Java client for gateapi diff --git a/src/main/java/io/gate/gateapi/ApiClient.java b/src/main/java/io/gate/gateapi/ApiClient.java index 3d57bef..93f201a 100644 --- a/src/main/java/io/gate/gateapi/ApiClient.java +++ b/src/main/java/io/gate/gateapi/ApiClient.java @@ -113,7 +113,7 @@ private void init() { json = new JSON(); // Set default User-Agent. - setUserAgent("OpenAPI-Generator/6.102.6/java"); + setUserAgent("OpenAPI-Generator/6.103.0/java"); authentications = new HashMap(); } diff --git a/src/main/java/io/gate/gateapi/api/FuturesApi.java b/src/main/java/io/gate/gateapi/api/FuturesApi.java index 1041847..d154c7c 100644 --- a/src/main/java/io/gate/gateapi/api/FuturesApi.java +++ b/src/main/java/io/gate/gateapi/api/FuturesApi.java @@ -45,6 +45,7 @@ import io.gate.gateapi.models.FuturesRiskLimitTier; import io.gate.gateapi.models.FuturesTicker; import io.gate.gateapi.models.FuturesTrade; +import io.gate.gateapi.models.InlineObject; import io.gate.gateapi.models.InsuranceRecord; import io.gate.gateapi.models.MyFuturesTrade; import io.gate.gateapi.models.MyFuturesTradeTimeRange; @@ -906,7 +907,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. 1 natual month, not 30 days (optional, default to "5m") + * @param interval Interval time between data points. Note that `1w` means natual week(Mon-Sun), while `7d` means every 7d since unix 0. 1 natual month, not 30 days (optional, default to 5m) * @return APIlistFuturesCandlesticksRequest */ public APIlistFuturesCandlesticksRequest interval(String interval) { @@ -1115,7 +1116,7 @@ public APIlistFuturesPremiumIndexRequest limit(Integer limit) { /** * Set interval - * @param interval Interval time between data points. (optional, default to "5m") + * @param interval Interval time between data points. (optional, default to 5m) * @return APIlistFuturesPremiumIndexRequest */ public APIlistFuturesPremiumIndexRequest interval(String interval) { @@ -3438,6 +3439,123 @@ public okhttp3.Call updatePositionCrossModeAsync(String settle, FuturesPositionC 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 Successfully retrieved. -
    + */ + 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; + } + + /** + * 双仓模式下切换全逐仓模式 + * + * @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 Successfully retrieved. -
    + */ + public List updateDualCompPositionCrossMode(String settle, InlineObject inlineObject) throws ApiException { + ApiResponse> localVarResp = updateDualCompPositionCrossModeWithHttpInfo(settle, inlineObject); + return localVarResp.getData(); + } + + /** + * 双仓模式下切换全逐仓模式 + * + * @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 Successfully retrieved. -
    + */ + 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); + } + + /** + * 双仓模式下切换全逐仓模式 (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 Successfully retrieved. -
    + */ + 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) @@ -6118,7 +6236,7 @@ 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 @@ -6135,6 +6253,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)); } @@ -6161,25 +6291,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; @@ -6189,6 +6319,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) { @@ -6215,6 +6348,36 @@ 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) @@ -6237,7 +6400,7 @@ public APIlistLiquidatesRequest at(Integer at) { */ 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); } /** @@ -6251,7 +6414,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { */ 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(); } @@ -6266,7 +6429,7 @@ public List execute() throws ApiException { */ public ApiResponse> executeWithHttpInfo() throws ApiException { - return listLiquidatesWithHttpInfo(settle, contract, limit, at); + return listLiquidatesWithHttpInfo(settle, contract, limit, offset, from, to, at); } /** @@ -6281,7 +6444,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcep */ 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); } } @@ -6300,7 +6463,7 @@ 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 @@ -6317,6 +6480,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)); } @@ -6343,25 +6518,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; @@ -6371,6 +6546,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) { @@ -6397,6 +6575,36 @@ 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) @@ -6419,7 +6627,7 @@ public APIlistAutoDeleveragesRequest at(Integer at) { */ 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); } /** @@ -6433,7 +6641,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { */ 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(); } @@ -6448,7 +6656,7 @@ public List execute() throws ApiException { */ public ApiResponse> executeWithHttpInfo() throws ApiException { - return listAutoDeleveragesWithHttpInfo(settle, contract, limit, at); + return listAutoDeleveragesWithHttpInfo(settle, contract, limit, offset, from, to, at); } /** @@ -6463,7 +6671,7 @@ public ApiResponse> executeWithHttpInfo() throws Api */ 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); } } diff --git a/src/main/java/io/gate/gateapi/models/InlineObject.java b/src/main/java/io/gate/gateapi/models/InlineObject.java new file mode 100644 index 0000000..4d89454 --- /dev/null +++ b/src/main/java/io/gate/gateapi/models/InlineObject.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; + +/** + * InlineObject + */ +public class InlineObject { + 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 InlineObject mode(String mode) { + + this.mode = mode; + return this; + } + + /** + * Full position-by-position model, ISOLATED-by-position, CROSS-full position. + * @return mode + **/ + public String getMode() { + return mode; + } + + + public void setMode(String mode) { + this.mode = mode; + } + + public InlineObject contract(String contract) { + + this.contract = contract; + return this; + } + + /** + * Contract 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; + } + InlineObject inlineObject = (InlineObject) o; + return Objects.equals(this.mode, inlineObject.mode) && + Objects.equals(this.contract, inlineObject.contract); + } + + @Override + public int hashCode() { + return Objects.hash(mode, contract); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class InlineObject {\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 "); + } + +} + From 9a402a48fa8c902be22cc3a6e1cd1f7d88030e31 Mon Sep 17 00:00:00 2001 From: gateio Date: Thu, 31 Jul 2025 02:50:44 +0000 Subject: [PATCH 12/14] update to v6.104.3 --- README.md | 571 ++++---- build.gradle | 2 +- build.sbt | 2 +- docs/AccountApi.md | 90 +- docs/AccountBalance.md | 8 +- docs/AccountDetail.md | 12 +- docs/AccountDetailKey.md | 4 +- docs/AccountRateLimit.md | 6 +- docs/AgencyCommission.md | 12 +- docs/AgencyCommissionHistory.md | 6 +- docs/AgencyTransaction.md | 18 +- docs/AgencyTransactionHistory.md | 6 +- docs/AutoRepaySetting.md | 2 +- docs/BatchAmendItem.md | 14 +- docs/BatchAmendOrderReq.md | 12 +- docs/BatchFuturesOrder.md | 48 +- docs/BatchOrder.md | 62 +- docs/BorrowCurrencyInfo.md | 10 +- docs/BrokerCommission.md | 4 +- docs/BrokerCommission1.md | 20 +- docs/BrokerCommissionSubBrokerInfo.md | 10 +- docs/BrokerTransaction.md | 4 +- docs/BrokerTransaction1.md | 18 +- docs/CancelBatchOrder.md | 4 +- docs/CancelOrderResult.md | 16 +- docs/CollateralAdjust.md | 6 +- docs/CollateralAdjustRes.md | 6 +- docs/CollateralAlign.md | 8 +- docs/CollateralCurrency.md | 4 +- docs/CollateralCurrencyInfo.md | 8 +- docs/CollateralCurrencyRes.md | 10 +- docs/CollateralCurrentRate.md | 6 +- docs/CollateralFixRate.md | 10 +- docs/CollateralLoanApi.md | 144 +- docs/CollateralLoanCurrency.md | 6 +- docs/CollateralLtv.md | 8 +- docs/CollateralOrder.md | 30 +- docs/CollateralRecord.md | 22 +- docs/Contract.md | 76 +- docs/ContractStat.md | 26 +- docs/ConvertSmallBalance.md | 6 +- docs/CountdownCancelAllFuturesTask.md | 4 +- docs/CountdownCancelAllOptionsTask.md | 6 +- docs/CountdownCancelAllSpotTask.md | 4 +- docs/CreateCollateralOrder.md | 8 +- docs/CreateMultiCollateralOrder.md | 18 +- docs/CreateUniLend.md | 10 +- docs/CreateUniLoan.md | 12 +- docs/CrossMarginBalance.md | 8 +- docs/CrossMarginLoan.md | 18 +- docs/CrossMarginRepayment.md | 12 +- docs/Currency.md | 18 +- docs/CurrencyChain.md | 14 +- docs/CurrencyPair.md | 40 +- docs/CurrencyQuota.md | 12 +- docs/DebitFee.md | 2 +- docs/DeliveryApi.md | 520 +++---- docs/DeliveryCandlestick.md | 14 +- docs/DeliveryContract.md | 78 +- docs/DeliverySettlement.md | 18 +- docs/DeliveryTicker.md | 44 +- docs/DepositAddress.md | 4 +- docs/DepositRecord.md | 16 +- docs/DualGetOrders.md | 34 +- docs/DualGetPlans.md | 26 +- docs/EarnApi.md | 98 +- docs/EarnUniApi.md | 128 +- docs/Eth2RateList.md | 6 +- docs/Eth2Swap.md | 6 +- docs/FindCoin.md | 4 +- docs/FlashSwapApi.md | 70 +- docs/FlashSwapCurrencyPair.md | 16 +- docs/FlashSwapOrder.md | 18 +- docs/FlashSwapOrderPreview.md | 10 +- docs/FlashSwapOrderRequest.md | 8 +- docs/FlashSwapPreviewRequest.md | 6 +- docs/FundingAccount.md | 10 +- docs/FundingRateRecord.md | 4 +- docs/FutureCancelOrderResult.md | 10 +- docs/FuturesAccount.md | 46 +- docs/FuturesAccountBook.md | 14 +- docs/FuturesAccountHistory.md | 22 +- docs/FuturesApi.md | 888 ++++++------ docs/FuturesAutoDeleverage.md | 20 +- docs/FuturesBatchAmendOrderRequest.md | 12 +- docs/FuturesCandlestick.md | 16 +- docs/FuturesFee.md | 6 +- docs/FuturesIndexConstituents.md | 4 +- docs/FuturesInitialOrder.md | 14 +- docs/FuturesLimitRiskTiers.md | 16 +- docs/FuturesLiqOrder.md | 14 +- docs/FuturesLiquidate.md | 24 +- docs/FuturesOrder.md | 48 +- docs/FuturesOrderAmendment.md | 4 +- docs/FuturesOrderBook.md | 8 +- docs/FuturesOrderBookItem.md | 4 +- docs/FuturesPositionCrossMode.md | 4 +- docs/FuturesPremiumIndex.md | 12 +- docs/FuturesPriceTrigger.md | 10 +- docs/FuturesPriceTriggeredOrder.md | 22 +- docs/FuturesRiskLimitTier.md | 14 +- docs/FuturesTicker.md | 40 +- docs/FuturesTrade.md | 14 +- docs/IndexConstituent.md | 4 +- docs/InlineObject.md | 4 +- docs/InlineResponse2001.md | 2 +- docs/InsuranceRecord.md | 4 +- docs/LedgerRecord.md | 24 +- docs/LiquidateOrder.md | 12 +- docs/MarginAccount.md | 12 +- docs/MarginAccountBook.md | 14 +- docs/MarginAccountCurrency.md | 12 +- docs/MarginApi.md | 164 +-- docs/MarginLeverageTier.md | 8 +- docs/MarginMarketLeverage.md | 6 +- docs/MarginTiers.md | 10 +- docs/MarginTransferable.md | 6 +- docs/MarginUniApi.md | 118 +- docs/MaxUniBorrowable.md | 6 +- docs/MockFuturesOrder.md | 8 +- docs/MockFuturesPosition.md | 6 +- docs/MockMarginResult.md | 14 +- docs/MockOptionsOrder.md | 8 +- docs/MockOptionsPosition.md | 6 +- docs/MockRiskUnit.md | 20 +- docs/MockSpotBalance.md | 6 +- docs/MockSpotOrder.md | 12 +- docs/MultiChainAddressItem.md | 8 +- docs/MultiCollateralCurrency.md | 6 +- docs/MultiCollateralItem.md | 6 +- docs/MultiCollateralLoanApi.md | 156 +- docs/MultiCollateralOrder.md | 28 +- docs/MultiCollateralRecord.md | 16 +- docs/MultiCollateralRecordCurrency.md | 12 +- docs/MultiLoanItem.md | 4 +- docs/MultiLoanRepayItem.md | 6 +- docs/MultiRepayRecord.md | 26 +- docs/MultiRepayResp.md | 6 +- docs/MyFuturesTrade.md | 22 +- docs/MyFuturesTradeTimeRange.md | 22 +- docs/OpenOrders.md | 4 +- docs/OptionsAccount.md | 32 +- docs/OptionsAccountBook.md | 8 +- docs/OptionsApi.md | 350 ++--- docs/OptionsCandlestick.md | 12 +- docs/OptionsContract.md | 52 +- docs/OptionsMMP.md | 12 +- docs/OptionsMMPReset.md | 12 +- docs/OptionsMySettlements.md | 18 +- docs/OptionsMyTrade.md | 16 +- docs/OptionsOrder.md | 50 +- docs/OptionsPosition.md | 32 +- docs/OptionsPositionClose.md | 12 +- docs/OptionsPositionCloseOrder.md | 8 +- docs/OptionsSettlement.md | 12 +- docs/OptionsTicker.md | 38 +- docs/OptionsUnderlying.md | 4 +- docs/OptionsUnderlyingTicker.md | 8 +- docs/Order.md | 58 +- docs/OrderBook.md | 8 +- docs/OrderCancel.md | 64 +- docs/OrderPatch.md | 12 +- docs/OrderResp.md | 2 +- docs/PartnerCommissionHistory.md | 4 +- docs/PartnerSub.md | 6 +- docs/PartnerSubList.md | 4 +- docs/PartnerTransactionHistory.md | 4 +- docs/PatchUniLend.md | 4 +- docs/PlaceDualInvestmentOrder.md | 8 +- docs/Position.md | 58 +- docs/PositionClose.md | 26 +- docs/PositionCloseOrder.md | 8 +- docs/ProfitLossRange.md | 8 +- docs/RebateApi.md | 222 +-- docs/RebateUserInfo.md | 4 +- docs/RepayCurrencyRes.md | 12 +- docs/RepayLoan.md | 6 +- docs/RepayMultiLoan.md | 6 +- docs/RepayRecord.md | 28 +- docs/RepayRecordCurrency.md | 12 +- docs/RepayRecordLeftInterest.md | 12 +- docs/RepayRecordRepaidCurrency.md | 12 +- docs/RepayRecordTotalInterest.md | 8 +- docs/RepayResp.md | 6 +- docs/RiskUnits.md | 16 +- docs/SavedAddress.md | 12 +- docs/SmallBalance.md | 10 +- docs/SmallBalanceHistory.md | 12 +- docs/SpotAccount.md | 8 +- docs/SpotAccountBook.md | 14 +- docs/SpotApi.md | 494 +++---- docs/SpotCurrencyChain.md | 10 +- docs/SpotFee.md | 16 +- docs/SpotInsuranceHistory.md | 6 +- docs/SpotPricePutOrder.md | 12 +- docs/SpotPriceTrigger.md | 6 +- docs/SpotPriceTriggeredOrder.md | 18 +- docs/StpGroup.md | 8 +- docs/StpGroupUser.md | 6 +- docs/StructuredBuy.md | 6 +- docs/StructuredGetProjectList.md | 24 +- docs/StructuredOrderList.md | 14 +- docs/SubAccount.md | 14 +- docs/SubAccountApi.md | 116 +- docs/SubAccountBalance.md | 4 +- docs/SubAccountCrossMarginBalance.md | 2 +- docs/SubAccountFuturesBalance.md | 4 +- docs/SubAccountKey.md | 18 +- docs/SubAccountKeyPerms.md | 4 +- docs/SubAccountMarginBalance.md | 4 +- docs/SubAccountToSubAccount.md | 14 +- docs/SubAccountTransfer.md | 12 +- docs/SubAccountTransferRecordItem.md | 20 +- docs/SubCrossMarginAccount.md | 26 +- docs/SubUserMode.md | 6 +- docs/SwapCoin.md | 10 +- docs/SwapCoinStruct.md | 26 +- docs/SystemTime.md | 2 +- docs/Ticker.md | 34 +- docs/TotalBalance.md | 4 +- docs/Trade.md | 32 +- docs/TradeFee.md | 22 +- docs/TransactionID.md | 2 +- docs/Transfer.md | 12 +- docs/TransferOrderStatus.md | 4 +- docs/TransferablesResult.md | 6 +- docs/TriggerOrderResponse.md | 2 +- docs/TriggerTime.md | 2 +- docs/UidPushOrder.md | 18 +- docs/UidPushWithdrawal.md | 6 +- docs/UidPushWithdrawalResp.md | 2 +- docs/UniCurrency.md | 12 +- docs/UniCurrencyInterest.md | 2 +- docs/UniCurrencyPair.md | 10 +- docs/UniInterestRecord.md | 12 +- docs/UniLend.md | 20 +- docs/UniLendInterest.md | 4 +- docs/UniLendRecord.md | 16 +- docs/UniLoan.md | 14 +- docs/UniLoanInterestRecord.md | 16 +- docs/UniLoanRecord.md | 12 +- docs/UnifiedAccount.md | 22 +- docs/UnifiedApi.md | 262 ++-- docs/UnifiedBalance.md | 20 +- docs/UnifiedBorrowable.md | 4 +- docs/UnifiedBorrowable1.md | 6 +- docs/UnifiedCollateralReq.md | 6 +- docs/UnifiedCollateralRes.md | 4 +- docs/UnifiedCurrency.md | 12 +- docs/UnifiedDiscount.md | 6 +- docs/UnifiedDiscountTiers.md | 10 +- docs/UnifiedHistoryLoanRate.md | 8 +- docs/UnifiedHistoryLoanRateRates.md | 4 +- docs/UnifiedLeverageConfig.md | 14 +- docs/UnifiedLeverageSetting.md | 6 +- docs/UnifiedLoan.md | 12 +- docs/UnifiedLoanRecord.md | 18 +- docs/UnifiedLoanResult.md | 4 +- docs/UnifiedMarginTiers.md | 6 +- docs/UnifiedModeSet.md | 2 +- docs/UnifiedPortfolioInput.md | 16 +- docs/UnifiedPortfolioOutput.md | 10 +- docs/UnifiedRiskUnits.md | 6 +- docs/UnifiedSettings.md | 8 +- docs/UnifiedTransferable.md | 4 +- docs/UserLtvInfo.md | 16 +- docs/UserSub.md | 8 +- docs/UserSubRelation.md | 2 +- docs/UserTotalAmount.md | 6 +- docs/WalletApi.md | 318 ++--- docs/WithdrawStatus.md | 24 +- docs/WithdrawalApi.md | 22 +- docs/WithdrawalRecord.md | 24 +- pom.xml | 2 +- .../java/io/gate/gateapi/ApiCallback.java | 2 +- src/main/java/io/gate/gateapi/ApiClient.java | 4 +- .../java/io/gate/gateapi/ApiException.java | 2 +- .../java/io/gate/gateapi/ApiResponse.java | 2 +- .../java/io/gate/gateapi/Configuration.java | 2 +- .../gate/gateapi/GzipRequestInterceptor.java | 2 +- src/main/java/io/gate/gateapi/JSON.java | 2 +- src/main/java/io/gate/gateapi/Pair.java | 2 +- .../io/gate/gateapi/ProgressRequestBody.java | 2 +- .../io/gate/gateapi/ProgressResponseBody.java | 2 +- src/main/java/io/gate/gateapi/StringUtil.java | 2 +- .../java/io/gate/gateapi/api/AccountApi.java | 200 +-- .../gate/gateapi/api/CollateralLoanApi.java | 194 +-- .../java/io/gate/gateapi/api/DeliveryApi.java | 758 +++++----- .../java/io/gate/gateapi/api/EarnApi.java | 158 +- .../java/io/gate/gateapi/api/EarnUniApi.java | 208 +-- .../io/gate/gateapi/api/FlashSwapApi.java | 94 +- .../java/io/gate/gateapi/api/FuturesApi.java | 1270 ++++++++--------- .../java/io/gate/gateapi/api/MarginApi.java | 224 +-- .../io/gate/gateapi/api/MarginUniApi.java | 172 +-- .../gateapi/api/MultiCollateralLoanApi.java | 228 +-- .../java/io/gate/gateapi/api/OptionsApi.java | 506 +++---- .../java/io/gate/gateapi/api/RebateApi.java | 216 +-- .../java/io/gate/gateapi/api/SpotApi.java | 726 +++++----- .../io/gate/gateapi/api/SubAccountApi.java | 250 ++-- .../java/io/gate/gateapi/api/UnifiedApi.java | 436 +++--- .../java/io/gate/gateapi/api/WalletApi.java | 396 ++--- .../io/gate/gateapi/api/WithdrawalApi.java | 56 +- .../java/io/gate/gateapi/auth/ApiKeyAuth.java | 2 +- .../io/gate/gateapi/auth/Authentication.java | 2 +- .../io/gate/gateapi/auth/GateApiV4Auth.java | 2 +- .../io/gate/gateapi/auth/HttpBasicAuth.java | 2 +- .../io/gate/gateapi/auth/HttpBearerAuth.java | 2 +- .../gate/gateapi/models/AccountBalance.java | 12 +- .../io/gate/gateapi/models/AccountDetail.java | 14 +- .../gate/gateapi/models/AccountDetailKey.java | 6 +- .../gate/gateapi/models/AccountRateLimit.java | 8 +- .../gate/gateapi/models/AgencyCommission.java | 14 +- .../models/AgencyCommissionHistory.java | 8 +- .../gateapi/models/AgencyTransaction.java | 20 +- .../models/AgencyTransactionHistory.java | 8 +- .../gate/gateapi/models/AutoRepaySetting.java | 6 +- .../gate/gateapi/models/BatchAmendItem.java | 16 +- .../gateapi/models/BatchAmendOrderReq.java | 14 +- .../gateapi/models/BatchFuturesOrder.java | 56 +- .../io/gate/gateapi/models/BatchOrder.java | 66 +- .../gateapi/models/BorrowCurrencyInfo.java | 12 +- .../gate/gateapi/models/BrokerCommission.java | 6 +- .../gateapi/models/BrokerCommission1.java | 22 +- .../models/BrokerCommissionSubBrokerInfo.java | 12 +- .../gateapi/models/BrokerTransaction.java | 6 +- .../gateapi/models/BrokerTransaction1.java | 20 +- .../gate/gateapi/models/CancelBatchOrder.java | 6 +- .../gateapi/models/CancelOrderResult.java | 18 +- .../gate/gateapi/models/CollateralAdjust.java | 8 +- .../gateapi/models/CollateralAdjustRes.java | 8 +- .../gate/gateapi/models/CollateralAlign.java | 10 +- .../gateapi/models/CollateralCurrency.java | 6 +- .../models/CollateralCurrencyInfo.java | 10 +- .../gateapi/models/CollateralCurrencyRes.java | 12 +- .../gateapi/models/CollateralCurrentRate.java | 8 +- .../gateapi/models/CollateralFixRate.java | 12 +- .../models/CollateralLoanCurrency.java | 8 +- .../io/gate/gateapi/models/CollateralLtv.java | 10 +- .../gate/gateapi/models/CollateralOrder.java | 32 +- .../gate/gateapi/models/CollateralRecord.java | 24 +- .../java/io/gate/gateapi/models/Contract.java | 82 +- .../io/gate/gateapi/models/ContractStat.java | 28 +- .../gateapi/models/ConvertSmallBalance.java | 8 +- .../models/CountdownCancelAllFuturesTask.java | 6 +- .../models/CountdownCancelAllOptionsTask.java | 8 +- .../models/CountdownCancelAllSpotTask.java | 6 +- .../gateapi/models/CreateCollateralOrder.java | 10 +- .../models/CreateMultiCollateralOrder.java | 20 +- .../io/gate/gateapi/models/CreateUniLend.java | 14 +- .../io/gate/gateapi/models/CreateUniLoan.java | 16 +- .../gateapi/models/CrossMarginBalance.java | 10 +- .../gate/gateapi/models/CrossMarginLoan.java | 20 +- .../gateapi/models/CrossMarginRepayment.java | 14 +- .../java/io/gate/gateapi/models/Currency.java | 20 +- .../io/gate/gateapi/models/CurrencyChain.java | 16 +- .../io/gate/gateapi/models/CurrencyPair.java | 44 +- .../io/gate/gateapi/models/CurrencyQuota.java | 14 +- .../java/io/gate/gateapi/models/DebitFee.java | 4 +- .../gateapi/models/DeliveryCandlestick.java | 16 +- .../gate/gateapi/models/DeliveryContract.java | 86 +- .../gateapi/models/DeliverySettlement.java | 20 +- .../gate/gateapi/models/DeliveryTicker.java | 46 +- .../gate/gateapi/models/DepositAddress.java | 6 +- .../io/gate/gateapi/models/DepositRecord.java | 18 +- .../io/gate/gateapi/models/DualGetOrders.java | 36 +- .../io/gate/gateapi/models/DualGetPlans.java | 28 +- .../io/gate/gateapi/models/Eth2RateList.java | 8 +- .../java/io/gate/gateapi/models/Eth2Swap.java | 8 +- .../java/io/gate/gateapi/models/FindCoin.java | 6 +- .../gateapi/models/FlashSwapCurrencyPair.java | 18 +- .../gate/gateapi/models/FlashSwapOrder.java | 20 +- .../gateapi/models/FlashSwapOrderPreview.java | 12 +- .../gateapi/models/FlashSwapOrderRequest.java | 10 +- .../models/FlashSwapPreviewRequest.java | 8 +- .../gate/gateapi/models/FundingAccount.java | 12 +- .../gateapi/models/FundingRateRecord.java | 6 +- .../models/FutureCancelOrderResult.java | 12 +- .../gate/gateapi/models/FuturesAccount.java | 48 +- .../gateapi/models/FuturesAccountBook.java | 16 +- .../gateapi/models/FuturesAccountHistory.java | 24 +- .../gateapi/models/FuturesAutoDeleverage.java | 22 +- .../models/FuturesBatchAmendOrderRequest.java | 14 +- .../gateapi/models/FuturesCandlestick.java | 18 +- .../io/gate/gateapi/models/FuturesFee.java | 8 +- .../models/FuturesIndexConstituents.java | 6 +- .../gateapi/models/FuturesInitialOrder.java | 18 +- .../gateapi/models/FuturesLimitRiskTiers.java | 18 +- .../gate/gateapi/models/FuturesLiqOrder.java | 16 +- .../gate/gateapi/models/FuturesLiquidate.java | 26 +- .../io/gate/gateapi/models/FuturesOrder.java | 56 +- .../gateapi/models/FuturesOrderAmendment.java | 6 +- .../gate/gateapi/models/FuturesOrderBook.java | 10 +- .../gateapi/models/FuturesOrderBookItem.java | 6 +- .../models/FuturesPositionCrossMode.java | 6 +- .../gateapi/models/FuturesPremiumIndex.java | 14 +- .../gateapi/models/FuturesPriceTrigger.java | 18 +- .../models/FuturesPriceTriggeredOrder.java | 28 +- .../gateapi/models/FuturesRiskLimitTier.java | 16 +- .../io/gate/gateapi/models/FuturesTicker.java | 42 +- .../io/gate/gateapi/models/FuturesTrade.java | 16 +- .../gate/gateapi/models/IndexConstituent.java | 6 +- .../io/gate/gateapi/models/InlineObject.java | 6 +- .../gateapi/models/InlineResponse200.java | 2 +- .../gateapi/models/InlineResponse2001.java | 4 +- .../gate/gateapi/models/InsuranceRecord.java | 6 +- .../io/gate/gateapi/models/LedgerRecord.java | 26 +- .../gate/gateapi/models/LiquidateOrder.java | 14 +- .../io/gate/gateapi/models/MarginAccount.java | 14 +- .../gateapi/models/MarginAccountBook.java | 16 +- .../gateapi/models/MarginAccountCurrency.java | 14 +- .../gateapi/models/MarginLeverageTier.java | 10 +- .../gateapi/models/MarginMarketLeverage.java | 8 +- .../io/gate/gateapi/models/MarginTiers.java | 12 +- .../gateapi/models/MarginTransferable.java | 8 +- .../gate/gateapi/models/MaxUniBorrowable.java | 8 +- .../gate/gateapi/models/MockFuturesOrder.java | 10 +- .../gateapi/models/MockFuturesPosition.java | 8 +- .../gate/gateapi/models/MockMarginResult.java | 16 +- .../gate/gateapi/models/MockOptionsOrder.java | 10 +- .../gateapi/models/MockOptionsPosition.java | 8 +- .../io/gate/gateapi/models/MockRiskUnit.java | 22 +- .../gate/gateapi/models/MockSpotBalance.java | 8 +- .../io/gate/gateapi/models/MockSpotOrder.java | 14 +- .../gateapi/models/MultiChainAddressItem.java | 10 +- .../models/MultiCollateralCurrency.java | 8 +- .../gateapi/models/MultiCollateralItem.java | 8 +- .../gateapi/models/MultiCollateralOrder.java | 30 +- .../gateapi/models/MultiCollateralRecord.java | 18 +- .../models/MultiCollateralRecordCurrency.java | 14 +- .../io/gate/gateapi/models/MultiLoanItem.java | 6 +- .../gateapi/models/MultiLoanRepayItem.java | 8 +- .../gate/gateapi/models/MultiRepayRecord.java | 28 +- .../gate/gateapi/models/MultiRepayResp.java | 8 +- .../gate/gateapi/models/MyFuturesTrade.java | 26 +- .../models/MyFuturesTradeTimeRange.java | 26 +- .../io/gate/gateapi/models/OpenOrders.java | 6 +- .../gate/gateapi/models/OptionsAccount.java | 34 +- .../gateapi/models/OptionsAccountBook.java | 10 +- .../gateapi/models/OptionsCandlestick.java | 14 +- .../gate/gateapi/models/OptionsContract.java | 54 +- .../io/gate/gateapi/models/OptionsMMP.java | 14 +- .../gate/gateapi/models/OptionsMMPReset.java | 14 +- .../gateapi/models/OptionsMySettlements.java | 20 +- .../gate/gateapi/models/OptionsMyTrade.java | 20 +- .../io/gate/gateapi/models/OptionsOrder.java | 58 +- .../gate/gateapi/models/OptionsPosition.java | 34 +- .../gateapi/models/OptionsPositionClose.java | 16 +- .../models/OptionsPositionCloseOrder.java | 10 +- .../gateapi/models/OptionsSettlement.java | 14 +- .../io/gate/gateapi/models/OptionsTicker.java | 40 +- .../gateapi/models/OptionsUnderlying.java | 6 +- .../models/OptionsUnderlyingTicker.java | 10 +- .../java/io/gate/gateapi/models/Order.java | 64 +- .../io/gate/gateapi/models/OrderBook.java | 10 +- .../io/gate/gateapi/models/OrderCancel.java | 70 +- .../io/gate/gateapi/models/OrderPatch.java | 14 +- .../io/gate/gateapi/models/OrderResp.java | 4 +- .../models/PartnerCommissionHistory.java | 6 +- .../io/gate/gateapi/models/PartnerSub.java | 8 +- .../gate/gateapi/models/PartnerSubList.java | 6 +- .../models/PartnerTransactionHistory.java | 6 +- .../io/gate/gateapi/models/PatchUniLend.java | 6 +- .../models/PlaceDualInvestmentOrder.java | 10 +- .../java/io/gate/gateapi/models/Position.java | 62 +- .../io/gate/gateapi/models/PositionClose.java | 30 +- .../gateapi/models/PositionCloseOrder.java | 10 +- .../gate/gateapi/models/ProfitLossRange.java | 10 +- .../gate/gateapi/models/RebateUserInfo.java | 6 +- .../gate/gateapi/models/RepayCurrencyRes.java | 14 +- .../io/gate/gateapi/models/RepayLoan.java | 8 +- .../gate/gateapi/models/RepayMultiLoan.java | 8 +- .../io/gate/gateapi/models/RepayRecord.java | 30 +- .../gateapi/models/RepayRecordCurrency.java | 14 +- .../models/RepayRecordLeftInterest.java | 14 +- .../models/RepayRecordRepaidCurrency.java | 14 +- .../models/RepayRecordTotalInterest.java | 10 +- .../io/gate/gateapi/models/RepayResp.java | 8 +- .../io/gate/gateapi/models/RiskUnits.java | 18 +- .../io/gate/gateapi/models/SavedAddress.java | 14 +- .../io/gate/gateapi/models/SmallBalance.java | 12 +- .../gateapi/models/SmallBalanceHistory.java | 14 +- .../io/gate/gateapi/models/SpotAccount.java | 10 +- .../gate/gateapi/models/SpotAccountBook.java | 16 +- .../gateapi/models/SpotCurrencyChain.java | 12 +- .../java/io/gate/gateapi/models/SpotFee.java | 18 +- .../gateapi/models/SpotInsuranceHistory.java | 8 +- .../gateapi/models/SpotPricePutOrder.java | 16 +- .../gate/gateapi/models/SpotPriceTrigger.java | 10 +- .../models/SpotPriceTriggeredOrder.java | 20 +- .../java/io/gate/gateapi/models/StpGroup.java | 10 +- .../io/gate/gateapi/models/StpGroupUser.java | 8 +- .../io/gate/gateapi/models/StructuredBuy.java | 8 +- .../models/StructuredGetProjectList.java | 26 +- .../gateapi/models/StructuredOrderList.java | 16 +- .../io/gate/gateapi/models/SubAccount.java | 16 +- .../gateapi/models/SubAccountBalance.java | 6 +- .../models/SubAccountCrossMarginBalance.java | 4 +- .../models/SubAccountFuturesBalance.java | 6 +- .../io/gate/gateapi/models/SubAccountKey.java | 20 +- .../gateapi/models/SubAccountKeyPerms.java | 6 +- .../models/SubAccountMarginBalance.java | 6 +- .../models/SubAccountToSubAccount.java | 16 +- .../gateapi/models/SubAccountTransfer.java | 14 +- .../models/SubAccountTransferRecordItem.java | 22 +- .../gateapi/models/SubCrossMarginAccount.java | 28 +- .../io/gate/gateapi/models/SubUserMode.java | 8 +- .../java/io/gate/gateapi/models/SwapCoin.java | 12 +- .../gate/gateapi/models/SwapCoinStruct.java | 28 +- .../io/gate/gateapi/models/SystemTime.java | 4 +- .../java/io/gate/gateapi/models/Ticker.java | 36 +- .../io/gate/gateapi/models/TotalBalance.java | 6 +- .../java/io/gate/gateapi/models/Trade.java | 38 +- .../java/io/gate/gateapi/models/TradeFee.java | 24 +- .../io/gate/gateapi/models/TransactionID.java | 4 +- .../java/io/gate/gateapi/models/Transfer.java | 18 +- .../gateapi/models/TransferOrderStatus.java | 6 +- .../gateapi/models/TransferablesResult.java | 8 +- .../gateapi/models/TriggerOrderResponse.java | 4 +- .../io/gate/gateapi/models/TriggerTime.java | 4 +- .../io/gate/gateapi/models/UidPushOrder.java | 20 +- .../gateapi/models/UidPushWithdrawal.java | 8 +- .../gateapi/models/UidPushWithdrawalResp.java | 4 +- .../io/gate/gateapi/models/UniCurrency.java | 14 +- .../gateapi/models/UniCurrencyInterest.java | 4 +- .../gate/gateapi/models/UniCurrencyPair.java | 12 +- .../gateapi/models/UniInterestRecord.java | 14 +- .../java/io/gate/gateapi/models/UniLend.java | 22 +- .../gate/gateapi/models/UniLendInterest.java | 6 +- .../io/gate/gateapi/models/UniLendRecord.java | 18 +- .../java/io/gate/gateapi/models/UniLoan.java | 16 +- .../gateapi/models/UniLoanInterestRecord.java | 18 +- .../io/gate/gateapi/models/UniLoanRecord.java | 14 +- .../gate/gateapi/models/UnifiedAccount.java | 24 +- .../gate/gateapi/models/UnifiedBalance.java | 22 +- .../gateapi/models/UnifiedBorrowable.java | 6 +- .../gateapi/models/UnifiedBorrowable1.java | 8 +- .../gateapi/models/UnifiedCollateralReq.java | 10 +- .../gateapi/models/UnifiedCollateralRes.java | 6 +- .../gate/gateapi/models/UnifiedCurrency.java | 14 +- .../gate/gateapi/models/UnifiedDiscount.java | 8 +- .../gateapi/models/UnifiedDiscountTiers.java | 12 +- .../models/UnifiedHistoryLoanRate.java | 10 +- .../models/UnifiedHistoryLoanRateRates.java | 6 +- .../gateapi/models/UnifiedLeverageConfig.java | 16 +- .../models/UnifiedLeverageSetting.java | 8 +- .../io/gate/gateapi/models/UnifiedLoan.java | 16 +- .../gateapi/models/UnifiedLoanRecord.java | 20 +- .../gateapi/models/UnifiedLoanResult.java | 6 +- .../gateapi/models/UnifiedMarginTiers.java | 8 +- .../gate/gateapi/models/UnifiedModeSet.java | 4 +- .../gateapi/models/UnifiedPortfolioInput.java | 18 +- .../models/UnifiedPortfolioOutput.java | 12 +- .../gate/gateapi/models/UnifiedRiskUnits.java | 8 +- .../gate/gateapi/models/UnifiedSettings.java | 10 +- .../gateapi/models/UnifiedTransferable.java | 6 +- .../io/gate/gateapi/models/UserLtvInfo.java | 18 +- .../java/io/gate/gateapi/models/UserSub.java | 10 +- .../gate/gateapi/models/UserSubRelation.java | 4 +- .../gate/gateapi/models/UserTotalAmount.java | 8 +- .../gate/gateapi/models/WithdrawStatus.java | 26 +- .../gate/gateapi/models/WithdrawalRecord.java | 26 +- 561 files changed, 9155 insertions(+), 9156 deletions(-) diff --git a/README.md b/README.md index 1b94cad..9a9b4ca 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,11 @@ Gate API -- API version: v4.103.0 -- SDK version: 6.103.0 +- API version: v4.104.3 +- SDK version: 6.104.3 Welcome to Gate API - APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces -for implementing API-based automated trading. +APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. For more information, please visit [https://www.gate.com/page/contacts](https://www.gate.com/page/contacts) @@ -53,7 +52,7 @@ Add this dependency to your project's POM: io.gate gate-api - 6.103.0 + 6.104.3 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.103.0" +compile "io.gate:gate-api:6.104.3" ``` ### Others @@ -76,7 +75,7 @@ mvn clean package Then manually install the following JARs: -* `target/gate-api-6.103.0.jar` +* `target/gate-api-6.104.3.jar` * `target/lib/*.jar` To install the API client library to your local Maven repository, simply execute: @@ -141,288 +140,288 @@ 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* | [**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. -*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* | [**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* | [**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. -*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* | [**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. -*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 | 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* | [**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. -*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* | [**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. -*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* | [**updateDualCompPositionCrossMode**](docs/FuturesApi.md#updateDualCompPositionCrossMode) | **POST** /futures/{settle}/dual_comp/positions/cross_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* | [**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* | [**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* | [**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 | 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. -*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* | [**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* | [**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. -*MarginApi* | [**listCrossMarginLoans**](docs/MarginApi.md#listCrossMarginLoans) | **GET** /margin/cross/loans | List cross margin borrow history. (deprecated). -*MarginApi* | [**listCrossMarginRepayments**](docs/MarginApi.md#listCrossMarginRepayments) | **GET** /margin/cross/repayments | Retrieve cross margin repayments. (deprecated). -*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* | [**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. -*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. -*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* | [**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* | [**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. +*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 | 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 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 | 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 | 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 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 +*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 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 | 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} | 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 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 | 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 | 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 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 | 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 | 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) +*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 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 | 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 | 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 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 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 | 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* | [**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. -*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* | [**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* | [**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. -*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* | [**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* | [**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* | [**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* | [**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* | [**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. -*UnifiedApi* | [**setUnifiedCollateral**](docs/UnifiedApi.md#setUnifiedCollateral) | **POST** /unified/collateral_currencies | Set Collateral Currency. -*WalletApi* | [**listCurrencyChains**](docs/WalletApi.md#listCurrencyChains) | **GET** /wallet/currency_chains | List 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* | [**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* | [**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* | [**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. -*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. +*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 | 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* | [**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 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 | 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 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 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 | 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 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 discount +*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 | 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 +*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 | 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 | 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 | 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 | 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 ## Documentation for Models diff --git a/build.gradle b/build.gradle index 83eef29..1d63fbe 100644 --- a/build.gradle +++ b/build.gradle @@ -3,7 +3,7 @@ apply plugin: 'eclipse' apply plugin: 'java' group = 'io.gate' -version = '6.103.0' +version = '6.104.3' buildscript { repositories { diff --git a/build.sbt b/build.sbt index 33a5aae..43e0e88 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.103.0", + version := "6.104.3", scalaVersion := "2.11.4", scalacOptions ++= Seq("-feature"), javacOptions in compile ++= Seq("-Xlint:deprecation"), diff --git a/docs/AccountApi.md b/docs/AccountApi.md index 5b6be5b..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. -[**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. +[**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 | 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,13 +77,13 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful. | - | +**200** | Successfully retrieved | - | # **getAccountRateLimit** > List<AccountRateLimit> getAccountRateLimit() -Get user transaction rate limit information. +Get user transaction rate limit information ### Example @@ -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,15 +213,15 @@ 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. +Only the main account is allowed to create a new STP user group ### Example @@ -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 can query the account. +Only the main account that created this STP group can query the account ID list in the current STP group ### Example @@ -314,7 +314,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); AccountApi apiInstance = new AccountApi(defaultClient); - Long stpId = 1L; // Long | STP Group ID. + Long stpId = 1L; // Long | STP Group ID try { List result = apiInstance.listSTPGroupsUsers(stpId); System.out.println(result); @@ -335,7 +335,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **stpId** | **Long**| STP Group ID. | + **stpId** | **Long**| STP Group ID | ### Return type @@ -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 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 @@ -384,8 +384,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); AccountApi apiInstance = new AccountApi(defaultClient); - Long stpId = 1L; // Long | STP Group ID. - List requestBody = Arrays.asList(); // List | User ID. + Long stpId = 1L; // Long | STP Group ID + List requestBody = Arrays.asList(); // List | User ID try { List result = apiInstance.addSTPGroupUsers(stpId, requestBody); System.out.println(result); @@ -406,8 +406,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **stpId** | **Long**| STP Group ID. | - **requestBody** | [**List<Long>**](Long.md)| User ID. | + **stpId** | **Long**| STP Group ID | + **requestBody** | [**List<Long>**](Long.md)| User ID | ### Return type @@ -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 @@ -456,8 +456,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 stpId = 1L; // Long | STP Group ID + 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); @@ -478,8 +478,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **stpId** | **Long**| STP Group ID. | - **userId** | **Long**| STP user ID, multiple can be separated by commas. | + **stpId** | **Long**| STP Group ID | + **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 @@ -563,15 +563,15 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success. | - | +**200** | Success | - | # **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 @@ -632,5 +632,5 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success. | - | +**200** | Success | - | diff --git a/docs/AccountBalance.md b/docs/AccountBalance.md index c9462db..1bb2651 100644 --- a/docs/AccountBalance.md +++ b/docs/AccountBalance.md @@ -1,16 +1,16 @@ # AccountBalance -Total balances calculated with specified currency unit. +Total balances calculated with specified currency unit ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**amount** | **String** | Account total balance amount. | [optional] -**currency** | [**CurrencyEnum**](#CurrencyEnum) | Currency. | [optional] +**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 70e557e..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] -**userId** | **Long** | User ID. | [optional] -**tier** | **Long** | User VIP level. | [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 - Normal user, 1 - Copy trading leader, follower, 3 - Both 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 96dce1d..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 cd486c8..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] -**updatedAt** | **String** | Update time. | [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 249ec82..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] -**userId** | **Long** | User ID. | [optional] -**groupName** | **String** | Group name. | [optional] -**commissionAmount** | **String** | Commission Amount. | [optional] -**commissionAsset** | **String** | Commission Asset. | [optional] -**source** | **String** | Source. SPOT - SPOT Rebate, FUTURES - Futures Rebate. | [optional] +**commissionTime** | **Long** | Commission time (Unix timestamp in seconds) | [optional] +**userId** | **Long** | User ID | [optional] +**groupName** | **String** | Group name | [optional] +**commissionAmount** | **String** | Transaction amount | [optional] +**commissionAsset** | **String** | Commission Asset | [optional] +**source** | **String** | Commission source: SPOT - Spot commission, FUTURES - Futures commission | [optional] diff --git a/docs/AgencyCommissionHistory.md b/docs/AgencyCommissionHistory.md index a89026e..d74cc13 100644 --- a/docs/AgencyCommissionHistory.md +++ b/docs/AgencyCommissionHistory.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currencyPair** | **String** | Currency pair. | [optional] -**total** | **Long** | Total. | [optional] -**list** | [**List<AgencyCommission>**](AgencyCommission.md) | List of comission history. | [optional] +**currencyPair** | **String** | Currency pair | [optional] +**total** | **Long** | Total | [optional] +**list** | [**List<AgencyCommission>**](AgencyCommission.md) | List of commission history | [optional] diff --git a/docs/AgencyTransaction.md b/docs/AgencyTransaction.md index 08e607d..4483e3f 100644 --- a/docs/AgencyTransaction.md +++ b/docs/AgencyTransaction.md @@ -5,13 +5,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**transactionTime** | **Long** | Transaction Time. (unix timestamp). | [optional] -**userId** | **Long** | User ID. | [optional] -**groupName** | **String** | Group name. | [optional] -**fee** | **String** | Fee. | [optional] -**feeAsset** | **String** | Fee currency. | [optional] -**currencyPair** | **String** | Currency pair. | [optional] -**amount** | **String** | Commission Amount. | [optional] -**amountAsset** | **String** | Commission Asset. | [optional] -**source** | **String** | Source. SPOT - SPOT Rebate, FUTURES - Futures Rebate. | [optional] +**transactionTime** | **Long** | Transaction Time. (unix timestamp) | [optional] +**userId** | **Long** | User ID | [optional] +**groupName** | **String** | Group name | [optional] +**fee** | **String** | Fee | [optional] +**feeAsset** | **String** | Fee currency | [optional] +**currencyPair** | **String** | Currency pair | [optional] +**amount** | **String** | Transaction amount | [optional] +**amountAsset** | **String** | Commission Asset | [optional] +**source** | **String** | Commission source: SPOT - Spot commission, FUTURES - Futures commission | [optional] diff --git a/docs/AgencyTransactionHistory.md b/docs/AgencyTransactionHistory.md index b10a6c3..2a78460 100644 --- a/docs/AgencyTransactionHistory.md +++ b/docs/AgencyTransactionHistory.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currencyPair** | **String** | Currency pair. | [optional] -**total** | **Long** | Total. | [optional] -**list** | [**List<AgencyTransaction>**](AgencyTransaction.md) | List of transaction history. | [optional] +**currencyPair** | **String** | Currency pair | [optional] +**total** | **Long** | Total | [optional] +**list** | [**List<AgencyTransaction>**](AgencyTransaction.md) | List of transaction history | [optional] diff --git a/docs/AutoRepaySetting.md b/docs/AutoRepaySetting.md index ddc3a88..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 d068ae6..e37ee0d 100644 --- a/docs/BatchAmendItem.md +++ b/docs/BatchAmendItem.md @@ -1,17 +1,17 @@ # BatchAmendItem -Order information that needs to be modified. +Order information that needs to be modified ## Properties 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). | -**currencyPair** | **String** | Currency pair. | -**account** | **String** | Default spot, unified account and warehouse-by-store leverage account. | [optional] -**amount** | **String** | Trading Quantity. Only one of amountor pricecan be specified. | [optional] -**price** | **String** | Trading Price. Only one of amountor pricecan be specified. | [optional] -**amendText** | **String** | Custom info during amending order. | [optional] +**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** | 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 935312f..b4a5a3b 100644 --- a/docs/BatchAmendOrderReq.md +++ b/docs/BatchAmendOrderReq.md @@ -1,15 +1,15 @@ # BatchAmendOrderReq -Modify contract order parameters. +Modify contract order parameters ## Properties 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, 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] +**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** | 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 e8aa664..5ed54b4 100644 --- a/docs/BatchFuturesOrder.md +++ b/docs/BatchFuturesOrder.md @@ -1,39 +1,39 @@ # BatchFuturesOrder -Futures order details. +Futures order details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**succeeded** | **Boolean** | Whether the batch of orders succeeded. | [optional] -**label** | **String** | Error label, only exists if execution fails. | [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 - 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] -**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] -**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] +**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 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** | 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] +**tkfr** | **String** | Taker fee | [optional] [readonly] +**mkfr** | **String** | Maker fee | [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, 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 1225438..36702e2 100644 --- a/docs/BatchOrder.md +++ b/docs/BatchOrder.md @@ -1,46 +1,46 @@ # BatchOrder -Batch order details. +Batch order details ## Properties 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] -**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] -**createTime** | **String** | Creation time of order. | [optional] [readonly] -**updateTime** | **String** | Last modification time of order. | [optional] [readonly] -**createTimeMs** | **Long** | Creation time of order (in milliseconds). | [optional] [readonly] -**updateTimeMs** | **Long** | Last modification time of order (in milliseconds). | [optional] [readonly] +**orderId** | **String** | Order ID | [optional] +**amendText** | **String** | The custom data that the user remarked when amending the order | [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] +**createTime** | **String** | Creation time of order | [optional] [readonly] +**updateTime** | **String** | Last modification time of order | [optional] [readonly] +**createTimeMs** | **Long** | Creation time of order (in milliseconds) | [optional] [readonly] +**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] +**currencyPair** | **String** | Currency pair | [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) | Buy or sell order. | [optional] -**amount** | **String** | Trade amount. | [optional] -**price** | **String** | Order price. | [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] -**left** | **String** | Amount left to fill. | [optional] [readonly] -**filledAmount** | **String** | Amount traded to fill. | [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] -**fee** | **String** | Fee deducted. | [optional] [readonly] -**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] -**rebatedFee** | **String** | Rebated fee. | [optional] [readonly] -**rebatedFeeCurrency** | **String** | Rebated fee currency unit. | [optional] [readonly] +**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 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] +**fee** | **String** | Fee deducted | [optional] [readonly] +**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 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, 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] diff --git a/docs/BorrowCurrencyInfo.md b/docs/BorrowCurrencyInfo.md index 3ff744b..7fe459d 100644 --- a/docs/BorrowCurrencyInfo.md +++ b/docs/BorrowCurrencyInfo.md @@ -5,9 +5,9 @@ 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] +**currency** | **String** | Currency | [optional] +**indexPrice** | **String** | Currency Index Price | [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 314c1b9..7a88b21 100644 --- a/docs/BrokerCommission.md +++ b/docs/BrokerCommission.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**total** | **Long** | Total. | [optional] -**list** | [**List<BrokerCommission1>**](BrokerCommission1.md) | List of comission history. | [optional] +**total** | **Long** | Total | [optional] +**list** | [**List<BrokerCommission1>**](BrokerCommission1.md) | List of commission history | [optional] diff --git a/docs/BrokerCommission1.md b/docs/BrokerCommission1.md index a27f115..761aa6b 100644 --- a/docs/BrokerCommission1.md +++ b/docs/BrokerCommission1.md @@ -5,15 +5,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**commissionTime** | **Long** | Commission Time. (unix timestamp). | [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.、Alpha | [optional] -**currencyPair** | **String** | Currency pair. | [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** | Commission transaction type: Spot, Futures, Options, Alpha | [optional] +**currencyPair** | **String** | Currency pair | [optional] **subBrokerInfo** | [**BrokerCommissionSubBrokerInfo**](BrokerCommissionSubBrokerInfo.md) | | [optional] -**alphaContractAddr** | **String** | Alpha token address | [optional] +**alphaContractAddr** | **String** | Alpha contract address | [optional] diff --git a/docs/BrokerCommissionSubBrokerInfo.md b/docs/BrokerCommissionSubBrokerInfo.md index 235c831..9c71f9c 100644 --- a/docs/BrokerCommissionSubBrokerInfo.md +++ b/docs/BrokerCommissionSubBrokerInfo.md @@ -1,14 +1,14 @@ # BrokerCommissionSubBrokerInfo -The sub broker info. +Sub-broker information ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Long** | The sub broker user ID. | [optional] -**originalCommissionRate** | **String** | The sub broker original commission rate. | [optional] -**relativeCommissionRate** | **String** | The sub broker relative commission rate. | [optional] -**commissionRate** | **String** | The sub broker actual commission rate. | [optional] +**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/BrokerTransaction.md b/docs/BrokerTransaction.md index 26381e8..3dafae9 100644 --- a/docs/BrokerTransaction.md +++ b/docs/BrokerTransaction.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**total** | **Long** | Total. | [optional] -**list** | [**List<BrokerTransaction1>**](BrokerTransaction1.md) | List of transaction history. | [optional] +**total** | **Long** | Total | [optional] +**list** | [**List<BrokerTransaction1>**](BrokerTransaction1.md) | List of transaction history | [optional] diff --git a/docs/BrokerTransaction1.md b/docs/BrokerTransaction1.md index 099aa77..627d8ce 100644 --- a/docs/BrokerTransaction1.md +++ b/docs/BrokerTransaction1.md @@ -5,14 +5,14 @@ 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] -**currencyPair** | **String** | Currency pair. | [optional] -**amount** | **String** | Commission Amount. | [optional] -**feeAsset** | **String** | Fee currency. | [optional] -**source** | **String** | Rebate Type: Spot、Futures、Options.、Alpha | [optional] +**transactionTime** | **Long** | Transaction Time. (unix timestamp) | [optional] +**userId** | **Long** | User ID | [optional] +**groupName** | **String** | Group name | [optional] +**fee** | **String** | Fee amount (USDT) | [optional] +**currencyPair** | **String** | Currency pair | [optional] +**amount** | **String** | Transaction amount | [optional] +**feeAsset** | **String** | Fee currency | [optional] +**source** | **String** | Commission transaction type: Spot, Futures, Options, Alpha | [optional] **subBrokerInfo** | [**BrokerCommissionSubBrokerInfo**](BrokerCommissionSubBrokerInfo.md) | | [optional] -**alphaContractAddr** | **String** | Alpha token address | [optional] +**alphaContractAddr** | **String** | Alpha contract address | [optional] diff --git a/docs/CancelBatchOrder.md b/docs/CancelBatchOrder.md index 67e55df..be6fb13 100644 --- a/docs/CancelBatchOrder.md +++ b/docs/CancelBatchOrder.md @@ -1,13 +1,13 @@ # CancelBatchOrder -Info of order to be cancelled. +Info of order to be cancelled ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currencyPair** | **String** | Order currency pair. | +**currencyPair** | **String** | Order currency pair | **id** | **String** | Order ID or user custom ID. Custom ID are accepted only within 30 minutes after order creation | **account** | **String** | If the canceled order is a unified account apikey, this field must be specified and set to `unified` | [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/CancelOrderResult.md b/docs/CancelOrderResult.md index 8c07a8c..2e4c268 100644 --- a/docs/CancelOrderResult.md +++ b/docs/CancelOrderResult.md @@ -1,17 +1,17 @@ # CancelOrderResult -Order cancellation result. +Order cancellation result ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currencyPair** | **String** | Order currency pair. | [optional] -**id** | **String** | Order ID. | [optional] -**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] -**account** | **String** | Default is empty (deprecated). | [optional] +**currencyPair** | **String** | Order currency pair | [optional] +**id** | **String** | Order ID | [optional] +**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 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 af3862c..3f7aecf 100644 --- a/docs/CollateralAdjust.md +++ b/docs/CollateralAdjust.md @@ -5,7 +5,7 @@ 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] +**orderId** | **Long** | Order ID | +**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 ccc05b6..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] +**orderId** | **Long** | Order ID | [optional] +**collateralCurrencies** | [**List<CollateralCurrencyRes>**](CollateralCurrencyRes.md) | Collateral currency information | [optional] diff --git a/docs/CollateralAlign.md b/docs/CollateralAlign.md index 5f5cf12..022b44b 100644 --- a/docs/CollateralAlign.md +++ b/docs/CollateralAlign.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**orderId** | **Long** | Order ID. | -**collateralCurrency** | **String** | Collateral. | -**collateralAmount** | **String** | Collateral amount. | -**type** | **String** | Operation types: append - for adding collateral, redeem - for withdrawing collateral | +**orderId** | **Long** | Order ID | +**collateralCurrency** | **String** | Collateral currency | +**collateralAmount** | **String** | Collateral amount | +**type** | **String** | Operation type: append - add collateral, redeem - withdraw collateral | diff --git a/docs/CollateralCurrency.md b/docs/CollateralCurrency.md index f9c833b..a05a724 100644 --- a/docs/CollateralCurrency.md +++ b/docs/CollateralCurrency.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency. | [optional] -**amount** | **String** | Size. | [optional] +**currency** | **String** | Currency | [optional] +**amount** | **String** | Size | [optional] diff --git a/docs/CollateralCurrencyInfo.md b/docs/CollateralCurrencyInfo.md index fd98fc3..2c87685 100644 --- a/docs/CollateralCurrencyInfo.md +++ b/docs/CollateralCurrencyInfo.md @@ -5,8 +5,8 @@ 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] +**currency** | **String** | Currency | [optional] +**indexPrice** | **String** | Currency Index Price | [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 82c0505..d0bad83 100644 --- a/docs/CollateralCurrencyRes.md +++ b/docs/CollateralCurrencyRes.md @@ -5,9 +5,9 @@ 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] -**currency** | **String** | Currency. | [optional] -**amount** | **String** | Quantity of successful collateral operation; 0 if the operation fails. | [optional] +**succeeded** | **Boolean** | Update success status | [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** | Successfully operated collateral quantity; 0 if operation fails | [optional] diff --git a/docs/CollateralCurrentRate.md b/docs/CollateralCurrentRate.md index 0c4d9ad..3594c07 100644 --- a/docs/CollateralCurrentRate.md +++ b/docs/CollateralCurrentRate.md @@ -1,12 +1,12 @@ # CollateralCurrentRate -Multi-currency pledge current interest rate. +Multi-collateral current interest rate ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency. | [optional] -**currentRate** | **String** | Currency current interest rate. | [optional] +**currency** | **String** | Currency | [optional] +**currentRate** | **String** | Currency current interest rate | [optional] diff --git a/docs/CollateralFixRate.md b/docs/CollateralFixRate.md index dde7626..1d725e3 100644 --- a/docs/CollateralFixRate.md +++ b/docs/CollateralFixRate.md @@ -1,14 +1,14 @@ # CollateralFixRate -Multi-collateral fixed interest rate. +Multi-collateral fixed interest rate ## Properties 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] +**currency** | **String** | Currency | [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 d7e468e..881aa73 100644 --- a/docs/CollateralLoanApi.md +++ b/docs/CollateralLoanApi.md @@ -4,23 +4,23 @@ 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. -[**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. -[**listCollateralCurrencies**](CollateralLoanApi.md#listCollateralCurrencies) | **GET** /loan/collateral/currencies | Query supported borrowing and collateral currencies. +[**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 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 # **listCollateralLoanOrders** > List<CollateralOrder> listCollateralLoanOrders().page(page).limit(limit).collateralCurrency(collateralCurrency).borrowCurrency(borrowCurrency).execute(); -List Orders. +Query collateral loan order list ### Example @@ -43,10 +43,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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. - String borrowCurrency = "USDT"; // String | Borrowed currency. + Integer page = 1; // Integer | Page number + 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() .page(page) @@ -72,10 +72,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 100] - **collateralCurrency** | **String**| Collateral. | [optional] - **borrowCurrency** | **String**| Borrowed currency. | [optional] + **page** | **Integer**| Page number | [optional] [default to 1] + **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 @@ -326,13 +326,13 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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. - 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. + String source = "repay"; // String | Operation type: repay - Regular repayment, liquidate - Liquidation + String borrowCurrency = "USDT"; // String | Borrowed currency + String collateralCurrency = "BTC"; // String | Collateral currency + Integer page = 1; // Integer | Page number + 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) @@ -360,13 +360,13 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **source** | **String**| Operation type: repay - Regular repayment, liquidate - Liquidation. | - **borrowCurrency** | **String**| Borrowed currency. | [optional] - **collateralCurrency** | **String**| Collateral. | [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] + **source** | **String**| Operation type: repay - Regular repayment, liquidate - Liquidation | + **borrowCurrency** | **String**| Borrowed currency | [optional] + **collateralCurrency** | **String**| Collateral currency | [optional] + **page** | **Integer**| Page number | [optional] [default to 1] + **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,13 +384,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved. | - | +**200** | Query successful | - | # **listCollateralRecords** > List<CollateralRecord> listCollateralRecords().page(page).limit(limit).from(from).to(to).borrowCurrency(borrowCurrency).collateralCurrency(collateralCurrency).execute(); -Query collateral adjustment records. +Query collateral adjustment records ### Example @@ -413,12 +413,12 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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. - String borrowCurrency = "USDT"; // String | Borrowed currency. - String collateralCurrency = "BTC"; // String | Collateral. + Integer page = 1; // Integer | Page number + 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 currency try { List result = apiInstance.listCollateralRecords() .page(page) @@ -446,12 +446,12 @@ 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] - **borrowCurrency** | **String**| Borrowed currency. | [optional] - **collateralCurrency** | **String**| Collateral. | [optional] + **page** | **Integer**| Page number | [optional] [default to 1] + **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 currency | [optional] ### Return type @@ -469,13 +469,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved. | - | +**200** | Query successful | - | # **operateCollateral** > operateCollateral(collateralAlign) -Increase or redeem collateral. +Increase or redeem collateral ### Example @@ -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,8 +629,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); CollateralLoanApi apiInstance = new CollateralLoanApi(defaultClient); - String collateralCurrency = "BTC"; // String | Collateral. - String borrowCurrency = "USDT"; // String | Borrowed currency. + String collateralCurrency = "BTC"; // String | Collateral currency + String borrowCurrency = "USDT"; // String | Borrowed currency try { UserLtvInfo result = apiInstance.getUserLtvInfo(collateralCurrency, borrowCurrency); System.out.println(result); @@ -651,8 +651,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **collateralCurrency** | **String**| Collateral. | - **borrowCurrency** | **String**| Borrowed currency. | + **collateralCurrency** | **String**| Collateral currency | + **borrowCurrency** | **String**| Borrowed currency | ### Return type @@ -670,13 +670,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved. | - | +**200** | Query successful | - | # **listCollateralCurrencies** > List<CollateralLoanCurrency> listCollateralCurrencies().loanCurrency(loanCurrency).execute(); -Query supported borrowing and collateral currencies. +Query supported borrowing and collateral currencies ### Example @@ -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. + 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. | [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/CollateralLoanCurrency.md b/docs/CollateralLoanCurrency.md index e0da6d6..92bdf8a 100644 --- a/docs/CollateralLoanCurrency.md +++ b/docs/CollateralLoanCurrency.md @@ -1,12 +1,12 @@ # CollateralLoanCurrency -Supported borrowing and collateral currencies. +Supported borrowing and collateral currencies ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**loanCurrency** | **String** | Borrowed currency. | [optional] -**collateralCurrency** | **List<String>** | List of supported collateral currencies. | [optional] +**loanCurrency** | **String** | Borrowed currency | [optional] +**collateralCurrency** | **List<String>** | List of supported collateral currencies | [optional] diff --git a/docs/CollateralLtv.md b/docs/CollateralLtv.md index 66d3322..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 b6be0de..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] -**collateralAmount** | **String** | Collateral amount. | [optional] -**borrowCurrency** | **String** | Borrowed currency. | [optional] -**borrowAmount** | **String** | Borrowing 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] +**orderId** | **Long** | Order ID | [optional] +**collateralCurrency** | **String** | Collateral currency | [optional] +**collateralAmount** | **String** | Collateral amount | [optional] +**borrowCurrency** | **String** | Borrowed currency | [optional] +**borrowAmount** | **String** | Borrowed amount | [optional] +**repaidAmount** | **String** | Repaid amount | [optional] +**repaidPrincipal** | **String** | Repaid principal | [optional] +**repaidInterest** | **String** | Repaid interest | [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] +**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 8e45007..da9834c 100644 --- a/docs/CollateralRecord.md +++ b/docs/CollateralRecord.md @@ -1,20 +1,20 @@ # CollateralRecord -Collateral record. +Collateral record ## Properties 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] +**orderId** | **Long** | Order ID | [optional] +**recordId** | **Long** | Collateral record ID | [optional] +**borrowCurrency** | **String** | Borrowed currency | [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 abb37af..7fc13c9 100644 --- a/docs/Contract.md +++ b/docs/Contract.md @@ -1,50 +1,50 @@ # Contract -Futures contract details. +Futures contract details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | Futures contract. | [optional] -**type** | [**TypeEnum**](#TypeEnum) | Futures contract type. | [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, 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] -**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] -**tradeId** | **Long** | Current trade ID. | [optional] -**tradeSize** | **Long** | Historical accumulated trade size. | [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` contract is offline | [optional] -**ordersLimit** | **Integer** | Maximum number of open orders. | [optional] -**enableBonus** | **Boolean** | Whether bouns is enabled. | [optional] -**enableCredit** | **Boolean** | Whether portfolio margin account is enabled. | [optional] -**createTime** | **Double** | Created time of the contract. | [optional] +**name** | **String** | Futures contract | [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 - 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, 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** | 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 cumulative trading volume | [optional] +**positionSize** | **Long** | Current total long position size | [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, trading, delisting, delisted. | [optional] -**launchTime** | **Long** | Contract expiry timestamp. | [optional] +**status** | **String** | Contract status types include: prelaunch (pre-launch), trading (active), delisting (delisting), delisted (delisted) | [optional] +**launchTime** | **Long** | Contract expiry timestamp | [optional] ## Enum: TypeEnum diff --git a/docs/ContractStat.md b/docs/ContractStat.md index 6952af2..ee844d1 100644 --- a/docs/ContractStat.md +++ b/docs/ContractStat.md @@ -5,17 +5,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] -**topLsrAccount** | **Double** | Top trader long/short account ratio. | [optional] -**topLsrSize** | **Double** | Top trader long/short position ratio. | [optional] +**time** | **Long** | Stat timestamp | [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] diff --git a/docs/ConvertSmallBalance.md b/docs/ConvertSmallBalance.md index d130582..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 79c0ca2..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 countdown | -**contract** | **String** | Futures contract. | [optional] +**contract** | **String** | Futures contract | [optional] diff --git a/docs/CountdownCancelAllOptionsTask.md b/docs/CountdownCancelAllOptionsTask.md index 08de556..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 countdown | -**contract** | **String** | Options contract name. | [optional] -**underlying** | **String** | Underlying. | [optional] +**contract** | **String** | Options contract name | [optional] +**underlying** | **String** | Underlying | [optional] diff --git a/docs/CountdownCancelAllSpotTask.md b/docs/CountdownCancelAllSpotTask.md index f31548a..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 countdown | -**currencyPair** | **String** | Currency pair. | [optional] +**currencyPair** | **String** | Currency pair | [optional] diff --git a/docs/CreateCollateralOrder.md b/docs/CreateCollateralOrder.md index 47391bb..9d28efe 100644 --- a/docs/CreateCollateralOrder.md +++ b/docs/CreateCollateralOrder.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**collateralAmount** | **String** | Collateral amount. | -**collateralCurrency** | **String** | Collateral. | -**borrowAmount** | **String** | Borrowing amount. | -**borrowCurrency** | **String** | Borrowed currency. | +**collateralAmount** | **String** | Collateral amount | +**collateralCurrency** | **String** | Collateral currency | +**borrowAmount** | **String** | Borrowed amount | +**borrowCurrency** | **String** | Borrowed currency | diff --git a/docs/CreateMultiCollateralOrder.md b/docs/CreateMultiCollateralOrder.md index 913c262..73b75d2 100644 --- a/docs/CreateMultiCollateralOrder.md +++ b/docs/CreateMultiCollateralOrder.md @@ -5,13 +5,13 @@ 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] -**borrowCurrency** | **String** | Borrowed currency. | -**borrowAmount** | **String** | Borrowing amount. | -**collateralCurrencies** | [**List<CollateralCurrency>**](CollateralCurrency.md) | Collateral currency and amount. | [optional] +**orderId** | **String** | Order ID | [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** | Borrowed amount | +**collateralCurrencies** | [**List<CollateralCurrency>**](CollateralCurrency.md) | Collateral currency and amount | [optional] diff --git a/docs/CreateUniLend.md b/docs/CreateUniLend.md index 5cf797c..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] +**currency** | **String** | Currency name | +**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 ea33789..350308f 100644 --- a/docs/CreateUniLoan.md +++ b/docs/CreateUniLoan.md @@ -1,17 +1,17 @@ # CreateUniLoan -Borrow or repay. +Borrow or repay ## Properties 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 repaid in full. | [optional] -**currencyPair** | **String** | Currency pair. | +**currency** | **String** | Currency | +**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/CrossMarginBalance.md b/docs/CrossMarginBalance.md index 76cd66b..347d99a 100644 --- a/docs/CrossMarginBalance.md +++ b/docs/CrossMarginBalance.md @@ -5,8 +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] +**available** | **String** | Available balance | [optional] +**freeze** | **String** | Locked balance | [optional] +**borrowed** | **String** | Borrowed balance | [optional] +**interest** | **String** | Unpaid interest | [optional] diff --git a/docs/CrossMarginLoan.md b/docs/CrossMarginLoan.md index 255d3ac..3572614 100644 --- a/docs/CrossMarginLoan.md +++ b/docs/CrossMarginLoan.md @@ -5,16 +5,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | Loan record ID. | [optional] [readonly] -**createTime** | **Long** | Creation timestamp, in milliseconds. | [optional] [readonly] -**updateTime** | **Long** | Update timestamp, in milliseconds. | [optional] [readonly] -**currency** | **String** | Currency name. | -**amount** | **String** | Borrowed amount. | -**text** | **String** | User defined custom ID. | [optional] +**id** | **String** | Loan record ID | [optional] [readonly] +**createTime** | **Long** | Creation timestamp, in milliseconds | [optional] [readonly] +**updateTime** | **Long** | Update timestamp, in milliseconds | [optional] [readonly] +**currency** | **String** | Currency name | +**amount** | **String** | Borrowed amount | +**text** | **String** | User defined custom ID | [optional] **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] +**repaid** | **String** | Repaid amount | [optional] [readonly] +**repaidInterest** | **String** | Repaid interest | [optional] [readonly] +**unpaidInterest** | **String** | Unpaid interest | [optional] [readonly] ## Enum: StatusEnum diff --git a/docs/CrossMarginRepayment.md b/docs/CrossMarginRepayment.md index f281bac..04c92f9 100644 --- a/docs/CrossMarginRepayment.md +++ b/docs/CrossMarginRepayment.md @@ -5,11 +5,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | Loan record ID. | [optional] -**createTime** | **Long** | Repayment time. | [optional] -**loanId** | **String** | Loan record ID. | [optional] -**currency** | **String** | Currency name. | [optional] -**principal** | **String** | Repaid principal. | [optional] -**interest** | **String** | Repaid interest. | [optional] +**id** | **String** | Loan record ID | [optional] +**createTime** | **Long** | Repayment time | [optional] +**loanId** | **String** | Loan record ID | [optional] +**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 after cancellation | [optional] [readonly] diff --git a/docs/Currency.md b/docs/Currency.md index ca6a039..0f1d258 100644 --- a/docs/Currency.md +++ b/docs/Currency.md @@ -5,14 +5,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency symbol. | [optional] -**name** | **String** | Currency name. | [optional] -**delisted** | **Boolean** | Whether currency is de-listed. | [optional] -**withdrawDisabled** | **Boolean** | Whether currency's withdrawal is disabled (deprecated). | [optional] -**withdrawDelayed** | **Boolean** | Whether currency's withdrawal is delayed (deprecated). | [optional] -**depositDisabled** | **Boolean** | Whether currency's deposit is disabled (deprecated). | [optional] -**tradeDisabled** | **Boolean** | Whether currency's trading is disabled. | [optional] +**currency** | **String** | Currency symbol | [optional] +**name** | **String** | Currency name | [optional] +**delisted** | **Boolean** | Whether currency is de-listed | [optional] +**withdrawDisabled** | **Boolean** | Whether currency's withdrawal is disabled (deprecated) | [optional] +**withdrawDelayed** | **Boolean** | Whether currency's withdrawal is delayed (deprecated) | [optional] +**depositDisabled** | **Boolean** | Whether currency's deposit is disabled (deprecated) | [optional] +**tradeDisabled** | **Boolean** | Whether currency's trading is disabled | [optional] **fixedRate** | **String** | Fixed fee rate. Only for fixed rate currencies, not valid for normal currencies | [optional] -**chain** | **String** | The main chain corresponding to the coin. | [optional] -**chains** | [**List<SpotCurrencyChain>**](SpotCurrencyChain.md) | All links corresponding to coins. | [optional] +**chain** | **String** | The main chain corresponding to the coin | [optional] +**chains** | [**List<SpotCurrencyChain>**](SpotCurrencyChain.md) | All links corresponding to coins | [optional] diff --git a/docs/CurrencyChain.md b/docs/CurrencyChain.md index 95176ad..ff36e70 100644 --- a/docs/CurrencyChain.md +++ b/docs/CurrencyChain.md @@ -5,12 +5,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**chain** | **String** | Chain name. | [optional] -**nameCn** | **String** | Chain name in Chinese. | [optional] -**nameEn** | **String** | Chain name in English. | [optional] +**chain** | **String** | Chain name | [optional] +**nameCn** | **String** | Chain name in Chinese | [optional] +**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] -**decimal** | **String** | Withdrawal precision. | [optional] +**isDisabled** | **Integer** | If it is disabled. 0 means NOT being disabled | [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 a5a997c..1295908 100644 --- a/docs/CurrencyPair.md +++ b/docs/CurrencyPair.md @@ -1,31 +1,31 @@ # CurrencyPair -Spot currency pair. +Spot currency pair ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | Currency pair. | [optional] -**base** | **String** | Base currency. | [optional] -**baseName** | **String** | Transaction currency name. | [optional] -**quote** | **String** | Quote currency. | [optional] -**quoteName** | **String** | Name of the denominated currency. | [optional] -**fee** | **String** | Trading fee. | [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: 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] +**id** | **String** | Currency pair | [optional] +**base** | **String** | Base currency | [optional] +**baseName** | **String** | Base currency name | [optional] +**quote** | **String** | Quote currency | [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) | 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 1b62ae2..93926c2 100644 --- a/docs/CurrencyQuota.md +++ b/docs/CurrencyQuota.md @@ -1,15 +1,15 @@ # CurrencyQuota -Currency Quota. +Currency Quota ## Properties 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] -**leftQuoteUsdt** | **String** | Remaining currency limit converted to USDT. | [optional] +**currency** | **String** | Currency | [optional] +**indexPrice** | **String** | Currency Index Price | [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 cf372bf..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 ac9234c..6ad3bba 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. -[**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. +[**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 | 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 @@ -58,7 +58,7 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency. + String settle = "usdt"; // String | Settle currency try { List result = apiInstance.listDeliveryContracts(settle); System.out.println(result); @@ -79,7 +79,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: usdt] + **settle** | **String**| Settle currency | [enum: usdt] ### Return type @@ -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 @@ -122,8 +122,8 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - String contract = "BTC_USDT_20200814"; // String | Futures contract. + String settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT_20200814"; // String | Futures contract try { DeliveryContract result = apiInstance.getDeliveryContract(settle, contract); System.out.println(result); @@ -144,8 +144,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: usdt] - **contract** | **String**| Futures contract. | + **settle** | **String**| Settle currency | [enum: usdt] + **contract** | **String**| Futures contract | ### Return type @@ -163,15 +163,15 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Contract information. | - | +**200** | Contract information | - | # **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. +Bids will be sorted by price from high to low, while asks sorted reversely ### Example @@ -190,11 +190,11 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 to return depth update ID. This ID increments by 1 each time. + String settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT_20200814"; // String | Futures contract + 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) @@ -219,11 +219,11 @@ public class Example { 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 to return depth update ID. This ID increments by 1 each time. | [optional] [default to false] + **settle** | **String**| Settle currency | [enum: usdt] + **contract** | **String**| Futures contract | + **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** | Depth query successful. | - | +**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 @@ -266,9 +266,9 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT_20200814"; // String | Futures contract + Integer limit = 100; // Integer | Maximum number of records returned in a single list String lastId = "12345"; // String | 以上个列表的最后一条记录的 ID 作为下个列表的起点。 该字段不再继续支持，新的请求请使用 `from` 和 `to` 字段来限定时间范围 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. @@ -297,9 +297,9 @@ public class Example { 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] + **settle** | **String**| Settle currency | [enum: usdt] + **contract** | **String**| Futures contract | + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] **lastId** | **String**| 以上个列表的最后一条记录的 ID 作为下个列表的起点。 该字段不再继续支持，新的请求请使用 `from` 和 `to` 字段来限定时间范围 | [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] @@ -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` @@ -347,12 +347,12 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - String contract = "BTC_USDT_20200814"; // String | Futures contract. + 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 | Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision specified - 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 | Time interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial timeweek, 7d time is aligned with Unix initial time + 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 timeTime interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial timeweek, 7d time is aligned with Unix initial time try { List result = apiInstance.listDeliveryCandlesticks(settle, contract) .from(from) @@ -378,12 +378,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: usdt] - **contract** | **String**| Futures contract. | + **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**| Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision specified | [optional] - **limit** | **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**| Time interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial timeweek, 7d time is aligned with Unix initial time | [optional] [default to 5m] [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 timeTime interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial timeweek, 7d time is aligned with Unix initial time | [optional] [default to 5m] [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 @@ -426,8 +426,8 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - String contract = "BTC_USDT_20200814"; // String | Futures contract. + String settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT_20200814"; // String | Futures contract try { List result = apiInstance.listDeliveryTickers(settle) .contract(contract) @@ -450,8 +450,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: usdt] - **contract** | **String**| Futures contract. | [optional] + **settle** | **String**| Settle currency | [enum: usdt] + **contract** | **String**| Futures contract | [optional] ### Return type @@ -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 @@ -494,8 +494,8 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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. + String settle = "usdt"; // String | Settle currency + Integer limit = 100; // Integer | Maximum number of records returned in a single list try { List result = apiInstance.listDeliveryInsuranceLedger(settle) .limit(limit) @@ -518,8 +518,8 @@ 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] + **settle** | **String**| Settle currency | [enum: usdt] + **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 @@ -566,7 +566,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency. + String settle = "usdt"; // String | Settle currency try { FuturesAccount result = apiInstance.listDeliveryAccounts(settle); System.out.println(result); @@ -587,7 +587,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: usdt] + **settle** | **String**| Settle currency | [enum: usdt] ### Return type @@ -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 @@ -634,8 +634,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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. + String settle = "usdt"; // String | Settle currency + 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 | Changing Type: - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: point_fee: POINT Trading fee - point_refr: POINT Referrer rebate @@ -664,8 +664,8 @@ 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] + **settle** | **String**| Settle currency | [enum: usdt] + **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**| Changing Type: - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: point_fee: POINT Trading fee - point_refr: POINT Referrer rebate | [optional] [enum: dnw, pnl, fee, refr, fund, point_dnw, point_fee, point_refr] @@ -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 @@ -715,7 +715,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency. + String settle = "usdt"; // String | Settle currency try { List result = apiInstance.listDeliveryPositions(settle); System.out.println(result); @@ -736,7 +736,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: usdt] + **settle** | **String**| Settle currency | [enum: usdt] ### Return type @@ -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 @@ -783,8 +783,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - String contract = "BTC_USDT_20200814"; // String | Futures contract. + String settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT_20200814"; // String | Futures contract try { Position result = apiInstance.getDeliveryPosition(settle, contract); System.out.println(result); @@ -805,8 +805,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: usdt] - **contract** | **String**| Futures contract. | + **settle** | **String**| Settle currency | [enum: usdt] + **contract** | **String**| Futures contract | ### Return type @@ -824,13 +824,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information. | - | +**200** | Position information | - | # **updateDeliveryPositionMargin** > Position updateDeliveryPositionMargin(settle, contract, change) -Update position margin. +Update position margin ### Example @@ -853,9 +853,9 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 amount, positive number increases, negative number. + String settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT_20200814"; // String | Futures contract + 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); @@ -876,9 +876,9 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: usdt] - **contract** | **String**| Futures contract. | - **change** | **String**| Margin change amount, positive number increases, negative number. | + **settle** | **String**| Settle currency | [enum: usdt] + **contract** | **String**| Futures contract | + **change** | **String**| Margin change amount, positive number increases, negative number decreases | ### Return type @@ -896,13 +896,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information. | - | +**200** | Position information | - | # **updateDeliveryPositionLeverage** > Position updateDeliveryPositionLeverage(settle, contract, leverage) -Update position leverage. +Update position leverage ### Example @@ -925,9 +925,9 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - String contract = "BTC_USDT_20200814"; // String | Futures contract. - String leverage = "10"; // String | New position leverage. + String settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT_20200814"; // String | Futures contract + String leverage = "10"; // String | New position leverage try { Position result = apiInstance.updateDeliveryPositionLeverage(settle, contract, leverage); System.out.println(result); @@ -948,9 +948,9 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: usdt] - **contract** | **String**| Futures contract. | - **leverage** | **String**| New position leverage. | + **settle** | **String**| Settle currency | [enum: usdt] + **contract** | **String**| Futures contract | + **leverage** | **String**| New position leverage | ### Return type @@ -968,13 +968,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information. | - | +**200** | Position information | - | # **updateDeliveryPositionRiskLimit** > Position updateDeliveryPositionRiskLimit(settle, contract, riskLimit) -Update position risk limit. +Update position risk limit ### Example @@ -997,9 +997,9 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - String contract = "BTC_USDT_20200814"; // String | Futures contract. - String riskLimit = "10"; // String | New position risk limit. + String settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT_20200814"; // String | Futures contract + String riskLimit = "10"; // String | New position risk limit try { Position result = apiInstance.updateDeliveryPositionRiskLimit(settle, contract, riskLimit); System.out.println(result); @@ -1020,9 +1020,9 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: usdt] - **contract** | **String**| Futures contract. | - **riskLimit** | **String**| New position risk limit. | + **settle** | **String**| Settle currency | [enum: usdt] + **contract** | **String**| Futures contract | + **riskLimit** | **String**| New position risk limit | ### Return type @@ -1040,15 +1040,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information. | - | +**200** | Position information | - | # **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 @@ -1071,13 +1071,13 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - String status = "open"; // String | Only list the orders with this 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 offset = 0; // Integer | List offset, starting from 0. - String lastId = "12345"; // String | Specify the currency name to query in batches, and support up to 100 pass parameters at a time. - Integer countTotal = 0; // Integer | Whether to return total number matched. Default to 0(no return). + String settle = "usdt"; // String | Settle currency + 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 returned in a single list + Integer offset = 0; // Integer | List offset, starting from 0 + String lastId = "12345"; // String | Specify the currency name to query in batches, and support up to 100 pass parameters at a time + Integer countTotal = 0; // Integer | Whether to return total number matched, defaults to 0 (no return) try { List result = apiInstance.listDeliveryOrders(settle, status) .contract(contract) @@ -1104,13 +1104,13 @@ 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] - **contract** | **String**| Futures contract. | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list. | [optional] [default to 100] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] - **lastId** | **String**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time. | [optional] - **countTotal** | **Integer**| Whether to return total number matched. Default to 0(no return). | [optional] [default to 0] [enum: 0, 1] + **settle** | **String**| Settle currency | [enum: usdt] + **status** | **String**| Query order list based on status | [enum: open, finished] + **contract** | **String**| Futures contract | [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] + **lastId** | **String**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time | [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 @@ -1159,7 +1159,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency. + String settle = "usdt"; // String | Settle currency FuturesOrder futuresOrder = new FuturesOrder(); // FuturesOrder | try { FuturesOrder result = apiInstance.createDeliveryOrder(settle, futuresOrder); @@ -1181,7 +1181,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: usdt] + **settle** | **String**| Settle currency | [enum: usdt] **futuresOrder** | [**FuturesOrder**](FuturesOrder.md)| | ### Return type @@ -1200,15 +1200,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Order details. | - | +**201** | Order details | - | # **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 @@ -1231,9 +1231,9 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT_20200814"; // String | Futures contract + 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); @@ -1254,9 +1254,9 @@ public class Example { 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] + **settle** | **String**| Settle currency | [enum: usdt] + **contract** | **String**| Futures contract | + **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 @@ -1305,8 +1305,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 settle = "usdt"; // String | Settle currency + String orderId = "12345"; // String | ID returned when order is successfully created try { FuturesOrder result = apiInstance.getDeliveryOrder(settle, orderId); System.out.println(result); @@ -1327,8 +1327,8 @@ 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. | + **settle** | **String**| Settle currency | [enum: usdt] + **orderId** | **String**| ID returned when order is successfully created | ### Return type @@ -1346,13 +1346,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order details. | - | +**200** | Order details | - | # **cancelDeliveryOrder** > FuturesOrder cancelDeliveryOrder(settle, orderId) -Cancel a single order. +Cancel single order ### Example @@ -1375,8 +1375,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 settle = "usdt"; // String | Settle currency + String orderId = "12345"; // String | ID returned when order is successfully created try { FuturesOrder result = apiInstance.cancelDeliveryOrder(settle, orderId); System.out.println(result); @@ -1397,8 +1397,8 @@ 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. | + **settle** | **String**| Settle currency | [enum: usdt] + **orderId** | **String**| ID returned when order is successfully created | ### Return type @@ -1416,13 +1416,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order details. | - | +**200** | Order details | - | # **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 @@ -1445,13 +1445,13 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - 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 offset = 0; // Integer | List offset, starting from 0. - String lastId = "12345"; // String | Specify the currency name to query in batches, and support up to 100 pass parameters at a time. - Integer countTotal = 0; // Integer | Whether to return total number matched. Default to 0(no return). + 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 returned in a single list + Integer offset = 0; // Integer | List offset, starting from 0 + String lastId = "12345"; // String | Specify the currency name to query in batches, and support up to 100 pass parameters at a time + Integer countTotal = 0; // Integer | Whether to return total number matched, defaults to 0 (no return) try { List result = apiInstance.getMyDeliveryTrades(settle) .contract(contract) @@ -1479,13 +1479,13 @@ public class Example { 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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] - **lastId** | **String**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time. | [optional] - **countTotal** | **Integer**| Whether to return total number matched. Default to 0(no return). | [optional] [default to 0] [enum: 0, 1] + **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 returned in a single list | [optional] [default to 100] + **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **lastId** | **String**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time | [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 @@ -1532,9 +1532,9 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT_20200814"; // String | Futures contract + Integer limit = 100; // Integer | Maximum number of records returned in a single list try { List result = apiInstance.listDeliveryPositionClose(settle) .contract(contract) @@ -1558,9 +1558,9 @@ public class Example { 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] + **settle** | **String**| Settle currency | [enum: usdt] + **contract** | **String**| Futures contract | [optional] + **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 @@ -1607,10 +1607,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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. + String settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT_20200814"; // String | Futures contract + 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) @@ -1635,10 +1635,10 @@ public class Example { 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] + **settle** | **String**| Settle currency | [enum: usdt] + **contract** | **String**| Futures contract | [optional] + **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 @@ -1685,10 +1685,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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. + String settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT_20200814"; // String | Futures contract + 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) @@ -1713,10 +1713,10 @@ public class Example { 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] + **settle** | **String**| Settle currency | [enum: usdt] + **contract** | **String**| Futures contract | [optional] + **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,13 +1734,13 @@ 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 empty. @@ -1761,10 +1761,10 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 offset = 0; // Integer | List offset, starting from 0. + String settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT_20200814"; // String | Futures contract + 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) .contract(contract) @@ -1789,10 +1789,10 @@ public class Example { 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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **settle** | **String**| Settle currency | [enum: usdt] + **contract** | **String**| Futures contract | [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 @@ -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 @@ -1839,11 +1839,11 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - String status = "status_example"; // String | Only list the orders with this 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 offset = 0; // Integer | List offset, starting from 0. + String settle = "usdt"; // String | Settle currency + 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 returned in a single list + Integer offset = 0; // Integer | List offset, starting from 0 try { List result = apiInstance.listPriceTriggeredDeliveryOrders(settle, status) .contract(contract) @@ -1868,11 +1868,11 @@ 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] - **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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **settle** | **String**| Settle currency | [enum: usdt] + **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 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 @@ -1919,7 +1919,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency. + String settle = "usdt"; // String | Settle currency FuturesPriceTriggeredOrder futuresPriceTriggeredOrder = new FuturesPriceTriggeredOrder(); // FuturesPriceTriggeredOrder | try { TriggerOrderResponse result = apiInstance.createPriceTriggeredDeliveryOrder(settle, futuresPriceTriggeredOrder); @@ -1941,7 +1941,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: usdt] + **settle** | **String**| Settle currency | [enum: usdt] **futuresPriceTriggeredOrder** | [**FuturesPriceTriggeredOrder**](FuturesPriceTriggeredOrder.md)| | ### Return type @@ -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 @@ -1989,8 +1989,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); DeliveryApi apiInstance = new DeliveryApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - String contract = "BTC_USDT"; // String | Futures contract. + String settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT"; // String | Futures contract try { List result = apiInstance.cancelPriceTriggeredDeliveryOrderList(settle, contract); System.out.println(result); @@ -2011,8 +2011,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: usdt] - **contract** | **String**| Futures contract. | + **settle** | **String**| Settle currency | [enum: usdt] + **contract** | **String**| Futures contract | ### Return type @@ -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 @@ -2059,8 +2059,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 settle = "usdt"; // String | Settle currency + String orderId = "orderId_example"; // String | ID returned when order is successfully created try { FuturesPriceTriggeredOrder result = apiInstance.getPriceTriggeredDeliveryOrder(settle, orderId); System.out.println(result); @@ -2081,8 +2081,8 @@ 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. | + **settle** | **String**| Settle currency | [enum: usdt] + **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 @@ -2129,8 +2129,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 settle = "usdt"; // String | Settle currency + String orderId = "orderId_example"; // String | ID returned when order is successfully created try { FuturesPriceTriggeredOrder result = apiInstance.cancelPriceTriggeredDeliveryOrder(settle, orderId); System.out.println(result); @@ -2151,8 +2151,8 @@ 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. | + **settle** | **String**| Settle currency | [enum: usdt] + **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/DeliveryCandlestick.md b/docs/DeliveryCandlestick.md index 8fb3a69..9544efc 100644 --- a/docs/DeliveryCandlestick.md +++ b/docs/DeliveryCandlestick.md @@ -1,16 +1,16 @@ # DeliveryCandlestick -data point in every timestamp. +data point in every timestamp ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**t** | **Double** | Unix timestamp in seconds. | [optional] -**v** | **Long** | size volume (contract size). Only returned if `contract` is not prefixed. | [optional] -**c** | **String** | Close price (quote currency). | [optional] -**h** | **String** | Highest price (quote currency). | [optional] -**l** | **String** | Lowest price (quote currency). | [optional] -**o** | **String** | Open price (quote currency). | [optional] +**t** | **Double** | Unix timestamp in seconds | [optional] +**v** | **Long** | size volume (contract size). Only returned if `contract` is not prefixed | [optional] +**c** | **String** | Close price (quote currency) | [optional] +**h** | **String** | Highest price (quote currency) | [optional] +**l** | **String** | Lowest price (quote currency) | [optional] +**o** | **String** | Open price (quote currency) | [optional] diff --git a/docs/DeliveryContract.md b/docs/DeliveryContract.md index b7e3262..de254b3 100644 --- a/docs/DeliveryContract.md +++ b/docs/DeliveryContract.md @@ -1,50 +1,50 @@ # DeliveryContract -Futures contract details. +Futures contract details ## Properties 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] -**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, 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] -**takerFeeRate** | **String** | Taker fee rate. | [optional] -**orderPriceRound** | **String** | Minimum order price increment. | [optional] -**markPriceRound** | **String** | Minimum mark price increment. | [optional] -**basisRate** | **String** | Fair basis rate. | [optional] -**basisValue** | **String** | Fair basis value. | [optional] -**basisImpactValue** | **String** | Funding used for calculating impact bid, ask price. | [optional] -**settlePrice** | **String** | Settle price. | [optional] -**settlePriceInterval** | **Integer** | Settle price update interval. | [optional] -**settlePriceDuration** | **Integer** | Settle price update duration in seconds. | [optional] -**expireTime** | **Long** | Contract expiry timestamp. | [optional] -**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] -**tradeId** | **Long** | Current trade ID. | [optional] -**tradeSize** | **Long** | Historical accumulated trade size. | [optional] -**positionSize** | **Long** | Current total long position size. | [optional] -**configChangeTime** | **Double** | Last changed time of configuration. | [optional] -**inDelisting** | **Boolean** | Contract is delisting. | [optional] -**ordersLimit** | **Integer** | Maximum number of open orders. | [optional] +**name** | **String** | Futures contract | [optional] +**underlying** | **String** | Underlying | [optional] +**cycle** | [**CycleEnum**](#CycleEnum) | Cycle type, e.g. WEEKLY, QUARTERLY | [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 - 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, 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] +**basisRate** | **String** | Fair basis rate | [optional] +**basisValue** | **String** | Fair basis value | [optional] +**basisImpactValue** | **String** | Funding used for calculating impact bid, ask price | [optional] +**settlePrice** | **String** | Settle price | [optional] +**settlePriceInterval** | **Integer** | Settle price update interval | [optional] +**settlePriceDuration** | **Integer** | Settle price update duration in seconds | [optional] +**expireTime** | **Long** | Contract expiry timestamp | [optional] +**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 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 cumulative trading volume | [optional] +**positionSize** | **Long** | Current total long position size | [optional] +**configChangeTime** | **Double** | Last configuration update time | [optional] +**inDelisting** | **Boolean** | Contract is delisting | [optional] +**ordersLimit** | **Integer** | Maximum number of pending orders | [optional] ## Enum: CycleEnum diff --git a/docs/DeliverySettlement.md b/docs/DeliverySettlement.md index 8dc451d..68582cf 100644 --- a/docs/DeliverySettlement.md +++ b/docs/DeliverySettlement.md @@ -5,13 +5,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**time** | **Long** | Liquidation time. | [optional] [readonly] -**contract** | **String** | Futures contract. | [optional] [readonly] -**leverage** | **String** | Position leverage. | [optional] [readonly] -**size** | **Long** | Position size. | [optional] [readonly] -**margin** | **String** | Position margin. | [optional] [readonly] -**entryPrice** | **String** | Average entry price. | [optional] [readonly] -**settlePrice** | **String** | Settled price. | [optional] [readonly] -**profit** | **String** | Profit. | [optional] [readonly] -**fee** | **String** | Fee deducted. | [optional] [readonly] +**time** | **Long** | Liquidation time | [optional] [readonly] +**contract** | **String** | Futures contract | [optional] [readonly] +**leverage** | **String** | Position leverage | [optional] [readonly] +**size** | **Long** | Position size | [optional] [readonly] +**margin** | **String** | Position margin | [optional] [readonly] +**entryPrice** | **String** | Average entry price | [optional] [readonly] +**settlePrice** | **String** | Settled price | [optional] [readonly] +**profit** | **String** | Profit | [optional] [readonly] +**fee** | **String** | Fee deducted | [optional] [readonly] diff --git a/docs/DeliveryTicker.md b/docs/DeliveryTicker.md index 63c77e8..ef83368 100644 --- a/docs/DeliveryTicker.md +++ b/docs/DeliveryTicker.md @@ -5,27 +5,27 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**contract** | **String** | Futures contract. | [optional] -**last** | **String** | Last trading price. | [optional] -**changePercentage** | **String** | Change percentage. | [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] -**markPrice** | **String** | Recent mark price. | [optional] -**fundingRate** | **String** | Funding rate. | [optional] -**fundingRateIndicative** | **String** | Indicative Funding rate in next period. (deprecated. use `funding_rate`). | [optional] -**indexPrice** | **String** | Index price. | [optional] +**contract** | **String** | Futures contract | [optional] +**last** | **String** | Last trading price | [optional] +**changePercentage** | **String** | Price change percentage. Negative values indicate price decrease, e.g. -7.45 | [optional] +**totalSize** | **String** | Contract total size | [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] +**indexPrice** | **String** | Index price | [optional] **quantoBaseRate** | **String** | Exchange rate of base currency and settlement currency in Quanto contract. Does not exists in contracts of other types | [optional] -**basisRate** | **String** | Basis rate. | [optional] -**basisValue** | **String** | Basis value. | [optional] -**lowestAsk** | **String** | Recent lowest ask. | [optional] -**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] +**basisRate** | **String** | Basis rate | [optional] +**basisValue** | **String** | Basis value | [optional] +**lowestAsk** | **String** | Recent lowest ask | [optional] +**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] diff --git a/docs/DepositAddress.md b/docs/DepositAddress.md index 9f9db10..8ec52fa 100644 --- a/docs/DepositAddress.md +++ b/docs/DepositAddress.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency detail. | -**address** | **String** | Deposit address. | +**currency** | **String** | Currency detail | +**address** | **String** | Deposit address | **multichainAddresses** | [**List<MultiChainAddressItem>**](MultiChainAddressItem.md) | | [optional] diff --git a/docs/DepositRecord.md b/docs/DepositRecord.md index 5b31601..77e8e6f 100644 --- a/docs/DepositRecord.md +++ b/docs/DepositRecord.md @@ -5,14 +5,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | Record ID. | [optional] [readonly] -**txid** | **String** | Hash record of the withdrawal. | [optional] [readonly] +**id** | **String** | Record ID | [optional] [readonly] +**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. | -**currency** | **String** | Currency name. | -**address** | **String** | Withdrawal address. Required for withdrawals. | [optional] -**memo** | **String** | Additional remarks with regards to the withdrawal. | [optional] +**timestamp** | **String** | Operation time | [optional] [readonly] +**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] **status** | **String** | Trading Status - REVIEW: Recharge review (compliance review) - PEND: Processing - DONE: Waiting for funds to be unlocked - INVALID: Invalid data - TRACK: Track the number of confirmations, waiting to add funds to the user (spot) - BLOCKED: Rejected Recharge - DEP_CREDITED: Recharge to account, withdrawal is not unlocked | [optional] [readonly] -**chain** | **String** | Name of the chain used in withdrawals. | +**chain** | **String** | Name of the chain used in withdrawals | diff --git a/docs/DualGetOrders.md b/docs/DualGetOrders.md index 9a04532..79966da 100644 --- a/docs/DualGetOrders.md +++ b/docs/DualGetOrders.md @@ -5,21 +5,21 @@ 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] -**exercisePrice** | **String** | Strike price. | [optional] -**settlementPrice** | **String** | settlement price. | [optional] -**settlementCurrency** | **String** | Settle currency. | [optional] -**apyDisplay** | **String** | APY. | [optional] -**apySettlement** | **String** | Settlement APY. | [optional] -**deliveryTime** | **Integer** | Settlement time. | [optional] -**text** | **String** | Custom order information. | [optional] +**id** | **Integer** | Order ID | [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** | 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 27fa3a3..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] -**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] +**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 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 7b649a9..1e8ef0f 100644 --- a/docs/EarnApi.md +++ b/docs/EarnApi.md @@ -4,23 +4,23 @@ 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. -[**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. +[**swapETH2**](EarnApi.md#swapETH2) | **POST** /earn/staking/eth2/swap | ETH2 swap +[**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 # **swapETH2** > swapETH2(eth2Swap) -ETH2 swap. +ETH2 swap ### Example @@ -81,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 @@ -147,13 +147,13 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful. | - | +**200** | Successfully retrieved | - | # **listDualInvestmentPlans** > List<DualGetPlans> listDualInvestmentPlans().planId(planId).execute(); -Dual Investment product list. +Dual Investment product list ### Example @@ -172,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) @@ -195,7 +195,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **planId** | **Long**| Financial project id. | [optional] + **planId** | **Long**| Financial project ID | [optional] ### Return type @@ -213,13 +213,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful. | - | +**200** | Successfully retrieved | - | # **listDualOrders** > List<DualGetOrders> listDualOrders().from(from).to(to).page(page).limit(limit).execute(); -Dual Investment order list. +Dual Investment order list ### Example @@ -242,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 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. + 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 returned in a single list try { List result = apiInstance.listDualOrders() .from(from) @@ -271,10 +271,10 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **from** | **Long**| Start checkout 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] + **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 returned in a single list | [optional] [default to 100] ### Return type @@ -292,13 +292,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful. | - | +**200** | Successfully retrieved | - | # **placeDualOrder** > placeDualOrder(placeDualInvestmentOrder) -Place Dual Investment order. +Place Dual Investment order ### Example @@ -359,13 +359,13 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success. | - | +**200** | Order placed successfully | - | # **listStructuredProducts** > List<StructuredGetProjectList> listStructuredProducts(status).type(type).page(page).limit(limit).execute(); -Structured Product List. +Structured Product List ### Example @@ -386,8 +386,8 @@ public class Example { EarnApi apiInstance = new EarnApi(defaultClient); 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 page = 1; // Integer | Page number + Integer limit = 100; // Integer | Maximum number of records returned in a single list try { List result = apiInstance.listStructuredProducts(status) .type(type) @@ -414,8 +414,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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] + **page** | **Integer**| Page number | [optional] [default to 1] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] ### Return type @@ -433,13 +433,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful. | - | +**200** | Successfully retrieved | - | # **listStructuredOrders** > List<StructuredOrderList> listStructuredOrders().from(from).to(to).page(page).limit(limit).execute(); -Structured Product Order List. +Structured Product Order List ### Example @@ -464,8 +464,8 @@ public class Example { EarnApi apiInstance = new EarnApi(defaultClient); 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 page = 1; // Integer | Page number + Integer limit = 100; // Integer | Maximum number of records returned in a single list try { List result = apiInstance.listStructuredOrders() .from(from) @@ -493,8 +493,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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] + **page** | **Integer**| Page number | [optional] [default to 1] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] ### Return type @@ -512,13 +512,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful. | - | +**200** | Successfully retrieved | - | # **placeStructuredOrder** > placeStructuredOrder(structuredBuy) -Place Structured Product Order. +Place Structured Product Order ### Example @@ -579,13 +579,13 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success. | - | +**200** | Order placed successfully | - | # **findCoin** > List<String> findCoin(findCoin) -Staking Coins. +Staking coins ### Example @@ -647,13 +647,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful. | - | +**200** | Successfully retrieved | - | # **swapStakingCoin** > SwapCoinStruct swapStakingCoin(swapCoin) -On-chain Token Swap for Earned Coins. +On-chain token swap for earned coins ### Example @@ -715,5 +715,5 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | swap success. | - | +**200** | Swap successful | - | diff --git a/docs/EarnUniApi.md b/docs/EarnUniApi.md index 20852f1..769e34c 100644 --- a/docs/EarnUniApi.md +++ b/docs/EarnUniApi.md @@ -4,24 +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. -[**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. +[**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 estimated annualized interest rate # **listUniCurrencies** > List<UniCurrency> listUniCurrencies() -List currencies for lending. +Query lending currency list ### Example @@ -75,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 @@ -100,7 +100,7 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); EarnUniApi apiInstance = new EarnUniApi(defaultClient); - String currency = "btc"; // String | Currency. + String currency = "btc"; // String | Currency try { UniCurrency result = apiInstance.getUniCurrency(currency); System.out.println(result); @@ -121,7 +121,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Currency. | + **currency** | **String**| Currency | ### Return type @@ -139,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 @@ -168,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. - Integer page = 1; // Integer | Page number. - Integer limit = 100; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 100. + String currency = "BTC"; // String | Query by specified currency name + Integer page = 1; // Integer | Page number + Integer limit = 100; // Integer | Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 try { List result = apiInstance.listUserUniLends() .currency(currency) @@ -195,9 +195,9 @@ public class Example { 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] + **currency** | **String**| Query by specified currency name | [optional] + **page** | **Integer**| Page number | [optional] [default to 1] + **limit** | **Integer**| Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100] ### Return type @@ -215,13 +215,13 @@ 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: 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. @@ -284,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 @@ -353,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 @@ -382,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. - Integer page = 1; // Integer | Page number. - Integer limit = 100; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 100. + String currency = "BTC"; // String | Query by specified currency name + Integer page = 1; // Integer | Page number + 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 | type: lend - lend, redeem - redeem. + String type = "lend"; // String | Operation type: lend - Lend, redeem - Redeem try { List result = apiInstance.listUniLendRecords() .currency(currency) @@ -415,12 +415,12 @@ public class Example { 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] + **currency** | **String**| Query by specified currency name | [optional] + **page** | **Integer**| Page number | [optional] [default to 1] + **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**| type: lend - lend, redeem - redeem. | [optional] [enum: lend, redeem] + **type** | **String**| Operation type: lend - Lend, redeem - Redeem | [optional] [enum: lend, redeem] ### Return type @@ -438,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 @@ -467,7 +467,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); EarnUniApi apiInstance = new EarnUniApi(defaultClient); - String currency = "btc"; // String | Currency. + String currency = "btc"; // String | Currency try { UniLendInterest result = apiInstance.getUniInterest(currency); System.out.println(result); @@ -488,7 +488,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Currency. | + **currency** | **String**| Currency | ### Return type @@ -506,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 @@ -535,9 +535,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. - Integer page = 1; // Integer | Page number. - Integer limit = 100; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 100. + String currency = "BTC"; // String | Query by specified currency name + Integer page = 1; // Integer | Page number + 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 { @@ -566,9 +566,9 @@ public class Example { 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] + **currency** | **String**| Query by specified currency name | [optional] + **page** | **Integer**| Page number | [optional] [default to 1] + **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] @@ -588,13 +588,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved. | - | +**200** | Query successful | - | # **getUniInterestStatus** > UniCurrencyInterest getUniInterestStatus(currency) -query currency interest compounding status. +Query currency interest compounding status ### Example @@ -617,7 +617,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); EarnUniApi apiInstance = new EarnUniApi(defaultClient); - String currency = "btc"; // String | Currency. + String currency = "btc"; // String | Currency try { UniCurrencyInterest result = apiInstance.getUniInterestStatus(currency); System.out.println(result); @@ -638,7 +638,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Currency. | + **currency** | **String**| Currency | ### Return type @@ -656,13 +656,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved. | - | +**200** | Query successful | - | # **listUniChart** > List<InlineResponse200> listUniChart(from, to, asset) -UniLoan currency annualized trend chart. +UniLoan currency annualized trend chart Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <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 @@ -687,9 +687,9 @@ 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. - String asset = "BTC"; // String | Currency name. + 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); System.out.println(result); @@ -710,9 +710,9 @@ 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. | - **asset** | **String**| Currency name. | + **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 @@ -736,7 +736,7 @@ Name | Type | Description | Notes # **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-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 e601241..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] -**date** | **String** | Date. | [optional] -**rate** | **String** | percentage. | [optional] +**dateTime** | **Long** | Date Timestamp | [optional] +**date** | **String** | Date | [optional] +**rate** | **String** | Percentage Rate | [optional] diff --git a/docs/Eth2Swap.md b/docs/Eth2Swap.md index 7df43aa..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 index c8f3100..eda7369 100644 --- a/docs/FindCoin.md +++ b/docs/FindCoin.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**coin** | **String** | Currency. | [optional] -**cointype** | **String** | Coin Type swap-Voucher lock-Locked. | [optional] +**coin** | **String** | Currency | [optional] +**cointype** | **String** | Token Type: swap-Voucher, lock-Locked | [optional] diff --git a/docs/FlashSwapApi.md b/docs/FlashSwapApi.md index b4cbebc..5cd0034 100644 --- a/docs/FlashSwapApi.md +++ b/docs/FlashSwapApi.md @@ -4,18 +4,18 @@ 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. -[**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. +[**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 | 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} | Query single flash swap order +[**previewFlashSwapOrder**](FlashSwapApi.md#previewFlashSwapOrder) | **POST** /flash_swap/orders/preview | Flash swap order preview # **listFlashSwapCurrencyPair** > List<FlashSwapCurrencyPair> listFlashSwapCurrencyPair().currency(currency).page(page).limit(limit).execute(); -List All Supported Currency Pairs In Flash Swap. +List All Supported Currency Pairs In Flash Swap `BTC_GT` represents selling BTC and buying GT. The limits for each currency may vary across different currency pairs. It is not necessary that two currencies that can be swapped instantaneously can be exchanged with each other. For example, it is possible to sell BTC and buy GT, but it does not necessarily mean that GT can be sold to buy BTC. @@ -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. - Integer page = 1; // Integer | Page number. - Integer limit = 1000; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 1000. + String currency = "BTC"; // String | Query by specified currency name + Integer page = 1; // Integer | Page number + 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] - **page** | **Integer**| Page number. | [optional] [default to 1] - **limit** | **Integer**| Maximum response items. Default: 100, minimum: 1, Maximum: 1000. | [optional] [default to 1000] + **currency** | **String**| Query by specified currency name | [optional] + **page** | **Integer**| Page number | [optional] [default to 1] + **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,12 +112,12 @@ 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) - ascending order(oldest first) - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list. - Integer page = 1; // Integer | Page number. + 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() .status(status) @@ -145,12 +145,12 @@ 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) - ascending order(oldest first) | [optional] - **limit** | **Integer**| Maximum number of records to be returned in a single list. | [optional] [default to 100] - **page** | **Integer**| Page number. | [optional] [default to 1] + **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,13 +168,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved. | - | +**200** | List retrieved successfully | - | # **createFlashSwapOrder** > FlashSwapOrder createFlashSwapOrder(flashSwapOrderRequest) -Create a flash swap order. +Create a flash swap order Initiate a flash swap preview in advance because order creation requires a preview result @@ -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 @@ -267,7 +267,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FlashSwapApi apiInstance = new FlashSwapApi(defaultClient); - Integer orderId = 1; // Integer | Flash swap order ID. + Integer orderId = 1; // Integer | Flash swap order ID try { FlashSwapOrder result = apiInstance.getFlashSwapOrder(orderId); System.out.println(result); @@ -288,7 +288,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **orderId** | **Integer**| Flash swap order ID. | + **orderId** | **Integer**| Flash swap order ID | ### Return type @@ -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 aef9f84..2ad2f0a 100644 --- a/docs/FlashSwapCurrencyPair.md +++ b/docs/FlashSwapCurrencyPair.md @@ -1,17 +1,17 @@ # FlashSwapCurrencyPair -List all supported currencies in flash swap. +List all supported currencies in flash swap ## Properties 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/FlashSwapOrder.md b/docs/FlashSwapOrder.md index 3990d15..fcf1cd3 100644 --- a/docs/FlashSwapOrder.md +++ b/docs/FlashSwapOrder.md @@ -1,19 +1,19 @@ # FlashSwapOrder -Flash swap order. +Flash swap order ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Long** | Flash swap order ID. | [optional] [readonly] -**createTime** | **Long** | Creation time of order (in milliseconds). | [optional] [readonly] -**userId** | **Long** | User ID. | [optional] [readonly] -**sellCurrency** | **String** | Currency to sell. | [optional] [readonly] -**sellAmount** | **String** | Amount to sell. | [optional] [readonly] -**buyCurrency** | **String** | Currency to buy. | [optional] [readonly] -**buyAmount** | **String** | Amount to buy. | [optional] [readonly] -**price** | **String** | Price. | [optional] [readonly] +**id** | **Long** | Flash swap order ID | [optional] [readonly] +**createTime** | **Long** | Creation time of order (in milliseconds) | [optional] [readonly] +**userId** | **Long** | User ID | [optional] [readonly] +**sellCurrency** | **String** | Currency to sell | [optional] [readonly] +**sellAmount** | **String** | Amount to sell | [optional] [readonly] +**buyCurrency** | **String** | Currency to buy | [optional] [readonly] +**buyAmount** | **String** | Amount to buy | [optional] [readonly] +**price** | **String** | Price | [optional] [readonly] **status** | **Integer** | Flash swap order status `1` - success `2` - failure | [optional] [readonly] diff --git a/docs/FlashSwapOrderPreview.md b/docs/FlashSwapOrderPreview.md index 7fa4fd8..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] +**previewId** | **String** | Preview result ID | [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] +**sellAmount** | **String** | Amount to sell | [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] +**buyAmount** | **String** | Amount to buy | [optional] +**price** | **String** | Price | [optional] diff --git a/docs/FlashSwapOrderRequest.md b/docs/FlashSwapOrderRequest.md index 9905c66..100b504 100644 --- a/docs/FlashSwapOrderRequest.md +++ b/docs/FlashSwapOrderRequest.md @@ -1,15 +1,15 @@ # FlashSwapOrderRequest -Parameters of flash swap order creation. +Parameters of flash swap order creation ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**previewId** | **String** | Preview result ID. | +**previewId** | **String** | Preview result ID | **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). | +**sellAmount** | **String** | Amount to sell (based on the preview result) | **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). | +**buyAmount** | **String** | Amount to buy (based on the preview result) | diff --git a/docs/FlashSwapPreviewRequest.md b/docs/FlashSwapPreviewRequest.md index a8d64e7..0819b9c 100644 --- a/docs/FlashSwapPreviewRequest.md +++ b/docs/FlashSwapPreviewRequest.md @@ -1,14 +1,14 @@ # FlashSwapPreviewRequest -Parameters of flash swap order creation. +Parameters of flash swap order creation ## Properties 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/FundingAccount.md b/docs/FundingAccount.md index 88d18f4..dfa4e8a 100644 --- a/docs/FundingAccount.md +++ b/docs/FundingAccount.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency name. | [optional] -**available** | **String** | Available assets to lend, which is identical to spot account `available`. | [optional] -**locked** | **String** | Locked amount. i.e. amount in `open` loans. | [optional] -**lent** | **String** | Outstanding loan amount yet to be repaid. | [optional] -**totalLent** | **String** | Amount used for lending. total_lent = lent + locked. | [optional] +**currency** | **String** | Currency name | [optional] +**available** | **String** | Available assets to lend, which is identical to spot account `available` | [optional] +**locked** | **String** | Locked amount. i.e. amount in `open` loans | [optional] +**lent** | **String** | Outstanding loan amount yet to be repaid | [optional] +**totalLent** | **String** | Amount used for lending. total_lent = lent + locked | [optional] diff --git a/docs/FundingRateRecord.md b/docs/FundingRateRecord.md index 4aa8567..07639ee 100644 --- a/docs/FundingRateRecord.md +++ b/docs/FundingRateRecord.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**t** | **Long** | Unix timestamp in seconds. | [optional] -**r** | **String** | Funding rate. | [optional] +**t** | **Long** | Unix timestamp in seconds | [optional] +**r** | **String** | Funding rate | [optional] diff --git a/docs/FutureCancelOrderResult.md b/docs/FutureCancelOrderResult.md index bf5e945..78b53f0 100644 --- a/docs/FutureCancelOrderResult.md +++ b/docs/FutureCancelOrderResult.md @@ -1,14 +1,14 @@ # FutureCancelOrderResult -Order cancellation result. +Order cancellation result ## Properties 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] +**id** | **String** | Order ID | [optional] +**userId** | **Long** | User ID | [optional] +**succeeded** | **Boolean** | Whether cancellation succeeded | [optional] +**message** | **String** | Error description when cancellation fails, empty if successful | [optional] diff --git a/docs/FuturesAccount.md b/docs/FuturesAccount.md index 7e1a327..1910590 100644 --- a/docs/FuturesAccount.md +++ b/docs/FuturesAccount.md @@ -6,29 +6,29 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **total** | **String** | total is the balance after the user's accumulated deposit, withdraw, profit and loss (including realized profit and loss, fund, fee and referral rebate), excluding unrealized profit and loss. total = SUM(history_dnw, history_pnl, history_fee, history_refr, history_fund) | [optional] -**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 withdrawn. The transfer amount needs to deduct the bonus) | [optional] -**point** | **String** | POINT amount. | [optional] -**currency** | **String** | Settle currency. | [optional] -**inDualMode** | **Boolean** | Whether dual mode is enabled. | [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] -**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] -**enableNewDualMode** | **Boolean** | Whether to open a new two-way position mode. | [optional] +**unrealisedPnl** | **String** | Unrealized PNL | [optional] +**positionMargin** | **String** | Position margin | [optional] +**orderMargin** | **String** | Order margin of unfinished orders | [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] +**enableCredit** | **Boolean** | Whether portfolio margin account mode is enabled | [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** | 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] +**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 2ea8816..67adf40 100644 --- a/docs/FuturesAccountBook.md +++ b/docs/FuturesAccountBook.md @@ -5,14 +5,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**time** | **Double** | Change time. | [optional] -**change** | **String** | Change amount. | [optional] -**balance** | **String** | Balance after change. | [optional] +**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_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction | [optional] -**text** | **String** | Comment. | [optional] -**contract** | **String** | Futures contract, the field is only available for data after 2023-10-30. | [optional] -**tradeId** | **String** | trade id. | [optional] -**id** | **String** | Account change record ID. | [optional] +**text** | **String** | Comment | [optional] +**contract** | **String** | Futures contract, the field is only available for data after 2023-10-30 | [optional] +**tradeId** | **String** | trade id | [optional] +**id** | **String** | Account change record ID | [optional] ## Enum: TypeEnum diff --git a/docs/FuturesAccountHistory.md b/docs/FuturesAccountHistory.md index 2b30d5c..67b7e58 100644 --- a/docs/FuturesAccountHistory.md +++ b/docs/FuturesAccountHistory.md @@ -1,20 +1,20 @@ # FuturesAccountHistory -Statistical data. +Statistical data ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**dnw** | **String** | total amount of deposit and withdraw. | [optional] -**pnl** | **String** | total amount of trading profit and loss. | [optional] -**fee** | **String** | total amount of fee. | [optional] -**refr** | **String** | total amount of referrer rebates. | [optional] -**fund** | **String** | total amount of funding costs. | [optional] -**pointDnw** | **String** | total amount of point deposit and withdraw. | [optional] -**pointFee** | **String** | total amount of point fee. | [optional] -**pointRefr** | **String** | total amount of referrer rebates of point fee. | [optional] -**bonusDnw** | **String** | total amount of perpetual contract bonus transfer. | [optional] -**bonusOffset** | **String** | total amount of perpetual contract bonus deduction. | [optional] +**dnw** | **String** | total amount of deposit and withdraw | [optional] +**pnl** | **String** | total amount of trading profit and loss | [optional] +**fee** | **String** | total amount of fee | [optional] +**refr** | **String** | total amount of referrer rebates | [optional] +**fund** | **String** | total amount of funding costs | [optional] +**pointDnw** | **String** | total amount of point deposit and withdraw | [optional] +**pointFee** | **String** | total amount of point fee | [optional] +**pointRefr** | **String** | total amount of referrer rebates of point fee | [optional] +**bonusDnw** | **String** | total amount of perpetual contract bonus transfer | [optional] +**bonusOffset** | **String** | total amount of perpetual contract bonus deduction | [optional] diff --git a/docs/FuturesApi.md b/docs/FuturesApi.md index eb72557..8f55a08 100644 --- a/docs/FuturesApi.md +++ b/docs/FuturesApi.md @@ -4,63 +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. -[**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. -[**updateDualCompPositionCrossMode**](FuturesApi.md#updateDualCompPositionCrossMode) | **POST** /futures/{settle}/dual_comp/positions/cross_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. -[**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. -[**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. -[**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 | 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. +[**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 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 | 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 | 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 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 @@ -79,9 +79,9 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 offset = 0; // Integer | List offset, starting from 0. + String settle = "usdt"; // String | Settle currency + 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) .limit(limit) @@ -105,9 +105,9 @@ 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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **settle** | **String**| Settle currency | [enum: btc, usdt] + **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 @@ -125,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 @@ -150,8 +150,8 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - String contract = "BTC_USDT"; // String | Futures contract. + String settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT"; // String | Futures contract try { Contract result = apiInstance.getFuturesContract(settle, contract); System.out.println(result); @@ -172,8 +172,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] - **contract** | **String**| Futures contract. | + **settle** | **String**| Settle currency | [enum: btc, usdt] + **contract** | **String**| Futures contract | ### Return type @@ -191,15 +191,15 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Contract information. | - | +**200** | Contract information | - | # **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. +Bids will be sorted by price from high to low, while asks sorted reversely ### Example @@ -218,11 +218,11 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 to return depth update ID. This ID increments by 1 each time. + String settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT"; // String | Futures contract + 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,11 +247,11 @@ public class Example { 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 to return depth update ID. This ID increments by 1 each time. | [optional] [default to false] + **settle** | **String**| Settle currency | [enum: btc, usdt] + **contract** | **String**| Futures contract | + **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 @@ -269,13 +269,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Depth query successful. | - | +**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,10 +294,10 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 offset = 0; // Integer | List offset, starting from 0. + String settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT"; // String | Futures contract + 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. @@ -327,10 +327,10 @@ public class Example { 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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **settle** | **String**| Settle currency | [enum: btc, usdt] + **contract** | **String**| Futures contract | + **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] @@ -351,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(); -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` @@ -378,12 +378,12 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - String contract = "BTC_USDT"; // String | Futures contract. + 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 | Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision specified - 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. 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 try { List result = apiInstance.listFuturesCandlesticks(settle, contract) .from(from) @@ -409,12 +409,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] - **contract** | **String**| Futures contract. | + **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**| Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision specified | [optional] - **limit** | **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. 1 natual month, not 30 days | [optional] [default to 5m] [enum: 10s, 1m, 5m, 15m, 30m, 1h, 4h, 8h, 1d, 7d] + **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] ### Return type @@ -432,13 +432,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 @@ -459,12 +459,12 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - String contract = "BTC_USDT"; // String | Futures contract. + 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 | Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision specified - 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) @@ -490,12 +490,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] - **contract** | **String**| Futures contract. | + **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**| Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision specified | [optional] - **limit** | **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] [enum: 10s, 1m, 5m, 15m, 30m, 1h, 4h, 8h, 1d, 7d] + **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 @@ -513,13 +513,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 @@ -538,8 +538,8 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified. + String settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified try { List result = apiInstance.listFuturesTickers(settle) .contract(contract) @@ -562,8 +562,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] - **contract** | **String**| Futures contract, return related data only if specified. | [optional] + **settle** | **String**| Settle currency | [enum: btc, usdt] + **contract** | **String**| Futures contract, return related data only if specified | [optional] ### Return type @@ -581,13 +581,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 +606,9 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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. + String settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT"; // String | Futures contract + 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 { @@ -635,9 +635,9 @@ public class Example { 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] + **settle** | **String**| Settle currency | [enum: btc, usdt] + **contract** | **String**| Futures contract | + **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] @@ -657,13 +657,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 @@ -682,8 +682,8 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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. + String settle = "usdt"; // String | Settle currency + Integer limit = 100; // Integer | Maximum number of records returned in a single list try { List result = apiInstance.listFuturesInsuranceLedger(settle) .limit(limit) @@ -706,8 +706,8 @@ 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] + **settle** | **String**| Settle currency | [enum: btc, usdt] + **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] ### Return type @@ -725,13 +725,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 @@ -750,9 +750,9 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - String contract = "BTC_USDT"; // String | Futures contract. - Long from = 1604561000L; // Long | Start timestamp. + String settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT"; // String | Futures contract + Long from = 1604561000L; // Long | Start timestamp String interval = "\"5m\""; // String | Integer limit = 30; // Integer | try { @@ -779,9 +779,9 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] - **contract** | **String**| Futures contract. | - **from** | **Long**| Start timestamp. | [optional] + **settle** | **String**| Settle currency | [enum: btc, usdt] + **contract** | **String**| Futures contract | + **from** | **Long**| Start timestamp | [optional] **interval** | **String**| | [optional] [default to "5m"] **limit** | **Integer**| | [optional] [default to 30] @@ -801,13 +801,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 @@ -826,8 +826,8 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - String index = "BTC_USDT"; // String | Index name. + String settle = "usdt"; // String | Settle currency + String index = "BTC_USDT"; // String | Index name try { FuturesIndexConstituents result = apiInstance.getIndexConstituents(settle, index); System.out.println(result); @@ -848,8 +848,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] - **index** | **String**| Index name. | + **settle** | **String**| Settle currency | [enum: btc, usdt] + **index** | **String**| Index name | ### Return type @@ -867,15 +867,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 -The time interval between from and to is maximum 3600. Some private fields are not returned by public interfaces, refer to field descriptions for interfaces, refer to field descriptions for details +The time interval between from and to is maximum 3600. Some private fields are not returned by public interfaces, refer to field descriptions for detailsThe time interval between from and to is maximum 3600. Some private fields are not returned by public interfaces, refer to field descriptions for interfaces, refer to field descriptions for details ### Example @@ -894,11 +894,11 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified. + 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 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 to be returned in a single list. + Integer limit = 100; // Integer | Maximum number of records returned in a single list try { List result = apiInstance.listLiquidatedOrders(settle) .contract(contract) @@ -924,11 +924,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] - **contract** | **String**| Futures contract, return related data only if specified. | [optional] + **settle** | **String**| Settle currency | [enum: btc, usdt] + **contract** | **String**| Futures contract, return related data only if specified | [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] - **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 @@ -946,13 +946,13 @@ 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 empty. @@ -973,10 +973,10 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 offset = 0; // Integer | List offset, starting from 0. + 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 returned in a single list + Integer offset = 0; // Integer | List offset, starting from 0 try { List result = apiInstance.listFuturesRiskLimitTiers(settle) .contract(contract) @@ -1001,10 +1001,10 @@ public class Example { 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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **settle** | **String**| Settle currency | [enum: btc, usdt] + **contract** | **String**| Futures contract, return related data only if 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 @@ -1022,13 +1022,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 @@ -1051,7 +1051,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. + String settle = "usdt"; // String | Settle currency try { FuturesAccount result = apiInstance.listFuturesAccounts(settle); System.out.println(result); @@ -1072,7 +1072,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] + **settle** | **String**| Settle currency | [enum: btc, usdt] ### Return type @@ -1090,15 +1090,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 passed, only records containing this field after 2023-10-30 can be filtered。 2023-10-30 can be filtered. +If the contract field is passed, only records containing this field after 2023-10-30 can be filtered. ### Example @@ -1121,10 +1121,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 offset = 0; // Integer | List offset, starting from 0. + 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 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 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_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction @@ -1155,10 +1155,10 @@ public class Example { 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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **settle** | **String**| Settle currency | [enum: btc, usdt] + **contract** | **String**| Futures contract, return related data only if 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] **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**| Changing Type： - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: point_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction | [optional] @@ -1179,13 +1179,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 @@ -1208,10 +1208,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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. - Integer offset = 0; // Integer | List offset, starting from 0. + 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 returned in a single list + Integer offset = 0; // Integer | List offset, starting from 0 try { List result = apiInstance.listPositions(settle) .holding(holding) @@ -1236,10 +1236,10 @@ 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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **settle** | **String**| Settle currency | [enum: btc, usdt] + **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 @@ -1257,13 +1257,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 @@ -1286,8 +1286,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - String contract = "BTC_USDT"; // String | Futures contract. + String settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT"; // String | Futures contract try { Position result = apiInstance.getPosition(settle, contract) .execute(); @@ -1309,8 +1309,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] - **contract** | **String**| Futures contract. | + **settle** | **String**| Settle currency | [enum: btc, usdt] + **contract** | **String**| Futures contract | ### Return type @@ -1328,13 +1328,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information. | - | +**200** | Position information | - | # **updatePositionMargin** > Position updatePositionMargin(settle, contract, change) -Update position margin. +Update position margin ### Example @@ -1357,9 +1357,9 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 amount, positive number increases, negative number. + String settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT"; // String | Futures contract + 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,9 +1380,9 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] - **contract** | **String**| Futures contract. | - **change** | **String**| Margin change amount, positive number increases, negative number. | + **settle** | **String**| Settle currency | [enum: btc, usdt] + **contract** | **String**| Futures contract | + **change** | **String**| Margin change amount, positive number increases, negative number decreases | ### Return type @@ -1400,13 +1400,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information. | - | +**200** | Position information | - | # **updatePositionLeverage** > Position updatePositionLeverage(settle, contract, leverage, crossLeverageLimit) -Update position leverage. +Update position leverage ### Example @@ -1429,10 +1429,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - 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 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) try { Position result = apiInstance.updatePositionLeverage(settle, contract, leverage, crossLeverageLimit); System.out.println(result); @@ -1453,10 +1453,10 @@ public class Example { 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] + **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] ### Return type @@ -1474,13 +1474,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information. | - | +**200** | Position information | - | # **updatePositionCrossMode** > Position updatePositionCrossMode(settle, futuresPositionCrossMode) -Switch to the full position-by-store mode. +Switch Position Margin Mode ### Example @@ -1503,7 +1503,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. + String settle = "usdt"; // String | Settle currency FuturesPositionCrossMode futuresPositionCrossMode = new FuturesPositionCrossMode(); // FuturesPositionCrossMode | try { Position result = apiInstance.updatePositionCrossMode(settle, futuresPositionCrossMode); @@ -1525,7 +1525,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] + **settle** | **String**| Settle currency | [enum: btc, usdt] **futuresPositionCrossMode** | [**FuturesPositionCrossMode**](FuturesPositionCrossMode.md)| | ### Return type @@ -1544,13 +1544,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information. | - | +**200** | Position information | - | # **updateDualCompPositionCrossMode** > List<Position> updateDualCompPositionCrossMode(settle, inlineObject) -双仓模式下切换全逐仓模式 +Switch Between Cross and Isolated Margin Modes Under Hedge Mode ### Example @@ -1573,7 +1573,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. + String settle = "usdt"; // String | Settle currency InlineObject inlineObject = new InlineObject(); // InlineObject | try { List result = apiInstance.updateDualCompPositionCrossMode(settle, inlineObject); @@ -1595,7 +1595,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] + **settle** | **String**| Settle currency | [enum: btc, usdt] **inlineObject** | [**InlineObject**](InlineObject.md)| | ### Return type @@ -1614,13 +1614,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved. | - | +**200** | Query successful | - | # **updatePositionRiskLimit** > Position updatePositionRiskLimit(settle, contract, riskLimit) -Update position risk limit. +Update position risk limit ### Example @@ -1643,9 +1643,9 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT"; // String | Futures contract + String riskLimit = "1000000"; // String | New risk limit value try { Position result = apiInstance.updatePositionRiskLimit(settle, contract, riskLimit); System.out.println(result); @@ -1666,9 +1666,9 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] - **contract** | **String**| Futures contract. | - **riskLimit** | **String**| New Risk Limit Value. | + **settle** | **String**| Settle currency | [enum: btc, usdt] + **contract** | **String**| Futures contract | + **riskLimit** | **String**| New risk limit value | ### Return type @@ -1686,15 +1686,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Position information. | - | +**200** | Position information | - | # **setDualMode** > FuturesAccount setDualMode(settle, dualMode) -Enable or disable dual mode. +Set position mode -The prerequisite for changing mode is that all positions have no holdings. +The prerequisite for changing mode is that all positions have no holdings and no pending orders ### Example @@ -1717,8 +1717,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - Boolean dualMode = true; // Boolean | Whether to enable dual mode. + String settle = "usdt"; // String | Settle currency + Boolean dualMode = true; // Boolean | Whether to enable dual mode try { FuturesAccount result = apiInstance.setDualMode(settle, dualMode); System.out.println(result); @@ -1739,8 +1739,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] - **dualMode** | **Boolean**| Whether to enable dual mode. | + **settle** | **String**| Settle currency | [enum: btc, usdt] + **dualMode** | **Boolean**| Whether to enable dual mode | ### Return type @@ -1758,13 +1758,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 @@ -1787,8 +1787,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - String contract = "BTC_USDT"; // String | Futures contract. + String settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT"; // String | Futures contract try { List result = apiInstance.getDualModePosition(settle, contract) .execute(); @@ -1810,8 +1810,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] - **contract** | **String**| Futures contract. | + **settle** | **String**| Settle currency | [enum: btc, usdt] + **contract** | **String**| Futures contract | ### Return type @@ -1829,13 +1829,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved. | - | +**200** | Query successful | - | # **updateDualModePositionMargin** > List<Position> updateDualModePositionMargin(settle, contract, change, dualSide) -Update position margin in dual mode. +Update position margin in dual mode ### Example @@ -1858,10 +1858,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 amount, positive number increases, negative number. - String dualSide = "dual_long"; // String | Long or short position. + String settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT"; // String | Futures contract + 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); System.out.println(result); @@ -1882,10 +1882,10 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] - **contract** | **String**| Futures contract. | - **change** | **String**| Margin change amount, positive number increases, negative number. | - **dualSide** | **String**| Long or short position. | + **settle** | **String**| Settle currency | [enum: btc, usdt] + **contract** | **String**| Futures contract | + **change** | **String**| Margin change amount, positive number increases, negative number decreases | + **dualSide** | **String**| Long or short position | ### Return type @@ -1903,13 +1903,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved. | - | +**200** | Query successful | - | # **updateDualModePositionLeverage** > List<Position> updateDualModePositionLeverage(settle, contract, leverage, crossLeverageLimit) -Update position leverage in dual mode. +Update position leverage in dual mode ### Example @@ -1932,10 +1932,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - 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 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) try { List result = apiInstance.updateDualModePositionLeverage(settle, contract, leverage, crossLeverageLimit); System.out.println(result); @@ -1956,10 +1956,10 @@ public class Example { 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] + **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] ### Return type @@ -1977,13 +1977,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved. | - | +**200** | Query successful | - | # **updateDualModePositionRiskLimit** > List<Position> updateDualModePositionRiskLimit(settle, contract, riskLimit) -Update position risk limit in dual mode. +Update position risk limit in dual mode ### Example @@ -2006,9 +2006,9 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT"; // String | Futures contract + String riskLimit = "1000000"; // String | New risk limit value try { List result = apiInstance.updateDualModePositionRiskLimit(settle, contract, riskLimit); System.out.println(result); @@ -2029,9 +2029,9 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] - **contract** | **String**| Futures contract. | - **riskLimit** | **String**| New Risk Limit Value. | + **settle** | **String**| Settle currency | [enum: btc, usdt] + **contract** | **String**| Futures contract | + **riskLimit** | **String**| New risk limit value | ### Return type @@ -2049,13 +2049,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`. @@ -2080,12 +2080,12 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - String status = "open"; // String | Only list the orders with this 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 offset = 0; // Integer | List offset, starting from 0. - String lastId = "12345"; // String | Specify the currency name to query in batches, and support up to 100 pass parameters at a time. + String settle = "usdt"; // String | Settle currency + 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 returned in a single list + Integer offset = 0; // Integer | List offset, starting from 0 + String lastId = "12345"; // String | Specify the currency name to query in batches, and support up to 100 pass parameters at a time try { List result = apiInstance.listFuturesOrders(settle, status) .contract(contract) @@ -2111,12 +2111,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] - **status** | **String**| Only list the orders with this 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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] - **lastId** | **String**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time. | [optional] + **settle** | **String**| Settle currency | [enum: btc, usdt] + **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 returned in a single list | [optional] [default to 100] + **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] + **lastId** | **String**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time | [optional] ### Return type @@ -2134,13 +2134,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
    | # **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 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` @@ -2165,7 +2165,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. + String settle = "usdt"; // String | Settle currency FuturesOrder futuresOrder = new FuturesOrder(); // FuturesOrder | 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 { @@ -2188,7 +2188,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] + **settle** | **String**| Settle currency | [enum: btc, usdt] **futuresOrder** | [**FuturesOrder**](FuturesOrder.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] @@ -2208,15 +2208,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Order details. | - | +**201** | Order details | - | # **cancelFuturesOrders** > List<FuturesOrder> cancelFuturesOrders(settle, contract, xGateExptime, 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 @@ -2239,8 +2239,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - String contract = "BTC_USDT"; // String | Futures contract. + 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, both are included if not specified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell orders try { @@ -2263,8 +2263,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] - **contract** | **String**| Futures contract. | + **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, both are included if not specified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell orders | [optional] @@ -2284,13 +2284,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 @@ -2313,12 +2313,12 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified. + 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 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 to be returned in a single list. - Integer offset = 0; // Integer | List offset, starting from 0. + 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) .contract(contract) @@ -2345,12 +2345,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] - **contract** | **String**| Futures contract, return related data only if specified. | [optional] + **settle** | **String**| Settle currency | [enum: btc, usdt] + **contract** | **String**| Futures contract, return related data only if specified | [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] - **limit** | **Integer**| Maximum number of records to be returned in a single list. | [optional] [default to 100] - **offset** | **Integer**| List offset, starting from 0. | [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] ### Return type @@ -2368,13 +2368,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 @@ -2399,7 +2399,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. + String settle = "usdt"; // String | Settle currency List futuresOrder = Arrays.asList(); // List | 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 { @@ -2422,7 +2422,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] + **settle** | **String**| Settle currency | [enum: btc, usdt] **futuresOrder** | [**List<FuturesOrder>**](FuturesOrder.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] @@ -2442,13 +2442,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. @@ -2473,7 +2473,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. + 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. 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); @@ -2495,7 +2495,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] + **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. finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. | ### Return type @@ -2514,13 +2514,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order details. | - | +**200** | Order details | - | # **amendFuturesOrder** > FuturesOrder amendFuturesOrder(settle, orderId, futuresOrderAmendment, xGateExptime) -Amend an order. +Amend single order ### Example @@ -2543,7 +2543,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. + 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. 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 @@ -2567,7 +2567,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] + **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. 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] @@ -2588,13 +2588,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order details. | - | +**200** | Order details | - | # **cancelFuturesOrder** > FuturesOrder cancelFuturesOrder(settle, orderId, xGateExptime) -Cancel a single order. +Cancel single order ### Example @@ -2617,7 +2617,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. + 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. 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 { @@ -2640,7 +2640,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] + **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. 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] @@ -2660,13 +2660,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order details. | - | +**200** | Order details | - | # **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`. @@ -2691,11 +2691,11 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 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 offset = 0; // Integer | List offset, starting from 0. + 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 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 { List result = apiInstance.getMyTrades(settle) @@ -2723,11 +2723,11 @@ public class Example { 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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **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 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] ### Return type @@ -2746,13 +2746,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 @@ -2775,13 +2775,13 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified. + 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 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 to be returned in a single list. - Integer offset = 0; // Integer | List offset, starting from 0. - String role = "maker"; // String | Query role, maker or taker. + 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 try { List result = apiInstance.getMyTradesWithTimeRange(settle) .contract(contract) @@ -2809,13 +2809,13 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] - **contract** | **String**| Futures contract, return related data only if specified. | [optional] + **settle** | **String**| Settle currency | [enum: btc, usdt] + **contract** | **String**| Futures contract, return related data only if specified | [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] - **limit** | **Integer**| Maximum number of records to be 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] + **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] ### Return type @@ -2833,13 +2833,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 @@ -2862,14 +2862,14 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 offset = 0; // Integer | List offset, starting from 0. + 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 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 - String side = "short"; // String | Query side. long or shot. - String pnl = "profit"; // String | Query profit or loss. + String side = "short"; // String | Query side. long or shot + String pnl = "profit"; // String | Query profit or loss try { List result = apiInstance.listPositionClose(settle) .contract(contract) @@ -2898,14 +2898,14 @@ public class Example { 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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **settle** | **String**| Settle currency | [enum: btc, usdt] + **contract** | **String**| Futures contract, return related data only if 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] **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] + **side** | **String**| Query side. long or shot | [optional] + **pnl** | **String**| Query profit or loss | [optional] ### Return type @@ -2923,13 +2923,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).offset(offset).from(from).to(to).at(at).execute(); -List liquidation history. +Query liquidation history ### Example @@ -2952,13 +2952,13 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 offset = 0; // Integer | List offset, starting from 0. + 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 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 a liquidation timestamp. + Integer at = 0; // Integer | Specify liquidation timestamp try { List result = apiInstance.listLiquidates(settle) .contract(contract) @@ -2986,13 +2986,13 @@ public class Example { 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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **settle** | **String**| Settle currency | [enum: btc, usdt] + **contract** | **String**| Futures contract, return related data only if 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] **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 a liquidation timestamp. | [optional] [default to 0] + **at** | **Integer**| Specify liquidation timestamp | [optional] [default to 0] ### Return type @@ -3010,13 +3010,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).offset(offset).from(from).to(to).at(at).execute(); -List Auto-Deleveraging History. +Query ADL auto-deleveraging order information ### Example @@ -3039,13 +3039,13 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 offset = 0; // Integer | List offset, starting from 0. + 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 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 an auto-deleveraging timestamp. + Integer at = 0; // Integer | Specify auto-deleveraging timestamp try { List result = apiInstance.listAutoDeleverages(settle) .contract(contract) @@ -3073,13 +3073,13 @@ public class Example { 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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **settle** | **String**| Settle currency | [enum: btc, usdt] + **contract** | **String**| Futures contract, return related data only if 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] **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 an auto-deleveraging timestamp. | [optional] [default to 0] + **at** | **Integer**| Specify auto-deleveraging timestamp | [optional] [default to 0] ### Return type @@ -3097,13 +3097,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved. | - | +**200** | List retrieved successfully | - | # **countdownCancelAllFutures** > TriggerTime countdownCancelAllFutures(settle, countdownCancelAllFuturesTask) -Countdown cancel orders. +Countdown cancel orders Heartbeat detection for contract orders: When the user-set `timeout` time is reached, if neither the existing countdown is canceled nor a new countdown is set, the relevant contract orders will be automatically canceled. This API can be called repeatedly to or cancel the countdown. Usage example: Repeatedly call this API at 30-second intervals, setting the `timeout` to 30 (seconds) each time. If this API is not called again within 30 seconds, all open orders on your specified `market` will be automatically canceled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will terminate, and the automatic order cancellation function will be disabled. @@ -3128,7 +3128,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. + String settle = "usdt"; // String | Settle currency CountdownCancelAllFuturesTask countdownCancelAllFuturesTask = new CountdownCancelAllFuturesTask(); // CountdownCancelAllFuturesTask | try { TriggerTime result = apiInstance.countdownCancelAllFutures(settle, countdownCancelAllFuturesTask); @@ -3150,7 +3150,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] + **settle** | **String**| Settle currency | [enum: btc, usdt] **countdownCancelAllFuturesTask** | [**CountdownCancelAllFuturesTask**](CountdownCancelAllFuturesTask.md)| | ### Return type @@ -3169,13 +3169,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 @@ -3198,8 +3198,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified. + String settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified try { Map result = apiInstance.getFuturesFee(settle) .contract(contract) @@ -3222,8 +3222,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] - **contract** | **String**| Futures contract, return related data only if specified. | [optional] + **settle** | **String**| Settle currency | [enum: btc, usdt] + **contract** | **String**| Futures contract, return related data only if specified | [optional] ### Return type @@ -3241,15 +3241,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 different order IDs can be specified. A maximum of 20 records. +Multiple different order IDs can be specified, maximum 20 records per request ### Example @@ -3272,7 +3272,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. + String settle = "usdt"; // String | Settle currency List requestBody = Arrays.asList(); // List | 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 { @@ -3295,7 +3295,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] + **settle** | **String**| Settle currency | [enum: btc, usdt] **requestBody** | [**List<String>**](String.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] @@ -3315,15 +3315,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order cancellation operation completed. | - | +**200** | Order cancellation operation completed | - | # **amendBatchFutureOrders** > List<BatchFuturesOrder> amendBatchFutureOrders(settle, batchAmendOrderReq, xGateExptime) -Batch modify orders with specified IDs. +Batch modify orders by specified IDs -Multiple different order IDs can be specified. A maximum of 10 orders can. +Multiple different order IDs can be specified, maximum 10 orders per request ### Example @@ -3346,7 +3346,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. + String settle = "usdt"; // String | Settle currency List batchAmendOrderReq = Arrays.asList(); // List | 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 { @@ -3369,7 +3369,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] + **settle** | **String**| Settle currency | [enum: btc, usdt] **batchAmendOrderReq** | [**List<BatchAmendOrderReq>**](BatchAmendOrderReq.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] @@ -3389,15 +3389,15 @@ 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. +Query risk limit table by table_id -Just pass table_id. +Just pass table_id ### Example @@ -3416,8 +3416,8 @@ public class Example { 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. + 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); @@ -3438,8 +3438,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] - **tableId** | **String**| Risk limit table ID. | + **settle** | **String**| Settle currency | [enum: btc, usdt] + **tableId** | **String**| Risk limit table ID | ### Return type @@ -3457,13 +3457,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved. | - | +**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 @@ -3486,11 +3486,11 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - String status = "status_example"; // String | Only list the orders with this 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 offset = 0; // Integer | List offset, starting from 0. + String settle = "usdt"; // String | Settle currency + 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 returned in a single list + Integer offset = 0; // Integer | List offset, starting from 0 try { List result = apiInstance.listPriceTriggeredOrders(settle, status) .contract(contract) @@ -3515,11 +3515,11 @@ 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] - **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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **settle** | **String**| Settle currency | [enum: btc, usdt] + **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 returned in a single list | [optional] [default to 100] + **offset** | **Integer**| List offset, starting from 0 | [optional] [default to 0] ### Return type @@ -3537,13 +3537,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 @@ -3566,7 +3566,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. + String settle = "usdt"; // String | Settle currency FuturesPriceTriggeredOrder futuresPriceTriggeredOrder = new FuturesPriceTriggeredOrder(); // FuturesPriceTriggeredOrder | try { TriggerOrderResponse result = apiInstance.createPriceTriggeredOrder(settle, futuresPriceTriggeredOrder); @@ -3588,7 +3588,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] + **settle** | **String**| Settle currency | [enum: btc, usdt] **futuresPriceTriggeredOrder** | [**FuturesPriceTriggeredOrder**](FuturesPriceTriggeredOrder.md)| | ### Return type @@ -3607,13 +3607,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 @@ -3636,8 +3636,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); FuturesApi apiInstance = new FuturesApi(defaultClient); - String settle = "usdt"; // String | Settle currency. - String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified. + String settle = "usdt"; // String | Settle currency + String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified try { List result = apiInstance.cancelPriceTriggeredOrderList(settle, contract); System.out.println(result); @@ -3658,8 +3658,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **settle** | **String**| Settle currency. | [enum: btc, usdt] - **contract** | **String**| Futures contract, return related data only if specified. | [optional] + **settle** | **String**| Settle currency | [enum: btc, usdt] + **contract** | **String**| Futures contract, return related data only if specified | [optional] ### Return type @@ -3677,13 +3677,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 @@ -3706,8 +3706,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 settle = "usdt"; // String | Settle currency + String orderId = "orderId_example"; // String | ID returned when order is successfully created try { FuturesPriceTriggeredOrder result = apiInstance.getPriceTriggeredOrder(settle, orderId); System.out.println(result); @@ -3728,8 +3728,8 @@ 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. | + **settle** | **String**| Settle currency | [enum: btc, usdt] + **orderId** | **String**| ID returned when order is successfully created | ### Return type @@ -3747,13 +3747,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 @@ -3776,8 +3776,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 settle = "usdt"; // String | Settle currency + String orderId = "orderId_example"; // String | ID returned when order is successfully created try { FuturesPriceTriggeredOrder result = apiInstance.cancelPriceTriggeredOrder(settle, orderId); System.out.println(result); @@ -3798,8 +3798,8 @@ 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. | + **settle** | **String**| Settle currency | [enum: btc, usdt] + **orderId** | **String**| ID returned when order is successfully created | ### Return type @@ -3817,5 +3817,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 8449e4e..30e8f27 100644 --- a/docs/FuturesAutoDeleverage.md +++ b/docs/FuturesAutoDeleverage.md @@ -5,14 +5,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**time** | **Long** | Automatic deleveraging time. | [optional] [readonly] -**user** | **Long** | User ID. | [optional] [readonly] -**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] -**entryPrice** | **String** | Average entry price. | [optional] [readonly] -**fillPrice** | **String** | Average fill price. | [optional] [readonly] -**tradeSize** | **Long** | Trading size. | [optional] [readonly] -**positionSize** | **Long** | Positions after auto-deleveraging. | [optional] [readonly] +**time** | **Long** | Automatic deleveraging time | [optional] [readonly] +**user** | **Long** | User ID | [optional] [readonly] +**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] +**entryPrice** | **String** | Average entry price | [optional] [readonly] +**fillPrice** | **String** | Average fill price | [optional] [readonly] +**tradeSize** | **Long** | Trading size | [optional] [readonly] +**positionSize** | **Long** | Positions after auto-deleveraging | [optional] [readonly] diff --git a/docs/FuturesBatchAmendOrderRequest.md b/docs/FuturesBatchAmendOrderRequest.md index ce50d49..246fed6 100644 --- a/docs/FuturesBatchAmendOrderRequest.md +++ b/docs/FuturesBatchAmendOrderRequest.md @@ -1,15 +1,15 @@ # FuturesBatchAmendOrderRequest -Modify contract order parameters. +Modify contract order parameters ## Properties 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, 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] +**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** | 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/FuturesCandlestick.md b/docs/FuturesCandlestick.md index 6172dd9..11ce407 100644 --- a/docs/FuturesCandlestick.md +++ b/docs/FuturesCandlestick.md @@ -1,17 +1,17 @@ # FuturesCandlestick -data point in every timestamp. +data point in every timestamp ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**t** | **Double** | Unix timestamp in seconds. | [optional] -**v** | **Long** | size volume (contract size). Only returned if `contract` is not prefixed. | [optional] -**c** | **String** | Close price (quote currency). | [optional] -**h** | **String** | Highest price (quote currency). | [optional] -**l** | **String** | Lowest price (quote currency). | [optional] -**o** | **String** | Open price (quote currency). | [optional] -**sum** | **String** | Trading volume (unit: Quote currency). | [optional] +**t** | **Double** | Unix timestamp in seconds | [optional] +**v** | **Long** | size volume (contract size). Only returned if `contract` is not prefixed | [optional] +**c** | **String** | Close price (quote currency) | [optional] +**h** | **String** | Highest price (quote currency) | [optional] +**l** | **String** | Lowest price (quote currency) | [optional] +**o** | **String** | Open price (quote currency) | [optional] +**sum** | **String** | Trading volume (unit: Quote currency) | [optional] diff --git a/docs/FuturesFee.md b/docs/FuturesFee.md index 7f83c14..c3b9cbd 100644 --- a/docs/FuturesFee.md +++ b/docs/FuturesFee.md @@ -1,12 +1,12 @@ # FuturesFee -The returned result is a map type, where the key represents the market and taker and maker fee rates. +The returned result is a map type, where the key represents the market and taker and maker fee rates ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**takerFee** | **String** | Taker fee. | [optional] [readonly] -**makerFee** | **String** | maker fee. | [optional] [readonly] +**takerFee** | **String** | Taker fee | [optional] [readonly] +**makerFee** | **String** | maker fee | [optional] [readonly] diff --git a/docs/FuturesIndexConstituents.md b/docs/FuturesIndexConstituents.md index 248c190..506c53c 100644 --- a/docs/FuturesIndexConstituents.md +++ b/docs/FuturesIndexConstituents.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**index** | **String** | Index name. | [optional] [readonly] -**constituents** | [**List<IndexConstituent>**](IndexConstituent.md) | Constituents. | [optional] [readonly] +**index** | **String** | Index name | [optional] [readonly] +**constituents** | [**List<IndexConstituent>**](IndexConstituent.md) | Constituents | [optional] [readonly] diff --git a/docs/FuturesInitialOrder.md b/docs/FuturesInitialOrder.md index 2ca6112..3c1f79d 100644 --- a/docs/FuturesInitialOrder.md +++ b/docs/FuturesInitialOrder.md @@ -5,16 +5,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**contract** | **String** | Futures contract. | +**contract** | **String** | Futures contract | **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. | +**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 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] -**isReduceOnly** | **Boolean** | Is the order reduce-only. | [optional] [readonly] -**isClose** | **Boolean** | Is the order to close position. | [optional] [readonly] +**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] ## Enum: TifEnum diff --git a/docs/FuturesLimitRiskTiers.md b/docs/FuturesLimitRiskTiers.md index d47013b..9b69262 100644 --- a/docs/FuturesLimitRiskTiers.md +++ b/docs/FuturesLimitRiskTiers.md @@ -1,17 +1,17 @@ # FuturesLimitRiskTiers -Retrieve risk limit configurations for different tiers under a specified contract. +Retrieve risk limit configurations for different tiers under a specified contract ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**tier** | **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] -**contract** | **String** | Markets, visible only during market pagination requests. | [optional] -**deduction** | **String** | Maintenance margin quick calculation deduction. | [optional] +**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] +**contract** | **String** | Market, only visible when market pagination is requested | [optional] +**deduction** | **String** | Maintenance margin quick calculation deduction amount | [optional] diff --git a/docs/FuturesLiqOrder.md b/docs/FuturesLiqOrder.md index 4e49f10..5b681bd 100644 --- a/docs/FuturesLiqOrder.md +++ b/docs/FuturesLiqOrder.md @@ -5,11 +5,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**time** | **Long** | Liquidation time. | [optional] [readonly] -**contract** | **String** | Futures contract. | [optional] [readonly] -**size** | **Long** | User position size. | [optional] [readonly] -**orderSize** | **Long** | Number of forced liquidation orders. | [optional] [readonly] -**orderPrice** | **String** | Liquidation order price. | [optional] [readonly] -**fillPrice** | **String** | Liquidation order average taker price. | [optional] [readonly] -**left** | **Long** | System liquidation order maker size. | [optional] [readonly] +**time** | **Long** | Liquidation time | [optional] [readonly] +**contract** | **String** | Futures contract | [optional] [readonly] +**size** | **Long** | User position size | [optional] [readonly] +**orderSize** | **Long** | Number of forced liquidation orders | [optional] [readonly] +**orderPrice** | **String** | Liquidation order price | [optional] [readonly] +**fillPrice** | **String** | Liquidation order average taker price | [optional] [readonly] +**left** | **Long** | System liquidation order maker size | [optional] [readonly] diff --git a/docs/FuturesLiquidate.md b/docs/FuturesLiquidate.md index 3057a00..82f4b49 100644 --- a/docs/FuturesLiquidate.md +++ b/docs/FuturesLiquidate.md @@ -5,16 +5,16 @@ 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] -**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] -**orderPrice** | **String** | Liquidation order price. | [optional] [readonly] -**fillPrice** | **String** | Liquidation order average taker price. | [optional] [readonly] -**left** | **Long** | Liquidation order maker size. | [optional] [readonly] +**time** | **Long** | Liquidation time | [optional] [readonly] +**contract** | **String** | Futures contract | [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] +**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 1d57ee1..6299959 100644 --- a/docs/FuturesOrder.md +++ b/docs/FuturesOrder.md @@ -1,38 +1,38 @@ # FuturesOrder -Futures order details. +Futures order details ## Properties 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] -**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 - 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] -**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] -**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] +**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 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** | 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-x: new liquidation mode (isolated, cross margin one-way mode, non-hedging part of cross margin hedge mode) b. Liquidation under isolated margin in unified account single currency margin mode - hedge-liq-x: Liquidation under the new liquidation mode of the classic account hedge mode, the cross margin hedged part undergoes liquidation, meaning both long and short positions are liquidated simultaneously. - pm_liquidate: Unified account multi-currency margin mode liquidation - comb_margin_liquidate: Unified account portfolio margin mode liquidation - scm_liquidate: Unified account single currency margin mode liquidation - insurance: insurance | [optional] -**tkfr** | **String** | Taker fee. | [optional] [readonly] -**mkfr** | **String** | Maker fee. | [optional] [readonly] -**refu** | **Integer** | Reference user ID. | [optional] [readonly] +**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** | 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, 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] +**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] ## Enum: FinishAsEnum diff --git a/docs/FuturesOrderAmendment.md b/docs/FuturesOrderAmendment.md index 7f095f0..12bc512 100644 --- a/docs/FuturesOrderAmendment.md +++ b/docs/FuturesOrderAmendment.md @@ -6,6 +6,6 @@ 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] +**price** | **String** | New order price | [optional] +**amendText** | **String** | Custom info during order amendment | [optional] diff --git a/docs/FuturesOrderBook.md b/docs/FuturesOrderBook.md index 80b77b9..b208487 100644 --- a/docs/FuturesOrderBook.md +++ b/docs/FuturesOrderBook.md @@ -6,8 +6,8 @@ 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. | +**current** | **Double** | Response data generation timestamp | [optional] +**update** | **Double** | Order book changed timestamp | [optional] +**asks** | [**List<FuturesOrderBookItem>**](FuturesOrderBookItem.md) | Ask Depth | +**bids** | [**List<FuturesOrderBookItem>**](FuturesOrderBookItem.md) | Bid Depth | diff --git a/docs/FuturesOrderBookItem.md b/docs/FuturesOrderBookItem.md index 453ef2c..564bf77 100644 --- a/docs/FuturesOrderBookItem.md +++ b/docs/FuturesOrderBookItem.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**p** | **String** | Price (quote currency). | [optional] -**s** | **Long** | Size. | [optional] +**p** | **String** | Price (quote currency) | [optional] +**s** | **Long** | Size | [optional] diff --git a/docs/FuturesPositionCrossMode.md b/docs/FuturesPositionCrossMode.md index 7dafd13..3c18231 100644 --- a/docs/FuturesPositionCrossMode.md +++ b/docs/FuturesPositionCrossMode.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/FuturesPremiumIndex.md b/docs/FuturesPremiumIndex.md index c3929ec..3ba1a47 100644 --- a/docs/FuturesPremiumIndex.md +++ b/docs/FuturesPremiumIndex.md @@ -1,15 +1,15 @@ # FuturesPremiumIndex -data point in every timestamp. +data point in every timestamp ## Properties 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] -**o** | **String** | Open price. | [optional] +**t** | **Double** | Unix timestamp in seconds | [optional] +**c** | **String** | Close price | [optional] +**h** | **String** | Highest price | [optional] +**l** | **String** | Lowest price | [optional] +**o** | **String** | Open price | [optional] diff --git a/docs/FuturesPriceTrigger.md b/docs/FuturesPriceTrigger.md index 11160a8..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 - 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 8b70553..10b3fa9 100644 --- a/docs/FuturesPriceTriggeredOrder.md +++ b/docs/FuturesPriceTriggeredOrder.md @@ -1,7 +1,7 @@ # FuturesPriceTriggeredOrder -Futures order details. +Futures price-triggered order details ## Properties @@ -9,16 +9,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **initial** | [**FuturesInitialOrder**](FuturesInitialOrder.md) | | **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 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`: 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] +**id** | **Long** | Auto order ID | [optional] [readonly] +**user** | **Integer** | User ID | [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 index 941d348..cc06201 100644 --- a/docs/FuturesRiskLimitTier.md +++ b/docs/FuturesRiskLimitTier.md @@ -1,16 +1,16 @@ # FuturesRiskLimitTier -Information for each tier of the risk limit ladder. +Information for each tier of the gradient risk limit table ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**tier** | **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. | [optional] +**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 5075cc1..4ee1b26 100644 --- a/docs/FuturesTicker.md +++ b/docs/FuturesTicker.md @@ -5,25 +5,25 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**contract** | **String** | Futures contract. | [optional] -**last** | **String** | Last trading price. | [optional] -**changePercentage** | **String** | Change percentage. | [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] -**markPrice** | **String** | Recent mark price. | [optional] -**fundingRate** | **String** | Funding rate. | [optional] -**fundingRateIndicative** | **String** | Indicative Funding rate in next period. (deprecated. use `funding_rate`). | [optional] -**indexPrice** | **String** | Index price. | [optional] +**contract** | **String** | Futures contract | [optional] +**last** | **String** | Last trading price | [optional] +**changePercentage** | **String** | Price change percentage. Negative values indicate price decrease, e.g. -7.45 | [optional] +**totalSize** | **String** | Contract total size | [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] +**indexPrice** | **String** | Index price | [optional] **quantoBaseRate** | **String** | Exchange rate of base currency and settlement currency in Quanto contract. Does not exists in contracts of other types | [optional] -**lowestAsk** | **String** | Recent lowest ask. | [optional] -**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] +**lowestAsk** | **String** | Recent lowest ask | [optional] +**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] diff --git a/docs/FuturesTrade.md b/docs/FuturesTrade.md index 81e8ebe..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] -**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. an internal trade, this field will not be returned. | [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** | 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/IndexConstituent.md b/docs/IndexConstituent.md index 0233c7e..0fb0098 100644 --- a/docs/IndexConstituent.md +++ b/docs/IndexConstituent.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**exchange** | **String** | Exchange. | [optional] -**symbols** | **List<String>** | Symbol list. | [optional] +**exchange** | **String** | Exchange | [optional] +**symbols** | **List<String>** | Symbol list | [optional] diff --git a/docs/InlineObject.md b/docs/InlineObject.md index 351bc7f..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/InlineResponse2001.md b/docs/InlineResponse2001.md index 87c312f..8c8b01e 100644 --- a/docs/InlineResponse2001.md +++ b/docs/InlineResponse2001.md @@ -6,5 +6,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | | [optional] -**estRate** | **String** | Unconverted percentage. | [optional] +**estRate** | **String** | Unconverted percentage | [optional] diff --git a/docs/InsuranceRecord.md b/docs/InsuranceRecord.md index 11f95ce..334a689 100644 --- a/docs/InsuranceRecord.md +++ b/docs/InsuranceRecord.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**t** | **Long** | Unix timestamp in seconds. | [optional] -**b** | **String** | Insurance balance. | [optional] +**t** | **Long** | Unix timestamp in seconds | [optional] +**b** | **String** | Insurance balance | [optional] diff --git a/docs/LedgerRecord.md b/docs/LedgerRecord.md index 6edf612..9625498 100644 --- a/docs/LedgerRecord.md +++ b/docs/LedgerRecord.md @@ -5,16 +5,16 @@ 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] -**timestamp** | **String** | Operation time. | [optional] [readonly] -**amount** | **String** | Currency 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] -**chain** | **String** | Name of the chain used in withdrawals. | +**id** | **String** | Record ID | [optional] [readonly] +**txid** | **String** | Hash record of the withdrawal | [optional] [readonly] +**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** | 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** | 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 9afd7ee..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] -**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] +**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 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 1660a92..ce57b53 100644 --- a/docs/MarginAccount.md +++ b/docs/MarginAccount.md @@ -1,17 +1,17 @@ # 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 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] +**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'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 68b03b4..094301c 100644 --- a/docs/MarginAccountBook.md +++ b/docs/MarginAccountBook.md @@ -5,12 +5,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | Balance change record ID. | [optional] -**time** | **String** | Balance changed timestamp. | [optional] -**timeMs** | **Long** | The timestamp of the change (in milliseconds). | [optional] -**currency** | **String** | Currency changed. | [optional] -**currencyPair** | **String** | Account currency pair. | [optional] -**change** | **String** | Amount changed. Positive value means transferring in, while negative out. | [optional] -**balance** | **String** | Balance after change. | [optional] +**id** | **String** | Balance change record ID | [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 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] diff --git a/docs/MarginAccountCurrency.md b/docs/MarginAccountCurrency.md index 9566b30..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] +**currency** | **String** | Currency name | [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 dcb4aa2..2dc7496 100644 --- a/docs/MarginApi.md +++ b/docs/MarginApi.md @@ -4,25 +4,25 @@ 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. -[**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. -[**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. -[**listCrossMarginLoans**](MarginApi.md#listCrossMarginLoans) | **GET** /margin/cross/loans | List cross margin borrow history. (deprecated). -[**listCrossMarginRepayments**](MarginApi.md#listCrossMarginRepayments) | **GET** /margin/cross/repayments | Retrieve cross margin repayments. (deprecated). +[**listMarginAccounts**](MarginApi.md#listMarginAccounts) | **GET** /margin/accounts | Margin account list +[**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 | 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) # **listMarginAccounts** > List<MarginAccount> listMarginAccounts().currencyPair(currencyPair).execute(); -Margin account list. +Margin account list ### Example @@ -45,7 +45,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginApi apiInstance = new MarginApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Currency pair. + String currencyPair = "BTC_USDT"; // String | Currency pair try { List result = apiInstance.listMarginAccounts() .currencyPair(currencyPair) @@ -68,7 +68,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair. | [optional] + **currencyPair** | **String**| Currency pair | [optional] ### Return type @@ -86,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 @@ -117,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. - Integer page = 1; // Integer | Page number. - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list. + 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 returned in a single list try { List result = apiInstance.listMarginAccountBook() .currency(currency) @@ -152,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] - **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] + **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 returned in a single list | [optional] [default to 100] ### Return type @@ -176,13 +176,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved. | - | +**200** | List retrieved successfully | - | # **listFundingAccounts** > List<FundingAccount> listFundingAccounts().currency(currency).execute(); -Funding account list. +Funding account list ### Example @@ -205,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) @@ -228,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 @@ -246,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 @@ -310,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 @@ -339,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); @@ -360,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 @@ -378,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 @@ -407,8 +407,8 @@ 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 currencyPair = "BTC_USDT"; // String | Currency pair. + String currency = "BTC"; // String | Query by specified currency name + String currencyPair = "BTC_USDT"; // String | Currency pair try { MarginTransferable result = apiInstance.getMarginTransferable(currency) .currencyPair(currencyPair) @@ -431,8 +431,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency. | - **currencyPair** | **String**| Currency pair. | [optional] + **currency** | **String**| Query by specified currency name | + **currencyPair** | **String**| Currency pair | [optional] ### Return type @@ -450,13 +450,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved. | - | +**200** | Query successful | - | # **getUserMarginTier** > List<MarginLeverageTier> getUserMarginTier(currencyPair) -Check the user's own leverage lending gradient in the current market. +Query user's own leverage lending tiers in current market ### Example @@ -479,7 +479,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginApi apiInstance = new MarginApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Currency pair. + String currencyPair = "BTC_USDT"; // String | Currency pair try { List result = apiInstance.getUserMarginTier(currencyPair); System.out.println(result); @@ -500,7 +500,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair. | + **currencyPair** | **String**| Currency pair | ### Return type @@ -518,13 +518,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved. | - | +**200** | Query successful | - | # **getMarketMarginTier** > List<MarginLeverageTier> getMarketMarginTier(currencyPair) -Query the current market leverage lending gradient. +Query current market leverage lending tiers ### Example @@ -543,7 +543,7 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); MarginApi apiInstance = new MarginApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Currency pair. + String currencyPair = "BTC_USDT"; // String | Currency pair try { List result = apiInstance.getMarketMarginTier(currencyPair); System.out.println(result); @@ -564,7 +564,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair. | + **currencyPair** | **String**| Currency pair | ### Return type @@ -582,13 +582,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved. | - | +**200** | Query successful | - | # **setUserMarketLeverage** > setUserMarketLeverage(marginMarketLeverage) -Set the user market leverage multiple. +Set user market leverage multiplier ### Example @@ -649,15 +649,15 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Success. | - | +**204** | Set successfully | - | # **listMarginUserAccount** > List<MarginAccount> listMarginUserAccount().currencyPair(currencyPair).execute(); -Query the user's leverage account list. +Query user's isolated margin account list -Support querying risk rate per position account and margin rate per position account +Supports querying risk ratio isolated accounts and margin ratio isolated accounts ### Example @@ -680,7 +680,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginApi apiInstance = new MarginApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Currency pair. + String currencyPair = "BTC_USDT"; // String | Currency pair try { List result = apiInstance.listMarginUserAccount() .currencyPair(currencyPair) @@ -703,7 +703,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair. | [optional] + **currencyPair** | **String**| Currency pair | [optional] ### Return type @@ -721,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 @@ -752,10 +752,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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. - Integer offset = 0; // Integer | List offset, starting from 0. + Integer status = 56; // Integer | Filter by status. Supported values are 2 and 3. (deprecated.) + 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 { List result = apiInstance.listCrossMarginLoans(status) @@ -782,10 +782,10 @@ 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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **status** | **Integer**| Filter by status. Supported values are 2 and 3. (deprecated.) | + **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] ### Return type @@ -804,15 +804,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved. | - | +**200** | Query successful | - | # **listCrossMarginRepayments** > List<CrossMarginRepayment> listCrossMarginRepayments().currency(currency).loanId(loanId).limit(limit).offset(offset).reverse(reverse).execute(); -Retrieve cross margin repayments. (deprecated). +Retrieve cross margin repayments. (deprecated) -Sort by creation time in descending order by default. Set `reverse=false` to return ascending results. +Sorted by creation time in descending order by default. Set `reverse=false` for ascending order ### Example @@ -837,8 +837,8 @@ 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 offset = 0; // Integer | List offset, starting from 0. + 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 { List result = apiInstance.listCrossMarginRepayments() @@ -868,8 +868,8 @@ 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] - **offset** | **Integer**| List offset, starting from 0. | [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] **reverse** | **Boolean**| Whether to sort in descending order, which is the default. Set `reverse=false` to return ascending results | [optional] [default to true] ### Return type @@ -888,5 +888,5 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved. | - | +**200** | List retrieved successfully | - | diff --git a/docs/MarginLeverageTier.md b/docs/MarginLeverageTier.md index 59a94c2..c8fa212 100644 --- a/docs/MarginLeverageTier.md +++ b/docs/MarginLeverageTier.md @@ -1,13 +1,13 @@ # MarginLeverageTier -Market gradient information. +Market gradient information ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**upperLimit** | **String** | Maximum loan limit. | [optional] -**mmr** | **String** | Maintenance margin rate. | [optional] -**leverage** | **String** | Maximum leverage multiple. | [optional] +**upperLimit** | **String** | Maximum loan limit | [optional] +**mmr** | **String** | Maintenance margin rate | [optional] +**leverage** | **String** | Maximum leverage multiple | [optional] diff --git a/docs/MarginMarketLeverage.md b/docs/MarginMarketLeverage.md index bf4ecdc..2dcd63d 100644 --- a/docs/MarginMarketLeverage.md +++ b/docs/MarginMarketLeverage.md @@ -1,12 +1,12 @@ # MarginMarketLeverage -Market leverage settings. +Market leverage settings ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currencyPair** | **String** | Currency pair. | [optional] -**leverage** | **String** | Position leverage. | +**currencyPair** | **String** | Market | [optional] +**leverage** | **String** | Position leverage | diff --git a/docs/MarginTiers.md b/docs/MarginTiers.md index e175b36..53d86e2 100644 --- a/docs/MarginTiers.md +++ b/docs/MarginTiers.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**tier** | **String** | Tier. | [optional] -**marginRate** | **String** | Discount. | [optional] -**lowerLimit** | **String** | Lower limit. | [optional] -**upperLimit** | **String** | Upper limit, \"\" indicates greater than (the last tier). | [optional] -**leverage** | **String** | Position leverage. | [optional] +**tier** | **String** | Tier | [optional] +**marginRate** | **String** | Discount | [optional] +**lowerLimit** | **String** | Lower limit | [optional] +**upperLimit** | **String** | Upper limit, \"\" indicates greater than (the last tier) | [optional] +**leverage** | **String** | Position leverage | [optional] diff --git a/docs/MarginTransferable.md b/docs/MarginTransferable.md index b7685ff..3f983d7 100644 --- a/docs/MarginTransferable.md +++ b/docs/MarginTransferable.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency detail. | [optional] -**currencyPair** | **String** | Currency pair. | [optional] -**amount** | **String** | Max transferable amount. | [optional] +**currency** | **String** | Currency detail | [optional] +**currencyPair** | **String** | Currency pair | [optional] +**amount** | **String** | Max transferable amount | [optional] diff --git a/docs/MarginUniApi.md b/docs/MarginUniApi.md index 5c2e750..54e1d25 100644 --- a/docs/MarginUniApi.md +++ b/docs/MarginUniApi.md @@ -4,21 +4,21 @@ 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. -[**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. +[**listUniCurrencyPairs**](MarginUniApi.md#listUniCurrencyPairs) | **GET** /margin/uni/currency_pairs | List lending markets +[**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 | 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 # **listUniCurrencyPairs** > List<UniCurrencyPair> listUniCurrencyPairs() -List lending markets. +List lending markets ### Example @@ -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 @@ -97,7 +97,7 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); MarginUniApi apiInstance = new MarginUniApi(defaultClient); - String currencyPair = "AE_USDT"; // String | Currency pair. + String currencyPair = "AE_USDT"; // String | Currency pair try { UniCurrencyPair result = apiInstance.getUniCurrencyPair(currencyPair); System.out.println(result); @@ -118,7 +118,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair. | + **currencyPair** | **String**| Currency pair | ### Return type @@ -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 @@ -235,10 +235,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginUniApi apiInstance = new MarginUniApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Currency pair. - 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. + String currencyPair = "BTC_USDT"; // String | Currency pair + String currency = "BTC"; // String | Query by specified currency name + Integer page = 1; // Integer | Page number + Integer limit = 100; // Integer | Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 try { List result = apiInstance.listUniLoans() .currencyPair(currencyPair) @@ -264,10 +264,10 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair. | [optional] - **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] + **currencyPair** | **String**| Currency pair | [optional] + **currency** | **String**| Query by specified currency name | [optional] + **page** | **Integer**| Page number | [optional] [default to 1] + **limit** | **Integer**| Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100] ### Return type @@ -285,13 +285,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved. | - | +**200** | Query successful | - | # **createUniLoan** > createUniLoan(createUniLoan) -Borrow or repay. +Borrow or repay ### Example @@ -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 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. + 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 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] - **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] + **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 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 @@ -463,10 +463,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MarginUniApi apiInstance = new MarginUniApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Currency pair. - String currency = "BTC"; // String | Retrieve data of the specified currency. - Integer page = 1; // Integer | Page number. - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list. + String currencyPair = "BTC_USDT"; // String | Currency pair + String currency = "BTC"; // String | Query by specified currency name + Integer page = 1; // Integer | Page number + 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 { @@ -496,10 +496,10 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair. | [optional] - **currency** | **String**| Retrieve data of the specified 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] + **currencyPair** | **String**| Currency pair | [optional] + **currency** | **String**| Query by specified currency name | [optional] + **page** | **Integer**| Page number | [optional] [default to 1] + **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] @@ -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,8 +548,8 @@ 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 currencyPair = "BTC_USDT"; // String | Currency pair. + String currency = "BTC"; // String | Query by specified currency name + String currencyPair = "BTC_USDT"; // String | Currency pair try { MaxUniBorrowable result = apiInstance.getUniBorrowable(currency, currencyPair); System.out.println(result); @@ -570,8 +570,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency. | - **currencyPair** | **String**| Currency pair. | + **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/MaxUniBorrowable.md b/docs/MaxUniBorrowable.md index 1fadabc..22621c1 100644 --- a/docs/MaxUniBorrowable.md +++ b/docs/MaxUniBorrowable.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency. | [readonly] -**currencyPair** | **String** | Currency pair. | [optional] [readonly] -**borrowable** | **String** | Maximum borrowable. | [readonly] +**currency** | **String** | Currency | [readonly] +**currencyPair** | **String** | Currency pair | [optional] [readonly] +**borrowable** | **String** | Maximum borrowable | [readonly] diff --git a/docs/MockFuturesOrder.md b/docs/MockFuturesOrder.md index 35a86cd..8860ed2 100644 --- a/docs/MockFuturesOrder.md +++ b/docs/MockFuturesOrder.md @@ -1,13 +1,13 @@ # MockFuturesOrder -Futures order. +Futures order ## Properties 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. | -**left** | **String** | Unfilled contract quantity, involved in actual calculation. | +**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 ec4b042..733eff4 100644 --- a/docs/MockFuturesPosition.md +++ b/docs/MockFuturesPosition.md @@ -1,12 +1,12 @@ # MockFuturesPosition -Futures positions. +Futures positions ## Properties 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 a357697..2a01ae7 100644 --- a/docs/MockMarginResult.md +++ b/docs/MockMarginResult.md @@ -1,17 +1,17 @@ # MockMarginResult -Margin result. +Margin result ## Properties 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` position | [optional] -**profitLossRanges** | [**List<ProfitLossRange>**](ProfitLossRange.md) | The results of 3 pressure scenarios for MR1. | [optional] +**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) | Results of 33 stress scenarios for MR1 | [optional] **maxLoss** | [**ProfitLossRange**](.md) | 最大损失 | [optional] -**mr1** | **String** | Stress testing. | [optional] -**mr2** | **String** | Basis spread risk. | [optional] -**mr3** | **String** | Volatility spread risk. | [optional] -**mr4** | **String** | Option short risk. | [optional] +**mr1** | **String** | Stress testing | [optional] +**mr2** | **String** | Basis spread risk | [optional] +**mr3** | **String** | Volatility spread risk | [optional] +**mr4** | **String** | Option short risk | [optional] diff --git a/docs/MockOptionsOrder.md b/docs/MockOptionsOrder.md index aa490fb..41ff221 100644 --- a/docs/MockOptionsOrder.md +++ b/docs/MockOptionsOrder.md @@ -1,13 +1,13 @@ # MockOptionsOrder -Option orders. +Option orders ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**optionsName** | **String** | Option name, currently only supports options for BTC and ETH with USDT. | -**size** | **String** | Initial order quantity, not involved in actual calculation. | -**left** | **String** | Unfilled contract quantity, involved in actual calculation. | +**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 5a25e38..c0b8c66 100644 --- a/docs/MockOptionsPosition.md +++ b/docs/MockOptionsPosition.md @@ -1,12 +1,12 @@ # MockOptionsPosition -Options positions. +Options positions ## Properties 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 882ef9f..2080695 100644 --- a/docs/MockRiskUnit.md +++ b/docs/MockRiskUnit.md @@ -1,19 +1,19 @@ # MockRiskUnit -Risk unit. +Risk unit ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**symbol** | **String** | Risk unit name. | [optional] -**spotInUse** | **String** | Spot usage. | [optional] -**maintainMargin** | **String** | Maintenance margin. | [optional] -**initialMargin** | **String** | Initial margin. | [optional] -**marginResult** | [**List<MockMarginResult>**](MockMarginResult.md) | Margin result. | [optional] -**delta** | **String** | Total Delta of risk unit. | [optional] -**gamma** | **String** | Total Gamma of risk unit. | [optional] -**theta** | **String** | Total Theta of risk unit. | [optional] -**vega** | **String** | Total Vega of risk unit. | [optional] +**symbol** | **String** | Risk unit name | [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] +**delta** | **String** | Total Delta of risk unit | [optional] +**gamma** | **String** | Total Gamma of risk unit | [optional] +**theta** | **String** | Total Theta of risk unit | [optional] +**vega** | **String** | Total Vega of risk unit | [optional] diff --git a/docs/MockSpotBalance.md b/docs/MockSpotBalance.md index 2899e5e..a1228c5 100644 --- a/docs/MockSpotBalance.md +++ b/docs/MockSpotBalance.md @@ -1,12 +1,12 @@ # MockSpotBalance -Spot. +Spot ## Properties 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. | +**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 BTC and ETH | diff --git a/docs/MockSpotOrder.md b/docs/MockSpotOrder.md index b6ea3f4..df55fea 100644 --- a/docs/MockSpotOrder.md +++ b/docs/MockSpotOrder.md @@ -1,15 +1,15 @@ # MockSpotOrder -Spot orders. +Spot orders ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currencyPairs** | **String** | Currency pair. | -**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. | +**currencyPairs** | **String** | Market | +**orderPrice** | **String** | Price | +**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/MultiChainAddressItem.md b/docs/MultiChainAddressItem.md index d5e3f03..64ff9cd 100644 --- a/docs/MultiChainAddressItem.md +++ b/docs/MultiChainAddressItem.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**chain** | **String** | Name of the chain. | [optional] -**address** | **String** | Deposit address. | [optional] -**paymentId** | **String** | Notes that some currencies required(e.g., Tag, Memo) when depositing. | [optional] -**paymentName** | **String** | Note type, `Tag` or `Memo`. | [optional] +**chain** | **String** | Name of the chain | [optional] +**address** | **String** | Deposit address | [optional] +**paymentId** | **String** | Notes that some currencies required(e.g., Tag, Memo) when depositing | [optional] +**paymentName** | **String** | Note type, `Tag` or `Memo` | [optional] **obtainFailed** | **Integer** | The obtain failed status- 0: address successfully obtained- 1: failed to obtain address | [optional] diff --git a/docs/MultiCollateralCurrency.md b/docs/MultiCollateralCurrency.md index 6fcb5f8..b1e08bc 100644 --- a/docs/MultiCollateralCurrency.md +++ b/docs/MultiCollateralCurrency.md @@ -1,12 +1,12 @@ # MultiCollateralCurrency -Borrowing and collateral currencies supported for Multi-Collateral. +Borrowing and collateral currencies supported for Multi-Collateral ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**loanCurrencies** | [**List<MultiLoanItem>**](MultiLoanItem.md) | List of supported borrowing currencies. | [optional] -**collateralCurrencies** | [**List<MultiCollateralItem>**](MultiCollateralItem.md) | List of supported collateral currencies. | [optional] +**loanCurrencies** | [**List<MultiLoanItem>**](MultiLoanItem.md) | List of supported borrowing currencies | [optional] +**collateralCurrencies** | [**List<MultiCollateralItem>**](MultiCollateralItem.md) | List of supported collateral currencies | [optional] diff --git a/docs/MultiCollateralItem.md b/docs/MultiCollateralItem.md index 27524de..9bf8bf4 100644 --- a/docs/MultiCollateralItem.md +++ b/docs/MultiCollateralItem.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency. | [optional] -**indexPrice** | **String** | Currency Index Price. | [optional] -**discount** | **String** | Discount. | [optional] +**currency** | **String** | Currency | [optional] +**indexPrice** | **String** | Currency Index Price | [optional] +**discount** | **String** | Discount | [optional] diff --git a/docs/MultiCollateralLoanApi.md b/docs/MultiCollateralLoanApi.md index e33bb8f..46a4d93 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. -[**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. +[**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 | 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 @@ -45,10 +45,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 | Query the current interest rate of the currency in the previous hour. - String orderType = "current"; // String | Order type: current - Query current orders, fixed - Query fixed orders, defaults to current orders if not specified + Integer page = 1; // Integer | Page number + 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 specifiedOrder type: current - Query current orders, fixed - Query fixed orders, defaults to current orders if not specified try { List result = apiInstance.listMultiCollateralOrders() .page(page) @@ -74,10 +74,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] - **sort** | **String**| Query the current interest rate of the currency in the previous hour. | [optional] - **orderType** | **String**| Order type: current - Query current orders, fixed - Query fixed orders, defaults to current orders if not specified | [optional] + **page** | **Integer**| Page number | [optional] [default to 1] + **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 specifiedOrder 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 @@ -260,12 +260,12 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); MultiCollateralLoanApi apiInstance = new MultiCollateralLoanApi(defaultClient); - 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. + 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 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) @@ -292,12 +292,12 @@ public class Example { 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] + **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 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,13 +383,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Operated successfully. | - | +**200** | Operation successful | - | # **listMultiCollateralRecords** > List<MultiCollateralRecord> listMultiCollateralRecords().page(page).limit(limit).from(from).to(to).collateralCurrency(collateralCurrency).execute(); -Query collateral adjustment records. +Query collateral adjustment records ### Example @@ -412,11 +412,11 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 page = 1; // Integer | Page number + 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) @@ -443,11 +443,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 10] - **from** | **Long**| Start timestamp of the query. | [optional] - **to** | **Long**| Time range ending, default to current time. | [optional] - **collateralCurrency** | **String**| Collateral. | [optional] + **page** | **Integer**| Page number | [optional] [default to 1] + **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 type: collateral - Collateral currency, borrow - Borrowing. - String currency = "BTC"; // String | When it is a collateral currency, multiple currencies can be passed separated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one commas; when it is a borrowing currency, only one currency can be passed + 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 type: collateral - Collateral currency, borrow - Borrowing. | - **currency** | **String**| When it is a collateral currency, multiple currencies can be passed separated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one commas; when it is a borrowing currency, only one currency can be passed | + **type** | **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 previous 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 currency name query array, separated by commas, maximum 100items. - 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 currency name query array, separated by commas, maximum 100items. | - **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 b4b1af1..bc39f2c 100644 --- a/docs/MultiCollateralOrder.md +++ b/docs/MultiCollateralOrder.md @@ -1,24 +1,24 @@ # MultiCollateralOrder -Multi-Collateral Order. +Multi-Collateral Order ## Properties 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] -**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] +**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] +**fixedRate** | **String** | Fixed interest 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] -**borrowCurrencies** | [**List<BorrowCurrencyInfo>**](BorrowCurrencyInfo.md) | Borrowing Currency List. | [optional] -**collateralCurrencies** | [**List<CollateralCurrencyInfo>**](CollateralCurrencyInfo.md) | Collateral Currency List. | [optional] +**borrowTime** | **Long** | Borrowing time, timestamp in seconds | [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 d21664c..c800ba4 100644 --- a/docs/MultiCollateralRecord.md +++ b/docs/MultiCollateralRecord.md @@ -1,17 +1,17 @@ # MultiCollateralRecord -Multi-Collateral adjustment record. +Multi-Collateral adjustment record ## Properties 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] -**borrowCurrencies** | [**List<MultiCollateralRecordCurrency>**](MultiCollateralRecordCurrency.md) | Borrowing Currency List. | [optional] -**collateralCurrencies** | [**List<MultiCollateralRecordCurrency>**](MultiCollateralRecordCurrency.md) | Collateral Currency List. | [optional] +**orderId** | **Long** | Order ID | [optional] +**recordId** | **Long** | Collateral record ID | [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 994e784..b147ff0 100644 --- a/docs/MultiCollateralRecordCurrency.md +++ b/docs/MultiCollateralRecordCurrency.md @@ -5,10 +5,10 @@ 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] +**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] diff --git a/docs/MultiLoanItem.md b/docs/MultiLoanItem.md index 2f7939a..ce949d7 100644 --- a/docs/MultiLoanItem.md +++ b/docs/MultiLoanItem.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency. | [optional] -**price** | **String** | Latest price of the currency. | [optional] +**currency** | **String** | Currency | [optional] +**price** | **String** | Latest price of the currency | [optional] diff --git a/docs/MultiLoanRepayItem.md b/docs/MultiLoanRepayItem.md index b7d31d5..e0268aa 100644 --- a/docs/MultiLoanRepayItem.md +++ b/docs/MultiLoanRepayItem.md @@ -5,7 +5,7 @@ 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] +**currency** | **String** | Repayment currency | [optional] +**amount** | **String** | Size | [optional] +**repaidAll** | **Boolean** | Repayment method, set to true for full repayment, false for partial repayment | [optional] diff --git a/docs/MultiRepayRecord.md b/docs/MultiRepayRecord.md index c7e2d12..43880bd 100644 --- a/docs/MultiRepayRecord.md +++ b/docs/MultiRepayRecord.md @@ -1,22 +1,22 @@ # MultiRepayRecord -Mult Repay Record. +Multi-Collateral Repayment Record ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**orderId** | **Long** | Order ID. | [optional] -**recordId** | **Long** | Repayment record ID. | [optional] -**initLtv** | **String** | The 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] -**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] +**orderId** | **Long** | Order ID | [optional] +**recordId** | **Long** | Repayment record ID | [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] +**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 remaining interest to be repaid | [optional] diff --git a/docs/MultiRepayResp.md b/docs/MultiRepayResp.md index 77f5be6..afdbea9 100644 --- a/docs/MultiRepayResp.md +++ b/docs/MultiRepayResp.md @@ -1,12 +1,12 @@ # MultiRepayResp -Repay Multi-Collateral Loan. +Multi-currency collateral repayment ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**orderId** | **Long** | Order ID. | [optional] -**repaidCurrencies** | [**List<RepayCurrencyRes>**](RepayCurrencyRes.md) | Repay Currency List. | [optional] +**orderId** | **Long** | Order ID | [optional] +**repaidCurrencies** | [**List<RepayCurrencyRes>**](RepayCurrencyRes.md) | Repay Currency List | [optional] diff --git a/docs/MyFuturesTrade.md b/docs/MyFuturesTrade.md index 3139059..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] -**contract** | **String** | Futures contract. | [optional] -**orderId** | **String** | Order ID related. | [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 > 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] +**id** | **Long** | Fill ID | [optional] +**createTime** | **Double** | Fill Time | [optional] +**contract** | **String** | Futures contract | [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 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 e0b4bf8..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] -**contract** | **String** | Futures contract. | [optional] -**orderId** | **String** | Order ID related. | [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 > 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] +**tradeId** | **String** | Fill ID | [optional] +**createTime** | **Double** | Fill Time | [optional] +**contract** | **String** | Futures contract | [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 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 ccf9f7d..75b0f2e 100644 --- a/docs/OpenOrders.md +++ b/docs/OpenOrders.md @@ -5,7 +5,7 @@ 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] +**currencyPair** | **String** | Currency pair | [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 0335ebc..df62861 100644 --- a/docs/OptionsAccount.md +++ b/docs/OptionsAccount.md @@ -5,24 +5,24 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**user** | **Long** | User ID. | [optional] -**total** | **String** | Account balance. | [optional] +**user** | **Long** | User ID | [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] -**mmpEnabled** | **Boolean** | Whether to enable MMP. | [optional] -**liqTriggered** | **Boolean** | Whether to trigger position liquidation. | [optional] +**equity** | **String** | Account equity, the sum of account balance and position value | [optional] +**shortEnabled** | **Boolean** | If the account is allowed to short | [optional] +**mmpEnabled** | **Boolean** | Whether to enable MMP | [optional] +**liqTriggered** | **Boolean** | Whether to trigger position liquidation | [optional] **marginMode** | [**MarginModeEnum**](#MarginModeEnum) | ｜ 保证金模式： - 0：经典现货保证金模式 - 1：跨币种保证金模式 - 2：组合保证金模式 | [optional] -**unrealisedPnl** | **String** | Unrealized PNL. | [optional] -**initMargin** | **String** | Initial position margin. | [optional] -**maintMargin** | **String** | Position maintenance margin. | [optional] -**orderMargin** | **String** | Order margin of unfinished orders. | [optional] -**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] -**ordersLimit** | **Integer** | Maximum number of outstanding orders. | [optional] +**unrealisedPnl** | **String** | Unrealized PNL | [optional] +**initMargin** | **String** | Initial position margin | [optional] +**maintMargin** | **String** | Position maintenance margin | [optional] +**orderMargin** | **String** | Order margin of unfinished orders | [optional] +**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 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] ## Enum: MarginModeEnum diff --git a/docs/OptionsAccountBook.md b/docs/OptionsAccountBook.md index 58826d5..7c12eb6 100644 --- a/docs/OptionsAccountBook.md +++ b/docs/OptionsAccountBook.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**time** | **Double** | Change time. | [optional] -**change** | **String** | Amount changed (USDT). | [optional] -**balance** | **String** | Account total balance after change (USDT). | [optional] +**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_fee: POINT Trading fee - point_refr: POINT Referrer rebate | [optional] -**text** | **String** | custom text. | [optional] +**text** | **String** | Remark | [optional] diff --git a/docs/OptionsApi.md b/docs/OptionsApi.md index bf208a4..a55b055 100644 --- a/docs/OptionsApi.md +++ b/docs/OptionsApi.md @@ -4,31 +4,31 @@ All URIs are relative to *https://api.gateio.ws/api/v4* Method | HTTP request | Description ------------- | ------------- | ------------- -[**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. -[**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. -[**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. -[**countdownCancelAllOptions**](OptionsApi.md#countdownCancelAllOptions) | **POST** /options/countdown_cancel_all | Countdown cancel orders. -[**listMyOptionsTrades**](OptionsApi.md#listMyOptionsTrades) | **GET** /options/my_trades | List personal trading history. +[**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 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 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 | 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 @@ -117,7 +117,7 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); OptionsApi apiInstance = new OptionsApi(defaultClient); - String underlying = "BTC_USDT"; // String | Underlying (Obtained by listing underlying endpoint). + String underlying = "BTC_USDT"; // String | Underlying (Obtained by listing underlying endpoint) try { List result = apiInstance.listOptionsExpirations(underlying); System.out.println(result); @@ -138,7 +138,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **underlying** | **String**| Underlying (Obtained by listing underlying endpoint). | + **underlying** | **String**| Underlying (Obtained by listing underlying endpoint) | ### Return type @@ -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 @@ -181,8 +181,8 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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. + String underlying = "BTC_USDT"; // String | Underlying (Obtained by listing underlying endpoint) + Long expiration = 1636588800L; // Long | Unix timestamp of expiration date try { List result = apiInstance.listOptionsContracts(underlying) .expiration(expiration) @@ -205,8 +205,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **underlying** | **String**| Underlying (Obtained by listing underlying endpoint). | - **expiration** | **Long**| Unix timestamp of the expiration time. | [optional] + **underlying** | **String**| Underlying (Obtained by listing underlying endpoint) | + **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,13 +288,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved. | - | +**200** | Query successful | - | # **listOptionsSettlements** > List<OptionsSettlement> listOptionsSettlements(underlying).limit(limit).offset(offset).from(from).to(to).execute(); -List settlement history. +List settlement history ### Example @@ -313,9 +313,9 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 offset = 0; // Integer | List offset, starting from 0. + String underlying = "BTC_USDT"; // String | Underlying (Obtained by listing underlying endpoint) + 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 try { @@ -343,9 +343,9 @@ 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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **underlying** | **String**| Underlying (Obtained by listing underlying endpoint) | + **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] @@ -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 @@ -391,7 +391,7 @@ public class Example { OptionsApi apiInstance = new OptionsApi(defaultClient); String contract = "BTC_USDT-20211130-65000-C"; // String | - String underlying = "BTC_USDT"; // String | Underlying (Obtained by listing underlying endpoint). + String underlying = "BTC_USDT"; // String | Underlying (Obtained by listing underlying endpoint) Long at = 56L; // Long | try { OptionsSettlement result = apiInstance.getOptionsSettlement(contract, underlying, at); @@ -414,7 +414,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **contract** | **String**| | - **underlying** | **String**| Underlying (Obtained by listing underlying endpoint). | + **underlying** | **String**| Underlying (Obtained by listing underlying endpoint) | **at** | **Long**| | ### Return type @@ -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 @@ -462,10 +462,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 offset = 0; // Integer | List offset, starting from 0. + 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 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 try { @@ -494,10 +494,10 @@ public class Example { 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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **underlying** | **String**| Underlying (Obtained by listing underlying endpoint) | + **contract** | **String**| Options contract name | [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 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] @@ -517,15 +517,15 @@ 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. +Bids will be sorted by price from high to low, while asks sorted reversely ### Example @@ -544,10 +544,10 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 to return depth update ID. This ID increments by 1 each time. + String contract = "BTC_USDT-20210916-5000-C"; // String | Options contract name + 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) @@ -572,10 +572,10 @@ 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 to return depth update ID. This ID increments by 1 each time. | [optional] [default to false] + **contract** | **String**| Options contract name | + **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** | Depth query successful. | - | +**200** | Depth query successful | - | # **listOptionsTickers** > List<OptionsTicker> listOptionsTickers(underlying) -List tickers of options contracts. +Query options market ticker information ### Example @@ -618,7 +618,7 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); OptionsApi apiInstance = new OptionsApi(defaultClient); - String underlying = "BTC_USDT"; // String | Underlying (Obtained by listing underlying endpoint). + String underlying = "BTC_USDT"; // String | Underlying (Obtained by listing underlying endpoint) try { List result = apiInstance.listOptionsTickers(underlying); System.out.println(result); @@ -639,7 +639,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **underlying** | **String**| Underlying (Obtained by listing underlying endpoint). | + **underlying** | **String**| Underlying (Obtained by listing underlying endpoint) | ### Return type @@ -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 @@ -682,7 +682,7 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); OptionsApi apiInstance = new OptionsApi(defaultClient); - String underlying = "BTC_USDT"; // String | Underlying. + String underlying = "BTC_USDT"; // String | Underlying try { OptionsUnderlyingTicker result = apiInstance.listOptionsUnderlyingTickers(underlying); System.out.println(result); @@ -703,7 +703,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **underlying** | **String**| Underlying. | + **underlying** | **String**| Underlying | ### Return type @@ -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 @@ -746,11 +746,11 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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. + String contract = "BTC_USDT-20210916-5000-C"; // String | Options contract name + 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 | Interval time between data points. + String interval = "5m"; // String | Time interval between data points try { List result = apiInstance.listOptionsCandlesticks(contract) .limit(limit) @@ -776,11 +776,11 @@ 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] + **contract** | **String**| Options contract name | + **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**| Interval time between data points. | [optional] [default to 5m] [enum: 1m, 5m, 15m, 30m, 1h] + **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 @@ -823,11 +823,11 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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. + String underlying = "BTC_USDT"; // String | Underlying (Obtained by listing underlying endpoint) + 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 | Interval time between data points. + String interval = "5m"; // String | Time interval between data points try { List result = apiInstance.listOptionsUnderlyingCandlesticks(underlying) .limit(limit) @@ -853,11 +853,11 @@ 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] + **underlying** | **String**| Underlying (Obtained by listing underlying endpoint) | + **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**| Interval time between data points. | [optional] [default to 5m] [enum: 1m, 5m, 15m, 30m, 1h] + **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 @@ -900,10 +900,10 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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. - Integer offset = 0; // Integer | List offset, starting from 0. + String contract = "BTC_USDT-20210916-5000-C"; // String | Options contract name + 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 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 { @@ -933,10 +933,10 @@ 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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **contract** | **String**| Options contract name | [optional] + **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 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] @@ -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 offset = 0; // Integer | List offset, starting from 0. + 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 - String type = "dnw"; // String | Changing Type: - dnw: Deposit & Withdraw - prem: Trading premium - fee: Trading fee - refr: Referrer rebate - set: settlement PNL + 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] - **offset** | **Integer**| List offset, starting from 0. | [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] - **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] + **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,13 +1102,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved. | - | +**200** | List retrieved successfully | - | # **listOptionsPositions** > List<OptionsPosition> listOptionsPositions().underlying(underlying).execute(); -List user's positions of specified underlying. +List user's positions of specified underlying ### Example @@ -1131,7 +1131,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); OptionsApi apiInstance = new OptionsApi(defaultClient); - String underlying = "BTC_USDT"; // String | Underlying. + String underlying = "BTC_USDT"; // String | Underlying try { List result = apiInstance.listOptionsPositions() .underlying(underlying) @@ -1154,7 +1154,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **underlying** | **String**| Underlying. | [optional] + **underlying** | **String**| Underlying | [optional] ### Return type @@ -1172,13 +1172,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved. | - | +**200** | List retrieved successfully | - | # **getOptionsPosition** > OptionsPosition getOptionsPosition(contract) -Get specified contract position. +Get specified contract position ### Example @@ -1240,13 +1240,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved. | - | +**200** | Query successful | - | # **listOptionsPositionClose** > List<OptionsPositionClose> listOptionsPositionClose(underlying).contract(contract).execute(); -List user's liquidation history of specified underlying. +List user's liquidation history of specified underlying ### Example @@ -1269,8 +1269,8 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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. + String underlying = "BTC_USDT"; // String | Underlying (Obtained by listing underlying endpoint) + String contract = "BTC_USDT-20210916-5000-C"; // String | Options contract name try { List result = apiInstance.listOptionsPositionClose(underlying) .contract(contract) @@ -1293,8 +1293,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **underlying** | **String**| Underlying (Obtained by listing underlying endpoint). | - **contract** | **String**| Options contract name. | [optional] + **underlying** | **String**| Underlying (Obtained by listing underlying endpoint) | + **contract** | **String**| Options contract name | [optional] ### Return type @@ -1312,13 +1312,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved. | - | +**200** | List retrieved successfully | - | # **listOptionsOrders** > List<OptionsOrder> listOptionsOrders(status).contract(contract).underlying(underlying).limit(limit).offset(offset).from(from).to(to).execute(); -List options orders. +List options orders ### Example @@ -1341,11 +1341,11 @@ 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 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 offset = 0; // Integer | List offset, starting from 0. + 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 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 try { @@ -1375,11 +1375,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **status** | **String**| Only list the orders with this 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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **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 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] @@ -1399,13 +1399,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved. | - | +**200** | List retrieved successfully | - | # **createOptionsOrder** > OptionsOrder createOptionsOrder(optionsOrder) -Create an options order. +Create an options order ### Example @@ -1467,13 +1467,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Order detail. | - | +**201** | Order detail | - | # **cancelOptionsOrders** > List<OptionsOrder> cancelOptionsOrders(contract, underlying, side) -Cancel all `open` orders matched. +Cancel all orders with 'open' status ### Example @@ -1496,9 +1496,9 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 contract = "BTC_USDT-20210916-5000-C"; // String | Options contract name + String underlying = "BTC_USDT"; // String | Underlying + 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); @@ -1519,9 +1519,9 @@ public class Example { 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] + **contract** | **String**| Options contract name | [optional] + **underlying** | **String**| Underlying | [optional] + **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 @@ -1607,13 +1607,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order detail. | - | +**200** | Order detail | - | # **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 @@ -1675,13 +1675,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order detail. | - | +**200** | Order detail | - | # **countdownCancelAllOptions** > TriggerTime countdownCancelAllOptions(countdownCancelAllOptionsTask) -Countdown cancel orders. +Countdown cancel orders Option order heartbeat detection, when the `timeout` time set by the user is reached, if the existing countdown is not canceled or a new countdown is set, the related `option pending order` will be automatically canceled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at intervals of 30 seconds, with each countdown `timeout` set to 30 (seconds). If this interface is not called again within 30 seconds, all pending orders on the `underlying` `contract` you specified will be automatically cancelled. If `underlying` `contract` is not specified, user will be automatically cancelled If `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the automatic order cancellation function will be cancelled. @@ -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 @@ -1774,10 +1774,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 offset = 0; // Integer | List offset, starting from 0. + 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 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 try { @@ -1806,10 +1806,10 @@ public class Example { 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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **underlying** | **String**| Underlying (Obtained by listing underlying endpoint) | + **contract** | **String**| Options contract name | [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 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] @@ -1829,7 +1829,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved. | - | +**200** | List retrieved successfully | - | # **getOptionsMMP** @@ -1858,7 +1858,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); OptionsApi apiInstance = new OptionsApi(defaultClient); - String underlying = "BTC_USDT"; // String | Underlying. + String underlying = "BTC_USDT"; // String | Underlying try { List result = apiInstance.getOptionsMMP() .underlying(underlying) @@ -1881,7 +1881,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **underlying** | **String**| Underlying. | [optional] + **underlying** | **String**| Underlying | [optional] ### Return type @@ -1899,7 +1899,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved. | - | +**200** | Query successful | - | # **setOptionsMMP** @@ -1967,7 +1967,7 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | MMP Information. | - | +**200** | MMP Information | - | # **resetOptionsMMP** @@ -2035,5 +2035,5 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | MMP Information. | - | +**200** | MMP Information | - | diff --git a/docs/OptionsCandlestick.md b/docs/OptionsCandlestick.md index 6b1b8ce..1f6a717 100644 --- a/docs/OptionsCandlestick.md +++ b/docs/OptionsCandlestick.md @@ -1,16 +1,16 @@ # OptionsCandlestick -data point in every timestamp. +data point in every timestamp ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**t** | **Double** | Unix timestamp in seconds. | [optional] -**v** | **Long** | size volume (contract size). Only returned if `contract` is not prefixed. | [optional] -**c** | **String** | Close price (quote currency, unit: underlying corresponding option price). | [optional] +**t** | **Double** | Unix timestamp in seconds | [optional] +**v** | **Long** | size volume (contract size). Only returned if `contract` is not prefixed | [optional] +**c** | **String** | Close price (quote currency, unit: underlying corresponding option price) | [optional] **h** | **String** | Highest price (quote currency, unit: underlying corresponding option price) | [optional] -**l** | **String** | Lowest price (quote currency, unit: underlying corresponding option price). | [optional] -**o** | **String** | Open price (quote currency, unit: underlying corresponding option price). | [optional] +**l** | **String** | Lowest price (quote currency, unit: underlying corresponding option price) | [optional] +**o** | **String** | Open price (quote currency, unit: underlying corresponding option price) | [optional] diff --git a/docs/OptionsContract.md b/docs/OptionsContract.md index 360f600..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] -**expirationTime** | **Double** | Expiration time. | [optional] -**isCall** | **Boolean** | `true` means call options, while `false` is 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] -**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 `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] -**tradeId** | **Long** | Current trade ID. | [optional] -**tradeSize** | **Long** | Historical accumulated trade size. | [optional] -**positionSize** | **Long** | Current total long position size. | [optional] -**ordersLimit** | **Integer** | Maximum number of open orders. | [optional] +**name** | **String** | Options contract name | [optional] +**tag** | **String** | Tag | [optional] +**createTime** | **Double** | Created time | [optional] +**expirationTime** | **Double** | Expiration time | [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, 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 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 cumulative trading volume | [optional] +**positionSize** | **Long** | Current total long position size | [optional] +**ordersLimit** | **Integer** | Maximum number of pending orders | [optional] diff --git a/docs/OptionsMMP.md b/docs/OptionsMMP.md index 29b1f46..2465f3a 100644 --- a/docs/OptionsMMP.md +++ b/docs/OptionsMMP.md @@ -7,11 +7,11 @@ MMP Settings Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**underlying** | **String** | Underlying. | -**window** | **Integer** | Time window (milliseconds), between 1-5000, 0 means disabling MMP. | +**underlying** | **String** | Underlying | +**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] +**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] diff --git a/docs/OptionsMMPReset.md b/docs/OptionsMMPReset.md index acb53cd..8f90a9c 100644 --- a/docs/OptionsMMPReset.md +++ b/docs/OptionsMMPReset.md @@ -7,11 +7,11 @@ MMP Reset Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**underlying** | **String** | Underlying. | -**window** | **Integer** | Time window (milliseconds), between 1-5000, 0 means disabling MMP. | [optional] [readonly] +**underlying** | **String** | Underlying | +**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] +**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] diff --git a/docs/OptionsMySettlements.md b/docs/OptionsMySettlements.md index 44f76fb..1bf8c76 100644 --- a/docs/OptionsMySettlements.md +++ b/docs/OptionsMySettlements.md @@ -5,13 +5,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**time** | **Double** | Settlement time. | [optional] -**underlying** | **String** | Underlying. | [optional] -**contract** | **String** | Options contract name. | [optional] -**strikePrice** | **String** | Strike price (quote currency). | [optional] -**settlePrice** | **String** | Settlement price (quote currency). | [optional] -**size** | **Long** | 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] +**time** | **Double** | Settlement time | [optional] +**underlying** | **String** | Underlying | [optional] +**contract** | **String** | Options contract name | [optional] +**strikePrice** | **String** | Strike price (quote currency) | [optional] +**settlePrice** | **String** | Settlement price (quote currency) | [optional] +**size** | **Long** | Settlement size | [optional] +**settleProfit** | **String** | Settlement profit (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 8e9cd59..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] -**contract** | **String** | Options contract name. | [optional] -**orderId** | **Integer** | Order ID related. | [optional] -**size** | **Long** | Trading size. | [optional] -**price** | **String** | Trading price (quote currency). | [optional] -**underlyingPrice** | **String** | Underlying price (quote currency). | [optional] -**role** | [**RoleEnum**](#RoleEnum) | Trade role. Available values are `taker` and `maker`. | [optional] +**id** | **Long** | Fill ID | [optional] +**createTime** | **Double** | Fill Time | [optional] +**contract** | **String** | Options contract name | [optional] +**orderId** | **Integer** | Related order ID | [optional] +**size** | **Long** | Trading size | [optional] +**price** | **String** | Trade price (quote currency) | [optional] +**underlyingPrice** | **String** | Underlying price (quote currency) | [optional] +**role** | [**RoleEnum**](#RoleEnum) | Trade role. taker - taker, maker - maker | [optional] ## Enum: RoleEnum diff --git a/docs/OptionsOrder.md b/docs/OptionsOrder.md index 0fd591a..e35daf6 100644 --- a/docs/OptionsOrder.md +++ b/docs/OptionsOrder.md @@ -1,37 +1,37 @@ # OptionsOrder -Options order detail. +Options order details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Long** | Options 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) | Ending method, including: - filled: fully completed - canceled: user canceled - liquidated: forced liquidation cancellation - ioc: Not fully filled immediately because tif is set to ioc - auto_deleveraged: automatic deleveraging cancel - reduce_only: Increased position is cancelled, or the position is closed - position_closed: Because the position was closed, the pending order was canceled - reduce_out: Only reduce the excluded pending orders that are not easy to be filled - mmp_cancelled: MMP canceled | [optional] [readonly] -**status** | [**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] -**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] +**id** | **Long** | Options 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) | 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, 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] -**refr** | **String** | Referrer rebate. | [optional] [readonly] +**tkfr** | **String** | Taker fee | [optional] [readonly] +**mkfr** | **String** | Maker fee | [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 52929c7..958bf5c 100644 --- a/docs/OptionsPosition.md +++ b/docs/OptionsPosition.md @@ -1,26 +1,26 @@ # OptionsPosition -Options position information. +Options contract position details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**user** | **Integer** | User ID. | [optional] [readonly] -**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] -**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] -**unrealisedPnl** | **String** | Unrealized PNL. | [optional] [readonly] -**pendingOrders** | **Integer** | Current open orders. | [optional] [readonly] +**user** | **Integer** | User ID | [optional] [readonly] +**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 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] +**unrealisedPnl** | **String** | Unrealized PNL | [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 09cec44..7f241db 100644 --- a/docs/OptionsPositionClose.md +++ b/docs/OptionsPositionClose.md @@ -5,12 +5,12 @@ 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] +**time** | **Double** | Position close time | [optional] [readonly] +**contract** | **String** | Options contract name | [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 9aac5c4..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 53a9f8e..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] -**contract** | **String** | Options contract name. | [optional] -**profit** | **String** | Settlement profit per size (quote currency). | [optional] -**fee** | **String** | Settlement fee per size (quote currency). | [optional] -**strikePrice** | **String** | Strike price (quote currency). | [optional] -**settlePrice** | **String** | Settlement price (quote currency). | [optional] +**time** | **Double** | Last configuration update time | [optional] +**contract** | **String** | Options contract name | [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 0063138..4f01c27 100644 --- a/docs/OptionsTicker.md +++ b/docs/OptionsTicker.md @@ -1,28 +1,28 @@ # 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] -**markPrice** | **String** | Current mark price (quote currency). | [optional] -**indexPrice** | **String** | Current index price (quote currency). | [optional] -**ask1Size** | **Long** | Best ask size. | [optional] -**ask1Price** | **String** | Best ask price. | [optional] -**bid1Size** | **Long** | Best bid size. | [optional] -**bid1Price** | **String** | Best bid price. | [optional] -**positionSize** | **Long** | Current total long position size. | [optional] -**markIv** | **String** | Implied volatility. | [optional] -**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] -**rho** | **String** | Rho. | [optional] +**name** | **String** | Options contract name | [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] +**ask1Price** | **String** | Best ask price | [optional] +**bid1Size** | **Long** | Best bid size | [optional] +**bid1Price** | **String** | Best bid price | [optional] +**positionSize** | **Long** | Current total long position size | [optional] +**markIv** | **String** | Implied volatility | [optional] +**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** | 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/OptionsUnderlying.md b/docs/OptionsUnderlying.md index 06f9abf..40e0148 100644 --- a/docs/OptionsUnderlying.md +++ b/docs/OptionsUnderlying.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | Underlying name. | [optional] -**indexPrice** | **String** | Spot index price (quote currency). | [optional] +**name** | **String** | Underlying name | [optional] +**indexPrice** | **String** | Spot index price (quote currency) | [optional] diff --git a/docs/OptionsUnderlyingTicker.md b/docs/OptionsUnderlyingTicker.md index 0f1a924..19d8af3 100644 --- a/docs/OptionsUnderlyingTicker.md +++ b/docs/OptionsUnderlyingTicker.md @@ -1,13 +1,13 @@ # OptionsUnderlyingTicker -Options underlying detail. +Options underlying detail ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**tradePut** | **Long** | Total put options trades amount in last 24h. | [optional] -**tradeCall** | **Long** | Total call options trades amount in last 24h. | [optional] -**indexPrice** | **String** | Index price (quote currency). | [optional] +**tradePut** | **Long** | Total put options trades amount in last 24h | [optional] +**tradeCall** | **Long** | Total call options trades amount in last 24h | [optional] +**indexPrice** | **String** | Index price (quote currency) | [optional] diff --git a/docs/Order.md b/docs/Order.md index 7ff21af..d1ae44c 100644 --- a/docs/Order.md +++ b/docs/Order.md @@ -1,46 +1,46 @@ # Order -Spot order details. +Spot order details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | Order ID. | [optional] [readonly] +**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] -**createTime** | **String** | Creation time of order. | [optional] [readonly] -**updateTime** | **String** | Last modification time of order. | [optional] [readonly] -**createTimeMs** | **Long** | Creation time of order (in milliseconds). | [optional] [readonly] -**updateTimeMs** | **Long** | Last modification time of order (in milliseconds). | [optional] [readonly] +**amendText** | **String** | The custom data that the user remarked when amending the order | [optional] [readonly] +**createTime** | **String** | Creation time of order | [optional] [readonly] +**updateTime** | **String** | Last modification time of order | [optional] [readonly] +**createTimeMs** | **Long** | Creation time of order (in milliseconds) | [optional] [readonly] +**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. | +**currencyPair** | **String** | Currency pair | **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) | Buy or sell order. | -**amount** | **String** | When `type` is limit, it refers to base currency. For instance, `BTC_USDT` means `BTC` When different currency according to `side` - `side` : `buy` means quote currency, `BTC_USDT` means `USDT` - `side` : `sell` means base currency，`BTC_USDT` means `BTC` | -**price** | **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] -**left** | **String** | Amount left to fill. | [optional] [readonly] -**filledAmount** | **String** | Amount traded to fill. | [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] -**fee** | **String** | Fee deducted. | [optional] [readonly] -**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] -**rebatedFee** | **String** | Rebated fee. | [optional] [readonly] -**rebatedFeeCurrency** | **String** | Rebated fee currency unit. | [optional] [readonly] +**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 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] +**fee** | **String** | Fee deducted | [optional] [readonly] +**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 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, 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) | 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] diff --git a/docs/OrderBook.md b/docs/OrderBook.md index d8ab07d..c3389ed 100644 --- a/docs/OrderBook.md +++ b/docs/OrderBook.md @@ -6,8 +6,8 @@ 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. | +**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) | Ask Depth | +**bids** | [**List<List<String>>**](List.md) | Bid Depth | diff --git a/docs/OrderCancel.md b/docs/OrderCancel.md index b86c08a..02edb7c 100644 --- a/docs/OrderCancel.md +++ b/docs/OrderCancel.md @@ -1,49 +1,49 @@ # OrderCancel -Spot order details. +Spot order details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | Order ID. | [optional] [readonly] +**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] -**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] -**updateTime** | **String** | Last modification time of order. | [optional] [readonly] -**createTimeMs** | **Long** | Creation time of order (in milliseconds). | [optional] [readonly] -**updateTimeMs** | **Long** | Last modification time of order (in milliseconds). | [optional] [readonly] +**amendText** | **String** | The custom data that the user remarked when amending the order | [optional] [readonly] +**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] +**updateTime** | **String** | Last modification time of order | [optional] [readonly] +**createTimeMs** | **Long** | Creation time of order (in milliseconds) | [optional] [readonly] +**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. | +**currencyPair** | **String** | Currency pair | **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) | Buy or sell order. | -**amount** | **String** | When `type` is limit, it refers to base currency. For instance, `BTC_USDT` means `BTC` When different currency according to `side` - `side` : `buy` means quote currency, `BTC_USDT` means `USDT` - `side` : `sell` means base currency，`BTC_USDT` means `BTC` | -**price** | **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] -**left** | **String** | Amount left to fill. | [optional] [readonly] -**filledAmount** | **String** | Amount traded to fill. | [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] -**fee** | **String** | Fee deducted. | [optional] [readonly] -**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] -**rebatedFee** | **String** | Rebated fee. | [optional] [readonly] -**rebatedFeeCurrency** | **String** | Rebated fee currency unit. | [optional] [readonly] +**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 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] +**fee** | **String** | Fee deducted | [optional] [readonly] +**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 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, 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 53c81f3..88d1655 100644 --- a/docs/OrderPatch.md +++ b/docs/OrderPatch.md @@ -1,16 +1,16 @@ # OrderPatch -Spot order details. +Spot order details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currencyPair** | **String** | Currency pair. | [optional] -**account** | **String** | Specify query account. | [optional] -**amount** | **String** | Trading Quantity. Either amountor pricemust be specified. | [optional] -**price** | **String** | Trading Price. Either amountor pricemust be specified. | [optional] -**amendText** | **String** | Custom info during amending order. | [optional] +**currencyPair** | **String** | Currency pair | [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/OrderResp.md b/docs/OrderResp.md index 4a85cc5..2ae418f 100644 --- a/docs/OrderResp.md +++ b/docs/OrderResp.md @@ -5,5 +5,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**orderId** | **Long** | Order ID. | [optional] +**orderId** | **Long** | Order ID | [optional] diff --git a/docs/PartnerCommissionHistory.md b/docs/PartnerCommissionHistory.md index 55d167c..aa64c35 100644 --- a/docs/PartnerCommissionHistory.md +++ b/docs/PartnerCommissionHistory.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**total** | **Long** | Total. | [optional] -**list** | [**List<AgencyCommission>**](AgencyCommission.md) | List of comission history. | [optional] +**total** | **Long** | Total | [optional] +**list** | [**List<AgencyCommission>**](AgencyCommission.md) | List of commission history | [optional] diff --git a/docs/PartnerSub.md b/docs/PartnerSub.md index 8849575..52b0f25 100644 --- a/docs/PartnerSub.md +++ b/docs/PartnerSub.md @@ -5,7 +5,7 @@ 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] +**userId** | **Long** | User ID | [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/PartnerSubList.md b/docs/PartnerSubList.md index b447892..5b4073b 100644 --- a/docs/PartnerSubList.md +++ b/docs/PartnerSubList.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**total** | **Long** | Total. | [optional] -**list** | [**List<PartnerSub>**](PartnerSub.md) | Subordinate list. | [optional] +**total** | **Long** | Total | [optional] +**list** | [**List<PartnerSub>**](PartnerSub.md) | Subordinate list | [optional] diff --git a/docs/PartnerTransactionHistory.md b/docs/PartnerTransactionHistory.md index 25b6a8a..af44969 100644 --- a/docs/PartnerTransactionHistory.md +++ b/docs/PartnerTransactionHistory.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**total** | **Long** | Total. | [optional] -**list** | [**List<AgencyTransaction>**](AgencyTransaction.md) | List of transaction history. | [optional] +**total** | **Long** | Total | [optional] +**list** | [**List<AgencyTransaction>**](AgencyTransaction.md) | List of transaction history | [optional] diff --git a/docs/PatchUniLend.md b/docs/PatchUniLend.md index 1087b73..91ad469 100644 --- a/docs/PatchUniLend.md +++ b/docs/PatchUniLend.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency name. | [optional] -**minRate** | **String** | Minimum interest rate. | [optional] +**currency** | **String** | Currency name | [optional] +**minRate** | **String** | Minimum interest rate | [optional] diff --git a/docs/PlaceDualInvestmentOrder.md b/docs/PlaceDualInvestmentOrder.md index 564f2a2..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 c6f8309..aa08162 100644 --- a/docs/Position.md +++ b/docs/Position.md @@ -1,45 +1,45 @@ # Position -Futures position details. +Futures position details ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**user** | **Long** | User ID. | [optional] [readonly] -**contract** | **String** | Futures contract. | [optional] [readonly] -**size** | **Long** | Position size. | [optional] [readonly] +**user** | **Long** | User ID | [optional] [readonly] +**contract** | **String** | Futures contract | [optional] [readonly] +**size** | **Long** | Position size | [optional] [readonly] **leverage** | **String** | Position leverage. 0 means cross margin; positive number means isolated margin | [optional] -**riskLimit** | **String** | Position risk limit. | [optional] -**leverageMax** | **String** | Maximum leverage under current risk limit. | [optional] [readonly] -**maintenanceRate** | **String** | Maintenance rate under current risk limit. | [optional] [readonly] -**value** | **String** | Position value calculated in settlement currency. | [optional] [readonly] -**margin** | **String** | Position margin. | [optional] -**entryPrice** | **String** | Entry price. | [optional] [readonly] -**liqPrice** | **String** | Liquidation price. | [optional] [readonly] -**markPrice** | **String** | Current mark price. | [optional] [readonly] +**riskLimit** | **String** | Position risk limit | [optional] +**leverageMax** | **String** | Maximum leverage under current risk limit | [optional] [readonly] +**maintenanceRate** | **String** | Maintenance rate under current risk limit | [optional] [readonly] +**value** | **String** | Position value calculated in settlement currency | [optional] [readonly] +**margin** | **String** | Position margin | [optional] +**entryPrice** | **String** | Entry price | [optional] [readonly] +**liqPrice** | **String** | Liquidation price | [optional] [readonly] +**markPrice** | **String** | Current mark price | [optional] [readonly] **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] -**pnlPnl** | **String** | Realized PNL - Position P/L. | [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] -**lastClosePnl** | **String** | PNL of last position close. | [optional] [readonly] -**realisedPoint** | **String** | Realized POINT PNL. | [optional] [readonly] -**historyPoint** | **String** | History realized POINT PNL. | [optional] [readonly] +**unrealisedPnl** | **String** | Unrealized 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] +**pnlFee** | **String** | Realized PNL - Transaction Fees | [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`: 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] -**openTime** | **Long** | First Open Time. | [optional] -**riskLimitTable** | **String** | Risk limit table ID. | [optional] [readonly] -**averageMaintenanceRate** | **String** | Average maintenance margin rate. | [optional] [readonly] +**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. 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] ## Enum: ModeEnum diff --git a/docs/PositionClose.md b/docs/PositionClose.md index a4b14f2..def9d71 100644 --- a/docs/PositionClose.md +++ b/docs/PositionClose.md @@ -5,19 +5,19 @@ 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] -**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] -**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 closing average price. | [optional] [readonly] -**shortPrice** | **String** | When 'side' is 'long,' it indicates the opening average price; when closing average price | [optional] [readonly] +**time** | **Double** | Position close time | [optional] [readonly] +**contract** | **String** | Futures contract | [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** | 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 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 cdf37a4..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 517af59..8c95b59 100644 --- a/docs/ProfitLossRange.md +++ b/docs/ProfitLossRange.md @@ -1,13 +1,13 @@ # ProfitLossRange -Profit and loss range. +Profit and loss range ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**pricePercentage** | **String** | Percentage change in price. | [optional] -**impliedVolatilityPercentage** | **String** | Percentage change in implied volatility. | [optional] -**profitLoss** | **String** | PNL. | [optional] +**pricePercentage** | **String** | Percentage change in price | [optional] +**impliedVolatilityPercentage** | **String** | Percentage change in implied volatility | [optional] +**profitLoss** | **String** | PnL | [optional] diff --git a/docs/RebateApi.md b/docs/RebateApi.md index f8d15af..fc55277 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. -[**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. +[**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 | 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,12 +44,12 @@ 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. - 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. - Integer offset = 0; // Integer | List offset, starting from 0. + 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 | 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() .currencyPair(currencyPair) @@ -77,12 +77,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Specify the currency pair, if not specified, return all currency 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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **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**| 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(); -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,12 +131,12 @@ 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. - 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. - Integer offset = 0; // Integer | List offset, starting from 0. + 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 | 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) @@ -164,12 +164,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Filter by currency. Return all currency records if not specified. | [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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **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**| 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 +187,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,12 +218,12 @@ 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. - 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. - Integer offset = 0; // Integer | List offset, starting from 0. + 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 | 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() .currencyPair(currencyPair) @@ -251,12 +251,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Specify the currency pair, if not specified, return all currency 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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **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**| 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 +274,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,12 +305,12 @@ 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. - 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. - Integer offset = 0; // Integer | List offset, starting from 0. + 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 | 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() .currency(currency) @@ -338,12 +338,12 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Filter by currency. Return all currency records if not specified. | [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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **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**| 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,15 +361,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved. | - | +**200** | List retrieved successfully | - | # **partnerSubList** > PartnerSubList partnerSubList().userId(userId).limit(limit).offset(offset).execute(); -Partner subordinate list. +Partner subordinate list -Including sub-agents, direct customers, indirect customers. +Including sub-agents, direct customers, and indirect customers ### Example @@ -392,9 +392,9 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 offset = 0; // Integer | List offset, starting from 0. + Long userId = 10003L; // Long | User ID. If not specified, all user records will be returned + 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() .userId(userId) @@ -419,9 +419,9 @@ 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] - **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] + **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 +439,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 +470,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 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. + 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 | 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 +501,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] - **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] + **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**| 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 +523,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 +554,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 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. + 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 | 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 +585,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] - **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] + **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**| 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 +607,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 +671,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 +702,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 +723,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 +741,5 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved. | - | +**200** | List retrieved successfully | - | diff --git a/docs/RebateUserInfo.md b/docs/RebateUserInfo.md index 757ecb7..b0e707d 100644 --- a/docs/RebateUserInfo.md +++ b/docs/RebateUserInfo.md @@ -1,11 +1,11 @@ # RebateUserInfo -Retrieve user rebate information. +Retrieve user rebate information ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**inviteUid** | **Long** | My inviter's UID. | [optional] +**inviteUid** | **Long** | My inviter's UID | [optional] diff --git a/docs/RepayCurrencyRes.md b/docs/RepayCurrencyRes.md index b6c5c4c..ad7ad8b 100644 --- a/docs/RepayCurrencyRes.md +++ b/docs/RepayCurrencyRes.md @@ -5,10 +5,10 @@ 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] -**currency** | **String** | Repayment currency. | [optional] -**repaidPrincipal** | **String** | Principal. | [optional] -**repaidInterest** | **String** | Principal. | [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 e159952..8ecfaaf 100644 --- a/docs/RepayLoan.md +++ b/docs/RepayLoan.md @@ -1,13 +1,13 @@ # RepayLoan -Repay. +Repay ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**orderId** | **Long** | Order ID. | -**repayAmount** | **String** | Repayment amount, it is mandatory when making partial repayments. | +**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 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 d6f9b84..835ffdd 100644 --- a/docs/RepayMultiLoan.md +++ b/docs/RepayMultiLoan.md @@ -1,12 +1,12 @@ # RepayMultiLoan -Repay Multi-Collateral Loan. +Multi-currency collateral repayment ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**orderId** | **Long** | Order ID. | -**repayItems** | [**List<MultiLoanRepayItem>**](MultiLoanRepayItem.md) | Repay Currency Item. | +**orderId** | **Long** | Order ID | +**repayItems** | [**List<MultiLoanRepayItem>**](MultiLoanRepayItem.md) | Repay Currency Item | diff --git a/docs/RepayRecord.md b/docs/RepayRecord.md index 8e4b0cc..8082201 100644 --- a/docs/RepayRecord.md +++ b/docs/RepayRecord.md @@ -1,23 +1,23 @@ # RepayRecord -Repayment record. +Repayment record ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**orderId** | **Long** | Order ID. | [optional] -**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] -**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] +**orderId** | **Long** | Order ID | [optional] +**recordId** | **Long** | Repayment record ID | [optional] +**repaidAmount** | **String** | Repayment amount | [optional] +**borrowCurrency** | **String** | Borrowed currency | [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 amount before repayment | [optional] +**afterLeftCollateral** | **String** | Collateral amount after repayment | [optional] diff --git a/docs/RepayRecordCurrency.md b/docs/RepayRecordCurrency.md index 15e763c..b597b39 100644 --- a/docs/RepayRecordCurrency.md +++ b/docs/RepayRecordCurrency.md @@ -5,10 +5,10 @@ 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] +**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] diff --git a/docs/RepayRecordLeftInterest.md b/docs/RepayRecordLeftInterest.md index 031e1be..1956af7 100644 --- a/docs/RepayRecordLeftInterest.md +++ b/docs/RepayRecordLeftInterest.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency. | [optional] -**indexPrice** | **String** | Currency Index Price. | [optional] -**beforeAmount** | **String** | Interest amount before repayment. | [optional] -**beforeAmountUsdt** | **String** | Converted value of interest before repayment in USDT. | [optional] -**afterAmount** | **String** | Interest amount after repayment. | [optional] -**afterAmountUsdt** | **String** | Converted value of interest after repayment in USDT. | [optional] +**currency** | **String** | Currency | [optional] +**indexPrice** | **String** | Currency Index Price | [optional] +**beforeAmount** | **String** | Interest amount before repayment | [optional] +**beforeAmountUsdt** | **String** | Converted value of interest before repayment in USDT | [optional] +**afterAmount** | **String** | Interest amount after repayment | [optional] +**afterAmountUsdt** | **String** | Converted value of interest after repayment in USDT | [optional] diff --git a/docs/RepayRecordRepaidCurrency.md b/docs/RepayRecordRepaidCurrency.md index edca262..60256f0 100644 --- a/docs/RepayRecordRepaidCurrency.md +++ b/docs/RepayRecordRepaidCurrency.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Repayment currency. | [optional] -**indexPrice** | **String** | Currency Index Price. | [optional] -**repaidAmount** | **String** | Repayment amount. | [optional] -**repaidPrincipal** | **String** | Principal. | [optional] -**repaidInterest** | **String** | Interest. | [optional] -**repaidAmountUsdt** | **String** | Value of the repayment amount in USDT. | [optional] +**currency** | **String** | Repayment currency | [optional] +**indexPrice** | **String** | Currency Index Price | [optional] +**repaidAmount** | **String** | Repayment amount | [optional] +**repaidPrincipal** | **String** | Principal | [optional] +**repaidInterest** | **String** | Interest | [optional] +**repaidAmountUsdt** | **String** | Repayment amount converted to USDT | [optional] diff --git a/docs/RepayRecordTotalInterest.md b/docs/RepayRecordTotalInterest.md index 57f416a..aa2b6a4 100644 --- a/docs/RepayRecordTotalInterest.md +++ b/docs/RepayRecordTotalInterest.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency. | [optional] -**indexPrice** | **String** | Currency Index Price. | [optional] -**amount** | **String** | Interest Amount. | [optional] -**amountUsdt** | **String** | Interest amount converted to USDT. | [optional] +**currency** | **String** | Currency | [optional] +**indexPrice** | **String** | Currency Index Price | [optional] +**amount** | **String** | Interest Amount | [optional] +**amountUsdt** | **String** | Interest amount converted to USDT | [optional] diff --git a/docs/RepayResp.md b/docs/RepayResp.md index e46515d..baaf387 100644 --- a/docs/RepayResp.md +++ b/docs/RepayResp.md @@ -1,12 +1,12 @@ # RepayResp -Repay. +Repay ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**repaidPrincipal** | **String** | Principal. | [optional] -**repaidInterest** | **String** | Interest. | [optional] +**repaidPrincipal** | **String** | Principal | [optional] +**repaidInterest** | **String** | Interest | [optional] diff --git a/docs/RiskUnits.md b/docs/RiskUnits.md index 615ec0a..ffbb7d1 100644 --- a/docs/RiskUnits.md +++ b/docs/RiskUnits.md @@ -5,12 +5,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**symbol** | **String** | Risk unit flag. | [optional] -**spotInUse** | **String** | Spot hedging utilization. | [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] -**gamma** | **String** | Total Gamma of risk unit. | [optional] -**theta** | **String** | Total Theta of risk unit. | [optional] -**vega** | **String** | Total Vega of risk unit. | [optional] +**symbol** | **String** | Risk unit flag | [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] +**gamma** | **String** | Total Gamma of risk unit | [optional] +**theta** | **String** | Total Theta of risk unit | [optional] +**vega** | **String** | Total Vega of risk unit | [optional] diff --git a/docs/SavedAddress.md b/docs/SavedAddress.md index 406aca3..2fcd258 100644 --- a/docs/SavedAddress.md +++ b/docs/SavedAddress.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency. | [optional] -**chain** | **String** | Chain name. | [optional] -**address** | **String** | Address. | [optional] -**name** | **String** | Name. | [optional] -**tag** | **String** | Tag. | [optional] -**verified** | **String** | Whether to pass the verification 0-unverified, 1-verified. | [optional] +**currency** | **String** | Currency | [optional] +**chain** | **String** | Chain name | [optional] +**address** | **String** | Address | [optional] +**name** | **String** | Name | [optional] +**tag** | **String** | Tag | [optional] +**verified** | **String** | Whether to pass the verification 0-unverified, 1-verified | [optional] diff --git a/docs/SmallBalance.md b/docs/SmallBalance.md index b5a35f7..574983d 100644 --- a/docs/SmallBalance.md +++ b/docs/SmallBalance.md @@ -1,14 +1,14 @@ # SmallBalance -Convert Small Balance. +Small Balance Conversion ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency. | [optional] -**availableBalance** | **String** | Available balance. | [optional] -**estimatedAsBtc** | **String** | Estimated as BTC. | [optional] -**convertibleToGt** | **String** | Estimated conversion to GT. | [optional] +**currency** | **String** | Currency | [optional] +**availableBalance** | **String** | Available balance | [optional] +**estimatedAsBtc** | **String** | Estimated as BTC | [optional] +**convertibleToGt** | **String** | Estimated conversion to GT | [optional] diff --git a/docs/SmallBalanceHistory.md b/docs/SmallBalanceHistory.md index 4482b26..3471863 100644 --- a/docs/SmallBalanceHistory.md +++ b/docs/SmallBalanceHistory.md @@ -1,15 +1,15 @@ # SmallBalanceHistory -Convert Small Balance. +Small Balance Conversion ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | Order ID. | [optional] [readonly] -**currency** | **String** | Currency. | [optional] [readonly] -**amount** | **String** | amount. | [optional] [readonly] -**gtAmount** | **String** | GT amount. | [optional] [readonly] -**createTime** | **Long** | Exchange time (in seconds). | [optional] [readonly] +**id** | **String** | Order ID | [optional] [readonly] +**currency** | **String** | Currency | [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/SpotAccount.md b/docs/SpotAccount.md index b856966..167c46d 100644 --- a/docs/SpotAccount.md +++ b/docs/SpotAccount.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency detail. | [optional] -**available** | **String** | Available amount. | [optional] -**locked** | **String** | Locked amount, used in trading. | [optional] -**updateId** | **Long** | Version number. | [optional] +**currency** | **String** | Currency detail | [optional] +**available** | **String** | Available amount | [optional] +**locked** | **String** | Locked amount, used in trading | [optional] +**updateId** | **Long** | Version number | [optional] diff --git a/docs/SpotAccountBook.md b/docs/SpotAccountBook.md index aa3c920..9e7096f 100644 --- a/docs/SpotAccountBook.md +++ b/docs/SpotAccountBook.md @@ -5,12 +5,12 @@ 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] +**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] -**code** | **String** | Account change code, see [Asset Record Code] (Asset Record Code). | [optional] -**text** | **String** | Additional information. | [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 2bdbaf3..36bef7a 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. -[**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. -[**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. -[**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. +[**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 +[**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 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 | 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 @@ -123,7 +123,7 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); SpotApi apiInstance = new SpotApi(defaultClient); - String currency = "GT"; // String | Currency name. + String currency = "GT"; // String | Currency name try { Currency result = apiInstance.getCurrency(currency); System.out.println(result); @@ -144,7 +144,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Currency name. | + **currency** | **String**| Currency name | ### Return type @@ -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 @@ -222,13 +222,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | All currency pairs retrieved. | - | +**200** | All currency pairs retrieved | - | # **getCurrencyPair** > CurrencyPair getCurrencyPair(currencyPair) -Get details of a specifc currency pair. +Query single currency pair details ### Example @@ -247,7 +247,7 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); SpotApi apiInstance = new SpotApi(defaultClient); - String currencyPair = "ETH_BTC"; // String | Currency pair. + String currencyPair = "ETH_BTC"; // String | Currency pair try { CurrencyPair result = apiInstance.getCurrencyPair(currencyPair); System.out.println(result); @@ -268,7 +268,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair. | + **currencyPair** | **String**| Currency pair | ### Return type @@ -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 @@ -313,8 +313,8 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); SpotApi apiInstance = new SpotApi(defaultClient); - String currencyPair = "BTC_USDT"; // String | Currency pair. - String timezone = "utc0"; // String | Timezone. + String currencyPair = "BTC_USDT"; // String | Currency pair + String timezone = "utc0"; // String | Timezone try { List result = apiInstance.listTickers() .currencyPair(currencyPair) @@ -338,8 +338,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currencyPair** | **String**| Currency pair. | [optional] - **timezone** | **String**| Timezone. | [optional] [enum: utc0, utc8, all] + **currencyPair** | **String**| Currency pair | [optional] + **timezone** | **String**| Timezone | [optional] [enum: utc0, utc8, all] ### Return type @@ -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 -Market depth buy orders are sorted by price from high to low, sell orders are reversed +Market depth buy orders are sorted by price from high to low, sell orders are sorted from low to high ### Example @@ -384,10 +384,10 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 currencyPair = "BTC_USDT"; // String | Currency pair + 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) @@ -412,10 +412,10 @@ 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] + **currencyPair** | **String**| Currency pair | + **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, is the last 30 days. The query method based on `last_id` page turn is no longer recommended. If `last_id` is specified, the time range query parameters will be ignored. The maximum number of pages when searching data using limit&page paging function is 100,0, that is, limit * (page - 1) <= 100,0. +Supports querying by time range using `from` and `to` parameters or pagination based on `last_id`. By default, queries the last 30 days. Pagination based on `last_id` is no longer recommended. If `last_id` is specified, the time range query parameters will be ignored. When using limit&page pagination to retrieve data, the maximum number of pages is 100,000, that is, limit * (page - 1) <= 100,000. ### Example @@ -460,13 +460,13 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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 the currency name to query in batches, and support up to 100 pass parameters at a time. - 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 page = 1; // Integer | Page number. + String currencyPair = "BTC_USDT"; // String | Currency pair + Integer limit = 100; // Integer | Maximum number of items returned in list. Default: 100, minimum: 1, maximum: 1000 + String lastId = "12345"; // String | Specify the currency name to query in batches, and support up to 100 pass parameters at a time + 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) .limit(limit) @@ -494,13 +494,13 @@ 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 the currency name to query in batches, and support up to 100 pass parameters at a time. | [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] - **page** | **Integer**| Page number. | [optional] [default to 1] + **currencyPair** | **String**| Currency pair | + **limit** | **Integer**| Maximum number of items returned in list. Default: 100, minimum: 1, maximum: 1000 | [optional] [default to 100] + **lastId** | **String**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time | [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 @@ -545,11 +545,11 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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. + String currencyPair = "BTC_USDT"; // String | Currency pair + 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 | Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision specified - 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) @@ -575,11 +575,11 @@ 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] + **currencyPair** | **String**| Currency pair | + **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**| Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision specified | [optional] - **interval** | **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,0, that is, limit * (page - 1) <= 100,0. +Record query time range cannot exceed 30 days. When using limit&page pagination to retrieve data, the maximum number of pages is 100,000, that is, limit * (page - 1) <= 100,000. ### Example @@ -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. - 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` + 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 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] - **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] + **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 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,13 +969,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Request is completed. | - | +**200** | Request execution completed | - | # **listAllOpenOrders** > List<OpenOrders> listAllOpenOrders().page(page).limit(limit).account(account).execute(); -List all open orders. +List all open orders Query the current order list of all trading pairs. Please note that the paging parameter controls the number of pending orders in each trading pair. There is no paging control trading pairs. All trading pairs with pending orders will be returned. @@ -1000,9 +1000,9 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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. + 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 try { List result = apiInstance.listAllOpenOrders() .page(page) @@ -1027,9 +1027,9 @@ public class Example { 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] + **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] ### 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,15 +1117,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | order created. | - | +**201** | Order created successfully | - | # **listOrders** > List<Order> listOrders(currencyPair, status).page(page).limit(limit).account(account).from(from).to(to).side(side).execute(); -List orders. +List orders -Note that the query results are spot order lists for spot, unified account and warehouse-by-site leverage accounts by default. `status` is set to `open`, that is, when querying the pending order list, only pagination control of `page` and `limit` is supported. `limit` Maximum setting is only allowed to 100 . The `side` and `from`, `to` parameters for time range query are not supported. `status` when querying historical delegations, in addition to pagination queries, `from` and `to` are also supported by time range queries. In addition, it supports setting the `side` parameter to filter one-side history. The parameters of the time range filtering are processed according to the order end time. +Note that query results default to spot order lists for spot, unified account, and isolated margin accounts. When `status` is set to `open` (i.e., when querying pending order lists), only `page` and `limit` pagination controls are supported. `limit` can only be set to a maximum of 100. The `side` parameter and time range query parameters `from` and `to` are not supported. When `status` is set to `finished` (i.e., when querying historical orders), in addition to pagination queries, `from` and `to` time range queries are also supported. Additionally, the `side` parameter can be set to filter one-sided history. Time range filter parameters are processed according to the order end time. ### Example @@ -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 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] + **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,15 +1208,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved. | - | +**200** | List retrieved successfully | - | # **createOrder** > Order createOrder(order, xGateExptime) -Create an order. +Create an order -Support spot, margin, leverage, and full-position leverage orders. Use different accounts through the `account` field, default is `spot`, that is, use the spot account to place an order if the user is `unified` account, default is to place an order with a unified account When using leveraged account trading, that is, when `account` is set to `margin`, you can set `auto_borrow` to `true`, In the case of insufficient account balance, the system will automatically execute the `POST /margin/uni/loans` to borrow the insufficient part. Whether the assets obtained after the leveraged order is automatically used to return the borrowing orders of the leveraged account in a position-by-store leverage account depends on the automatic repayment settings of the user's position-by-store leverage account**, The account automatic repayment settings can be queried and set through `/margin/auto_repay`. Use unified is set to `unified`, `auto_borrow` \" can also be enableTo realize the insufficient part of automatic borrowing, but unlike the leverage account, whether the entrustment of a unified account is automatically repayable depends on the when placing an order`auto_repay` setting, this setting is only effective for the current entrustment, that is, only the assets obtained after the entrustment transaction will be used to repay the borrowing orders of the full-position leverage account. Unified account ordering currently supports `auto_borrow` and `auto_repay` at the same time. Auto repayment will be triggered at the end of the order, i.e. `status` is `cancelled` or `closed` . **Delegation Status** The entrustment status in the pending order is `open`, which remains at `open` until all the quantity is traded. If it is eaten, the order ends and the status becomes `closed`. If the order is cancelled before all transactions are completed, regardless of whether there are partial transactions, the status will become `cancelled` **Iceberg Entrustment** `iceberg` is used to set the number of iceberg delegations displayed, and does not support complete hiding. Note that when hidden part of the transaction is charged according to the taker's handling rate. **Restrict user transactions** Set `stp_act` to decide to use strategies that limit user transactions +Supports spot, margin, leverage, and cross-margin leverage orders. Use different accounts through the `account` field. Default is `spot`, which means using the spot account to place orders. If the user has a `unified` account, the default is to place orders with the unified account. When using leveraged account trading (i.e., when `account` is set to `margin`), you can set `auto_borrow` to `true`. In case of insufficient account balance, the system will automatically execute `POST /margin/uni/loans` to borrow the insufficient amount. Whether assets obtained after leveraged order execution are automatically used to repay borrowing orders of the isolated margin account depends on the automatic repayment settings of the user's isolated margin account. Account automatic repayment settings can be queried and set through `/margin/auto_repay`. When using unified account trading (i.e., when `account` is set to `unified`), `auto_borrow` can also be enabled to realize automatic borrowing of insufficient amounts. However, unlike the isolated margin account, whether unified account orders are automatically repaid depends on the `auto_repay` setting when placing the order. This setting only applies to the current order, meaning only assets obtained after order execution will be used to repay borrowing orders of the cross-margin account. Unified account ordering currently supports enabling both `auto_borrow` and `auto_repay` simultaneously. Auto repayment will be triggered when the order ends, i.e., when `status` is `cancelled` or `closed`. **Order Status** The order status in pending orders is `open`, which remains `open` until all quantity is filled. If fully filled, the order ends and status becomes `closed`. If the order is cancelled before all transactions are completed, regardless of partial fills, the status will become `cancelled`. **Iceberg Orders** `iceberg` is used to set the displayed quantity of iceberg orders and does not support complete hiding. Note that hidden portions are charged according to the taker's fee rate. **Self-Trade Prevention** Set `stp_act` to determine the self-trade prevention strategy to use ### Example @@ -1280,15 +1280,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Order created. | - | +**201** | Order created | - | # **cancelOrders** > List<OrderCancel> cancelOrders(currencyPair, side, account, actionMode, xGateExptime) -Cancel all `open` orders in specified currency pair. +Cancel all `open` orders in specified currency pair -When the `account` parameter is not specified, all pending orders including spot, unified account, and position-by-position leverage will be cancelled. When transaction pairs are revoked You can specify a certain account separately to cancel all orders under the specified account +When the `account` parameter is not specified, all pending orders including spot, unified account, and isolated margin will be cancelled. When `currency_pair` is not specified, all trading pair pending orders will be cancelled. You can specify a particular account to cancel all pending orders under that account ### Example @@ -1311,10 +1311,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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: 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 currencyPair = "BTC_USDT"; // String | Currency pair + 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); @@ -1336,10 +1336,10 @@ 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: 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] + **currencyPair** | **String**| Currency pair | [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 @@ -1430,15 +1430,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Batch cancellation completed. | - | +**200** | Batch cancellation completed | - | # **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 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 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 @@ -1504,13 +1504,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Detail retrieved. | - | +**200** | Detail retrieved | - | # **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. @@ -1536,9 +1536,9 @@ 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 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 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); @@ -1561,9 +1561,9 @@ 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**| 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] + **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] **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 @@ -1582,13 +1582,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order cancelled. | - | +**200** | Order cancelled | - | # **amendOrder** > Order amendOrder(orderId, orderPatch, currencyPair, account, xGateExptime) -Amend an order. +Amend single order Modify orders in spot, unified account and isolated margin account by default. Currently both request body and query support currency_pair and account parameters, but request body has higher priority. currency_pair must be filled in one of the request body or query parameters. About rate limit: Order modification and order creation share the same rate limit rules. About matching priority: Only reducing the quantity does not affect the matching priority. Modifying the price or increasing the quantity will adjust the priority to the end of the new price level. Note: Modifying the quantity to be less than the filled quantity will trigger a cancellation and isolated margin account by default. Currently both request body and query support currency_pair and account parameters, but request body has higher priority. currency_pair must be filled in one of the request body or query parameters. About rate limit: Order modification and order creation share the same rate limit rules. About matching priority: Only reducing the quantity does not affect the matching priority. Modifying the price or increasing the quantity will adjust the priority to the end of the new price level. Note: Modifying the quantity to be less than the filled quantity will trigger a cancellation operation. @@ -1615,8 +1615,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) OrderPatch orderPatch = new OrderPatch(); // OrderPatch | - String currencyPair = "BTC_USDT"; // String | Currency pair. - String account = "spot"; // String | Specify query account. + String currencyPair = "BTC_USDT"; // String | Currency pair + 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); @@ -1640,8 +1640,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) | **orderPatch** | [**OrderPatch**](OrderPatch.md)| | - **currencyPair** | **String**| Currency pair. | [optional] - **account** | **String**| Specify query account. | [optional] + **currencyPair** | **String**| Currency pair | [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,13 +1660,13 @@ 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 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. @@ -1691,13 +1691,13 @@ 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. - Integer limit = 100; // Integer | Maximum number of records to be returned in a single list. Default: 100, Minimum: 1, Maximum: 1000 - Integer page = 1; // Integer | Page number. + String currencyPair = "BTC_USDT"; // String | Retrieve results with specified currency pair + 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) @@ -1726,13 +1726,13 @@ 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] - **page** | **Integer**| Page number. | [optional] [default to 1] + **currencyPair** | **String**| Retrieve results with specified currency pair | [optional] + **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,13 +1750,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved. | - | +**200** | List retrieved successfully | - | # **getSystemTime** > SystemTime getSystemTime() -Get server current time. +Get server current time ### Example @@ -1810,13 +1810,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved. | - | +**200** | Query successful | - | # **countdownCancelAllSpot** > TriggerTime countdownCancelAllSpot(countdownCancelAllSpotTask) -Countdown cancel orders. +Countdown cancel orders Spot order heartbeat detection. If there is no \"cancel existing countdown\" or \"set new countdown\" when the user-set `timeout` time is reached, the related `spot pending orders` will be automatically cancelled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at 30s intervals, setting the countdown `timeout` to `30 (seconds)` each time. If this interface is not called again within 30 seconds, all pending orders on the `market` you specified will be automatically cancelled. If no `market` is specified, all market cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will be terminated and the automatic order cancellation function will be cancelled. @@ -1880,15 +1880,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Set countdown successfully. | - | +**200** | Countdown set successfully | - | # **amendBatchOrders** > List<BatchOrder> amendBatchOrders(batchAmendItem, xGateExptime) -Batch modification of orders. +Batch modification of orders -Modify orders in spot, unified account and isolated margin account by default. Modify uncompleted orders, up to 5 orders can be modified at a time. Request parameters should be passed in array format. If there are order modification failures during the batch modification process, the modification of the next order will continue to be executed, and the execution will return with the corresponding order failure information. The call order of batch modification orders is consistent with the order list order. The return is consistent with the order list order. +Modify orders in spot, unified account and isolated margin account by default. Modify uncompleted orders, up to 5 orders can be modified at a time. Request parameters should be passed in array format. If there are order modification failures during the batch modification process, the modification of the next order will continue to be executed, and the execution will return with the corresponding order failure information. The call order of batch modification orders is consistent with the order list order. The return content order of batch modification orders is consistent with the order list order. ### Example @@ -1952,13 +1952,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Order modification executed successfully. | - | +**200** | Order modification executed successfully | - | # **getSpotInsuranceHistory** > List<SpotInsuranceHistory> getSpotInsuranceHistory(business, currency, from, to).page(page).limit(limit).execute(); -Query spot insurance fund historical data. +Query spot insurance fund historical data ### Example @@ -1978,11 +1978,11 @@ 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. - Integer page = 1; // Integer | Page number. - Integer limit = 30; // Integer | The maximum number of items returned in the list, the default value is 30. + String currency = "BTC"; // String | Currency + 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 { List result = apiInstance.getSpotInsuranceHistory(business, currency, from, to) .page(page) @@ -2007,11 +2007,11 @@ public class Example { 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. | - **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] + **currency** | **String**| Currency | + **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] ### Return type @@ -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,11 +2058,11 @@ 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. - Integer offset = 0; // Integer | List offset, starting from 0. + 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) .market(market) @@ -2088,11 +2088,11 @@ 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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **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 5bb7d78..a5b9ee0 100644 --- a/docs/SpotCurrencyChain.md +++ b/docs/SpotCurrencyChain.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | Chain 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] -**depositDisabled** | **Boolean** | Whether currency's deposit is disabled. | [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] +**depositDisabled** | **Boolean** | Whether currency's deposit is disabled | [optional] diff --git a/docs/SpotFee.md b/docs/SpotFee.md index cb214be..4af52ff 100644 --- a/docs/SpotFee.md +++ b/docs/SpotFee.md @@ -5,14 +5,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] +**userId** | **Long** | User ID | [optional] +**takerFee** | **String** | taker fee rate | [optional] +**makerFee** | **String** | maker fee rate | [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] -**loanFee** | **String** | Loan fee rate of margin lending. | [optional] -**pointType** | **String** | Point type. 0 - Initial version. 1 - new version since 202009. | [optional] -**currencyPair** | **String** | Currency pair. | [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 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 b797b4c..9a5427d 100644 --- a/docs/SpotInsuranceHistory.md +++ b/docs/SpotInsuranceHistory.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency. | [optional] -**balance** | **String** | balance. | [optional] -**time** | **Long** | Creation time, timestamp, milliseconds. | [optional] +**currency** | **String** | Currency | [optional] +**balance** | **String** | Balance | [optional] +**time** | **Long** | Creation time, timestamp, milliseconds | [optional] diff --git a/docs/SpotPricePutOrder.md b/docs/SpotPricePutOrder.md index 8321296..96165ab 100644 --- a/docs/SpotPricePutOrder.md +++ b/docs/SpotPricePutOrder.md @@ -7,13 +7,13 @@ 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 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 | +**price** | **String** | Order price | +**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] +**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 call - app: Mobile app | [optional] ## Enum: TypeEnum diff --git a/docs/SpotPriceTrigger.md b/docs/SpotPriceTrigger.md index 7a5c758..cc6f694 100644 --- a/docs/SpotPriceTrigger.md +++ b/docs/SpotPriceTrigger.md @@ -5,9 +5,9 @@ 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 - `<=`: or equal to `price` field | -**expiration** | **Integer** | How long (in seconds) to wait for the condition to be triggered before cancelling the order. | +**price** | **String** | Trigger price | +**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 fe8bfd7..d7ba163 100644 --- a/docs/SpotPriceTriggeredOrder.md +++ b/docs/SpotPriceTriggeredOrder.md @@ -1,7 +1,7 @@ # SpotPriceTriggeredOrder -Spot order detail. +Spot price order details ## Properties @@ -9,12 +9,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **trigger** | [**SpotPriceTrigger**](SpotPriceTrigger.md) | | **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] +**id** | **Long** | Auto order ID | [optional] [readonly] +**user** | **Integer** | User ID | [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 fa54513..732f17c 100644 --- a/docs/StpGroup.md +++ b/docs/StpGroup.md @@ -5,8 +5,8 @@ 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] +**id** | **Long** | STP Group ID | [optional] +**name** | **String** | STP Group name | +**creatorId** | **Long** | Creator ID | [optional] +**createTime** | **Long** | Created time | [optional] diff --git a/docs/StpGroupUser.md b/docs/StpGroupUser.md index 3be334a..b873a7c 100644 --- a/docs/StpGroupUser.md +++ b/docs/StpGroupUser.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Long** | User ID. | [optional] -**stpId** | **Long** | STP Group ID. | [optional] -**createTime** | **Long** | Creation time. | [optional] +**userId** | **Long** | User ID | [optional] +**stpId** | **Long** | STP Group ID | [optional] +**createTime** | **Long** | Created time | [optional] diff --git a/docs/StructuredBuy.md b/docs/StructuredBuy.md index f3deeab..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 51d587f..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 664b8a9..5b25dc7 100644 --- a/docs/StructuredOrderList.md +++ b/docs/StructuredOrderList.md @@ -1,17 +1,17 @@ # StructuredOrderList -Structured order. +Structured order ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Integer** | Order ID. | [optional] -**pid** | **String** | Plan ID. | [optional] -**lockCoin** | **String** | Locked coin. | [optional] -**amount** | **String** | Locked amount. | [optional] +**id** | **Integer** | Order 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] -**income** | **String** | Income. | [optional] -**createTime** | **Integer** | Created time. | [optional] +**income** | **String** | Income | [optional] +**createTime** | **Integer** | Created time | [optional] diff --git a/docs/SubAccount.md b/docs/SubAccount.md index 07d87c7..13aee78 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 | -**password** | **String** | The sub-account's password. (Default: the same as main account's password). | [optional] +**remark** | **String** | Remark | [optional] +**loginName** | **String** | 子账户登陆名：仅支持字母、数字、下划线，不可包含其他非法字符。 | +**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] -**createTime** | **Long** | Created time. | [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 7d219e0..439800d 100644 --- a/docs/SubAccountApi.md +++ b/docs/SubAccountApi.md @@ -4,24 +4,24 @@ All URIs are relative to *https://api.gateio.ws/api/v4* 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. -[**listUnifiedMode**](SubAccountApi.md#listUnifiedMode) | **GET** /sub_accounts/unified_mode | Get sub-account mode. +[**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 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 # **listSubAccounts** > List<SubAccount> listSubAccounts().type(type).execute(); -List sub-accounts. +List sub-accounts ### Example @@ -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,13 +85,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved. | - | +**200** | List retrieved successfully | - | # **createSubAccounts** > SubAccount createSubAccounts(subAccount) -Create a new sub-account. +Create a new sub-account ### Example @@ -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** > SubAccountKey createSubAccountKeys(userId, subAccountKey) -Create API Key of the sub-account. +Create new sub-account API key pair ### Example @@ -318,7 +318,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 SubAccountKey subAccountKey = new SubAccountKey(); // SubAccountKey | try { SubAccountKey result = apiInstance.createSubAccountKeys(userId, subAccountKey); @@ -340,7 +340,7 @@ 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 @@ -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,15 +703,15 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Unlock successfully. | - | +**204** | Unlocked successfully | - | # **listUnifiedMode** > List<SubUserMode> listUnifiedMode() -Get sub-account mode. +Get sub-account mode -Unified account mode： - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode +Unified account mode: - `classic`: Classic account mode - `multi_currency`: Multi-currency margin mode - `portfolio`: Portfolio margin mode ### Example @@ -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/SubAccountBalance.md b/docs/SubAccountBalance.md index 6dcbeb8..6e1ce23 100644 --- a/docs/SubAccountBalance.md +++ b/docs/SubAccountBalance.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**uid** | **String** | User ID. | [optional] -**available** | **Map<String, String>** | Available balances of currencies. | [optional] +**uid** | **String** | User ID | [optional] +**available** | **Map<String, String>** | Available balances of currencies | [optional] diff --git a/docs/SubAccountCrossMarginBalance.md b/docs/SubAccountCrossMarginBalance.md index d685241..c9de6fc 100644 --- a/docs/SubAccountCrossMarginBalance.md +++ b/docs/SubAccountCrossMarginBalance.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**uid** | **String** | User ID. | [optional] +**uid** | **String** | User ID | [optional] **available** | [**SubCrossMarginAccount**](.md) | 账户余额信息 | [optional] diff --git a/docs/SubAccountFuturesBalance.md b/docs/SubAccountFuturesBalance.md index d461dae..c1ea4b0 100644 --- a/docs/SubAccountFuturesBalance.md +++ b/docs/SubAccountFuturesBalance.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**uid** | **String** | User ID. | [optional] -**available** | [**Map<String, FuturesAccount>**](FuturesAccount.md) | Futures account balances. | [optional] +**uid** | **String** | User ID | [optional] +**available** | [**Map<String, FuturesAccount>**](FuturesAccount.md) | Futures account balances | [optional] diff --git a/docs/SubAccountKey.md b/docs/SubAccountKey.md index a4b7c77..a9700da 100644 --- a/docs/SubAccountKey.md +++ b/docs/SubAccountKey.md @@ -5,14 +5,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Long** | User ID. | [optional] [readonly] -**mode** | **Integer** | Mode: 1 - classic 2 - portfolio account. | [optional] -**name** | **String** | API key name. | [optional] +**userId** | **Long** | User ID | [optional] [readonly] +**mode** | **Integer** | Mode: 1 - classic 2 - portfolio account | [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] -**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] +**ipWhitelist** | **List<String>** | IP whitelist (list will be cleared if no value is passed) | [optional] +**key** | **String** | API Key | [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 f063a88..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/SubAccountMarginBalance.md b/docs/SubAccountMarginBalance.md index 5ad104e..ab7ed81 100644 --- a/docs/SubAccountMarginBalance.md +++ b/docs/SubAccountMarginBalance.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**uid** | **String** | User ID. | [optional] -**available** | [**List<MarginAccount>**](MarginAccount.md) | Margin account balances. | [optional] +**uid** | **String** | User ID | [optional] +**available** | [**List<MarginAccount>**](MarginAccount.md) | Margin account balances | [optional] diff --git a/docs/SubAccountToSubAccount.md b/docs/SubAccountToSubAccount.md index 5ef27b5..c15d433 100644 --- a/docs/SubAccountToSubAccount.md +++ b/docs/SubAccountToSubAccount.md @@ -5,11 +5,11 @@ 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] -**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. | -**subAccountTo** | **String** | Transfer to the user id of the sub-account. | -**subAccountToType** | **String** | Transferred sub-account trading account: spot - spot account, futures - perpetual contract account, delivery - delivery contract account | -**amount** | **String** | Transfer amount. | +**currency** | **String** | Transfer currency name | +**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** | 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** | 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 4391c0e..dca8285 100644 --- a/docs/SubAccountTransfer.md +++ b/docs/SubAccountTransfer.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**subAccount** | **String** | Sub account user ID. | -**subAccountType** | **String** | Target sub user's account. `spot` - spot account, `futures` - perpetual contract account, `delivery` - delivery 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 | -**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] +**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 | +**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 index 9fbc942..5b5a70c 100644 --- a/docs/SubAccountTransferRecordItem.md +++ b/docs/SubAccountTransferRecordItem.md @@ -5,14 +5,14 @@ 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] -**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] +**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 6aa518b..d8c4f02 100644 --- a/docs/SubCrossMarginAccount.md +++ b/docs/SubCrossMarginAccount.md @@ -5,20 +5,20 @@ 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] +**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] -**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] -**totalInitialMargin** | **String** | Total initial margin. | [optional] -**totalMarginBalance** | **String** | Total margin balance. | [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] +**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 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] +**totalInitialMarginRate** | **String** | Total initial margin rate | [optional] +**totalMaintenanceMarginRate** | **String** | Total maintenance margin rate | [optional] +**totalAvailableMargin** | **String** | Total available margin | [optional] diff --git a/docs/SubUserMode.md b/docs/SubUserMode.md index bee9dcd..68bb280 100644 --- a/docs/SubUserMode.md +++ b/docs/SubUserMode.md @@ -5,7 +5,7 @@ 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] +**userId** | **Long** | User ID | [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 index 8f1de15..13f5657 100644 --- a/docs/SwapCoin.md +++ b/docs/SwapCoin.md @@ -1,14 +1,14 @@ # SwapCoin -Blockchain Mining. +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] +**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 index 57b8471..4a942e4 100644 --- a/docs/SwapCoinStruct.md +++ b/docs/SwapCoinStruct.md @@ -5,19 +5,19 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Integer** | Order ID. | [optional] -**pid** | **Integer** | Plan ID. | [optional] -**uid** | **Integer** | User ID. | [optional] -**coin** | **String** | Currency. | [optional] -**type** | **Integer** | 类型 0-质押 1-赎回 | [optional] +**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** | 子类型 | [optional] -**amount** | **String** | Amount. | [optional] -**exchangeRate** | **String** | Exchange Ratio. | [optional] -**exchangeAmount** | **String** | 兑换金额 | [optional] +**amount** | **String** | Amount | [optional] +**exchangeRate** | **String** | Exchange ratio | [optional] +**exchangeAmount** | **String** | Redemption Amount | [optional] **updateStamp** | **Integer** | 更新时间戳 | [optional] -**createStamp** | **Integer** | Transaction timestamp. | [optional] -**status** | **Integer** | status 1-success. | [optional] -**protocolType** | **Integer** | DEFI协议类型 | [optional] -**clientOrderId** | **String** | 参考ID | [optional] -**source** | **String** | Order source. | [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/SystemTime.md b/docs/SystemTime.md index d0b9da9..ebc18b1 100644 --- a/docs/SystemTime.md +++ b/docs/SystemTime.md @@ -5,5 +5,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**serverTime** | **Long** | Server current time(ms). | [optional] +**serverTime** | **Long** | Server current time(ms) | [optional] diff --git a/docs/Ticker.md b/docs/Ticker.md index 54db8a5..77c5da5 100644 --- a/docs/Ticker.md +++ b/docs/Ticker.md @@ -5,21 +5,21 @@ 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] -**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] -**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] -**etfLeverage** | **String** | ETF current leverage. | [optional] +**currencyPair** | **String** | Currency pair | [optional] +**last** | **String** | Last trading price | [optional] +**lowestAsk** | **String** | Recent lowest ask | [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** | 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 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 050abc7..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 4a0cb91..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] -**createTimeMs** | **String** | Trading time, with millisecond precision. | [optional] -**currencyPair** | **String** | Currency pair. | [optional] -**side** | [**SideEnum**](#SideEnum) | Buy or sell order. | [optional] -**role** | [**RoleEnum**](#RoleEnum) | Trade role. No value 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] -**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] +**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) | 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, 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** | 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 1c86874..cb01b2d 100644 --- a/docs/TradeFee.md +++ b/docs/TradeFee.md @@ -5,17 +5,17 @@ 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] +**userId** | **Long** | User ID | [optional] +**takerFee** | **String** | taker fee rate | [optional] +**makerFee** | **String** | maker fee rate | [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] -**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] +**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 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 6b10285..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 e7eeed8..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 | -**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] +**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 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 f727861..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 8393991..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] +**currency** | **String** | Currency detail | [optional] +**amount** | **String** | Maximum transferable amount | [optional] diff --git a/docs/TriggerOrderResponse.md b/docs/TriggerOrderResponse.md index 85019c1..23fc48c 100644 --- a/docs/TriggerOrderResponse.md +++ b/docs/TriggerOrderResponse.md @@ -5,5 +5,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Long** | Auto order ID. | [optional] +**id** | **Long** | Auto order ID | [optional] diff --git a/docs/TriggerTime.md b/docs/TriggerTime.md index 2476867..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 7b1edae..66934e7 100644 --- a/docs/UidPushOrder.md +++ b/docs/UidPushOrder.md @@ -5,13 +5,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Long** | Order ID. | [optional] -**pushUid** | **Long** | Initiator User ID. | [optional] -**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] -**transactionType** | **String** | Order Type. | [optional] +**id** | **Long** | Order ID | [optional] +**pushUid** | **Long** | Initiator User ID | [optional] +**receiveUid** | **Long** | Recipient User ID | [optional] +**currency** | **String** | Currency name | [optional] +**amount** | **String** | Transfer amount | [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/UidPushWithdrawal.md b/docs/UidPushWithdrawal.md index afab0c6..4fcd82e 100644 --- a/docs/UidPushWithdrawal.md +++ b/docs/UidPushWithdrawal.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**receiveUid** | **Long** | Recipient UID. | -**currency** | **String** | Currency name. | -**amount** | **String** | Transfer amount. | +**receiveUid** | **Long** | Recipient UID | +**currency** | **String** | Currency name | +**amount** | **String** | Transfer amount | diff --git a/docs/UidPushWithdrawalResp.md b/docs/UidPushWithdrawalResp.md index 5bf74f0..5d7e783 100644 --- a/docs/UidPushWithdrawalResp.md +++ b/docs/UidPushWithdrawalResp.md @@ -5,5 +5,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **Long** | Order ID. | [optional] +**id** | **Long** | Order ID | [optional] diff --git a/docs/UniCurrency.md b/docs/UniCurrency.md index 881614b..0cc1548 100644 --- a/docs/UniCurrency.md +++ b/docs/UniCurrency.md @@ -1,15 +1,15 @@ # UniCurrency -Currency detail. +Currency detail ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency name. | [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] +**currency** | **String** | Currency name | [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 cf8c91e..212afc2 100644 --- a/docs/UniCurrencyInterest.md +++ b/docs/UniCurrencyInterest.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency. | [optional] [readonly] +**currency** | **String** | Currency | [optional] [readonly] **interestStatus** | **String** | Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment | [optional] [readonly] diff --git a/docs/UniCurrencyPair.md b/docs/UniCurrencyPair.md index d4a6509..2b09132 100644 --- a/docs/UniCurrencyPair.md +++ b/docs/UniCurrencyPair.md @@ -1,14 +1,14 @@ # UniCurrencyPair -Currency pair of the loan. +Currency pair of the loan ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currencyPair** | **String** | Currency pair. | [optional] [readonly] -**baseMinBorrowAmount** | **String** | Minimum borrow amount of base currency. | [optional] [readonly] -**quoteMinBorrowAmount** | **String** | Minimum borrow amount of quote currency. | [optional] [readonly] -**leverage** | **String** | Position leverage. | [optional] [readonly] +**currencyPair** | **String** | Currency pair | [optional] [readonly] +**baseMinBorrowAmount** | **String** | Minimum borrow amount of base currency | [optional] [readonly] +**quoteMinBorrowAmount** | **String** | Minimum borrow amount of quote currency | [optional] [readonly] +**leverage** | **String** | Position leverage | [optional] [readonly] diff --git a/docs/UniInterestRecord.md b/docs/UniInterestRecord.md index 10bdd82..bd2d474 100644 --- a/docs/UniInterestRecord.md +++ b/docs/UniInterestRecord.md @@ -1,16 +1,16 @@ # UniInterestRecord -Interest Record. +Interest Record ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**status** | **Integer** | Status: 0 - fail, 1 - success. | [optional] [readonly] -**currency** | **String** | Currency. | [optional] [readonly] -**actualRate** | **String** | Actual Rate. | [optional] [readonly] -**interest** | **String** | Interest. | [optional] [readonly] +**status** | **Integer** | Status: 0 - fail, 1 - success | [optional] [readonly] +**currency** | **String** | Currency | [optional] [readonly] +**actualRate** | **String** | Actual Rate | [optional] [readonly] +**interest** | **String** | Interest | [optional] [readonly] **interestStatus** | **String** | Interest status: interest_dividend - Normal dividend, interest_reinvest - Interest reinvestment | [optional] [readonly] -**createTime** | **Long** | Created time. | [optional] [readonly] +**createTime** | **Long** | Created time | [optional] [readonly] diff --git a/docs/UniLend.md b/docs/UniLend.md index 72561ae..961d0ab 100644 --- a/docs/UniLend.md +++ b/docs/UniLend.md @@ -1,20 +1,20 @@ # UniLend -Loan record. +Loan record ## Properties 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] -**minRate** | **String** | Minimum interest rate. | [optional] [readonly] +**currency** | **String** | Currency | [optional] [readonly] +**currentAmount** | **String** | Current 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 - Normal 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] +**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 9131360..feaaf25 100644 --- a/docs/UniLendInterest.md +++ b/docs/UniLendInterest.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency. | [optional] [readonly] -**interest** | **String** | Interest. | [optional] [readonly] +**currency** | **String** | Currency | [optional] [readonly] +**interest** | **String** | Interest income | [optional] [readonly] diff --git a/docs/UniLendRecord.md b/docs/UniLendRecord.md index 1419170..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] -**createTime** | **Long** | Created time. | [optional] [readonly] +**currency** | **String** | Currency name | [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 b40e6a1..758c1ed 100644 --- a/docs/UniLoan.md +++ b/docs/UniLoan.md @@ -1,16 +1,16 @@ # UniLoan -Loan. +Borrowing ## Properties 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] -**createTime** | **Long** | Created time. | [optional] [readonly] -**updateTime** | **Long** | Updated time. | [optional] [readonly] +**currency** | **String** | Currency | [optional] [readonly] +**currencyPair** | **String** | Currency pair | [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** | Last Update Time | [optional] [readonly] diff --git a/docs/UniLoanInterestRecord.md b/docs/UniLoanInterestRecord.md index 88c97f5..31bfe46 100644 --- a/docs/UniLoanInterestRecord.md +++ b/docs/UniLoanInterestRecord.md @@ -1,17 +1,17 @@ # UniLoanInterestRecord -Interest record. +Interest Deduction Record ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency name. | [optional] [readonly] -**currencyPair** | **String** | Currency pair. | [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] -**createTime** | **Long** | Created time. | [optional] [readonly] +**currency** | **String** | Currency name | [optional] [readonly] +**currencyPair** | **String** | Currency pair | [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 borrowing, margin - Margin borrowing | [optional] [readonly] +**createTime** | **Long** | Created time | [optional] [readonly] diff --git a/docs/UniLoanRecord.md b/docs/UniLoanRecord.md index 8cdf0f6..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] -**currencyPair** | **String** | Currency pair. | [optional] [readonly] -**currency** | **String** | Currency. | [optional] [readonly] -**amount** | **String** | The amount of lending or repaying. | [optional] [readonly] -**createTime** | **Long** | Created time. | [optional] [readonly] +**type** | **String** | Type: `borrow` - borrow, `repay` - repay | [optional] [readonly] +**currencyPair** | **String** | Currency pair | [optional] [readonly] +**currency** | **String** | Currency | [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 d583dc0..67395f9 100644 --- a/docs/UnifiedAccount.md +++ b/docs/UnifiedAccount.md @@ -5,24 +5,24 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Long** | User ID. | [optional] -**refreshTime** | **Long** | Time of the most recent refresh. | [optional] +**userId** | **Long** | User ID | [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] -**isAllCollateral** | **Boolean** | Whether all currencies are used as margin, true - false - No | [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 6c5d1a8..67dddd1 100644 --- a/docs/UnifiedApi.md +++ b/docs/UnifiedApi.md @@ -4,37 +4,37 @@ 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. -[**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. -[**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. -[**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. -[**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. -[**setUnifiedCollateral**](UnifiedApi.md#setUnifiedCollateral) | **POST** /unified/collateral_currencies | Set Collateral Currency. +[**listUnifiedAccounts**](UnifiedApi.md#listUnifiedAccounts) | **GET** /unified/accounts | Get unified account information +[**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 | 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 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 discount +[**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 | 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 +[**setUnifiedCollateral**](UnifiedApi.md#setUnifiedCollateral) | **POST** /unified/collateral_currencies | Set collateral currency # **listUnifiedAccounts** > UnifiedAccount listUnifiedAccounts().currency(currency).subUid(subUid).execute(); -Get unified account information. +Get unified account information -The assets of each currency in the account will be adjusted according to their liquidity, defined by corresponding adjustment coefficients, and then uniformly converted to USD to calculate the total asset value and position value of the account. You can refer to the [Formula](#portfolio-account) in the documentation +The assets of each currency in the account will be adjusted according to their liquidity, defined by corresponding adjustment coefficients, and then uniformly converted to USD to calculate the total asset value and position value of the account. For specific formulas, please refer to [Margin Formula](#margin-formula) ### Example @@ -57,8 +57,8 @@ 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 subUid = "10001"; // String | Sub account user ID. + String currency = "BTC"; // String | Query by specified currency name + String subUid = "10001"; // String | Sub account user ID try { UnifiedAccount result = apiInstance.listUnifiedAccounts() .currency(currency) @@ -82,8 +82,8 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Retrieve data of the specified currency. | [optional] - **subUid** | **String**| Sub account user ID. | [optional] + **currency** | **String**| Query by specified currency name | [optional] + **subUid** | **String**| Sub account user ID | [optional] ### Return type @@ -101,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 @@ -130,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); @@ -151,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 @@ -169,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 @@ -198,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); @@ -219,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 @@ -237,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 @@ -266,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); @@ -287,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 @@ -305,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 @@ -334,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); @@ -355,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 @@ -373,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 @@ -402,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. - 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. + String currency = "BTC"; // String | Query by specified currency name + Integer page = 1; // Integer | Page number + 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) @@ -431,10 +431,10 @@ public class Example { 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] - **type** | **String**| Loan type, platform - platform, margin - margin. | [optional] + **currency** | **String**| Query by specified currency name | [optional] + **page** | **Integer**| Page number | [optional] [default to 1] + **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 @@ -452,15 +452,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved. | - | +**200** | Query successful | - | # **createUnifiedLoan** > UnifiedLoanResult createUnifiedLoan(unifiedLoan) -Borrow or repay. +Borrow or repay -When borrowing, it is essential to ensure that the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and the user. The interest on the loan will be automatically deducted from the account at regular intervals. It is the user's responsibility to manage the repayment of the borrowed amount. For repayment, the option to repay the available by setting the parameter `repaid_all=true` +When borrowing, ensure the borrowed amount is not below the minimum borrowing threshold for the specific cryptocurrency and does not exceed the maximum borrowing limit set by the platform and user. Loan interest will be automatically deducted from the account at regular intervals. Users are responsible for managing repayment of borrowed amounts. For repayment, use `repaid_all=true` to repay all available amounts ### Example @@ -522,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 @@ -551,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, repaying the borrowed funds - 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. + 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 number of items returned. Default: 100, minimum: 1, maximum: 100 try { List result = apiInstance.listUnifiedLoanRecords() .type(type) @@ -580,10 +580,10 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **type** | **String**| The types of lending records, borrow - indicates the action of borrowing funds, repaying the borrowed funds | [optional] - **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] + **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 number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100] ### Return type @@ -601,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 @@ -630,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. - 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 + String currency = "BTC"; // String | Query by specified currency name + Integer page = 1; // Integer | Page number + 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) @@ -663,12 +663,12 @@ public class Example { 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 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] + **currency** | **String**| Query by specified currency name | [optional] + **page** | **Integer**| Page number | [optional] [default to 1] + **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 @@ -686,15 +686,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved. | - | +**200** | Query successful | - | # **getUnifiedRiskUnits** > UnifiedRiskUnits getUnifiedRiskUnits() -Get user risk unit details. +Get user risk unit details -Retrieve user risk unit details, only valid in portfolio margin mode. +Get user risk unit details, only valid in portfolio margin mode ### Example @@ -752,13 +752,13 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved. | - | +**200** | Query successful | - | # **getUnifiedMode** > UnifiedModeSet getUnifiedMode() -Query mode of the unified account. +Query mode of the unified account Unified account mode: - `classic`: Classic account mode - `multi_currency`: Cross-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single-currency margin mode @@ -818,13 +818,13 @@ 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 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\" } ``` @@ -887,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 @@ -918,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); @@ -939,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 @@ -957,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 discount ### Example @@ -1017,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 @@ -1077,15 +1077,15 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved. | - | +**200** | Query successful | - | # **calculatePortfolioMargin** > UnifiedPortfolioOutput calculatePortfolioMargin(unifiedPortfolioInput) -Portfolio margin calculator. +Portfolio margin calculator -Portfolio Margin Calculator When inputting a simulated position portfolio, each position includes the position name and quantity held, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. When inputting simulated orders, each order includes the market identifier, order price, and order of BTC and ETH perpetual contracts, options, and spot markets. Market orders are not included. +Portfolio Margin Calculator When inputting simulated position portfolios, each position includes the position name and quantity held, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. When inputting simulated orders, each order includes the market identifier, order price, and order quantity, supporting markets within the range of BTC and ETH perpetual contracts, options, and spot markets. Market orders are not included. ### Example @@ -1143,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 @@ -1172,7 +1172,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); UnifiedApi apiInstance = new UnifiedApi(defaultClient); - String currency = "BTC"; // String | Currency. + String currency = "BTC"; // String | Currency try { UnifiedLeverageConfig result = apiInstance.getUserLeverageCurrencyConfig(currency); System.out.println(result); @@ -1193,7 +1193,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Currency. | + **currency** | **String**| Currency | ### Return type @@ -1211,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 @@ -1242,9 +1242,9 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); UnifiedApi apiInstance = new UnifiedApi(defaultClient); - String currency = "BTC"; // String | Currency. + String currency = "BTC"; // String | Currency try { - UnifiedLeverageSetting result = apiInstance.getUserLeverageCurrencySetting() + List result = apiInstance.getUserLeverageCurrencySetting() .currency(currency) .execute(); System.out.println(result); @@ -1265,11 +1265,11 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Currency. | [optional] + **currency** | **String**| Currency | [optional] ### Return type -[**UnifiedLeverageSetting**](UnifiedLeverageSetting.md) +[**List<UnifiedLeverageSetting>**](UnifiedLeverageSetting.md) ### Authorization @@ -1283,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 @@ -1350,13 +1350,13 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Success. | - | +**204** | Set successfully | - | # **listUnifiedCurrencies** > List<UnifiedCurrency> listUnifiedCurrencies().currency(currency).execute(); -List of loan currencies supported by unified account. +List of loan currencies supported by unified account ### Example @@ -1375,7 +1375,7 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); UnifiedApi apiInstance = new UnifiedApi(defaultClient); - String currency = "BTC"; // String | Currency. + String currency = "BTC"; // String | Currency try { List result = apiInstance.listUnifiedCurrencies() .currency(currency) @@ -1398,7 +1398,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Currency. | [optional] + **currency** | **String**| Currency | [optional] ### Return type @@ -1416,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,10 +1441,10 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); 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. - Integer page = 1; // Integer | Page number. - Integer limit = 100; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 100. + String currency = "USDT"; // String | Currency + String tier = "1"; // String | VIP level for the floating rate to be queried + Integer page = 1; // Integer | Page number + Integer limit = 100; // Integer | Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 try { UnifiedHistoryLoanRate result = apiInstance.getHistoryLoanRate(currency) .tier(tier) @@ -1469,10 +1469,10 @@ 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] - **page** | **Integer**| Page number. | [optional] [default to 1] - **limit** | **Integer**| Maximum response items. Default: 100, minimum: 1, Maximum: 100. | [optional] [default to 100] + **currency** | **String**| Currency | + **tier** | **String**| VIP level for the floating rate to be queried | [optional] + **page** | **Integer**| Page number | [optional] [default to 1] + **limit** | **Integer**| Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100] ### Return type @@ -1490,13 +1490,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved. | - | +**200** | Query successful | - | # **setUnifiedCollateral** > UnifiedCollateralRes setUnifiedCollateral(unifiedCollateralReq) -Set Collateral Currency. +Set collateral currency ### Example @@ -1558,5 +1558,5 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | UpdateSuccess. | - | +**200** | Updated successfully | - | diff --git a/docs/UnifiedBalance.md b/docs/UnifiedBalance.md index a512f81..f19915a 100644 --- a/docs/UnifiedBalance.md +++ b/docs/UnifiedBalance.md @@ -5,24 +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 turned on as a unified account margin switch | [optional] -**fundingVersion** | **String** | Funding version. | [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] -**enabledCollateral** | **Boolean** | Currency enabled as margin: true - Enabled, false - Disabled. | [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/UnifiedBorrowable.md b/docs/UnifiedBorrowable.md index 23abf56..f23cf0a 100644 --- a/docs/UnifiedBorrowable.md +++ b/docs/UnifiedBorrowable.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency detail. | [optional] -**amount** | **String** | Max borrowable amount. | [optional] +**currency** | **String** | Currency detail | [optional] +**amount** | **String** | Max borrowable amount | [optional] diff --git a/docs/UnifiedBorrowable1.md b/docs/UnifiedBorrowable1.md index e9e930f..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] +**currency** | **String** | Currency detail | [optional] +**amount** | **String** | Maximum borrowable amount | [optional] diff --git a/docs/UnifiedCollateralReq.md b/docs/UnifiedCollateralReq.md index f146014..367f95d 100644 --- a/docs/UnifiedCollateralReq.md +++ b/docs/UnifiedCollateralReq.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**collateralType** | [**CollateralTypeEnum**](#CollateralTypeEnum) | User-set collateral mode0(all)-All currencies used as collateral, collateral; when collateral_type is 0(all), the enable_list and disable_list parameters are invalid | [optional] -**enableList** | **List<String>** | Currency list, where collateral_type=1(custom) indicates the logic of addition | [optional] -**disableList** | **List<String>** | Cancellation list, indicating the logic of cancellation. | [optional] +**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 diff --git a/docs/UnifiedCollateralRes.md b/docs/UnifiedCollateralRes.md index 8c7108a..23b7c2a 100644 --- a/docs/UnifiedCollateralRes.md +++ b/docs/UnifiedCollateralRes.md @@ -1,11 +1,11 @@ # UnifiedCollateralRes -Return of unified account collateral mode settings. +Unified account collateral mode settings response ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**isSuccess** | **Boolean** | Whether the setting was successful. | [optional] +**isSuccess** | **Boolean** | Whether the setting was successful | [optional] diff --git a/docs/UnifiedCurrency.md b/docs/UnifiedCurrency.md index 4f53965..d941bfe 100644 --- a/docs/UnifiedCurrency.md +++ b/docs/UnifiedCurrency.md @@ -5,10 +5,10 @@ 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] +**name** | **String** | Currency name | [optional] +**prec** | **String** | Currency precision | [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 2b9726c..5e9b790 100644 --- a/docs/UnifiedDiscount.md +++ b/docs/UnifiedDiscount.md @@ -1,12 +1,12 @@ # UnifiedDiscount -Currency discount tiers. +Unified account tiered discount ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency name. | [optional] -**discountTiers** | [**List<UnifiedDiscountTiers>**](UnifiedDiscountTiers.md) | Tiered discount. | [optional] +**currency** | **String** | Currency name | [optional] +**discountTiers** | [**List<UnifiedDiscountTiers>**](UnifiedDiscountTiers.md) | Tiered discount | [optional] diff --git a/docs/UnifiedDiscountTiers.md b/docs/UnifiedDiscountTiers.md index 91e4f3f..ab0ac91 100644 --- a/docs/UnifiedDiscountTiers.md +++ b/docs/UnifiedDiscountTiers.md @@ -5,9 +5,9 @@ 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] -**leverage** | **String** | Position leverage. | [optional] +**tier** | **String** | Tier | [optional] +**discount** | **String** | Discount | [optional] +**lowerLimit** | **String** | Lower limit | [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 2eb0e18..4be5ce0 100644 --- a/docs/UnifiedHistoryLoanRate.md +++ b/docs/UnifiedHistoryLoanRate.md @@ -5,8 +5,8 @@ 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] +**currency** | **String** | Currency name | [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 5f311f4..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 4ade484..2bb44f2 100644 --- a/docs/UnifiedLeverageConfig.md +++ b/docs/UnifiedLeverageConfig.md @@ -5,11 +5,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currentLeverage** | **String** | Current leverage ratio. | [optional] -**minLeverage** | **String** | Minimum adjustable leverage ratio. | [optional] -**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 be borrowed, whichever is smaller | [optional] +**currentLeverage** | **String** | Current leverage ratio | [optional] +**minLeverage** | **String** | Minimum adjustable leverage ratio | [optional] +**maxLeverage** | **String** | Maximum adjustable leverage ratio | [optional] +**debit** | **String** | Current liabilities | [optional] +**availableMargin** | **String** | Available Margin | [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 2b130ac..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. | +**currency** | **String** | Currency name | +**leverage** | **String** | Multiplier | diff --git a/docs/UnifiedLoan.md b/docs/UnifiedLoan.md index 783acea..58564c0 100644 --- a/docs/UnifiedLoan.md +++ b/docs/UnifiedLoan.md @@ -1,17 +1,17 @@ # UnifiedLoan -Borrow or repay. +Borrow or repay ## Properties 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] -**text** | **String** | User defined custom ID. | [optional] +**currency** | **String** | Currency | +**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 ea2abf1..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 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] -**currencyPair** | **String** | Currency pair. | [optional] [readonly] -**currency** | **String** | Currency. | [optional] [readonly] -**amount** | **String** | The amount of lending or repaying. | [optional] [readonly] -**createTime** | **Long** | Created time. | [optional] [readonly] +**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** | Borrow or repayment amount | [optional] [readonly] +**createTime** | **Long** | Created time | [optional] [readonly] diff --git a/docs/UnifiedLoanResult.md b/docs/UnifiedLoanResult.md index 3575837..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 73a5fdc..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] +**currency** | **String** | Currency name | [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 52fb40a..78bb520 100644 --- a/docs/UnifiedPortfolioInput.md +++ b/docs/UnifiedPortfolioInput.md @@ -1,17 +1,17 @@ # UnifiedPortfolioInput -Input for the portfolio margin calculator. +Portfolio margin calculator input ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**spotBalances** | [**List<MockSpotBalance>**](MockSpotBalance.md) | Spot. | [optional] -**spotOrders** | [**List<MockSpotOrder>**](MockSpotOrder.md) | Spot orders. | [optional] -**futuresPositions** | [**List<MockFuturesPosition>**](MockFuturesPosition.md) | Futures positions. | [optional] -**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] +**spotBalances** | [**List<MockSpotBalance>**](MockSpotBalance.md) | Spot | [optional] +**spotOrders** | [**List<MockSpotOrder>**](MockSpotOrder.md) | Spot orders | [optional] +**futuresPositions** | [**List<MockFuturesPosition>**](MockFuturesPosition.md) | Futures positions | [optional] +**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] diff --git a/docs/UnifiedPortfolioOutput.md b/docs/UnifiedPortfolioOutput.md index 571eccf..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, orders. | [optional] -**calculateTime** | **Long** | Calculate time. | [optional] -**riskUnit** | [**List<MockRiskUnit>**](MockRiskUnit.md) | Risk unit. | [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 ed22873..f64d09e 100644 --- a/docs/UnifiedRiskUnits.md +++ b/docs/UnifiedRiskUnits.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**userId** | **Long** | User ID. | [optional] -**spotHedge** | **Boolean** | Spot hedging status, true - enabled, false - not enabled. | [optional] -**riskUnits** | [**List<RiskUnits>**](RiskUnits.md) | Risk unit. | [optional] +**userId** | **Long** | User ID | [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 a63820f..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 5cf70cc..23e6b01 100644 --- a/docs/UnifiedTransferable.md +++ b/docs/UnifiedTransferable.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency detail. | [optional] -**amount** | **String** | The maximum amount that can be transferred out. | [optional] +**currency** | **String** | Currency detail | [optional] +**amount** | **String** | Maximum transferable amount | [optional] diff --git a/docs/UserLtvInfo.md b/docs/UserLtvInfo.md index c2f0107..0298471 100644 --- a/docs/UserLtvInfo.md +++ b/docs/UserLtvInfo.md @@ -1,17 +1,17 @@ # UserLtvInfo -User's currency statistics data. +User's currency statistics data ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**collateralCurrency** | **String** | Collateral. | [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] -**minBorrowAmount** | **String** | Minimum borrowable amount for the loan currency. | [optional] -**leftBorrowableAmount** | **String** | Remaining borrowable amount for the loan currency. | [optional] +**collateralCurrency** | **String** | Collateral currency | [optional] +**borrowCurrency** | **String** | Borrowed currency | [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 b69844b..4ebec41 100644 --- a/docs/UserSub.md +++ b/docs/UserSub.md @@ -5,8 +5,8 @@ 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 customer 4-indirect direct customer 5-ordinary user) | [optional] -**refUid** | **Long** | Inviter user ID. | [optional] +**uid** | **Long** | User ID | [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/UserSubRelation.md b/docs/UserSubRelation.md index 00ca137..5a2eb51 100644 --- a/docs/UserSubRelation.md +++ b/docs/UserSubRelation.md @@ -5,5 +5,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**list** | [**List<UserSub>**](UserSub.md) | Subordinate relationship list. | [optional] +**list** | [**List<UserSub>**](UserSub.md) | Subordinate relationship list | [optional] diff --git a/docs/UserTotalAmount.md b/docs/UserTotalAmount.md index 38324ef..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 bfd8d24..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. -[**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. -[**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. -[**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. -[**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. +[**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 | 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 | 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 | Transfer between sub-accounts +[**getTransferOrderStatus**](WalletApi.md#getTransferOrderStatus) | **GET** /wallet/order_status | Transfer status query +[**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 @@ -50,7 +50,7 @@ public class Example { defaultClient.setBasePath("https://api.gateio.ws/api/v4"); WalletApi apiInstance = new WalletApi(defaultClient); - String currency = "GT"; // String | Currency name. + String currency = "GT"; // String | Currency name try { List result = apiInstance.listCurrencyChains(currency); System.out.println(result); @@ -71,7 +71,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Currency name. | + **currency** | **String**| Currency name | ### Return type @@ -89,13 +89,13 @@ No authorization required ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successfully retrieved. | - | +**200** | Query successful | - | # **getDepositAddress** > DepositAddress getDepositAddress(currency) -Generate currency deposit address. +Generate currency deposit address ### Example @@ -118,7 +118,7 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); WalletApi apiInstance = new WalletApi(defaultClient); - String currency = "USDT"; // String | Currency name. + String currency = "USDT"; // String | Currency name try { DepositAddress result = apiInstance.getDepositAddress(currency); System.out.println(result); @@ -139,7 +139,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **currency** | **String**| Currency name. | + **currency** | **String**| Currency name | ### Return type @@ -157,15 +157,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Address successfully generated. | - | +**200** | Address successfully generated | - | # **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,14 +188,14 @@ 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. - Integer offset = 0; // Integer | List offset, starting from 0. + 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() .currency(currency) @@ -225,14 +225,14 @@ 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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **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,11 +281,11 @@ 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. - Integer offset = 0; // Integer | List offset, starting from 0. + 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() .currency(currency) @@ -312,11 +312,11 @@ 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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **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,15 +334,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved. | - | +**200** | List retrieved successfully | - | # **transfer** > TransactionID transfer(transfer) -Transfer between trading accounts. +Transfer between trading accounts -Transfer between different accounts. Currently support transfers between the following: 1. spot - margin 2. spot - futures(perpetual) 3. options +Balance transfers between personal trading accounts. Currently supports the following transfer operations: 1. Spot account - Margin account 2. Spot account - Perpetual futures account 3. Spot account - Delivery futures account 4. Spot account - Options account ### Example @@ -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<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 20-04-10can be retrieved +Record query time range cannot exceed 30 days > Note: Only records after 2020-04-10 can be retrieved ### Example @@ -435,11 +435,11 @@ 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. - Integer offset = 0; // Integer | List offset, starting from 0. + 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() .subUid(subUid) @@ -466,11 +466,11 @@ 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] - **offset** | **Integer**| List offset, starting from 0. | [optional] [default to 0] + **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 @@ -488,15 +488,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | List retrieved. | - | +**200** | List retrieved successfully | - | # **transferWithSubAccount** > TransactionID transferWithSubAccount(subAccountTransfer) -Transfer between main and sub accounts. +Transfer between main and sub accounts -Support transferring with sub user's spot or futures account. Note that only main user's spot account is used no matter which sub user's account is operated. +Supports transfers to/from sub-account's spot or futures accounts. Note that regardless of which sub-account is operated, only the main account's spot account is used ### Example @@ -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 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,15 +628,15 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Balance transferred. | - | +**200** | Transfer operation successful | - | # **getTransferOrderStatus** > TransferOrderStatus getTransferOrderStatus().clientOrderId(clientOrderId).txId(txId).execute(); -Transfer status query. +Transfer status query -Support querying transfer status based on user-defined client_order_id or tx_id returned by the transfer interface +Supports querying transfer status based on user-defined client_order_id or tx_id returned by the transfer interface ### Example @@ -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 @@ -1085,10 +1085,10 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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. - Integer page = 1; // Integer | Page number. + String currency = "USDT"; // String | Currency + String chain = "\"\""; // String | Chain name + String limit = "\"50\""; // String | Maximum number returned, up to 100 + Integer page = 1; // Integer | Page number try { List result = apiInstance.listSavedAddress(currency) .chain(chain) @@ -1113,10 +1113,10 @@ public class Example { 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"] - **page** | **Integer**| Page number. | [optional] [default to 1] + **currency** | **String**| Currency | + **chain** | **String**| Chain name | [optional] [default to ""] + **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` /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 @@ -1343,13 +1343,13 @@ This endpoint does not need any parameter. ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success. | - | +**200** | Success | - | # **convertSmallBalance** > convertSmallBalance(convertSmallBalance) -Convert small balance. +Convert small balance currency ### Example @@ -1410,13 +1410,13 @@ null (empty response body) ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success. | - | +**200** | Success | - | # **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. - Integer page = 1; // Integer | Page number. - Integer limit = 100; // Integer | Maximum response items. Default: 100, minimum: 1, Maximum: 100. + String currency = "currency_example"; // String | Currency to convert + Integer page = 1; // Integer | Page number + 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] - **page** | **Integer**| Page number. | [optional] [default to 1] - **limit** | **Integer**| Maximum response items. Default: 100, minimum: 1, Maximum: 100. | [optional] [default to 100] + **currency** | **String**| Currency to convert | [optional] + **page** | **Integer**| Page number | [optional] [default to 1] + **limit** | **Integer**| Maximum number of items returned. Default: 100, minimum: 1, maximum: 100 | [optional] [default to 100] ### Return type @@ -1486,13 +1486,13 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success. | - | +**200** | Success | - | # **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 @@ -1515,12 +1515,12 @@ public class Example { defaultClient.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET"); 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 offset = 0; // Integer | List offset, starting from 0. - String transactionType = "\"withdraw\""; // String | The list returns the order type `withdraw`, `deposit`, the default is `withdraw`. + Integer id = 56; // Integer | Order ID + 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 | Order type returned in the list: `withdraw`, `deposit`. Default is `withdraw`. try { List result = apiInstance.listPushOrders() .id(id) @@ -1548,12 +1548,12 @@ 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] - **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"] + **id** | **Integer**| Order ID | [optional] + **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**| Order type returned in the list: `withdraw`, `deposit`. Default is `withdraw`. | [optional] [default to "withdraw"] ### Return type @@ -1571,5 +1571,5 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Success. | - | +**200** | Success | - | diff --git a/docs/WithdrawStatus.md b/docs/WithdrawStatus.md index 9dbcb39..8ae61da 100644 --- a/docs/WithdrawStatus.md +++ b/docs/WithdrawStatus.md @@ -5,16 +5,16 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**currency** | **String** | Currency. | [optional] -**name** | **String** | Currency name. | [optional] -**nameCn** | **String** | Currency Chinese name. | [optional] -**deposit** | **String** | Deposits fee. | [optional] -**withdrawPercent** | **String** | Withdrawal fee rate percentage. | [optional] -**withdrawFix** | **String** | Fixed withdrawal fee. | [optional] -**withdrawDayLimit** | **String** | Daily allowed withdrawal amount. | [optional] -**withdrawAmountMini** | **String** | Minimum withdrawal amount. | [optional] -**withdrawDayLimitRemain** | **String** | Daily withdrawal amount left. | [optional] -**withdrawEachtimeLimit** | **String** | Maximum amount for each withdrawal. | [optional] -**withdrawFixOnChains** | **Map<String, String>** | Fixed withdrawal fee on multiple chains. | [optional] -**withdrawPercentOnChains** | **Map<String, String>** | Percentage withdrawal fee on multiple chains. | [optional] +**currency** | **String** | Currency | [optional] +**name** | **String** | Currency name | [optional] +**nameCn** | **String** | Currency Chinese name | [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] +**withdrawAmountMini** | **String** | Minimum withdrawal amount | [optional] +**withdrawDayLimitRemain** | **String** | Daily withdrawal amount left | [optional] +**withdrawEachtimeLimit** | **String** | Maximum amount for each withdrawal | [optional] +**withdrawFixOnChains** | **Map<String, String>** | Fixed withdrawal fee on multiple chains | [optional] +**withdrawPercentOnChains** | **Map<String, String>** | Percentage withdrawal fee on multiple chains | [optional] diff --git a/docs/WithdrawalApi.md b/docs/WithdrawalApi.md index 5734e66..167f992 100644 --- a/docs/WithdrawalApi.md +++ b/docs/WithdrawalApi.md @@ -4,18 +4,18 @@ All URIs are relative to *https://api.gateio.ws/api/v4* Method | HTTP request | Description ------------- | ------------- | ------------- -[**withdraw**](WithdrawalApi.md#withdraw) | **POST** /withdrawals | Withdraw. -[**withdrawPushOrder**](WithdrawalApi.md#withdrawPushOrder) | **POST** /withdrawals/push | UID transfer. -[**cancelWithdrawal**](WithdrawalApi.md#cancelWithdrawal) | **DELETE** /withdrawals/{withdrawal_id} | Cancel withdrawal with specified ID. +[**withdraw**](WithdrawalApi.md#withdraw) | **POST** /withdrawals | Withdraw +[**withdrawPushOrder**](WithdrawalApi.md#withdrawPushOrder) | **POST** /withdrawals/push | UID transfer +[**cancelWithdrawal**](WithdrawalApi.md#cancelWithdrawal) | **DELETE** /withdrawals/{withdrawal_id} | Cancel withdrawal with specified ID # **withdraw** > LedgerRecord withdraw(ledgerRecord) -Withdraw. +Withdraw -Withdrawals to Gate addresses do not incur transaction fees. +If the recipient's on-chain address is also Gate, no transaction fee will be charged ### Example @@ -77,15 +77,15 @@ 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** > UidPushWithdrawalResp withdrawPushOrder(uidPushWithdrawal) -UID transfer. +UID transfer -Transfers between main spot accounts are allowed; however, both parties cannot be sub-accounts +Transfers between main spot accounts. Both parties cannot be sub-accounts ### Example @@ -147,13 +147,13 @@ 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** > LedgerRecord cancelWithdrawal(withdrawalId) -Cancel withdrawal with specified ID. +Cancel withdrawal with specified ID ### Example @@ -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 eb20f50..58247a8 100644 --- a/docs/WithdrawalRecord.md +++ b/docs/WithdrawalRecord.md @@ -5,18 +5,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | Record ID. | [optional] [readonly] -**txid** | **String** | Hash record of the withdrawal. | [optional] [readonly] -**blockNumber** | **String** | Block Number. | [optional] [readonly] +**id** | **String** | Record ID | [optional] [readonly] +**txid** | **String** | Hash record of the withdrawal | [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. | -**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 | [optional] -**memo** | **String** | Additional remarks with regards to the withdrawal. | [optional] +**timestamp** | **String** | Operation time | [optional] [readonly] +**amount** | **String** | Token amount | +**fee** | **String** | fee | [optional] [readonly] +**currency** | **String** | Currency name | +**address** | **String** | Withdrawal address | [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. | +**chain** | **String** | Name of the chain used in withdrawals | diff --git a/pom.xml b/pom.xml index a087715..4b747b3 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ gate-api jar gate-api - 6.103.0 + 6.104.3 https://github.com/gateio/gateapi-java.git Java client for gateapi diff --git a/src/main/java/io/gate/gateapi/ApiCallback.java b/src/main/java/io/gate/gateapi/ApiCallback.java index ef483bf..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 93f201a..abb28f4 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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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.103.0/java"); + setUserAgent("OpenAPI-Generator/6.104.3/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 e93f79b..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 b9a5356..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 fe9166e..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 4ebfb51..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 0fdcebb..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 d0fb65f..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 b3db2b8..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 015d21e..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 b0d2a64..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 91d372a..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 { @@ -196,14 +196,14 @@ private okhttp3.Call getAccountRateLimitValidateBeforeCall(final ApiCallback _ca } /** - * Get user transaction rate limit information. + * Get user transaction rate limit information * * @return List<AccountRateLimit> * @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 getAccountRateLimit() throws ApiException { @@ -212,14 +212,14 @@ public List getAccountRateLimit() throws ApiException { } /** - * Get user transaction rate limit information. + * Get user transaction rate limit information * * @return ApiResponse<List<AccountRateLimit>> * @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> getAccountRateLimitWithHttpInfo() throws ApiException { @@ -229,7 +229,7 @@ public ApiResponse> getAccountRateLimitWithHttpInfo() thr } /** - * Get user transaction rate limit information. (asynchronously) + * Get user transaction rate limit information (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -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,15 +443,15 @@ private okhttp3.Call createSTPGroupValidateBeforeCall(StpGroup stpGroup, final A } /** - * Create STP Group. - * Only the main account is allowed to create a new STP user group. + * Create STP user group + * Only the main account is allowed to create a new STP user group * @param stpGroup (required) * @return StpGroup * @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 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,15 +460,15 @@ public StpGroup createSTPGroup(StpGroup stpGroup) throws ApiException { } /** - * Create STP Group. - * Only the main account is allowed to create a new STP user group. + * Create STP user group + * Only the main account is allowed to create a new STP user group * @param stpGroup (required) * @return ApiResponse<StpGroup> * @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 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,8 +478,8 @@ public ApiResponse createSTPGroupWithHttpInfo(StpGroup stpGroup) throw } /** - * Create STP Group. (asynchronously) - * Only the main account is allowed to create a new STP user group. + * 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 * @return The request call @@ -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 { @@ -499,14 +499,14 @@ 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 can query the account. - * @param stpId STP Group ID. (required) + * 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 can query the account. - * @param stpId STP Group ID. (required) + * 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,16 +586,16 @@ public ApiResponse> listSTPGroupsUsersWithHttpInfo(Long stpId } /** - * List users of the STP group. (asynchronously) - * Only the main account that created this STP group can query the account. - * @param stpId STP Group ID. (required) + * 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 * @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 listSTPGroupsUsersAsync(Long stpId, final ApiCallback> _callback) throws ApiException { @@ -607,15 +607,15 @@ 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,16 +665,16 @@ 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 group.- Only accounts under the main account are allowed to be added. Cross-account is not permitted - * @param stpId STP Group ID. (required) - * @param requestBody User ID. (required) + * 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> * @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 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,16 +683,16 @@ 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 group.- Only accounts under the main account are allowed to be added. Cross-account is not permitted - * @param stpId STP Group ID. (required) - * @param requestBody User ID. (required) + * 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>> * @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 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,17 +702,17 @@ 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 group.- Only accounts under the main account are allowed to be added. Cross-account is not permitted - * @param stpId STP Group ID. (required) - * @param requestBody User ID. (required) + * 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 * @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 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 { @@ -724,15 +724,15 @@ 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 stpId STP Group ID (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 stpId STP Group ID (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 stpId STP Group ID (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 stpId STP Group ID (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 { @@ -851,7 +851,7 @@ public okhttp3.Call deleteSTPGroupUsersAsync(Long stpId, Long userId, final ApiC * @http.response.details - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public okhttp3.Call getDebitFeeCall(final ApiCallback _callback) throws ApiException { @@ -890,14 +890,14 @@ 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 - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public DebitFee getDebitFee() throws ApiException { @@ -906,14 +906,14 @@ 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 - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public ApiResponse getDebitFeeWithHttpInfo() throws ApiException { @@ -923,15 +923,15 @@ 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 * @http.response.details - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public okhttp3.Call getDebitFeeAsync(final ApiCallback _callback) throws ApiException { @@ -950,7 +950,7 @@ public okhttp3.Call getDebitFeeAsync(final ApiCallback _callback) thro * @http.response.details - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public okhttp3.Call setDebitFeeCall(DebitFee debitFee, final ApiCallback _callback) throws ApiException { @@ -994,14 +994,14 @@ 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 - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public void setDebitFee(DebitFee debitFee) throws ApiException { @@ -1009,15 +1009,15 @@ 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 * @http.response.details - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public ApiResponse setDebitFeeWithHttpInfo(DebitFee debitFee) throws ApiException { @@ -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 @@ -1035,7 +1035,7 @@ public ApiResponse setDebitFeeWithHttpInfo(DebitFee debitFee) throws ApiEx * @http.response.details - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public okhttp3.Call setDebitFeeAsync(DebitFee debitFee, final ApiCallback _callback) throws ApiException { diff --git a/src/main/java/io/gate/gateapi/api/CollateralLoanApi.java b/src/main/java/io/gate/gateapi/api/CollateralLoanApi.java index e06c5e0..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -133,7 +133,7 @@ private APIlistCollateralLoanOrdersRequest() { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistCollateralLoanOrdersRequest */ public APIlistCollateralLoanOrdersRequest page(Integer page) { @@ -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) { @@ -163,7 +163,7 @@ public APIlistCollateralLoanOrdersRequest collateralCurrency(String collateralCu /** * Set borrowCurrency - * @param borrowCurrency Borrowed currency. (optional) + * @param borrowCurrency Borrowed currency (optional) * @return APIlistCollateralLoanOrdersRequest */ public APIlistCollateralLoanOrdersRequest borrowCurrency(String borrowCurrency) { @@ -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 { @@ -664,7 +664,7 @@ private APIlistRepayRecordsRequest(String source) { /** * Set borrowCurrency - * @param borrowCurrency Borrowed currency. (optional) + * @param borrowCurrency Borrowed currency (optional) * @return APIlistRepayRecordsRequest */ public APIlistRepayRecordsRequest borrowCurrency(String borrowCurrency) { @@ -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) { @@ -684,7 +684,7 @@ public APIlistRepayRecordsRequest collateralCurrency(String collateralCurrency) /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistRepayRecordsRequest */ public APIlistRepayRecordsRequest page(Integer page) { @@ -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) + * @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) { @@ -883,7 +883,7 @@ private APIlistCollateralRecordsRequest() { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistCollateralRecordsRequest */ public APIlistCollateralRecordsRequest page(Integer page) { @@ -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) { @@ -923,7 +923,7 @@ public APIlistCollateralRecordsRequest to(Long to) { /** * Set borrowCurrency - * @param borrowCurrency Borrowed currency. (optional) + * @param borrowCurrency Borrowed currency (optional) * @return APIlistCollateralRecordsRequest */ public APIlistCollateralRecordsRequest borrowCurrency(String borrowCurrency) { @@ -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 { @@ -1002,13 +1002,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _call } /** - * Query collateral adjustment records. + * Query collateral adjustment records * * @return APIlistCollateralRecordsRequest * @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 { @@ -1068,14 +1068,14 @@ private okhttp3.Call operateCollateralValidateBeforeCall(CollateralAlign collate } /** - * Increase or redeem collateral. + * Increase or redeem collateral * * @param collateralAlign (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 operateCollateral(CollateralAlign collateralAlign) throws ApiException { @@ -1083,7 +1083,7 @@ public void operateCollateral(CollateralAlign collateralAlign) throws ApiExcepti } /** - * Increase or redeem collateral. + * Increase or redeem collateral * * @param collateralAlign (required) * @return ApiResponse<Void> @@ -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 { @@ -1100,7 +1100,7 @@ public ApiResponse operateCollateralWithHttpInfo(CollateralAlign collatera } /** - * Increase or redeem collateral. (asynchronously) + * Increase or redeem collateral (asynchronously) * * @param collateralAlign (required) * @param _callback The callback to be executed when the API call finishes @@ -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,15 +1218,15 @@ public okhttp3.Call getUserTotalAmountAsync(final ApiCallback _ /** * Build call for getUserLtvInfo - * @param collateralCurrency Collateral. (required) - * @param borrowCurrency Borrowed currency. (required) + * @param collateralCurrency Collateral currency (required) + * @param borrowCurrency Borrowed 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. -
    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 borrowCurrency Borrowed currency. (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 borrowCurrency Borrowed currency. (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,17 +1320,17 @@ 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 borrowCurrency Borrowed currency. (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 * @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 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. (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 { @@ -1470,13 +1470,13 @@ public okhttp3.Call executeAsync(final ApiCallback> } /** - * Query supported borrowing and collateral currencies. + * Query supported borrowing and collateral currencies * * @return APIlistCollateralCurrenciesRequest * @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 b635679..a331494 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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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,14 +65,14 @@ public void setApiClient(ApiClient apiClient) { /** * Build call for listDeliveryContracts - * @param settle Settle currency. (required) + * @param settle Settle 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 List retrieved. -
    200 List retrieved successfully -
    */ public okhttp3.Call listDeliveryContractsCall(String settle, final ApiCallback _callback) throws ApiException { @@ -117,15 +117,15 @@ private okhttp3.Call listDeliveryContractsValidateBeforeCall(String settle, fina } /** - * List all futures contracts. + * Query all futures contracts * - * @param settle Settle currency. (required) + * @param settle Settle currency (required) * @return List<DeliveryContract> * @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 listDeliveryContracts(String settle) throws ApiException { @@ -134,15 +134,15 @@ public List listDeliveryContracts(String settle) throws ApiExc } /** - * List all futures contracts. + * Query all futures contracts * - * @param settle Settle currency. (required) + * @param settle Settle currency (required) * @return ApiResponse<List<DeliveryContract>> * @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> listDeliveryContractsWithHttpInfo(String settle) throws ApiException { @@ -152,16 +152,16 @@ public ApiResponse> listDeliveryContractsWithHttpInfo(Str } /** - * List all futures contracts. (asynchronously) + * Query all futures contracts (asynchronously) * - * @param settle Settle currency. (required) + * @param settle Settle 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 List retrieved. -
    200 List retrieved successfully -
    */ public okhttp3.Call listDeliveryContractsAsync(String settle, final ApiCallback> _callback) throws ApiException { @@ -173,15 +173,15 @@ public okhttp3.Call listDeliveryContractsAsync(String settle, final ApiCallback< /** * Build call for getDeliveryContract - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (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 Contract information. -
    200 Contract information -
    */ public okhttp3.Call getDeliveryContractCall(String settle, String contract, final ApiCallback _callback) throws ApiException { @@ -232,16 +232,16 @@ 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) + * @param settle Settle currency (required) + * @param contract Futures contract (required) * @return DeliveryContract * @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 Contract information. -
    200 Contract information -
    */ public DeliveryContract getDeliveryContract(String settle, String contract) throws ApiException { @@ -250,16 +250,16 @@ 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) + * @param settle Settle currency (required) + * @param contract Futures contract (required) * @return ApiResponse<DeliveryContract> * @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 Contract information. -
    200 Contract information -
    */ public ApiResponse getDeliveryContractWithHttpInfo(String settle, String contract) throws ApiException { @@ -269,17 +269,17 @@ 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) + * @param settle Settle currency (required) + * @param contract Futures contract (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 Contract information. -
    200 Contract information -
    */ public okhttp3.Call getDeliveryContractAsync(String settle, String contract, final ApiCallback _callback) throws ApiException { @@ -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 to return depth update ID. This ID increments by 1 each time. (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 Depth query successful. -
    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 Depth query successful. -
    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 Depth query successful. -
    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 Depth query successful. -
    200 Depth query successful -
    */ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -468,15 +468,15 @@ public okhttp3.Call executeAsync(final ApiCallback _callback) } /** - * Futures order book. - * Bids will be sorted by price from high to low, while asks sorted reversely. - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) + * 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) * @return APIlistDeliveryOrderBookRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Depth query successful. -
    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) { @@ -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,15 +677,15 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * Futures trading history. + * Futures market transaction records * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (required) * @return APIlistDeliveryTradesRequest * @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 Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision specified (optional) + * @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 Time interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial timeweek, 7d time is aligned with Unix initial time (optional, default to 5m) + * @param interval Time interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial timeTime interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial timeweek, 7d time is aligned with Unix initial time (optional, default to 5m) * @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,15 +886,15 @@ 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) + * @param settle Settle currency (required) + * @param contract Futures contract (required) * @return APIlistDeliveryCandlesticksRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved. -
    200 Query successful -
    */ public APIlistDeliveryCandlesticksRequest listDeliveryCandlesticks(String settle, String contract) { @@ -970,7 +970,7 @@ private APIlistDeliveryTickersRequest(String settle) { /** * Set contract - * @param contract Futures contract. (optional) + * @param contract Futures contract (optional) * @return APIlistDeliveryTickersRequest */ public APIlistDeliveryTickersRequest contract(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) + * @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) + * @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) { @@ -1207,14 +1207,14 @@ public APIlistDeliveryInsuranceLedgerRequest listDeliveryInsuranceLedger(String /** * Build call for listDeliveryAccounts - * @param settle Settle currency. (required) + * @param settle Settle 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 List retrieved. -
    200 List retrieved successfully -
    */ public okhttp3.Call listDeliveryAccountsCall(String settle, final ApiCallback _callback) throws ApiException { @@ -1259,15 +1259,15 @@ private okhttp3.Call listDeliveryAccountsValidateBeforeCall(String settle, final } /** - * Query futures account. + * Get futures account * - * @param settle Settle currency. (required) + * @param settle Settle currency (required) * @return FuturesAccount * @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 FuturesAccount listDeliveryAccounts(String settle) throws ApiException { @@ -1276,15 +1276,15 @@ public FuturesAccount listDeliveryAccounts(String settle) throws ApiException { } /** - * Query futures account. + * Get futures account * - * @param settle Settle currency. (required) + * @param settle Settle currency (required) * @return ApiResponse<FuturesAccount> * @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 listDeliveryAccountsWithHttpInfo(String settle) throws ApiException { @@ -1294,16 +1294,16 @@ public ApiResponse listDeliveryAccountsWithHttpInfo(String settl } /** - * Query futures account. (asynchronously) + * Get futures account (asynchronously) * - * @param settle Settle currency. (required) + * @param settle Settle 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 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) { @@ -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) + * @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) { @@ -1512,14 +1512,14 @@ public APIlistDeliveryAccountBookRequest listDeliveryAccountBook(String settle) /** * Build call for listDeliveryPositions - * @param settle Settle currency. (required) + * @param settle Settle 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 List retrieved. -
    200 List retrieved successfully -
    */ public okhttp3.Call listDeliveryPositionsCall(String settle, final ApiCallback _callback) throws ApiException { @@ -1564,15 +1564,15 @@ private okhttp3.Call listDeliveryPositionsValidateBeforeCall(String settle, fina } /** - * List all positions of a user. + * Get user position list * - * @param settle Settle currency. (required) + * @param settle Settle currency (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 List retrieved. -
    200 List retrieved successfully -
    */ public List listDeliveryPositions(String settle) throws ApiException { @@ -1581,15 +1581,15 @@ public List listDeliveryPositions(String settle) throws ApiException { } /** - * List all positions of a user. + * Get user position list * - * @param settle Settle currency. (required) + * @param settle Settle currency (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 List retrieved. -
    200 List retrieved successfully -
    */ public ApiResponse> listDeliveryPositionsWithHttpInfo(String settle) throws ApiException { @@ -1599,16 +1599,16 @@ public ApiResponse> listDeliveryPositionsWithHttpInfo(String sett } /** - * List all positions of a user. (asynchronously) + * Get user position list (asynchronously) * - * @param settle Settle currency. (required) + * @param settle Settle 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 List retrieved. -
    200 List retrieved successfully -
    */ public okhttp3.Call listDeliveryPositionsAsync(String settle, final ApiCallback> _callback) throws ApiException { @@ -1620,15 +1620,15 @@ public okhttp3.Call listDeliveryPositionsAsync(String settle, final ApiCallback< /** * Build call for getDeliveryPosition - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (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 Position information. -
    200 Position information -
    */ public okhttp3.Call getDeliveryPositionCall(String settle, String contract, final ApiCallback _callback) throws ApiException { @@ -1679,16 +1679,16 @@ private okhttp3.Call getDeliveryPositionValidateBeforeCall(String settle, String } /** - * Get single position. + * Get single position information * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (required) * @return 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 Position information. -
    200 Position information -
    */ public Position getDeliveryPosition(String settle, String contract) throws ApiException { @@ -1697,16 +1697,16 @@ 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) + * @param settle Settle currency (required) + * @param contract Futures contract (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 - +
    Status Code Description Response Headers
    200 Position information. -
    200 Position information -
    */ public ApiResponse getDeliveryPositionWithHttpInfo(String settle, String contract) throws ApiException { @@ -1716,17 +1716,17 @@ 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) + * @param settle Settle currency (required) + * @param contract Futures contract (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 Position information. -
    200 Position information -
    */ public okhttp3.Call getDeliveryPositionAsync(String settle, String contract, final ApiCallback _callback) throws ApiException { @@ -1738,16 +1738,16 @@ 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 amount, positive number increases, negative number. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (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 * @http.response.details - +
    Status Code Description Response Headers
    200 Position information. -
    200 Position information -
    */ public okhttp3.Call updateDeliveryPositionMarginCall(String settle, String contract, String change, final ApiCallback _callback) throws ApiException { @@ -1807,17 +1807,17 @@ private okhttp3.Call updateDeliveryPositionMarginValidateBeforeCall(String settl } /** - * Update position margin. + * Update position margin * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param change Margin change amount, positive number increases, negative number. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (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 - +
    Status Code Description Response Headers
    200 Position information. -
    200 Position information -
    */ public Position updateDeliveryPositionMargin(String settle, String contract, String change) throws ApiException { @@ -1826,17 +1826,17 @@ public Position updateDeliveryPositionMargin(String settle, String contract, Str } /** - * Update position margin. + * Update position margin * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param change Margin change amount, positive number increases, negative number. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (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 - +
    Status Code Description Response Headers
    200 Position information. -
    200 Position information -
    */ public ApiResponse updateDeliveryPositionMarginWithHttpInfo(String settle, String contract, String change) throws ApiException { @@ -1846,18 +1846,18 @@ public ApiResponse updateDeliveryPositionMarginWithHttpInfo(String set } /** - * Update position margin. (asynchronously) + * Update position margin (asynchronously) * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param change Margin change amount, positive number increases, negative number. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (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 * @http.response.details - +
    Status Code Description Response Headers
    200 Position information. -
    200 Position information -
    */ public okhttp3.Call updateDeliveryPositionMarginAsync(String settle, String contract, String change, final ApiCallback _callback) throws ApiException { @@ -1869,16 +1869,16 @@ public okhttp3.Call updateDeliveryPositionMarginAsync(String settle, String cont /** * Build call for updateDeliveryPositionLeverage - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param leverage New position leverage. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (required) + * @param leverage New position leverage (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 Position information. -
    200 Position information -
    */ public okhttp3.Call updateDeliveryPositionLeverageCall(String settle, String contract, String leverage, final ApiCallback _callback) throws ApiException { @@ -1938,17 +1938,17 @@ private okhttp3.Call updateDeliveryPositionLeverageValidateBeforeCall(String set } /** - * Update position leverage. + * Update position leverage * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param leverage New position leverage. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (required) + * @param leverage New position leverage (required) * @return 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 Position information. -
    200 Position information -
    */ public Position updateDeliveryPositionLeverage(String settle, String contract, String leverage) throws ApiException { @@ -1957,17 +1957,17 @@ public Position updateDeliveryPositionLeverage(String settle, String contract, S } /** - * Update position leverage. + * Update position leverage * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param leverage New position leverage. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (required) + * @param leverage New position leverage (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 - +
    Status Code Description Response Headers
    200 Position information. -
    200 Position information -
    */ public ApiResponse updateDeliveryPositionLeverageWithHttpInfo(String settle, String contract, String leverage) throws ApiException { @@ -1977,18 +1977,18 @@ public ApiResponse updateDeliveryPositionLeverageWithHttpInfo(String s } /** - * Update position leverage. (asynchronously) + * Update position leverage (asynchronously) * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param leverage New position leverage. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (required) + * @param leverage New position leverage (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 Position information. -
    200 Position information -
    */ public okhttp3.Call updateDeliveryPositionLeverageAsync(String settle, String contract, String leverage, final ApiCallback _callback) throws ApiException { @@ -2000,16 +2000,16 @@ public okhttp3.Call updateDeliveryPositionLeverageAsync(String settle, String co /** * Build call for updateDeliveryPositionRiskLimit - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param riskLimit New position risk limit. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (required) + * @param riskLimit New position risk limit (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 Position information. -
    200 Position information -
    */ public okhttp3.Call updateDeliveryPositionRiskLimitCall(String settle, String contract, String riskLimit, final ApiCallback _callback) throws ApiException { @@ -2069,17 +2069,17 @@ private okhttp3.Call updateDeliveryPositionRiskLimitValidateBeforeCall(String se } /** - * Update position risk limit. + * Update position risk limit * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param riskLimit New position risk limit. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (required) + * @param riskLimit New position risk limit (required) * @return 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 Position information. -
    200 Position information -
    */ public Position updateDeliveryPositionRiskLimit(String settle, String contract, String riskLimit) throws ApiException { @@ -2088,17 +2088,17 @@ public Position updateDeliveryPositionRiskLimit(String settle, String contract, } /** - * Update position risk limit. + * Update position risk limit * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param riskLimit New position risk limit. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (required) + * @param riskLimit New position risk limit (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 - +
    Status Code Description Response Headers
    200 Position information. -
    200 Position information -
    */ public ApiResponse updateDeliveryPositionRiskLimitWithHttpInfo(String settle, String contract, String riskLimit) throws ApiException { @@ -2108,18 +2108,18 @@ public ApiResponse updateDeliveryPositionRiskLimitWithHttpInfo(String } /** - * Update position risk limit. (asynchronously) + * Update position risk limit (asynchronously) * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param riskLimit New position risk limit. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (required) + * @param riskLimit New position risk limit (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 Position information. -
    200 Position information -
    */ public okhttp3.Call updateDeliveryPositionRiskLimitAsync(String settle, String contract, String riskLimit, final ApiCallback _callback) throws ApiException { @@ -2229,7 +2229,7 @@ private APIlistDeliveryOrdersRequest(String settle, String status) { /** * Set contract - * @param contract Futures contract. (optional) + * @param contract Futures contract (optional) * @return APIlistDeliveryOrdersRequest */ public APIlistDeliveryOrdersRequest contract(String contract) { @@ -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) { @@ -2249,7 +2249,7 @@ public APIlistDeliveryOrdersRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistDeliveryOrdersRequest */ public APIlistDeliveryOrdersRequest offset(Integer offset) { @@ -2259,7 +2259,7 @@ public APIlistDeliveryOrdersRequest offset(Integer offset) { /** * Set lastId - * @param lastId Specify the currency name to query in batches, and support up to 100 pass parameters at a time. (optional) + * @param lastId Specify the currency name to query in batches, and support up to 100 pass parameters at a time (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. - * @param settle Settle currency. (required) - * @param status Only list the orders with this status. (required) + * Query futures order list + * Zero-fill orders cannot be retrieved 10 minutes after order cancellation + * @param settle Settle currency (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) { @@ -2355,7 +2355,7 @@ public APIlistDeliveryOrdersRequest listDeliveryOrders(String settle, String sta /** * Build call for createDeliveryOrder - * @param settle Settle currency. (required) + * @param settle Settle currency (required) * @param futuresOrder (required) * @param _callback Callback for upload/download progress * @return Call to execute @@ -2363,7 +2363,7 @@ public APIlistDeliveryOrdersRequest listDeliveryOrders(String settle, String sta * @http.response.details - +
    Status Code Description Response Headers
    201 Order details. -
    201 Order details -
    */ public okhttp3.Call createDeliveryOrderCall(String settle, FuturesOrder futuresOrder, final ApiCallback _callback) throws ApiException { @@ -2413,16 +2413,16 @@ private okhttp3.Call createDeliveryOrderValidateBeforeCall(String settle, Future } /** - * Create a futures order. - * Zero-filled order cannot be retrieved 10 minutes after order cancellation. - * @param settle Settle currency. (required) + * Place futures order + * Zero-fill orders cannot be retrieved 10 minutes after order cancellation + * @param settle Settle currency (required) * @param futuresOrder (required) * @return 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
    201 Order details. -
    201 Order details -
    */ public FuturesOrder createDeliveryOrder(String settle, FuturesOrder futuresOrder) throws ApiException { @@ -2431,16 +2431,16 @@ public FuturesOrder createDeliveryOrder(String settle, FuturesOrder futuresOrder } /** - * Create a futures order. - * Zero-filled order cannot be retrieved 10 minutes after order cancellation. - * @param settle Settle currency. (required) + * 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> * @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 details. -
    201 Order details -
    */ public ApiResponse createDeliveryOrderWithHttpInfo(String settle, FuturesOrder futuresOrder) throws ApiException { @@ -2450,9 +2450,9 @@ public ApiResponse createDeliveryOrderWithHttpInfo(String settle, } /** - * Create a futures order. (asynchronously) - * Zero-filled order cannot be retrieved 10 minutes after order cancellation. - * @param settle Settle currency. (required) + * 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 * @return The request call @@ -2460,7 +2460,7 @@ public ApiResponse createDeliveryOrderWithHttpInfo(String settle, * @http.response.details - +
    Status Code Description Response Headers
    201 Order details. -
    201 Order details -
    */ public okhttp3.Call createDeliveryOrderAsync(String settle, FuturesOrder futuresOrder, final ApiCallback _callback) throws ApiException { @@ -2472,16 +2472,16 @@ 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 settle Settle currency (required) + * @param contract Futures contract (required) + * @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. - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param side All bids or asks. Both included if not specified. (optional) + * 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 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. - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param side All bids or asks. Both included if not specified. (optional) + * 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 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. - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param side All bids or asks. Both included if not specified. (optional) + * 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 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 { @@ -2601,15 +2601,15 @@ 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 settle Settle currency (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 Order details. -
    200 Order details -
    */ public okhttp3.Call getDeliveryOrderCall(String settle, String orderId, final ApiCallback _callback) throws ApiException { @@ -2660,16 +2660,16 @@ private okhttp3.Call getDeliveryOrderValidateBeforeCall(String settle, String or } /** - * Get a single order. - * Zero-filled order 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) + * Query single order details + * Zero-fill orders cannot be retrieved 10 minutes after order cancellation + * @param settle Settle currency (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 - +
    Status Code Description Response Headers
    200 Order details. -
    200 Order details -
    */ public FuturesOrder getDeliveryOrder(String settle, String orderId) throws ApiException { @@ -2678,16 +2678,16 @@ public FuturesOrder getDeliveryOrder(String settle, String orderId) throws ApiEx } /** - * Get a single order. - * Zero-filled order 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) + * Query single order details + * Zero-fill orders cannot be retrieved 10 minutes after order cancellation + * @param settle Settle currency (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 - +
    Status Code Description Response Headers
    200 Order details. -
    200 Order details -
    */ public ApiResponse getDeliveryOrderWithHttpInfo(String settle, String orderId) throws ApiException { @@ -2697,17 +2697,17 @@ public ApiResponse getDeliveryOrderWithHttpInfo(String settle, Str } /** - * Get a single order. (asynchronously) - * Zero-filled order 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) + * Query single order details (asynchronously) + * Zero-fill orders cannot be retrieved 10 minutes after order cancellation + * @param settle Settle currency (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 Order details. -
    200 Order details -
    */ public okhttp3.Call getDeliveryOrderAsync(String settle, String orderId, final ApiCallback _callback) throws ApiException { @@ -2719,15 +2719,15 @@ 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 settle Settle currency (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 Order details. -
    200 Order details -
    */ public okhttp3.Call cancelDeliveryOrderCall(String settle, String orderId, final ApiCallback _callback) throws ApiException { @@ -2778,16 +2778,16 @@ 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 settle Settle currency (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 - +
    Status Code Description Response Headers
    200 Order details. -
    200 Order details -
    */ public FuturesOrder cancelDeliveryOrder(String settle, String orderId) throws ApiException { @@ -2796,16 +2796,16 @@ 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 settle Settle currency (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 - +
    Status Code Description Response Headers
    200 Order details. -
    200 Order details -
    */ public ApiResponse cancelDeliveryOrderWithHttpInfo(String settle, String orderId) throws ApiException { @@ -2815,17 +2815,17 @@ 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 settle Settle currency (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 Order details. -
    200 Order details -
    */ public okhttp3.Call cancelDeliveryOrderAsync(String settle, String orderId, final ApiCallback _callback) throws ApiException { @@ -2929,7 +2929,7 @@ private APIgetMyDeliveryTradesRequest(String settle) { /** * Set contract - * @param contract Futures contract. (optional) + * @param contract Futures contract (optional) * @return APIgetMyDeliveryTradesRequest */ public APIgetMyDeliveryTradesRequest contract(String contract) { @@ -2939,7 +2939,7 @@ public APIgetMyDeliveryTradesRequest contract(String contract) { /** * Set order - * @param order Futures order ID, return related data only if specified. (optional) + * @param order Futures order ID, return related data only if specified (optional) * @return APIgetMyDeliveryTradesRequest */ public APIgetMyDeliveryTradesRequest order(Long order) { @@ -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) { @@ -2959,7 +2959,7 @@ public APIgetMyDeliveryTradesRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIgetMyDeliveryTradesRequest */ public APIgetMyDeliveryTradesRequest offset(Integer offset) { @@ -2969,7 +2969,7 @@ public APIgetMyDeliveryTradesRequest offset(Integer offset) { /** * Set lastId - * @param lastId Specify the currency name to query in batches, and support up to 100 pass parameters at a time. (optional) + * @param lastId Specify the currency name to query in batches, and support up to 100 pass parameters at a time (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) + * @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) { @@ -3136,7 +3136,7 @@ private APIlistDeliveryPositionCloseRequest(String settle) { /** * Set contract - * @param contract Futures contract. (optional) + * @param contract Futures contract (optional) * @return APIlistDeliveryPositionCloseRequest */ public APIlistDeliveryPositionCloseRequest contract(String contract) { @@ -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) + * @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) { @@ -3308,7 +3308,7 @@ private APIlistDeliveryLiquidatesRequest(String settle) { /** * Set contract - * @param contract Futures contract. (optional) + * @param contract Futures contract (optional) * @return APIlistDeliveryLiquidatesRequest */ public APIlistDeliveryLiquidatesRequest contract(String contract) { @@ -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) + * @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) { @@ -3490,7 +3490,7 @@ private APIlistDeliverySettlementsRequest(String settle) { /** * Set contract - * @param contract Futures contract. (optional) + * @param contract Futures contract (optional) * @return APIlistDeliverySettlementsRequest */ public APIlistDeliverySettlementsRequest contract(String contract) { @@ -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) + * @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) { @@ -3672,7 +3672,7 @@ private APIlistDeliveryRiskLimitTiersRequest(String settle) { /** * Set contract - * @param contract Futures contract. (optional) + * @param contract Futures contract (optional) * @return APIlistDeliveryRiskLimitTiersRequest */ public APIlistDeliveryRiskLimitTiersRequest contract(String contract) { @@ -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) { @@ -3692,7 +3692,7 @@ public APIlistDeliveryRiskLimitTiersRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistDeliveryRiskLimitTiersRequest */ public APIlistDeliveryRiskLimitTiersRequest offset(Integer offset) { @@ -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. + * Query risk limit tiers * When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets.'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect empty. - * @param settle Settle currency. (required) + * @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) { @@ -3865,7 +3865,7 @@ private APIlistPriceTriggeredDeliveryOrdersRequest(String settle, String status) /** * Set contract - * @param contract Futures contract, return related data only if specified. (optional) + * @param contract Futures contract, return related data only if specified (optional) * @return APIlistPriceTriggeredDeliveryOrdersRequest */ public APIlistPriceTriggeredDeliveryOrdersRequest contract(String contract) { @@ -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) { @@ -3885,7 +3885,7 @@ public APIlistPriceTriggeredDeliveryOrdersRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistPriceTriggeredDeliveryOrdersRequest */ public APIlistPriceTriggeredDeliveryOrdersRequest offset(Integer offset) { @@ -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) { @@ -3971,7 +3971,7 @@ public APIlistPriceTriggeredDeliveryOrdersRequest listPriceTriggeredDeliveryOrde /** * Build call for createPriceTriggeredDeliveryOrder - * @param settle Settle currency. (required) + * @param settle Settle currency (required) * @param futuresPriceTriggeredOrder (required) * @param _callback Callback for upload/download progress * @return Call to execute @@ -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,16 +4029,16 @@ private okhttp3.Call createPriceTriggeredDeliveryOrderValidateBeforeCall(String } /** - * Create a price-triggered order. + * Create price-triggered order * - * @param settle Settle currency. (required) + * @param settle Settle currency (required) * @param futuresPriceTriggeredOrder (required) * @return TriggerOrderResponse * @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 TriggerOrderResponse createPriceTriggeredDeliveryOrder(String settle, FuturesPriceTriggeredOrder futuresPriceTriggeredOrder) throws ApiException { @@ -4047,16 +4047,16 @@ public TriggerOrderResponse createPriceTriggeredDeliveryOrder(String settle, Fut } /** - * Create a price-triggered order. + * Create price-triggered order * - * @param settle Settle currency. (required) + * @param settle Settle currency (required) * @param futuresPriceTriggeredOrder (required) * @return ApiResponse<TriggerOrderResponse> * @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 createPriceTriggeredDeliveryOrderWithHttpInfo(String settle, FuturesPriceTriggeredOrder futuresPriceTriggeredOrder) throws ApiException { @@ -4066,9 +4066,9 @@ public ApiResponse createPriceTriggeredDeliveryOrderWithHt } /** - * Create a price-triggered order. (asynchronously) + * Create price-triggered order (asynchronously) * - * @param settle Settle currency. (required) + * @param settle Settle currency (required) * @param futuresPriceTriggeredOrder (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -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 { @@ -4088,15 +4088,15 @@ public okhttp3.Call createPriceTriggeredDeliveryOrderAsync(String settle, Future /** * Build call for cancelPriceTriggeredDeliveryOrderList - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (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 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,16 +4150,16 @@ private okhttp3.Call cancelPriceTriggeredDeliveryOrderListValidateBeforeCall(Str } /** - * Cancel All Price-triggered Orders. + * Cancel all auto orders * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (required) * @return List<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 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,16 +4168,16 @@ public List cancelPriceTriggeredDeliveryOrderList(St } /** - * Cancel All Price-triggered Orders. + * Cancel all auto orders * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (required) * @return ApiResponse<List<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 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,17 +4187,17 @@ public ApiResponse> cancelPriceTriggeredDeliver } /** - * Cancel All Price-triggered Orders. (asynchronously) + * Cancel all auto orders (asynchronously) * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (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 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 { @@ -4209,15 +4209,15 @@ 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 settle Settle currency (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 settle Settle currency (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 settle Settle currency (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 settle Settle currency (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 { @@ -4327,15 +4327,15 @@ 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 settle Settle currency (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 settle Settle currency (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 settle Settle currency (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 settle Settle currency (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 d71cf5f..4b5dbad 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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 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 { @@ -110,14 +110,14 @@ private okhttp3.Call swapETH2ValidateBeforeCall(Eth2Swap eth2Swap, final ApiCall } /** - * ETH2 swap. + * ETH2 swap * * @param eth2Swap (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 swap success. -
    200 Swap successful -
    */ public void swapETH2(Eth2Swap eth2Swap) throws ApiException { @@ -125,7 +125,7 @@ public void swapETH2(Eth2Swap eth2Swap) throws ApiException { } /** - * ETH2 swap. + * ETH2 swap * * @param eth2Swap (required) * @return ApiResponse<Void> @@ -133,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 { @@ -142,7 +142,7 @@ public ApiResponse swapETH2WithHttpInfo(Eth2Swap eth2Swap) throws ApiExcep } /** - * ETH2 swap. (asynchronously) + * ETH2 swap (asynchronously) * * @param eth2Swap (required) * @param _callback The callback to be executed when the API call finishes @@ -151,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 { @@ -168,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 { @@ -207,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 { @@ -223,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 { @@ -240,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 { @@ -319,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) { @@ -335,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 { @@ -349,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 { @@ -364,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 { @@ -379,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 { @@ -388,13 +388,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * Dual Investment product list. + * Dual Investment product list * * @return APIlistDualInvestmentPlansRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Successful. -
    200 Successfully retrieved -
    */ public APIlistDualInvestmentPlansRequest listDualInvestmentPlans() { @@ -477,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) { @@ -487,7 +487,7 @@ public APIlistDualOrdersRequest from(Long from) { /** * Set to - * @param to End settlement time. (optional) + * @param to End settlement time (optional) * @return APIlistDualOrdersRequest */ public APIlistDualOrdersRequest to(Long to) { @@ -497,7 +497,7 @@ public APIlistDualOrdersRequest to(Long to) { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistDualOrdersRequest */ public APIlistDualOrdersRequest page(Integer page) { @@ -507,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) { @@ -523,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 { @@ -537,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 { @@ -552,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 { @@ -567,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 { @@ -576,13 +576,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callbac } /** - * Dual Investment order list. + * Dual Investment order list * * @return APIlistDualOrdersRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Successful. -
    200 Successfully retrieved -
    */ public APIlistDualOrdersRequest listDualOrders() { @@ -598,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 { @@ -642,14 +642,14 @@ private okhttp3.Call placeDualOrderValidateBeforeCall(PlaceDualInvestmentOrder p } /** - * Place Dual Investment order. + * Place Dual Investment order * * @param placeDualInvestmentOrder (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 Success. -
    200 Order placed successfully -
    */ public void placeDualOrder(PlaceDualInvestmentOrder placeDualInvestmentOrder) throws ApiException { @@ -657,7 +657,7 @@ public void placeDualOrder(PlaceDualInvestmentOrder placeDualInvestmentOrder) th } /** - * Place Dual Investment order. + * Place Dual Investment order * * @param placeDualInvestmentOrder (required) * @return ApiResponse<Void> @@ -665,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 { @@ -674,7 +674,7 @@ public ApiResponse placeDualOrderWithHttpInfo(PlaceDualInvestmentOrder pla } /** - * Place Dual Investment order. (asynchronously) + * Place Dual Investment order (asynchronously) * * @param placeDualInvestmentOrder (required) * @param _callback The callback to be executed when the API call finishes @@ -683,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 { @@ -784,7 +784,7 @@ public APIlistStructuredProductsRequest type(String type) { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistStructuredProductsRequest */ public APIlistStructuredProductsRequest page(Integer page) { @@ -794,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) { @@ -810,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 { @@ -824,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 { @@ -839,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 { @@ -854,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 { @@ -863,14 +863,14 @@ public okhttp3.Call executeAsync(final ApiCallback Status Code Description Response Headers - 200 Successful. - + 200 Successfully retrieved - */ public APIlistStructuredProductsRequest listStructuredProducts(String status) { @@ -973,7 +973,7 @@ public APIlistStructuredOrdersRequest to(Long to) { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistStructuredOrdersRequest */ public APIlistStructuredOrdersRequest page(Integer page) { @@ -983,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) { @@ -999,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 { @@ -1013,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 { @@ -1028,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 { @@ -1043,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 { @@ -1052,13 +1052,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _c } /** - * Structured Product Order List. + * Structured Product Order List * * @return APIlistStructuredOrdersRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Successful. -
    200 Successfully retrieved -
    */ public APIlistStructuredOrdersRequest listStructuredOrders() { @@ -1074,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 { @@ -1118,14 +1118,14 @@ private okhttp3.Call placeStructuredOrderValidateBeforeCall(StructuredBuy struct } /** - * Place Structured Product Order. + * Place Structured Product Order * * @param structuredBuy (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 Success. -
    200 Order placed successfully -
    */ public void placeStructuredOrder(StructuredBuy structuredBuy) throws ApiException { @@ -1133,7 +1133,7 @@ public void placeStructuredOrder(StructuredBuy structuredBuy) throws ApiExceptio } /** - * Place Structured Product Order. + * Place Structured Product Order * * @param structuredBuy (required) * @return ApiResponse<Void> @@ -1141,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 { @@ -1150,7 +1150,7 @@ public ApiResponse placeStructuredOrderWithHttpInfo(StructuredBuy structur } /** - * Place Structured Product Order. (asynchronously) + * Place Structured Product Order (asynchronously) * * @param structuredBuy (required) * @param _callback The callback to be executed when the API call finishes @@ -1159,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 { @@ -1177,7 +1177,7 @@ public okhttp3.Call placeStructuredOrderAsync(StructuredBuy structuredBuy, final * @http.response.details - +
    Status Code Description Response Headers
    200 Successful. -
    200 Successfully retrieved -
    */ public okhttp3.Call findCoinCall(FindCoin findCoin, final ApiCallback _callback) throws ApiException { @@ -1221,7 +1221,7 @@ private okhttp3.Call findCoinValidateBeforeCall(FindCoin findCoin, final ApiCall } /** - * Staking Coins. + * Staking coins * * @param findCoin (required) * @return List<String> @@ -1229,7 +1229,7 @@ private okhttp3.Call findCoinValidateBeforeCall(FindCoin findCoin, final ApiCall * @http.response.details - +
    Status Code Description Response Headers
    200 Successful. -
    200 Successfully retrieved -
    */ public List findCoin(FindCoin findCoin) throws ApiException { @@ -1238,7 +1238,7 @@ public List findCoin(FindCoin findCoin) throws ApiException { } /** - * Staking Coins. + * Staking coins * * @param findCoin (required) * @return ApiResponse<List<String>> @@ -1246,7 +1246,7 @@ public List findCoin(FindCoin findCoin) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successful. -
    200 Successfully retrieved -
    */ public ApiResponse> findCoinWithHttpInfo(FindCoin findCoin) throws ApiException { @@ -1256,7 +1256,7 @@ public ApiResponse> findCoinWithHttpInfo(FindCoin findCoin) throws } /** - * Staking Coins. (asynchronously) + * Staking coins (asynchronously) * * @param findCoin (required) * @param _callback The callback to be executed when the API call finishes @@ -1265,7 +1265,7 @@ public ApiResponse> findCoinWithHttpInfo(FindCoin findCoin) throws * @http.response.details - +
    Status Code Description Response Headers
    200 Successful. -
    200 Successfully retrieved -
    */ public okhttp3.Call findCoinAsync(FindCoin findCoin, final ApiCallback> _callback) throws ApiException { @@ -1284,7 +1284,7 @@ public okhttp3.Call findCoinAsync(FindCoin findCoin, final ApiCallback Status Code Description Response Headers - 200 swap success. - + 200 Swap successful - */ public okhttp3.Call swapStakingCoinCall(SwapCoin swapCoin, final ApiCallback _callback) throws ApiException { @@ -1328,7 +1328,7 @@ private okhttp3.Call swapStakingCoinValidateBeforeCall(SwapCoin swapCoin, final } /** - * On-chain Token Swap for Earned Coins. + * On-chain token swap for earned coins * * @param swapCoin (required) * @return SwapCoinStruct @@ -1336,7 +1336,7 @@ private okhttp3.Call swapStakingCoinValidateBeforeCall(SwapCoin swapCoin, final * @http.response.details - +
    Status Code Description Response Headers
    200 swap success. -
    200 Swap successful -
    */ public SwapCoinStruct swapStakingCoin(SwapCoin swapCoin) throws ApiException { @@ -1345,7 +1345,7 @@ public SwapCoinStruct swapStakingCoin(SwapCoin swapCoin) throws ApiException { } /** - * On-chain Token Swap for Earned Coins. + * On-chain token swap for earned coins * * @param swapCoin (required) * @return ApiResponse<SwapCoinStruct> @@ -1353,7 +1353,7 @@ public SwapCoinStruct swapStakingCoin(SwapCoin swapCoin) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 swap success. -
    200 Swap successful -
    */ public ApiResponse swapStakingCoinWithHttpInfo(SwapCoin swapCoin) throws ApiException { @@ -1363,7 +1363,7 @@ public ApiResponse swapStakingCoinWithHttpInfo(SwapCoin swapCoin } /** - * On-chain Token Swap for Earned Coins. (asynchronously) + * On-chain token swap for earned coins (asynchronously) * * @param swapCoin (required) * @param _callback The callback to be executed when the API call finishes @@ -1372,7 +1372,7 @@ public ApiResponse swapStakingCoinWithHttpInfo(SwapCoin swapCoin * @http.response.details - +
    Status Code Description Response Headers
    200 swap success. -
    200 Swap successful -
    */ public okhttp3.Call swapStakingCoinAsync(SwapCoin swapCoin, final ApiCallback _callback) throws ApiException { diff --git a/src/main/java/io/gate/gateapi/api/EarnUniApi.java b/src/main/java/io/gate/gateapi/api/EarnUniApi.java index 0c0d06f..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -64,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 { @@ -103,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 { @@ -119,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 { @@ -136,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 @@ -144,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 { @@ -156,14 +156,14 @@ public okhttp3.Call listUniCurrenciesAsync(final ApiCallback> /** * Build call for getUniCurrency - * @param currency Currency. (required) + * @param currency 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. -
    200 Query successful -
    */ public okhttp3.Call getUniCurrencyCall(String currency, final ApiCallback _callback) throws ApiException { @@ -208,15 +208,15 @@ private okhttp3.Call getUniCurrencyValidateBeforeCall(String currency, final Api } /** - * Get currency detail for lending. + * Query single lending currency details * - * @param currency Currency. (required) + * @param currency Currency (required) * @return 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 UniCurrency getUniCurrency(String currency) throws ApiException { @@ -225,15 +225,15 @@ public UniCurrency getUniCurrency(String currency) throws ApiException { } /** - * Get currency detail for lending. + * Query single lending currency details * - * @param currency Currency. (required) + * @param currency Currency (required) * @return ApiResponse<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 getUniCurrencyWithHttpInfo(String currency) throws ApiException { @@ -243,16 +243,16 @@ public ApiResponse getUniCurrencyWithHttpInfo(String currency) thro } /** - * Get currency detail for lending. (asynchronously) + * Query single lending currency details (asynchronously) * - * @param currency Currency. (required) + * @param currency 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. -
    200 Query successful -
    */ public okhttp3.Call getUniCurrencyAsync(String currency, final ApiCallback _callback) throws ApiException { @@ -333,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) { @@ -343,7 +343,7 @@ public APIlistUserUniLendsRequest currency(String currency) { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistUserUniLendsRequest */ public APIlistUserUniLendsRequest page(Integer page) { @@ -353,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) { @@ -369,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 { @@ -383,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 { @@ -398,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 { @@ -413,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 { @@ -422,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() { @@ -444,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 { @@ -488,14 +488,14 @@ private okhttp3.Call createUniLendValidateBeforeCall(CreateUniLend createUniLend } /** - * Lend or redeem. + * Create lending or redemption * Lending: When lending, a minimum lending rate must be set. After successful lending is determined on an hourly basis, earnings will be calculated based on the determined rate. Earnings for each hour will be settled at the top of the hour. If lending fails due to an excessively high interest rate, no interest will be earned for that hour. If funds are redeemed before the hourly for that hour. Priority: Under the same interest rate, wealth management products created or modified earlier will be prioritized for lending. Redemption: For funds that failed to be lent, redemption will be credited immediately. For funds successfully lent, they are entitled to the earnings for that hour, and redemption will be credited in the next hourly interval. Note: The two minutes before and after the hourly mark are the settlement period, during which lending and redemption are prohibited. * @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 { @@ -503,7 +503,7 @@ public void createUniLend(CreateUniLend createUniLend) throws ApiException { } /** - * Lend or redeem. + * Create lending or redemption * Lending: When lending, a minimum lending rate must be set. After successful lending is determined on an hourly basis, earnings will be calculated based on the determined rate. Earnings for each hour will be settled at the top of the hour. If lending fails due to an excessively high interest rate, no interest will be earned for that hour. If funds are redeemed before the hourly for that hour. Priority: Under the same interest rate, wealth management products created or modified earlier will be prioritized for lending. Redemption: For funds that failed to be lent, redemption will be credited immediately. For funds successfully lent, they are entitled to the earnings for that hour, and redemption will be credited in the next hourly interval. Note: The two minutes before and after the hourly mark are the settlement period, during which lending and redemption are prohibited. * @param createUniLend (required) * @return ApiResponse<Void> @@ -511,7 +511,7 @@ public void createUniLend(CreateUniLend createUniLend) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    204 Operated successfully. -
    204 Operation successful -
    */ public ApiResponse createUniLendWithHttpInfo(CreateUniLend createUniLend) throws ApiException { @@ -520,7 +520,7 @@ public ApiResponse createUniLendWithHttpInfo(CreateUniLend createUniLend) } /** - * Lend or redeem. (asynchronously) + * 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 @@ -529,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 { @@ -547,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 { @@ -591,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 { @@ -606,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 { @@ -623,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 @@ -632,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 { @@ -727,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) { @@ -737,7 +737,7 @@ public APIlistUniLendRecordsRequest currency(String currency) { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistUniLendRecordsRequest */ public APIlistUniLendRecordsRequest page(Integer page) { @@ -747,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) { @@ -777,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) { @@ -793,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 { @@ -807,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 { @@ -822,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 { @@ -837,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 { @@ -846,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() { @@ -861,14 +861,14 @@ public APIlistUniLendRecordsRequest listUniLendRecords() { /** * Build call for getUniInterest - * @param currency Currency. (required) + * @param currency 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. -
    200 Query successful -
    */ public okhttp3.Call getUniInterestCall(String currency, final ApiCallback _callback) throws ApiException { @@ -913,15 +913,15 @@ 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) + * @param currency Currency (required) * @return UniLendInterest * @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 UniLendInterest getUniInterest(String currency) throws ApiException { @@ -930,15 +930,15 @@ 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) + * @param currency Currency (required) * @return ApiResponse<UniLendInterest> * @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 getUniInterestWithHttpInfo(String currency) throws ApiException { @@ -948,16 +948,16 @@ 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 currency 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. -
    200 Query successful -
    */ public okhttp3.Call getUniInterestAsync(String currency, final ApiCallback _callback) throws ApiException { @@ -1048,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) { @@ -1058,7 +1058,7 @@ public APIlistUniInterestRecordsRequest currency(String currency) { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistUniInterestRecordsRequest */ public APIlistUniInterestRecordsRequest page(Integer page) { @@ -1068,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) { @@ -1104,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 { @@ -1118,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 { @@ -1133,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 { @@ -1148,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 { @@ -1157,13 +1157,13 @@ 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() { @@ -1172,14 +1172,14 @@ public APIlistUniInterestRecordsRequest listUniInterestRecords() { /** * Build call for getUniInterestStatus - * @param currency Currency. (required) + * @param currency 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. -
    200 Query successful -
    */ public okhttp3.Call getUniInterestStatusCall(String currency, final ApiCallback _callback) throws ApiException { @@ -1224,15 +1224,15 @@ private okhttp3.Call getUniInterestStatusValidateBeforeCall(String currency, fin } /** - * query currency interest compounding status. + * Query currency interest compounding status * - * @param currency Currency. (required) + * @param currency Currency (required) * @return UniCurrencyInterest * @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 UniCurrencyInterest getUniInterestStatus(String currency) throws ApiException { @@ -1241,15 +1241,15 @@ public UniCurrencyInterest getUniInterestStatus(String currency) throws ApiExcep } /** - * query currency interest compounding status. + * Query currency interest compounding status * - * @param currency Currency. (required) + * @param currency Currency (required) * @return ApiResponse<UniCurrencyInterest> * @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 getUniInterestStatusWithHttpInfo(String currency) throws ApiException { @@ -1259,16 +1259,16 @@ public ApiResponse getUniInterestStatusWithHttpInfo(String } /** - * query currency interest compounding status. (asynchronously) + * Query currency interest compounding status (asynchronously) * - * @param currency Currency. (required) + * @param currency 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. -
    200 Query successful -
    */ public okhttp3.Call getUniInterestStatusAsync(String currency, final ApiCallback _callback) throws ApiException { @@ -1280,9 +1280,9 @@ 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 asset Currency name. (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 * @throws ApiException If fail to serialize the request body object @@ -1355,11 +1355,11 @@ private okhttp3.Call listUniChartValidateBeforeCall(Long from, Long to, String a } /** - * UniLoan currency annualized trend chart. + * UniLoan currency annualized trend chart * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <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, unit s, maximum span of 30 days. (required) - * @param to End timestamp, unit s, maximum span of 30 days. (required) - * @param asset Currency name. (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) * @return List<InlineResponse200> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1374,11 +1374,11 @@ public List listUniChart(Long from, Long to, String asset) th } /** - * UniLoan currency annualized trend chart. + * UniLoan currency annualized trend chart * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <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, unit s, maximum span of 30 days. (required) - * @param to End timestamp, unit s, maximum span of 30 days. (required) - * @param asset Currency name. (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) * @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 @@ -1394,11 +1394,11 @@ public ApiResponse> listUniChartWithHttpInfo(Long from, } /** - * UniLoan currency annualized trend chart. (asynchronously) + * UniLoan currency annualized trend chart (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 from Start timestamp, unit s, maximum span of 30 days. (required) - * @param to End timestamp, unit s, maximum span of 30 days. (required) - * @param asset Currency name. (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 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 @@ -1462,7 +1462,7 @@ private okhttp3.Call listUniRateValidateBeforeCall(final ApiCallback _callback) } /** - * Currency estimate annualized interest rate. + * Currency estimated annualized interest rate * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <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 @@ -1478,7 +1478,7 @@ public List listUniRate() throws ApiException { } /** - * Currency estimate annualized interest rate. + * Currency estimated annualized interest rate * Project-Id-Version: GateApiTools 1.0.0 Report-Msgid-Bugs-To: EMAIL@ADDRESS POT-Creation-Date: 2025-07-17 21:35+0800 PO-Revision-Date: 2019-01-02 17:30+0800 Last-Translator: FULL NAME <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 @@ -1495,7 +1495,7 @@ public ApiResponse> listUniRateWithHttpInfo() throws Ap } /** - * Currency estimate annualized interest rate. (asynchronously) + * 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 diff --git a/src/main/java/io/gate/gateapi/api/FlashSwapApi.java b/src/main/java/io/gate/gateapi/api/FlashSwapApi.java index 5032327..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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) { @@ -132,7 +132,7 @@ public APIlistFlashSwapCurrencyPairRequest currency(String currency) { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistFlashSwapCurrencyPairRequest */ public APIlistFlashSwapCurrencyPairRequest page(Integer page) { @@ -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 { @@ -211,13 +211,13 @@ public okhttp3.Call executeAsync(final ApiCallback> } /** - * List All Supported Currency Pairs In Flash Swap. + * List All Supported Currency Pairs In Flash Swap * `BTC_GT` represents selling BTC and buying GT. The limits for each currency may vary across different currency pairs. It is not necessary that two currencies that can be swapped instantaneously can be exchanged with each other. For example, it is possible to sell BTC and buy GT, but it does not necessarily mean that GT can be sold to buy BTC. * @return APIlistFlashSwapCurrencyPairRequest * @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) - 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) { @@ -360,7 +360,7 @@ public APIlistFlashSwapOrdersRequest limit(Integer limit) { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistFlashSwapOrdersRequest */ public APIlistFlashSwapOrdersRequest page(Integer page) { @@ -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 { @@ -495,7 +495,7 @@ private okhttp3.Call createFlashSwapOrderValidateBeforeCall(FlashSwapOrderReques } /** - * Create a flash swap order. + * Create a flash swap order * Initiate a flash swap preview in advance because order creation requires a preview result * @param flashSwapOrderRequest (required) * @return FlashSwapOrder @@ -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 { @@ -512,7 +512,7 @@ public FlashSwapOrder createFlashSwapOrder(FlashSwapOrderRequest flashSwapOrderR } /** - * Create a flash swap order. + * Create a flash swap order * Initiate a flash swap preview in advance because order creation requires a preview result * @param flashSwapOrderRequest (required) * @return ApiResponse<FlashSwapOrder> @@ -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 { @@ -530,7 +530,7 @@ public ApiResponse createFlashSwapOrderWithHttpInfo(FlashSwapOrd } /** - * Create a flash swap order. (asynchronously) + * Create a flash swap order (asynchronously) * Initiate a flash swap preview in advance because order creation requires a preview result * @param flashSwapOrderRequest (required) * @param _callback The callback to be executed when the API call finishes @@ -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 { @@ -551,14 +551,14 @@ public okhttp3.Call createFlashSwapOrderAsync(FlashSwapOrderRequest flashSwapOrd /** * Build call for getFlashSwapOrder - * @param orderId Flash swap order ID. (required) + * @param orderId Flash swap order 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. -
    200 Query successful -
    */ public okhttp3.Call getFlashSwapOrderCall(Integer orderId, final ApiCallback _callback) throws ApiException { @@ -603,15 +603,15 @@ 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) + * @param orderId Flash swap order ID (required) * @return FlashSwapOrder * @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 FlashSwapOrder getFlashSwapOrder(Integer orderId) throws ApiException { @@ -620,15 +620,15 @@ 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) + * @param orderId Flash swap order ID (required) * @return ApiResponse<FlashSwapOrder> * @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 getFlashSwapOrderWithHttpInfo(Integer orderId) throws ApiException { @@ -638,16 +638,16 @@ 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 orderId Flash swap order 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. -
    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 d154c7c..1f9bd01 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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -153,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) { @@ -163,7 +163,7 @@ public APIlistFuturesContractsRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistFuturesContractsRequest */ public APIlistFuturesContractsRequest offset(Integer offset) { @@ -179,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 { @@ -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 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 { @@ -232,14 +232,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) th } /** - * List all futures contracts. + * Query all futures contracts * - * @param settle Settle currency. (required) + * @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) { @@ -248,15 +248,15 @@ public APIlistFuturesContractsRequest listFuturesContracts(String settle) { /** * Build call for getFuturesContract - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (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 Contract information. -
    200 Contract information -
    */ public okhttp3.Call getFuturesContractCall(String settle, String contract, final ApiCallback _callback) throws ApiException { @@ -307,16 +307,16 @@ 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) + * @param settle Settle currency (required) + * @param contract Futures contract (required) * @return Contract * @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 Contract information. -
    200 Contract information -
    */ public Contract getFuturesContract(String settle, String contract) throws ApiException { @@ -325,16 +325,16 @@ 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) + * @param settle Settle currency (required) + * @param contract Futures contract (required) * @return ApiResponse<Contract> * @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 Contract information. -
    200 Contract information -
    */ public ApiResponse getFuturesContractWithHttpInfo(String settle, String contract) throws ApiException { @@ -344,17 +344,17 @@ 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) + * @param settle Settle currency (required) + * @param contract Futures contract (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 Contract information. -
    200 Contract information -
    */ public okhttp3.Call getFuturesContractAsync(String settle, String contract, final ApiCallback _callback) throws ApiException { @@ -454,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) { @@ -464,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) { @@ -474,7 +474,7 @@ public APIlistFuturesOrderBookRequest limit(Integer limit) { /** * Set withId - * @param withId Whether to return depth update ID. This ID increments by 1 each time. (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) { @@ -490,7 +490,7 @@ public APIlistFuturesOrderBookRequest withId(Boolean withId) { * @http.response.details - +
    Status Code Description Response Headers
    200 Depth query successful. -
    200 Depth query successful -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -504,7 +504,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Depth query successful. -
    200 Depth query successful -
    */ public FuturesOrderBook execute() throws ApiException { @@ -519,7 +519,7 @@ public FuturesOrderBook execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Depth query successful. -
    200 Depth query successful -
    */ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -534,7 +534,7 @@ public ApiResponse executeWithHttpInfo() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Depth query successful. -
    200 Depth query successful -
    */ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -543,15 +543,15 @@ public okhttp3.Call executeAsync(final ApiCallback _callback) } /** - * Futures order book. - * Bids will be sorted by price from high to low, while asks sorted reversely. - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) + * 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) * @return APIlistFuturesOrderBookRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Depth query successful. -
    200 Depth query successful -
    */ public APIlistFuturesOrderBookRequest listFuturesOrderBook(String settle, String contract) { @@ -658,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) { @@ -668,7 +668,7 @@ public APIlistFuturesTradesRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistFuturesTradesRequest */ public APIlistFuturesTradesRequest offset(Integer offset) { @@ -714,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 { @@ -728,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 { @@ -743,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 { @@ -758,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 { @@ -767,15 +767,15 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * Futures trading history. + * Futures market transaction records * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (required) * @return APIlistFuturesTradesRequest * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved. -
    200 List retrieved successfully -
    */ public APIlistFuturesTradesRequest listFuturesTrades(String settle, String contract) { @@ -887,7 +887,7 @@ public APIlistFuturesCandlesticksRequest from(Long from) { /** * Set to - * @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 specified (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) { @@ -897,7 +897,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) { @@ -907,7 +907,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. 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) { @@ -923,7 +923,7 @@ 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 { @@ -937,7 +937,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 { @@ -952,7 +952,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 { @@ -967,7 +967,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 { @@ -976,15 +976,15 @@ public okhttp3.Call executeAsync(final ApiCallback> _ca } /** - * 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) + * @param settle Settle currency (required) + * @param contract Futures contract (required) * @return APIlistFuturesCandlesticksRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved. -
    200 Query successful -
    */ public APIlistFuturesCandlesticksRequest listFuturesCandlesticks(String settle, String contract) { @@ -1096,7 +1096,7 @@ public APIlistFuturesPremiumIndexRequest from(Long from) { /** * Set to - * @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 specified (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) { @@ -1106,7 +1106,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) { @@ -1116,7 +1116,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) { @@ -1132,7 +1132,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 { @@ -1146,7 +1146,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 { @@ -1161,7 +1161,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 { @@ -1176,7 +1176,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 { @@ -1185,15 +1185,15 @@ 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) + * @param settle Settle currency (required) + * @param contract Futures contract (required) * @return APIlistFuturesPremiumIndexRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved. -
    200 Query successful -
    */ public APIlistFuturesPremiumIndexRequest listFuturesPremiumIndex(String settle, String contract) { @@ -1269,7 +1269,7 @@ private APIlistFuturesTickersRequest(String settle) { /** * Set contract - * @param contract Futures contract, return related data only if specified. (optional) + * @param contract Futures contract, return related data only if specified (optional) * @return APIlistFuturesTickersRequest */ public APIlistFuturesTickersRequest contract(String contract) { @@ -1285,7 +1285,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 { @@ -1299,7 +1299,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 { @@ -1314,7 +1314,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 { @@ -1329,7 +1329,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 { @@ -1338,14 +1338,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callbac } /** - * List futures tickers. + * Get all futures trading statistics * - * @param settle Settle currency. (required) + * @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) { @@ -1442,7 +1442,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) { @@ -1478,7 +1478,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 { @@ -1492,7 +1492,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 { @@ -1507,7 +1507,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 { @@ -1522,7 +1522,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 { @@ -1531,15 +1531,15 @@ 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) + * @param settle Settle currency (required) + * @param contract Futures contract (required) * @return APIlistFuturesFundingRateHistoryRequest * @http.response.details - +
    Status Code Description Response Headers
    200 History retrieved. -
    200 History query successful -
    */ public APIlistFuturesFundingRateHistoryRequest listFuturesFundingRateHistory(String settle, String contract) { @@ -1615,7 +1615,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) { @@ -1631,7 +1631,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 { @@ -1645,7 +1645,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 { @@ -1660,7 +1660,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 { @@ -1675,7 +1675,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 { @@ -1684,14 +1684,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callb } /** - * Futures insurance balance history. + * Futures market insurance fund history * - * @param settle Settle currency. (required) + * @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) { @@ -1788,7 +1788,7 @@ private APIlistContractStatsRequest(String settle, String contract) { /** * Set from - * @param from Start timestamp. (optional) + * @param from Start timestamp (optional) * @return APIlistContractStatsRequest */ public APIlistContractStatsRequest from(Long from) { @@ -1824,7 +1824,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 { @@ -1838,7 +1838,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 { @@ -1853,7 +1853,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 { @@ -1868,7 +1868,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 { @@ -1877,15 +1877,15 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * Futures stats. + * Futures statistics * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (required) * @return APIlistContractStatsRequest * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved. -
    200 List retrieved successfully -
    */ public APIlistContractStatsRequest listContractStats(String settle, String contract) { @@ -1894,15 +1894,15 @@ public APIlistContractStatsRequest listContractStats(String settle, String contr /** * Build call for getIndexConstituents - * @param settle Settle currency. (required) - * @param index Index name. (required) + * @param settle Settle currency (required) + * @param index Index 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 getIndexConstituentsCall(String settle, String index, final ApiCallback _callback) throws ApiException { @@ -1953,16 +1953,16 @@ private okhttp3.Call getIndexConstituentsValidateBeforeCall(String settle, Strin } /** - * Get index constituents. + * Query index constituents * - * @param settle Settle currency. (required) - * @param index Index name. (required) + * @param settle Settle currency (required) + * @param index Index name (required) * @return FuturesIndexConstituents * @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 FuturesIndexConstituents getIndexConstituents(String settle, String index) throws ApiException { @@ -1971,16 +1971,16 @@ public FuturesIndexConstituents getIndexConstituents(String settle, String index } /** - * Get index constituents. + * Query index constituents * - * @param settle Settle currency. (required) - * @param index Index name. (required) + * @param settle Settle currency (required) + * @param index Index name (required) * @return ApiResponse<FuturesIndexConstituents> * @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 getIndexConstituentsWithHttpInfo(String settle, String index) throws ApiException { @@ -1990,17 +1990,17 @@ public ApiResponse getIndexConstituentsWithHttpInfo(St } /** - * Get index constituents. (asynchronously) + * Query index constituents (asynchronously) * - * @param settle Settle currency. (required) - * @param index Index name. (required) + * @param settle Settle currency (required) + * @param index Index 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 getIndexConstituentsAsync(String settle, String index, final ApiCallback _callback) throws ApiException { @@ -2094,7 +2094,7 @@ private APIlistLiquidatedOrdersRequest(String settle) { /** * Set contract - * @param contract Futures contract, return related data only if specified. (optional) + * @param contract Futures contract, return related data only if specified (optional) * @return APIlistLiquidatedOrdersRequest */ public APIlistLiquidatedOrdersRequest contract(String contract) { @@ -2124,7 +2124,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) { @@ -2140,7 +2140,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 { @@ -2154,7 +2154,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 { @@ -2169,7 +2169,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 { @@ -2184,7 +2184,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 { @@ -2193,14 +2193,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callb } /** - * Retrieve liquidation history. - * The time interval between from and to is maximum 3600. Some private fields are not returned by public interfaces, refer to field descriptions for interfaces, refer to field descriptions for details - * @param settle Settle currency. (required) + * 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 detailsThe time interval between from and to is maximum 3600. Some private fields are not returned by public interfaces, refer to field descriptions for interfaces, refer to field descriptions for details + * @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) { @@ -2286,7 +2286,7 @@ private APIlistFuturesRiskLimitTiersRequest(String settle) { /** * Set contract - * @param contract Futures contract, return related data only if specified. (optional) + * @param contract Futures contract, return related data only if specified (optional) * @return APIlistFuturesRiskLimitTiersRequest */ public APIlistFuturesRiskLimitTiersRequest contract(String contract) { @@ -2296,7 +2296,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) { @@ -2306,7 +2306,7 @@ public APIlistFuturesRiskLimitTiersRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistFuturesRiskLimitTiersRequest */ public APIlistFuturesRiskLimitTiersRequest offset(Integer offset) { @@ -2322,7 +2322,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 { @@ -2336,7 +2336,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 { @@ -2351,7 +2351,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 { @@ -2366,7 +2366,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 { @@ -2375,14 +2375,14 @@ public okhttp3.Call executeAsync(final ApiCallback> } /** - * List risk limit tiers. + * Query risk limit tiers * When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets.'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect empty. - * @param settle Settle currency. (required) + * @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) { @@ -2391,14 +2391,14 @@ public APIlistFuturesRiskLimitTiersRequest listFuturesRiskLimitTiers(String sett /** * Build call for listFuturesAccounts - * @param settle Settle currency. (required) + * @param settle Settle 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. -
    200 Query successful -
    */ public okhttp3.Call listFuturesAccountsCall(String settle, final ApiCallback _callback) throws ApiException { @@ -2443,15 +2443,15 @@ private okhttp3.Call listFuturesAccountsValidateBeforeCall(String settle, final } /** - * Query futures account. + * Get futures account * - * @param settle Settle currency. (required) + * @param settle Settle currency (required) * @return FuturesAccount * @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 FuturesAccount listFuturesAccounts(String settle) throws ApiException { @@ -2460,15 +2460,15 @@ public FuturesAccount listFuturesAccounts(String settle) throws ApiException { } /** - * Query futures account. + * Get futures account * - * @param settle Settle currency. (required) + * @param settle Settle currency (required) * @return ApiResponse<FuturesAccount> * @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 listFuturesAccountsWithHttpInfo(String settle) throws ApiException { @@ -2478,16 +2478,16 @@ public ApiResponse listFuturesAccountsWithHttpInfo(String settle } /** - * Query futures account. (asynchronously) + * Get futures account (asynchronously) * - * @param settle Settle currency. (required) + * @param settle Settle 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. -
    200 Query successful -
    */ public okhttp3.Call listFuturesAccountsAsync(String settle, final ApiCallback _callback) throws ApiException { @@ -2591,7 +2591,7 @@ private APIlistFuturesAccountBookRequest(String settle) { /** * Set contract - * @param contract Futures contract, return related data only if specified. (optional) + * @param contract Futures contract, return related data only if specified (optional) * @return APIlistFuturesAccountBookRequest */ public APIlistFuturesAccountBookRequest contract(String contract) { @@ -2601,7 +2601,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) { @@ -2611,7 +2611,7 @@ public APIlistFuturesAccountBookRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistFuturesAccountBookRequest */ public APIlistFuturesAccountBookRequest offset(Integer offset) { @@ -2657,7 +2657,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 { @@ -2671,7 +2671,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 { @@ -2686,7 +2686,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 { @@ -2701,7 +2701,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 { @@ -2710,14 +2710,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _ca } /** - * Query account book. - * If the contract field is passed, only records containing this field after 2023-10-30 can be filtered。 2023-10-30 can be filtered. - * @param settle Settle currency. (required) + * 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) { @@ -2803,7 +2803,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) { @@ -2813,7 +2813,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) { @@ -2823,7 +2823,7 @@ public APIlistPositionsRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistPositionsRequest */ public APIlistPositionsRequest offset(Integer offset) { @@ -2839,7 +2839,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 { @@ -2853,7 +2853,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 { @@ -2868,7 +2868,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 { @@ -2883,7 +2883,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 { @@ -2892,14 +2892,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) th } /** - * List all positions of a user. + * Get user position list * - * @param settle Settle currency. (required) + * @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) { @@ -2984,7 +2984,7 @@ private APIgetPositionRequest(String settle, String contract) { * @http.response.details - +
    Status Code Description Response Headers
    200 Position information. -
    200 Position information -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2998,7 +2998,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Position information. -
    200 Position information -
    */ public Position execute() throws ApiException { @@ -3013,7 +3013,7 @@ public Position execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Position information. -
    200 Position information -
    */ public ApiResponse executeWithHttpInfo() throws ApiException { @@ -3028,7 +3028,7 @@ public ApiResponse executeWithHttpInfo() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Position information. -
    200 Position information -
    */ public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException { @@ -3037,15 +3037,15 @@ 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) + * @param settle Settle currency (required) + * @param contract Futures contract (required) * @return APIgetPositionRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Position information. -
    200 Position information -
    */ public APIgetPositionRequest getPosition(String settle, String contract) { @@ -3054,16 +3054,16 @@ 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 amount, positive number increases, negative number. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (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 * @http.response.details - +
    Status Code Description Response Headers
    200 Position information. -
    200 Position information -
    */ public okhttp3.Call updatePositionMarginCall(String settle, String contract, String change, final ApiCallback _callback) throws ApiException { @@ -3123,17 +3123,17 @@ private okhttp3.Call updatePositionMarginValidateBeforeCall(String settle, Strin } /** - * Update position margin. + * Update position margin * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param change Margin change amount, positive number increases, negative number. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (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 - +
    Status Code Description Response Headers
    200 Position information. -
    200 Position information -
    */ public Position updatePositionMargin(String settle, String contract, String change) throws ApiException { @@ -3142,17 +3142,17 @@ public Position updatePositionMargin(String settle, String contract, String chan } /** - * Update position margin. + * Update position margin * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param change Margin change amount, positive number increases, negative number. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (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 - +
    Status Code Description Response Headers
    200 Position information. -
    200 Position information -
    */ public ApiResponse updatePositionMarginWithHttpInfo(String settle, String contract, String change) throws ApiException { @@ -3162,18 +3162,18 @@ public ApiResponse updatePositionMarginWithHttpInfo(String settle, Str } /** - * Update position margin. (asynchronously) + * Update position margin (asynchronously) * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param change Margin change amount, positive number increases, negative number. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (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 * @http.response.details - +
    Status Code Description Response Headers
    200 Position information. -
    200 Position information -
    */ public okhttp3.Call updatePositionMarginAsync(String settle, String contract, String change, final ApiCallback _callback) throws ApiException { @@ -3185,17 +3185,17 @@ public okhttp3.Call updatePositionMarginAsync(String settle, String contract, St /** * Build call for updatePositionLeverage - * @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 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 _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 Position information. -
    200 Position information -
    */ public okhttp3.Call updatePositionLeverageCall(String settle, String contract, String leverage, String crossLeverageLimit, final ApiCallback _callback) throws ApiException { @@ -3259,18 +3259,18 @@ private okhttp3.Call updatePositionLeverageValidateBeforeCall(String settle, Str } /** - * Update position leverage. + * Update position leverage * - * @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 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) * @return 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 Position information. -
    200 Position information -
    */ public Position updatePositionLeverage(String settle, String contract, String leverage, String crossLeverageLimit) throws ApiException { @@ -3279,18 +3279,18 @@ public Position updatePositionLeverage(String settle, String contract, String le } /** - * Update position leverage. + * Update position leverage * - * @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 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) * @return ApiResponse<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 Position information. -
    200 Position information -
    */ public ApiResponse updatePositionLeverageWithHttpInfo(String settle, String contract, String leverage, String crossLeverageLimit) throws ApiException { @@ -3300,19 +3300,19 @@ public ApiResponse updatePositionLeverageWithHttpInfo(String settle, S } /** - * Update position leverage. (asynchronously) + * Update position leverage (asynchronously) * - * @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 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 _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 Position information. -
    200 Position information -
    */ public okhttp3.Call updatePositionLeverageAsync(String settle, String contract, String leverage, String crossLeverageLimit, final ApiCallback _callback) throws ApiException { @@ -3324,7 +3324,7 @@ public okhttp3.Call updatePositionLeverageAsync(String settle, String contract, /** * Build call for updatePositionCrossMode - * @param settle Settle currency. (required) + * @param settle Settle currency (required) * @param futuresPositionCrossMode (required) * @param _callback Callback for upload/download progress * @return Call to execute @@ -3332,7 +3332,7 @@ public okhttp3.Call updatePositionLeverageAsync(String settle, String contract, * @http.response.details - +
    Status Code Description Response Headers
    200 Position information. -
    200 Position information -
    */ public okhttp3.Call updatePositionCrossModeCall(String settle, FuturesPositionCrossMode futuresPositionCrossMode, final ApiCallback _callback) throws ApiException { @@ -3382,16 +3382,16 @@ private okhttp3.Call updatePositionCrossModeValidateBeforeCall(String settle, Fu } /** - * Switch to the full position-by-store mode. + * Switch Position Margin Mode * - * @param settle Settle currency. (required) + * @param settle Settle currency (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 - +
    Status Code Description Response Headers
    200 Position information. -
    200 Position information -
    */ public Position updatePositionCrossMode(String settle, FuturesPositionCrossMode futuresPositionCrossMode) throws ApiException { @@ -3400,16 +3400,16 @@ public Position updatePositionCrossMode(String settle, FuturesPositionCrossMode } /** - * Switch to the full position-by-store mode. + * Switch Position Margin Mode * - * @param settle Settle currency. (required) + * @param settle Settle currency (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 - +
    Status Code Description Response Headers
    200 Position information. -
    200 Position information -
    */ public ApiResponse updatePositionCrossModeWithHttpInfo(String settle, FuturesPositionCrossMode futuresPositionCrossMode) throws ApiException { @@ -3419,9 +3419,9 @@ public ApiResponse updatePositionCrossModeWithHttpInfo(String settle, } /** - * Switch to the full position-by-store mode. (asynchronously) + * Switch Position Margin Mode (asynchronously) * - * @param settle Settle currency. (required) + * @param settle Settle currency (required) * @param futuresPositionCrossMode (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -3429,7 +3429,7 @@ public ApiResponse updatePositionCrossModeWithHttpInfo(String settle, * @http.response.details - +
    Status Code Description Response Headers
    200 Position information. -
    200 Position information -
    */ public okhttp3.Call updatePositionCrossModeAsync(String settle, FuturesPositionCrossMode futuresPositionCrossMode, final ApiCallback _callback) throws ApiException { @@ -3441,7 +3441,7 @@ public okhttp3.Call updatePositionCrossModeAsync(String settle, FuturesPositionC /** * Build call for updateDualCompPositionCrossMode - * @param settle Settle currency. (required) + * @param settle Settle currency (required) * @param inlineObject (required) * @param _callback Callback for upload/download progress * @return Call to execute @@ -3449,7 +3449,7 @@ public okhttp3.Call updatePositionCrossModeAsync(String settle, FuturesPositionC * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved. -
    200 Query successful -
    */ public okhttp3.Call updateDualCompPositionCrossModeCall(String settle, InlineObject inlineObject, final ApiCallback _callback) throws ApiException { @@ -3499,16 +3499,16 @@ private okhttp3.Call updateDualCompPositionCrossModeValidateBeforeCall(String se } /** - * 双仓模式下切换全逐仓模式 + * Switch Between Cross and Isolated Margin Modes Under Hedge Mode * - * @param settle Settle currency. (required) + * @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 Successfully retrieved. -
    200 Query successful -
    */ public List updateDualCompPositionCrossMode(String settle, InlineObject inlineObject) throws ApiException { @@ -3517,16 +3517,16 @@ public List updateDualCompPositionCrossMode(String settle, InlineObjec } /** - * 双仓模式下切换全逐仓模式 + * Switch Between Cross and Isolated Margin Modes Under Hedge Mode * - * @param settle Settle currency. (required) + * @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 Successfully retrieved. -
    200 Query successful -
    */ public ApiResponse> updateDualCompPositionCrossModeWithHttpInfo(String settle, InlineObject inlineObject) throws ApiException { @@ -3536,9 +3536,9 @@ public ApiResponse> updateDualCompPositionCrossModeWithHttpInfo(S } /** - * 双仓模式下切换全逐仓模式 (asynchronously) + * Switch Between Cross and Isolated Margin Modes Under Hedge Mode (asynchronously) * - * @param settle Settle currency. (required) + * @param settle Settle currency (required) * @param inlineObject (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -3546,7 +3546,7 @@ public ApiResponse> updateDualCompPositionCrossModeWithHttpInfo(S * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved. -
    200 Query successful -
    */ public okhttp3.Call updateDualCompPositionCrossModeAsync(String settle, InlineObject inlineObject, final ApiCallback> _callback) throws ApiException { @@ -3558,16 +3558,16 @@ public okhttp3.Call updateDualCompPositionCrossModeAsync(String settle, InlineOb /** * Build call for updatePositionRiskLimit - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param riskLimit New Risk Limit Value. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (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 Position information. -
    200 Position information -
    */ public okhttp3.Call updatePositionRiskLimitCall(String settle, String contract, String riskLimit, final ApiCallback _callback) throws ApiException { @@ -3627,17 +3627,17 @@ private okhttp3.Call updatePositionRiskLimitValidateBeforeCall(String settle, St } /** - * Update position risk limit. + * Update position risk limit * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param riskLimit New Risk Limit Value. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (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 - +
    Status Code Description Response Headers
    200 Position information. -
    200 Position information -
    */ public Position updatePositionRiskLimit(String settle, String contract, String riskLimit) throws ApiException { @@ -3646,17 +3646,17 @@ public Position updatePositionRiskLimit(String settle, String contract, String r } /** - * Update position risk limit. + * Update position risk limit * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param riskLimit New Risk Limit Value. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (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 - +
    Status Code Description Response Headers
    200 Position information. -
    200 Position information -
    */ public ApiResponse updatePositionRiskLimitWithHttpInfo(String settle, String contract, String riskLimit) throws ApiException { @@ -3666,18 +3666,18 @@ public ApiResponse updatePositionRiskLimitWithHttpInfo(String settle, } /** - * Update position risk limit. (asynchronously) + * Update position risk limit (asynchronously) * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param riskLimit New Risk Limit Value. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (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 Position information. -
    200 Position information -
    */ public okhttp3.Call updatePositionRiskLimitAsync(String settle, String contract, String riskLimit, final ApiCallback _callback) throws ApiException { @@ -3689,15 +3689,15 @@ public okhttp3.Call updatePositionRiskLimitAsync(String settle, String contract, /** * Build call for setDualMode - * @param settle Settle currency. (required) - * @param dualMode Whether to enable dual mode. (required) + * @param settle Settle currency (required) + * @param dualMode Whether to enable dual mode (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. -
    200 Updated successfully -
    */ public okhttp3.Call setDualModeCall(String settle, Boolean dualMode, final ApiCallback _callback) throws ApiException { @@ -3751,16 +3751,16 @@ private okhttp3.Call setDualModeValidateBeforeCall(String settle, Boolean dualMo } /** - * Enable or disable dual mode. - * The prerequisite for changing mode is that all positions have no holdings. - * @param settle Settle currency. (required) - * @param dualMode Whether to enable dual mode. (required) + * 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 * @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 FuturesAccount setDualMode(String settle, Boolean dualMode) throws ApiException { @@ -3769,16 +3769,16 @@ public FuturesAccount setDualMode(String settle, Boolean dualMode) throws ApiExc } /** - * Enable or disable dual mode. - * The prerequisite for changing mode is that all positions have no holdings. - * @param settle Settle currency. (required) - * @param dualMode Whether to enable dual mode. (required) + * 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> * @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 setDualModeWithHttpInfo(String settle, Boolean dualMode) throws ApiException { @@ -3788,17 +3788,17 @@ public ApiResponse setDualModeWithHttpInfo(String settle, Boolea } /** - * Enable or disable dual mode. (asynchronously) - * The prerequisite for changing mode is that all positions have no holdings. - * @param settle Settle currency. (required) - * @param dualMode Whether to enable dual mode. (required) + * 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 * @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. -
    200 Updated successfully -
    */ public okhttp3.Call setDualModeAsync(String settle, Boolean dualMode, final ApiCallback _callback) throws ApiException { @@ -3886,7 +3886,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 { @@ -3900,7 +3900,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 { @@ -3915,7 +3915,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 { @@ -3930,7 +3930,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 { @@ -3939,15 +3939,15 @@ 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) + * @param settle Settle currency (required) + * @param contract Futures contract (required) * @return APIgetDualModePositionRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved. -
    200 Query successful -
    */ public APIgetDualModePositionRequest getDualModePosition(String settle, String contract) { @@ -3956,17 +3956,17 @@ 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 amount, positive number increases, negative number. (required) - * @param dualSide Long or short position. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (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 * @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 updateDualModePositionMarginCall(String settle, String contract, String change, String dualSide, final ApiCallback _callback) throws ApiException { @@ -4035,18 +4035,18 @@ private okhttp3.Call updateDualModePositionMarginValidateBeforeCall(String settl } /** - * Update position margin in dual mode. + * Update position margin in dual mode * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param change Margin change amount, positive number increases, negative number. (required) - * @param dualSide Long or short position. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (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 { @@ -4055,18 +4055,18 @@ public List updateDualModePositionMargin(String settle, String contrac } /** - * Update position margin in dual mode. + * Update position margin in dual mode * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param change Margin change amount, positive number increases, negative number. (required) - * @param dualSide Long or short position. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (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 { @@ -4076,19 +4076,19 @@ public ApiResponse> updateDualModePositionMarginWithHttpInfo(Stri } /** - * Update position margin in dual mode. (asynchronously) + * Update position margin in dual mode (asynchronously) * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param change Margin change amount, positive number increases, negative number. (required) - * @param dualSide Long or short position. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (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 * @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 updateDualModePositionMarginAsync(String settle, String contract, String change, String dualSide, final ApiCallback> _callback) throws ApiException { @@ -4100,17 +4100,17 @@ public okhttp3.Call updateDualModePositionMarginAsync(String settle, String cont /** * Build call for updateDualModePositionLeverage - * @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 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 _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 { @@ -4174,18 +4174,18 @@ private okhttp3.Call updateDualModePositionLeverageValidateBeforeCall(String set } /** - * Update position leverage in dual mode. + * Update position leverage in dual mode * - * @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 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) * @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 { @@ -4194,18 +4194,18 @@ public List updateDualModePositionLeverage(String settle, String contr } /** - * Update position leverage in dual mode. + * Update position leverage in dual mode * - * @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 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) * @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 { @@ -4215,19 +4215,19 @@ public ApiResponse> updateDualModePositionLeverageWithHttpInfo(St } /** - * Update position leverage in dual mode. (asynchronously) + * Update position leverage in dual mode (asynchronously) * - * @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 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 _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 { @@ -4239,16 +4239,16 @@ 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 settle Settle currency (required) + * @param contract Futures contract (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 { @@ -4308,17 +4308,17 @@ private okhttp3.Call updateDualModePositionRiskLimitValidateBeforeCall(String se } /** - * Update position risk limit in dual mode. + * Update position risk limit in dual mode * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param riskLimit New Risk Limit Value. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (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 { @@ -4327,17 +4327,17 @@ public List updateDualModePositionRiskLimit(String settle, String cont } /** - * Update position risk limit in dual mode. + * Update position risk limit in dual mode * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param riskLimit New Risk Limit Value. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (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 { @@ -4347,18 +4347,18 @@ public ApiResponse> updateDualModePositionRiskLimitWithHttpInfo(S } /** - * Update position risk limit in dual mode. (asynchronously) + * Update position risk limit in dual mode (asynchronously) * - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) - * @param riskLimit New Risk Limit Value. (required) + * @param settle Settle currency (required) + * @param contract Futures contract (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 { @@ -4463,7 +4463,7 @@ private APIlistFuturesOrdersRequest(String settle, String status) { /** * Set contract - * @param contract Futures contract, return related data only if specified. (optional) + * @param contract Futures contract, return related data only if specified (optional) * @return APIlistFuturesOrdersRequest */ public APIlistFuturesOrdersRequest contract(String contract) { @@ -4473,7 +4473,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) { @@ -4483,7 +4483,7 @@ public APIlistFuturesOrdersRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistFuturesOrdersRequest */ public APIlistFuturesOrdersRequest offset(Integer offset) { @@ -4493,7 +4493,7 @@ public APIlistFuturesOrdersRequest offset(Integer offset) { /** * Set lastId - * @param lastId Specify the currency name to query in batches, and support up to 100 pass parameters at a time. (optional) + * @param lastId Specify the currency name to query in batches, and support up to 100 pass parameters at a time (optional) * @return APIlistFuturesOrdersRequest */ public APIlistFuturesOrdersRequest lastId(String lastId) { @@ -4509,7 +4509,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 { @@ -4523,7 +4523,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 { @@ -4538,7 +4538,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 { @@ -4553,7 +4553,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 { @@ -4562,15 +4562,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 settle Settle currency (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) { @@ -4579,7 +4579,7 @@ public APIlistFuturesOrdersRequest listFuturesOrders(String settle, String statu /** * Build call for createFuturesOrder - * @param settle Settle currency. (required) + * @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) * @param _callback Callback for upload/download progress @@ -4588,7 +4588,7 @@ public APIlistFuturesOrdersRequest listFuturesOrders(String settle, String statu * @http.response.details - +
    Status Code Description Response Headers
    201 Order details. -
    201 Order details -
    */ public okhttp3.Call createFuturesOrderCall(String settle, FuturesOrder futuresOrder, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -4642,9 +4642,9 @@ private okhttp3.Call createFuturesOrderValidateBeforeCall(String settle, Futures } /** - * Create a futures order. + * Place futures order * - When placing an order, the number of contracts is specified `size`, not the number of coins. The number of coins corresponding to each contract is returned in the contract details interface `quanto_multiplier` - 0 The order that was completed cannot be obtained after 10 minutes of withdrawal, and the order will be mentioned that the order does not exist - Setting `reduce_only` to `true` can prevent the position from being penetrated when reducing the position - In single-position mode, if you need to close the position, you need to set `size` to 0 and `close` to `true` - In dual warehouse mode, - Reduce position: reduce_only=true, size is a positive number that indicates short position, negative number that indicates long position - Add number that indicates adding long positions, and negative numbers indicate adding short positions - Close position: size=0, set the direction of closing position according to auto_size, and set `reduce_only` to true at the same time - reduce_only: Make sure to only perform position reduction operations to prevent increased positions - Set `stp_act` to determine the use of a strategy that restricts user transactions. For detailed usage, refer to the body parameter `stp_act` - * @param settle Settle currency. (required) + * @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) * @return FuturesOrder @@ -4652,7 +4652,7 @@ private okhttp3.Call createFuturesOrderValidateBeforeCall(String settle, Futures * @http.response.details - +
    Status Code Description Response Headers
    201 Order details. -
    201 Order details -
    */ public FuturesOrder createFuturesOrder(String settle, FuturesOrder futuresOrder, String xGateExptime) throws ApiException { @@ -4661,9 +4661,9 @@ public FuturesOrder createFuturesOrder(String settle, FuturesOrder futuresOrder, } /** - * Create a futures order. + * Place futures order * - When placing an order, the number of contracts is specified `size`, not the number of coins. The number of coins corresponding to each contract is returned in the contract details interface `quanto_multiplier` - 0 The order that was completed cannot be obtained after 10 minutes of withdrawal, and the order will be mentioned that the order does not exist - Setting `reduce_only` to `true` can prevent the position from being penetrated when reducing the position - In single-position mode, if you need to close the position, you need to set `size` to 0 and `close` to `true` - In dual warehouse mode, - Reduce position: reduce_only=true, size is a positive number that indicates short position, negative number that indicates long position - Add number that indicates adding long positions, and negative numbers indicate adding short positions - Close position: size=0, set the direction of closing position according to auto_size, and set `reduce_only` to true at the same time - reduce_only: Make sure to only perform position reduction operations to prevent increased positions - Set `stp_act` to determine the use of a strategy that restricts user transactions. For detailed usage, refer to the body parameter `stp_act` - * @param settle Settle currency. (required) + * @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) * @return ApiResponse<FuturesOrder> @@ -4671,7 +4671,7 @@ public FuturesOrder createFuturesOrder(String settle, FuturesOrder futuresOrder, * @http.response.details - +
    Status Code Description Response Headers
    201 Order details. -
    201 Order details -
    */ public ApiResponse createFuturesOrderWithHttpInfo(String settle, FuturesOrder futuresOrder, String xGateExptime) throws ApiException { @@ -4681,9 +4681,9 @@ public ApiResponse createFuturesOrderWithHttpInfo(String settle, F } /** - * Create a futures order. (asynchronously) + * 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 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) * @param _callback The callback to be executed when the API call finishes @@ -4692,7 +4692,7 @@ public ApiResponse createFuturesOrderWithHttpInfo(String settle, F * @http.response.details - +
    Status Code Description Response Headers
    201 Order details. -
    201 Order details -
    */ public okhttp3.Call createFuturesOrderAsync(String settle, FuturesOrder futuresOrder, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -4704,8 +4704,8 @@ public okhttp3.Call createFuturesOrderAsync(String settle, FuturesOrder futuresO /** * Build call for cancelFuturesOrders - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) + * @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, both are included if not specified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell orders (optional) * @param _callback Callback for upload/download progress @@ -4714,7 +4714,7 @@ public okhttp3.Call createFuturesOrderAsync(String settle, FuturesOrder futuresO * @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 { @@ -4776,10 +4776,10 @@ private okhttp3.Call cancelFuturesOrdersValidateBeforeCall(String settle, String } /** - * Cancel all `open` orders matched. - * Zero-filled order cannot be retrieved 10 minutes after order cancellation. - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) + * 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, both are included if not specified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell orders (optional) * @return List<FuturesOrder> @@ -4787,7 +4787,7 @@ private okhttp3.Call cancelFuturesOrdersValidateBeforeCall(String settle, String * @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 { @@ -4796,10 +4796,10 @@ public List cancelFuturesOrders(String settle, String contract, St } /** - * Cancel all `open` orders matched. - * Zero-filled order cannot be retrieved 10 minutes after order cancellation. - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) + * 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, both are included if not specified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell orders (optional) * @return ApiResponse<List<FuturesOrder>> @@ -4807,7 +4807,7 @@ public List cancelFuturesOrders(String settle, String contract, St * @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 { @@ -4817,10 +4817,10 @@ public ApiResponse> cancelFuturesOrdersWithHttpInfo(String se } /** - * Cancel all `open` orders matched. (asynchronously) - * Zero-filled order cannot be retrieved 10 minutes after order cancellation. - * @param settle Settle currency. (required) - * @param contract Futures contract. (required) + * 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, both are included if not specified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell orders (optional) * @param _callback The callback to be executed when the API call finishes @@ -4829,7 +4829,7 @@ public ApiResponse> cancelFuturesOrdersWithHttpInfo(String se * @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 { @@ -4928,7 +4928,7 @@ private APIgetOrdersWithTimeRangeRequest(String settle) { /** * Set contract - * @param contract Futures contract, return related data only if specified. (optional) + * @param contract Futures contract, return related data only if specified (optional) * @return APIgetOrdersWithTimeRangeRequest */ public APIgetOrdersWithTimeRangeRequest contract(String contract) { @@ -4958,7 +4958,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) { @@ -4968,7 +4968,7 @@ public APIgetOrdersWithTimeRangeRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIgetOrdersWithTimeRangeRequest */ public APIgetOrdersWithTimeRangeRequest offset(Integer offset) { @@ -4984,7 +4984,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 { @@ -4998,7 +4998,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 { @@ -5013,7 +5013,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 { @@ -5028,7 +5028,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 { @@ -5037,14 +5037,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) + * @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) { @@ -5053,7 +5053,7 @@ public APIgetOrdersWithTimeRangeRequest getOrdersWithTimeRange(String settle) { /** * Build call for createBatchFuturesOrder - * @param settle Settle currency. (required) + * @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) * @param _callback Callback for upload/download progress @@ -5062,7 +5062,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 { @@ -5116,9 +5116,9 @@ 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 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) * @return List<BatchFuturesOrder> @@ -5126,7 +5126,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 { @@ -5135,9 +5135,9 @@ 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 { @@ -5155,9 +5155,9 @@ 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 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) * @param _callback The callback to be executed when the API call finishes @@ -5166,7 +5166,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 { @@ -5178,7 +5178,7 @@ public okhttp3.Call createBatchFuturesOrderAsync(String settle, List Status Code Description Response Headers - 200 Order details. - + 200 Order details - */ public okhttp3.Call getFuturesOrderCall(String settle, String orderId, final ApiCallback _callback) throws ApiException { @@ -5237,16 +5237,16 @@ private okhttp3.Call getFuturesOrderValidateBeforeCall(String settle, String ord } /** - * 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. - * @param settle Settle currency. (required) + * @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. finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. (required) * @return 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 Order details. -
    200 Order details -
    */ public FuturesOrder getFuturesOrder(String settle, String orderId) throws ApiException { @@ -5255,16 +5255,16 @@ public FuturesOrder getFuturesOrder(String settle, String orderId) throws ApiExc } /** - * 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. - * @param settle Settle currency. (required) + * @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. finished, it can be checked within 60 seconds after the end of the order. After that, only order ID is accepted. (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 - +
    Status Code Description Response Headers
    200 Order details. -
    200 Order details -
    */ public ApiResponse getFuturesOrderWithHttpInfo(String settle, String orderId) throws ApiException { @@ -5274,9 +5274,9 @@ public ApiResponse 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 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. 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 @@ -5284,7 +5284,7 @@ public ApiResponse getFuturesOrderWithHttpInfo(String settle, Stri * @http.response.details - +
    Status Code Description Response Headers
    200 Order details. -
    200 Order details -
    */ public okhttp3.Call getFuturesOrderAsync(String settle, String orderId, final ApiCallback _callback) throws ApiException { @@ -5296,7 +5296,7 @@ public okhttp3.Call getFuturesOrderAsync(String settle, String orderId, final Ap /** * Build call for amendFuturesOrder - * @param settle Settle currency. (required) + * @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. 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) @@ -5306,7 +5306,7 @@ public okhttp3.Call getFuturesOrderAsync(String settle, String orderId, final Ap * @http.response.details - +
    Status Code Description Response Headers
    200 Order details. -
    200 Order details -
    */ public okhttp3.Call amendFuturesOrderCall(String settle, String orderId, FuturesOrderAmendment futuresOrderAmendment, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -5366,9 +5366,9 @@ private okhttp3.Call amendFuturesOrderValidateBeforeCall(String settle, String o } /** - * Amend an order. + * Amend single order * - * @param settle Settle currency. (required) + * @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. 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) @@ -5377,7 +5377,7 @@ private okhttp3.Call amendFuturesOrderValidateBeforeCall(String settle, String o * @http.response.details - +
    Status Code Description Response Headers
    200 Order details. -
    200 Order details -
    */ public FuturesOrder amendFuturesOrder(String settle, String orderId, FuturesOrderAmendment futuresOrderAmendment, String xGateExptime) throws ApiException { @@ -5386,9 +5386,9 @@ public FuturesOrder amendFuturesOrder(String settle, String orderId, FuturesOrde } /** - * Amend an order. + * Amend single order * - * @param settle Settle currency. (required) + * @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. 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) @@ -5397,7 +5397,7 @@ public FuturesOrder amendFuturesOrder(String settle, String orderId, FuturesOrde * @http.response.details - +
    Status Code Description Response Headers
    200 Order details. -
    200 Order details -
    */ public ApiResponse amendFuturesOrderWithHttpInfo(String settle, String orderId, FuturesOrderAmendment futuresOrderAmendment, String xGateExptime) throws ApiException { @@ -5407,9 +5407,9 @@ public ApiResponse amendFuturesOrderWithHttpInfo(String settle, St } /** - * Amend an order. (asynchronously) + * Amend single order (asynchronously) * - * @param settle Settle currency. (required) + * @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. 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) @@ -5419,7 +5419,7 @@ public ApiResponse amendFuturesOrderWithHttpInfo(String settle, St * @http.response.details - +
    Status Code Description Response Headers
    200 Order details. -
    200 Order details -
    */ public okhttp3.Call amendFuturesOrderAsync(String settle, String orderId, FuturesOrderAmendment futuresOrderAmendment, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -5431,7 +5431,7 @@ public okhttp3.Call amendFuturesOrderAsync(String settle, String orderId, Future /** * Build call for cancelFuturesOrder - * @param settle Settle currency. (required) + * @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. 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 @@ -5440,7 +5440,7 @@ public okhttp3.Call amendFuturesOrderAsync(String settle, String orderId, Future * @http.response.details - +
    Status Code Description Response Headers
    200 Order details. -
    200 Order details -
    */ public okhttp3.Call cancelFuturesOrderCall(String settle, String orderId, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -5495,9 +5495,9 @@ private okhttp3.Call cancelFuturesOrderValidateBeforeCall(String settle, String } /** - * Cancel a single order. + * Cancel single order * - * @param settle Settle currency. (required) + * @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. 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 @@ -5505,7 +5505,7 @@ private okhttp3.Call cancelFuturesOrderValidateBeforeCall(String settle, String * @http.response.details - +
    Status Code Description Response Headers
    200 Order details. -
    200 Order details -
    */ public FuturesOrder cancelFuturesOrder(String settle, String orderId, String xGateExptime) throws ApiException { @@ -5514,9 +5514,9 @@ public FuturesOrder cancelFuturesOrder(String settle, String orderId, String xGa } /** - * Cancel a single order. + * Cancel single order * - * @param settle Settle currency. (required) + * @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. 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> @@ -5524,7 +5524,7 @@ public FuturesOrder cancelFuturesOrder(String settle, String orderId, String xGa * @http.response.details - +
    Status Code Description Response Headers
    200 Order details. -
    200 Order details -
    */ public ApiResponse cancelFuturesOrderWithHttpInfo(String settle, String orderId, String xGateExptime) throws ApiException { @@ -5534,9 +5534,9 @@ public ApiResponse cancelFuturesOrderWithHttpInfo(String settle, S } /** - * Cancel a single order. (asynchronously) + * Cancel single order (asynchronously) * - * @param settle Settle currency. (required) + * @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. 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 @@ -5545,7 +5545,7 @@ public ApiResponse cancelFuturesOrderWithHttpInfo(String settle, S * @http.response.details - +
    Status Code Description Response Headers
    200 Order details. -
    200 Order details -
    */ public okhttp3.Call cancelFuturesOrderAsync(String settle, String orderId, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -5644,7 +5644,7 @@ private APIgetMyTradesRequest(String settle) { /** * Set contract - * @param contract Futures contract, return related data only if specified. (optional) + * @param contract Futures contract, return related data only if specified (optional) * @return APIgetMyTradesRequest */ public APIgetMyTradesRequest contract(String contract) { @@ -5654,7 +5654,7 @@ public APIgetMyTradesRequest contract(String contract) { /** * Set order - * @param order Futures order ID, return related data only if specified. (optional) + * @param order Futures order ID, return related data only if specified (optional) * @return APIgetMyTradesRequest */ public APIgetMyTradesRequest order(Long order) { @@ -5664,7 +5664,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) { @@ -5674,7 +5674,7 @@ public APIgetMyTradesRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIgetMyTradesRequest */ public APIgetMyTradesRequest offset(Integer offset) { @@ -5700,7 +5700,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 { @@ -5714,7 +5714,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 { @@ -5729,7 +5729,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 { @@ -5744,7 +5744,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 { @@ -5753,14 +5753,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) + * @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) { @@ -5861,7 +5861,7 @@ private APIgetMyTradesWithTimeRangeRequest(String settle) { /** * Set contract - * @param contract Futures contract, return related data only if specified. (optional) + * @param contract Futures contract, return related data only if specified (optional) * @return APIgetMyTradesWithTimeRangeRequest */ public APIgetMyTradesWithTimeRangeRequest contract(String contract) { @@ -5891,7 +5891,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) { @@ -5901,7 +5901,7 @@ public APIgetMyTradesWithTimeRangeRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIgetMyTradesWithTimeRangeRequest */ public APIgetMyTradesWithTimeRangeRequest offset(Integer offset) { @@ -5911,7 +5911,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) { @@ -5927,7 +5927,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 { @@ -5941,7 +5941,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 { @@ -5956,7 +5956,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 { @@ -5971,7 +5971,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 { @@ -5980,14 +5980,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) + * @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) { @@ -6093,7 +6093,7 @@ private APIlistPositionCloseRequest(String settle) { /** * Set contract - * @param contract Futures contract, return related data only if specified. (optional) + * @param contract Futures contract, return related data only if specified (optional) * @return APIlistPositionCloseRequest */ public APIlistPositionCloseRequest contract(String contract) { @@ -6103,7 +6103,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) { @@ -6113,7 +6113,7 @@ public APIlistPositionCloseRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistPositionCloseRequest */ public APIlistPositionCloseRequest offset(Integer offset) { @@ -6143,7 +6143,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) { @@ -6153,7 +6153,7 @@ public APIlistPositionCloseRequest side(String side) { /** * Set pnl - * @param pnl Query profit or loss. (optional) + * @param pnl Query profit or loss (optional) * @return APIlistPositionCloseRequest */ public APIlistPositionCloseRequest pnl(String pnl) { @@ -6169,7 +6169,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 { @@ -6183,7 +6183,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 { @@ -6198,7 +6198,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 { @@ -6213,7 +6213,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 { @@ -6222,14 +6222,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callbac } /** - * List position close history. + * Query position close history * - * @param settle Settle currency. (required) + * @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) { @@ -6330,7 +6330,7 @@ private APIlistLiquidatesRequest(String settle) { /** * Set contract - * @param contract Futures contract, return related data only if specified. (optional) + * @param contract Futures contract, return related data only if specified (optional) * @return APIlistLiquidatesRequest */ public APIlistLiquidatesRequest contract(String contract) { @@ -6340,7 +6340,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) { @@ -6350,7 +6350,7 @@ public APIlistLiquidatesRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistLiquidatesRequest */ public APIlistLiquidatesRequest offset(Integer offset) { @@ -6380,7 +6380,7 @@ public APIlistLiquidatesRequest to(Long to) { /** * 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) { @@ -6396,7 +6396,7 @@ 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 { @@ -6410,7 +6410,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 { @@ -6425,7 +6425,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 { @@ -6440,7 +6440,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 { @@ -6449,14 +6449,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _call } /** - * List liquidation history. + * Query liquidation history * - * @param settle Settle currency. (required) + * @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) { @@ -6557,7 +6557,7 @@ private APIlistAutoDeleveragesRequest(String settle) { /** * Set contract - * @param contract Futures contract, return related data only if specified. (optional) + * @param contract Futures contract, return related data only if specified (optional) * @return APIlistAutoDeleveragesRequest */ public APIlistAutoDeleveragesRequest contract(String contract) { @@ -6567,7 +6567,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) { @@ -6577,7 +6577,7 @@ public APIlistAutoDeleveragesRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistAutoDeleveragesRequest */ public APIlistAutoDeleveragesRequest offset(Integer offset) { @@ -6607,7 +6607,7 @@ public APIlistAutoDeleveragesRequest to(Long to) { /** * 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) { @@ -6623,7 +6623,7 @@ 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 { @@ -6637,7 +6637,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 { @@ -6652,7 +6652,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 { @@ -6667,7 +6667,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 { @@ -6676,14 +6676,14 @@ public okhttp3.Call executeAsync(final ApiCallback> } /** - * List Auto-Deleveraging History. + * Query ADL auto-deleveraging order information * - * @param settle Settle currency. (required) + * @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) { @@ -6692,7 +6692,7 @@ public APIlistAutoDeleveragesRequest listAutoDeleverages(String settle) { /** * Build call for countdownCancelAllFutures - * @param settle Settle currency. (required) + * @param settle Settle currency (required) * @param countdownCancelAllFuturesTask (required) * @param _callback Callback for upload/download progress * @return Call to execute @@ -6700,7 +6700,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 { @@ -6750,16 +6750,16 @@ private okhttp3.Call countdownCancelAllFuturesValidateBeforeCall(String settle, } /** - * Countdown cancel orders. + * Countdown cancel orders * Heartbeat detection for contract orders: When the user-set `timeout` time is reached, if neither the existing countdown is canceled nor a new countdown is set, the relevant contract orders will be automatically canceled. This API can be called repeatedly to or cancel the countdown. Usage example: Repeatedly call this API at 30-second intervals, setting the `timeout` to 30 (seconds) each time. If this API is not called again within 30 seconds, all open orders on your specified `market` will be automatically canceled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will terminate, and the automatic order cancellation function will be disabled. - * @param settle Settle currency. (required) + * @param settle Settle currency (required) * @param countdownCancelAllFuturesTask (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 countdownCancelAllFutures(String settle, CountdownCancelAllFuturesTask countdownCancelAllFuturesTask) throws ApiException { @@ -6768,16 +6768,16 @@ public TriggerTime countdownCancelAllFutures(String settle, CountdownCancelAllFu } /** - * Countdown cancel orders. + * Countdown cancel orders * Heartbeat detection for contract orders: When the user-set `timeout` time is reached, if neither the existing countdown is canceled nor a new countdown is set, the relevant contract orders will be automatically canceled. This API can be called repeatedly to or cancel the countdown. Usage example: Repeatedly call this API at 30-second intervals, setting the `timeout` to 30 (seconds) each time. If this API is not called again within 30 seconds, all open orders on your specified `market` will be automatically canceled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will terminate, and the automatic order cancellation function will be disabled. - * @param settle Settle currency. (required) + * @param settle Settle currency (required) * @param countdownCancelAllFuturesTask (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 countdownCancelAllFuturesWithHttpInfo(String settle, CountdownCancelAllFuturesTask countdownCancelAllFuturesTask) throws ApiException { @@ -6787,9 +6787,9 @@ public ApiResponse countdownCancelAllFuturesWithHttpInfo(String set } /** - * Countdown cancel orders. (asynchronously) + * Countdown cancel orders (asynchronously) * 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 settle Settle currency (required) * @param countdownCancelAllFuturesTask (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -6797,7 +6797,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 { @@ -6876,7 +6876,7 @@ private APIgetFuturesFeeRequest(String settle) { /** * Set contract - * @param contract Futures contract, return related data only if specified. (optional) + * @param contract Futures contract, return related data only if specified (optional) * @return APIgetFuturesFeeRequest */ public APIgetFuturesFeeRequest contract(String contract) { @@ -6892,7 +6892,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 { @@ -6906,7 +6906,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 { @@ -6921,7 +6921,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 { @@ -6936,7 +6936,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 { @@ -6945,14 +6945,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _cal } /** - * Query user trading fee rates. + * Query futures market trading fee rates * - * @param settle Settle currency. (required) + * @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) { @@ -6961,7 +6961,7 @@ public APIgetFuturesFeeRequest getFuturesFee(String settle) { /** * Build call for cancelBatchFutureOrders - * @param settle Settle currency. (required) + * @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) * @param _callback Callback for upload/download progress @@ -6970,7 +6970,7 @@ public APIgetFuturesFeeRequest getFuturesFee(String settle) { * @http.response.details - +
    Status Code Description Response Headers
    200 Order cancellation operation completed. -
    200 Order cancellation operation completed -
    */ public okhttp3.Call cancelBatchFutureOrdersCall(String settle, List requestBody, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -7024,9 +7024,9 @@ private okhttp3.Call cancelBatchFutureOrdersValidateBeforeCall(String settle, Li } /** - * Cancel a batch of orders with an ID list. - * Multiple different order IDs can be specified. A maximum of 20 records. - * @param settle Settle currency. (required) + * 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) * @return List<FutureCancelOrderResult> @@ -7034,7 +7034,7 @@ private okhttp3.Call cancelBatchFutureOrdersValidateBeforeCall(String settle, Li * @http.response.details - +
    Status Code Description Response Headers
    200 Order cancellation operation completed. -
    200 Order cancellation operation completed -
    */ public List cancelBatchFutureOrders(String settle, List requestBody, String xGateExptime) throws ApiException { @@ -7043,9 +7043,9 @@ public List cancelBatchFutureOrders(String settle, List } /** - * Cancel a batch of orders with an ID list. - * Multiple different order IDs can be specified. A maximum of 20 records. - * @param settle Settle currency. (required) + * 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) * @return ApiResponse<List<FutureCancelOrderResult>> @@ -7053,7 +7053,7 @@ public List cancelBatchFutureOrders(String settle, List * @http.response.details - +
    Status Code Description Response Headers
    200 Order cancellation operation completed. -
    200 Order cancellation operation completed -
    */ public ApiResponse> cancelBatchFutureOrdersWithHttpInfo(String settle, List requestBody, String xGateExptime) throws ApiException { @@ -7063,9 +7063,9 @@ public ApiResponse> cancelBatchFutureOrdersWithHtt } /** - * Cancel a batch of orders with an ID list. (asynchronously) - * Multiple different order IDs can be specified. A maximum of 20 records. - * @param settle Settle currency. (required) + * 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) * @param _callback The callback to be executed when the API call finishes @@ -7074,7 +7074,7 @@ public ApiResponse> cancelBatchFutureOrdersWithHtt * @http.response.details - +
    Status Code Description Response Headers
    200 Order cancellation operation completed. -
    200 Order cancellation operation completed -
    */ public okhttp3.Call cancelBatchFutureOrdersAsync(String settle, List requestBody, String xGateExptime, final ApiCallback> _callback) throws ApiException { @@ -7086,7 +7086,7 @@ public okhttp3.Call cancelBatchFutureOrdersAsync(String settle, List req /** * Build call for amendBatchFutureOrders - * @param settle Settle currency. (required) + * @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) * @param _callback Callback for upload/download progress @@ -7095,7 +7095,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 { @@ -7149,9 +7149,9 @@ private okhttp3.Call amendBatchFutureOrdersValidateBeforeCall(String settle, Lis } /** - * Batch modify orders with specified IDs. - * Multiple different order IDs can be specified. A maximum of 10 orders can. - * @param settle Settle currency. (required) + * 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) * @return List<BatchFuturesOrder> @@ -7159,7 +7159,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 { @@ -7168,9 +7168,9 @@ 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 { @@ -7188,9 +7188,9 @@ public ApiResponse> amendBatchFutureOrdersWithHttpInfo(S } /** - * Batch modify orders with specified IDs. (asynchronously) - * Multiple different order IDs can be specified. A maximum of 10 orders can. - * @param settle Settle currency. (required) + * 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) * @param _callback The callback to be executed when the API call finishes @@ -7199,7 +7199,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 { @@ -7211,15 +7211,15 @@ public okhttp3.Call amendBatchFutureOrdersAsync(String settle, List Status Code Description Response Headers - 200 Successfully retrieved. - + 200 Query successful - */ public okhttp3.Call getFuturesRiskLimitTableCall(String settle, String tableId, final ApiCallback _callback) throws ApiException { @@ -7273,16 +7273,16 @@ private okhttp3.Call getFuturesRiskLimitTableValidateBeforeCall(String settle, S } /** - * Query risk limit table by table_id. - * Just pass table_id. - * @param settle Settle currency. (required) - * @param tableId Risk limit table ID. (required) + * 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 Successfully retrieved. -
    200 Query successful -
    */ public List getFuturesRiskLimitTable(String settle, String tableId) throws ApiException { @@ -7291,16 +7291,16 @@ public List getFuturesRiskLimitTable(String settle, String } /** - * Query risk limit table by table_id. - * Just pass table_id. - * @param settle Settle currency. (required) - * @param tableId Risk limit table ID. (required) + * 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 Successfully retrieved. -
    200 Query successful -
    */ public ApiResponse> getFuturesRiskLimitTableWithHttpInfo(String settle, String tableId) throws ApiException { @@ -7310,17 +7310,17 @@ public ApiResponse> getFuturesRiskLimitTableWithHttpI } /** - * Query risk limit table by table_id. (asynchronously) - * Just pass table_id. - * @param settle Settle currency. (required) - * @param tableId Risk limit table ID. (required) + * 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 Successfully retrieved. -
    200 Query successful -
    */ public okhttp3.Call getFuturesRiskLimitTableAsync(String settle, String tableId, final ApiCallback> _callback) throws ApiException { @@ -7420,7 +7420,7 @@ private APIlistPriceTriggeredOrdersRequest(String settle, String status) { /** * Set contract - * @param contract Futures contract, return related data only if specified. (optional) + * @param contract Futures contract, return related data only if specified (optional) * @return APIlistPriceTriggeredOrdersRequest */ public APIlistPriceTriggeredOrdersRequest contract(String contract) { @@ -7430,7 +7430,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) { @@ -7440,7 +7440,7 @@ public APIlistPriceTriggeredOrdersRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistPriceTriggeredOrdersRequest */ public APIlistPriceTriggeredOrdersRequest offset(Integer offset) { @@ -7456,7 +7456,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 { @@ -7470,7 +7470,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 { @@ -7485,7 +7485,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 { @@ -7500,7 +7500,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 { @@ -7509,15 +7509,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) { @@ -7526,7 +7526,7 @@ public APIlistPriceTriggeredOrdersRequest listPriceTriggeredOrders(String settle /** * Build call for createPriceTriggeredOrder - * @param settle Settle currency. (required) + * @param settle Settle currency (required) * @param futuresPriceTriggeredOrder (required) * @param _callback Callback for upload/download progress * @return Call to execute @@ -7534,7 +7534,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 { @@ -7584,16 +7584,16 @@ private okhttp3.Call createPriceTriggeredOrderValidateBeforeCall(String settle, } /** - * Create a price-triggered order. + * Create price-triggered order * - * @param settle Settle currency. (required) + * @param settle Settle currency (required) * @param futuresPriceTriggeredOrder (required) * @return TriggerOrderResponse * @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 TriggerOrderResponse createPriceTriggeredOrder(String settle, FuturesPriceTriggeredOrder futuresPriceTriggeredOrder) throws ApiException { @@ -7602,16 +7602,16 @@ public TriggerOrderResponse createPriceTriggeredOrder(String settle, FuturesPric } /** - * Create a price-triggered order. + * Create price-triggered order * - * @param settle Settle currency. (required) + * @param settle Settle currency (required) * @param futuresPriceTriggeredOrder (required) * @return ApiResponse<TriggerOrderResponse> * @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 createPriceTriggeredOrderWithHttpInfo(String settle, FuturesPriceTriggeredOrder futuresPriceTriggeredOrder) throws ApiException { @@ -7621,9 +7621,9 @@ public ApiResponse createPriceTriggeredOrderWithHttpInfo(S } /** - * Create a price-triggered order. (asynchronously) + * Create price-triggered order (asynchronously) * - * @param settle Settle currency. (required) + * @param settle Settle currency (required) * @param futuresPriceTriggeredOrder (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -7631,7 +7631,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 { @@ -7643,15 +7643,15 @@ public okhttp3.Call createPriceTriggeredOrderAsync(String settle, FuturesPriceTr /** * Build call for cancelPriceTriggeredOrderList - * @param settle Settle currency. (required) - * @param contract Futures contract, return related data only if specified. (optional) + * @param settle Settle currency (required) + * @param contract Futures contract, return related data only if 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 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 { @@ -7700,16 +7700,16 @@ 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) + * @param settle Settle currency (required) + * @param contract Futures contract, return related data only if specified (optional) * @return List<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 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 { @@ -7718,16 +7718,16 @@ 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) + * @param settle Settle currency (required) + * @param contract Futures contract, return related data only if specified (optional) * @return ApiResponse<List<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 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 { @@ -7737,17 +7737,17 @@ 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) + * @param settle Settle currency (required) + * @param contract Futures contract, return related data only if 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 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 { @@ -7759,15 +7759,15 @@ 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 settle Settle currency (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 { @@ -7818,16 +7818,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 settle Settle currency (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 { @@ -7836,16 +7836,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 settle Settle currency (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 { @@ -7855,17 +7855,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 settle Settle currency (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 { @@ -7877,15 +7877,15 @@ 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 settle Settle currency (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 { @@ -7936,16 +7936,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 settle Settle currency (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 { @@ -7954,16 +7954,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 settle Settle currency (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 { @@ -7973,17 +7973,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 settle Settle currency (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 9507541..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -116,7 +116,7 @@ private APIlistMarginAccountsRequest() { /** * Set currencyPair - * @param currencyPair Currency pair. (optional) + * @param currencyPair Currency pair (optional) * @return APIlistMarginAccountsRequest */ public APIlistMarginAccountsRequest currencyPair(String currencyPair) { @@ -132,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 { @@ -146,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 { @@ -161,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 { @@ -176,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 { @@ -185,13 +185,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callbac } /** - * Margin account list. + * Margin account list * * @return APIlistMarginAccountsRequest * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved. -
    200 List retrieved successfully -
    */ public APIlistMarginAccountsRequest listMarginAccounts() { @@ -289,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) { @@ -299,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) { @@ -309,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) { @@ -319,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) { @@ -329,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) { @@ -339,7 +339,7 @@ public APIlistMarginAccountBookRequest to(Long to) { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistMarginAccountBookRequest */ public APIlistMarginAccountBookRequest page(Integer page) { @@ -349,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) { @@ -365,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 { @@ -379,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 { @@ -394,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 { @@ -409,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 { @@ -418,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() { @@ -492,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) { @@ -508,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 { @@ -522,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 { @@ -537,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 { @@ -552,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 { @@ -561,13 +561,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callba } /** - * Funding account list. + * Funding account list * * @return APIlistFundingAccountsRequest * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved. -
    200 List retrieved successfully -
    */ public APIlistFundingAccountsRequest listFundingAccounts() { @@ -582,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 { @@ -621,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 { @@ -637,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 { @@ -654,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 @@ -662,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 { @@ -674,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 { @@ -729,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 { @@ -746,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 { @@ -764,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 { @@ -855,7 +855,7 @@ private APIgetMarginTransferableRequest(String currency) { /** * Set currencyPair - * @param currencyPair Currency pair. (optional) + * @param currencyPair Currency pair (optional) * @return APIgetMarginTransferableRequest */ public APIgetMarginTransferableRequest currencyPair(String currencyPair) { @@ -871,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 { @@ -885,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 { @@ -900,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 { @@ -915,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 { @@ -924,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) { @@ -940,14 +940,14 @@ public APIgetMarginTransferableRequest getMarginTransferable(String currency) { /** * Build call for getUserMarginTier - * @param currencyPair Currency pair. (required) + * @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 -
    */ public okhttp3.Call getUserMarginTierCall(String currencyPair, final ApiCallback _callback) throws ApiException { @@ -995,15 +995,15 @@ private okhttp3.Call getUserMarginTierValidateBeforeCall(String currencyPair, fi } /** - * Check the user's own leverage lending gradient in the current market. + * Query user's own leverage lending tiers in current market * - * @param currencyPair Currency pair. (required) + * @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 -
    */ public List getUserMarginTier(String currencyPair) throws ApiException { @@ -1012,15 +1012,15 @@ public List getUserMarginTier(String currencyPair) throws Ap } /** - * Check the user's own leverage lending gradient in the current market. + * Query user's own leverage lending tiers in current market * - * @param currencyPair Currency pair. (required) + * @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 -
    */ public ApiResponse> getUserMarginTierWithHttpInfo(String currencyPair) throws ApiException { @@ -1030,16 +1030,16 @@ public ApiResponse> getUserMarginTierWithHttpInfo(Strin } /** - * Check the user's own leverage lending gradient in the current market. (asynchronously) + * Query user's own leverage lending tiers in current market (asynchronously) * - * @param currencyPair Currency pair. (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 -
    */ public okhttp3.Call getUserMarginTierAsync(String currencyPair, final ApiCallback> _callback) throws ApiException { @@ -1051,14 +1051,14 @@ public okhttp3.Call getUserMarginTierAsync(String currencyPair, final ApiCallbac /** * Build call for getMarketMarginTier - * @param currencyPair Currency pair. (required) + * @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 -
    */ public okhttp3.Call getMarketMarginTierCall(String currencyPair, final ApiCallback _callback) throws ApiException { @@ -1106,15 +1106,15 @@ private okhttp3.Call getMarketMarginTierValidateBeforeCall(String currencyPair, } /** - * Query the current market leverage lending gradient. + * Query current market leverage lending tiers * - * @param currencyPair Currency pair. (required) + * @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 -
    */ public List getMarketMarginTier(String currencyPair) throws ApiException { @@ -1123,15 +1123,15 @@ public List getMarketMarginTier(String currencyPair) throws } /** - * Query the current market leverage lending gradient. + * Query current market leverage lending tiers * - * @param currencyPair Currency pair. (required) + * @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 -
    */ public ApiResponse> getMarketMarginTierWithHttpInfo(String currencyPair) throws ApiException { @@ -1141,16 +1141,16 @@ public ApiResponse> getMarketMarginTierWithHttpInfo(Str } /** - * Query the current market leverage lending gradient. (asynchronously) + * Query current market leverage lending tiers (asynchronously) * - * @param currencyPair Currency pair. (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 -
    */ public okhttp3.Call getMarketMarginTierAsync(String currencyPair, final ApiCallback> _callback) throws ApiException { @@ -1169,7 +1169,7 @@ public okhttp3.Call getMarketMarginTierAsync(String currencyPair, final ApiCallb * @http.response.details - +
    Status Code Description Response Headers
    204 Success. -
    204 Set successfully -
    */ public okhttp3.Call setUserMarketLeverageCall(MarginMarketLeverage marginMarketLeverage, final ApiCallback _callback) throws ApiException { @@ -1213,14 +1213,14 @@ private okhttp3.Call setUserMarketLeverageValidateBeforeCall(MarginMarketLeverag } /** - * Set the user market leverage multiple. + * Set user market leverage multiplier * * @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. -
    204 Set successfully -
    */ public void setUserMarketLeverage(MarginMarketLeverage marginMarketLeverage) throws ApiException { @@ -1228,7 +1228,7 @@ public void setUserMarketLeverage(MarginMarketLeverage marginMarketLeverage) thr } /** - * Set the user market leverage multiple. + * Set user market leverage multiplier * * @param marginMarketLeverage (required) * @return ApiResponse<Void> @@ -1236,7 +1236,7 @@ public void setUserMarketLeverage(MarginMarketLeverage marginMarketLeverage) thr * @http.response.details - +
    Status Code Description Response Headers
    204 Success. -
    204 Set successfully -
    */ public ApiResponse setUserMarketLeverageWithHttpInfo(MarginMarketLeverage marginMarketLeverage) throws ApiException { @@ -1245,7 +1245,7 @@ public ApiResponse setUserMarketLeverageWithHttpInfo(MarginMarketLeverage } /** - * Set the user market leverage multiple. (asynchronously) + * Set user market leverage multiplier (asynchronously) * * @param marginMarketLeverage (required) * @param _callback The callback to be executed when the API call finishes @@ -1254,7 +1254,7 @@ public ApiResponse setUserMarketLeverageWithHttpInfo(MarginMarketLeverage * @http.response.details - +
    Status Code Description Response Headers
    204 Success. -
    204 Set successfully -
    */ public okhttp3.Call setUserMarketLeverageAsync(MarginMarketLeverage marginMarketLeverage, final ApiCallback _callback) throws ApiException { @@ -1324,7 +1324,7 @@ private APIlistMarginUserAccountRequest() { /** * Set currencyPair - * @param currencyPair Currency pair. (optional) + * @param currencyPair Currency pair (optional) * @return APIlistMarginUserAccountRequest */ public APIlistMarginUserAccountRequest currencyPair(String currencyPair) { @@ -1340,7 +1340,7 @@ public APIlistMarginUserAccountRequest 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 { @@ -1354,7 +1354,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 { @@ -1369,7 +1369,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 { @@ -1384,7 +1384,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 { @@ -1393,13 +1393,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callbac } /** - * Query the user's leverage account list. - * Support querying risk rate per position account and margin rate per position account + * 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 -
    */ public APIlistMarginUserAccountRequest listMarginUserAccount() { @@ -1494,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) { @@ -1504,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) { @@ -1514,7 +1514,7 @@ public APIlistCrossMarginLoansRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistCrossMarginLoansRequest */ public APIlistCrossMarginLoansRequest offset(Integer offset) { @@ -1540,7 +1540,7 @@ public APIlistCrossMarginLoansRequest reverse(Boolean reverse) { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved. -
    200 Query successful -
    * @deprecated */ @@ -1556,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 */ @@ -1573,7 +1573,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved. -
    200 Query successful -
    * @deprecated */ @@ -1590,7 +1590,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExcept * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved. -
    200 Query successful -
    * @deprecated */ @@ -1601,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. - * @param status Filter by status. Supported values are 2 and 3. (deprecated.). (required) + * 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 */ @@ -1719,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) { @@ -1729,7 +1729,7 @@ public APIlistCrossMarginRepaymentsRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistCrossMarginRepaymentsRequest */ public APIlistCrossMarginRepaymentsRequest offset(Integer offset) { @@ -1755,7 +1755,7 @@ public APIlistCrossMarginRepaymentsRequest reverse(Boolean reverse) { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved. -
    200 List retrieved successfully -
    * @deprecated */ @@ -1771,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 */ @@ -1788,7 +1788,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved. -
    200 List retrieved successfully -
    * @deprecated */ @@ -1805,7 +1805,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiE * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved. -
    200 List retrieved successfully -
    * @deprecated */ @@ -1816,13 +1816,13 @@ 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. + * Retrieve cross margin repayments. (deprecated) + * 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 */ diff --git a/src/main/java/io/gate/gateapi/api/MarginUniApi.java b/src/main/java/io/gate/gateapi/api/MarginUniApi.java index 7af17f7..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 { @@ -99,14 +99,14 @@ private okhttp3.Call listUniCurrencyPairsValidateBeforeCall(final ApiCallback _c } /** - * List lending markets. + * List lending markets * * @return List<UniCurrencyPair> * @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 listUniCurrencyPairs() throws ApiException { @@ -115,14 +115,14 @@ public List listUniCurrencyPairs() throws ApiException { } /** - * List lending markets. + * List lending markets * * @return ApiResponse<List<UniCurrencyPair>> * @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> listUniCurrencyPairsWithHttpInfo() throws ApiException { @@ -132,7 +132,7 @@ public ApiResponse> listUniCurrencyPairsWithHttpInfo() thr } /** - * List lending markets. (asynchronously) + * List lending markets (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -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 { @@ -152,14 +152,14 @@ 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,15 +204,15 @@ private okhttp3.Call getUniCurrencyPairValidateBeforeCall(String currencyPair, f } /** - * Get detail of lending market. + * Get lending market details * - * @param currencyPair Currency pair. (required) + * @param currencyPair Currency pair (required) * @return UniCurrencyPair * @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 UniCurrencyPair getUniCurrencyPair(String currencyPair) throws ApiException { @@ -221,15 +221,15 @@ public UniCurrencyPair getUniCurrencyPair(String currencyPair) throws ApiExcepti } /** - * Get detail of lending market. + * Get lending market details * - * @param currencyPair Currency pair. (required) + * @param currencyPair Currency pair (required) * @return ApiResponse<UniCurrencyPair> * @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 getUniCurrencyPairWithHttpInfo(String currencyPair) throws ApiException { @@ -239,16 +239,16 @@ public ApiResponse getUniCurrencyPairWithHttpInfo(String curren } /** - * Get detail of lending market. (asynchronously) + * Get lending market details (asynchronously) * - * @param currencyPair Currency pair. (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 -
    */ 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 { @@ -445,7 +445,7 @@ private APIlistUniLoansRequest() { /** * Set currencyPair - * @param currencyPair Currency pair. (optional) + * @param currencyPair Currency pair (optional) * @return APIlistUniLoansRequest */ public APIlistUniLoansRequest currencyPair(String currencyPair) { @@ -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) { @@ -465,7 +465,7 @@ public APIlistUniLoansRequest currency(String currency) { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistUniLoansRequest */ public APIlistUniLoansRequest page(Integer page) { @@ -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 { @@ -610,14 +610,14 @@ private okhttp3.Call createUniLoanValidateBeforeCall(CreateUniLoan createUniLoan } /** - * Borrow or repay. + * Borrow or repay * * @param createUniLoan (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 createUniLoan(CreateUniLoan createUniLoan) throws ApiException { @@ -625,7 +625,7 @@ public void createUniLoan(CreateUniLoan createUniLoan) throws ApiException { } /** - * Borrow or repay. + * Borrow or repay * * @param createUniLoan (required) * @return ApiResponse<Void> @@ -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 { @@ -642,7 +642,7 @@ public ApiResponse createUniLoanWithHttpInfo(CreateUniLoan createUniLoan) } /** - * Borrow or repay. (asynchronously) + * Borrow or repay (asynchronously) * * @param createUniLoan (required) * @param _callback The callback to be executed when the API call finishes @@ -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) { @@ -761,7 +761,7 @@ public APIlistUniLoanRecordsRequest currency(String currency) { /** * Set currencyPair - * @param currencyPair Currency pair. (optional) + * @param currencyPair Currency pair (optional) * @return APIlistUniLoanRecordsRequest */ public APIlistUniLoanRecordsRequest currencyPair(String currencyPair) { @@ -771,7 +771,7 @@ public APIlistUniLoanRecordsRequest currencyPair(String currencyPair) { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistUniLoanRecordsRequest */ public APIlistUniLoanRecordsRequest page(Integer page) { @@ -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() { @@ -949,7 +949,7 @@ private APIlistUniLoanInterestRecordsRequest() { /** * Set currencyPair - * @param currencyPair Currency pair. (optional) + * @param currencyPair Currency pair (optional) * @return APIlistUniLoanInterestRecordsRequest */ public APIlistUniLoanInterestRecordsRequest currencyPair(String currencyPair) { @@ -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) { @@ -969,7 +969,7 @@ public APIlistUniLoanInterestRecordsRequest currency(String currency) { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistUniLoanInterestRecordsRequest */ public APIlistUniLoanInterestRecordsRequest page(Integer page) { @@ -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) { @@ -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,15 +1083,15 @@ public APIlistUniLoanInterestRecordsRequest listUniLoanInterestRecords() { /** * Build call for getUniBorrowable - * @param currency Retrieve data of the specified currency. (required) - * @param currencyPair Currency pair. (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 * @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 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 currencyPair Currency pair. (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 currencyPair Currency pair. (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,17 +1185,17 @@ 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 currencyPair Currency pair. (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 * @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 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 0faf990..c9e4270 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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -136,7 +136,7 @@ private APIlistMultiCollateralOrdersRequest() { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistMultiCollateralOrdersRequest */ public APIlistMultiCollateralOrdersRequest page(Integer page) { @@ -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 Query the current interest rate of the currency in the previous hour. (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, defaults to current orders if not specified (optional) + * @param orderType Order type: current - Query current orders, fixed - Query fixed orders, defaults to current orders if not specifiedOrder 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 { @@ -555,7 +555,7 @@ private APIlistMultiRepayRecordsRequest(String type) { /** * Set borrowCurrency - * @param borrowCurrency Borrowed currency. (optional) + * @param borrowCurrency Borrowed currency (optional) * @return APIlistMultiRepayRecordsRequest */ public APIlistMultiRepayRecordsRequest borrowCurrency(String borrowCurrency) { @@ -565,7 +565,7 @@ public APIlistMultiRepayRecordsRequest borrowCurrency(String borrowCurrency) { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistMultiRepayRecordsRequest */ public APIlistMultiRepayRecordsRequest page(Integer page) { @@ -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) + * @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 { @@ -866,7 +866,7 @@ private APIlistMultiCollateralRecordsRequest() { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistMultiCollateralRecordsRequest */ public APIlistMultiCollateralRecordsRequest page(Integer page) { @@ -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 { @@ -975,13 +975,13 @@ public okhttp3.Call executeAsync(final ApiCallback> } /** - * Query collateral adjustment records. + * Query collateral adjustment records * * @return APIlistMultiCollateralRecordsRequest * @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 type: collateral - Collateral currency, borrow - Borrowing. (required) - * @param currency When it is a collateral currency, multiple currencies can be passed separated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one commas; when it is a borrowing currency, only one currency can be passed (required) + * @param 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 type: collateral - Collateral currency, borrow - Borrowing. (required) - * @param currency When it is a collateral currency, multiple currencies can be passed separated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one commas; when it is a borrowing currency, only one currency can be passed (required) + * @param 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 type: collateral - Collateral currency, borrow - Borrowing. (required) - * @param currency When it is a collateral currency, multiple currencies can be passed separated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one commas; when it is a borrowing currency, only one currency can be passed (required) + * @param 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 type: collateral - Collateral currency, borrow - Borrowing. (required) - * @param currency When it is a collateral currency, multiple currencies can be passed separated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one currency can be passedseparated by commas; when it is a borrowing currency, only one commas; when it is a borrowing currency, only one currency can be passed (required) + * @param 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 previous hour. - * @param currencies Specify currency name query array, separated by commas, maximum 100items. (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 76972a4..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 { @@ -166,14 +166,14 @@ 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,15 +221,15 @@ private okhttp3.Call listOptionsExpirationsValidateBeforeCall(String underlying, } /** - * List all expiration times. + * List all expiration dates * - * @param underlying Underlying (Obtained by listing underlying endpoint). (required) + * @param underlying Underlying (Obtained by listing underlying endpoint) (required) * @return List<Long> * @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 expiration times of specified underlying. -
    200 List expiration dates for specified underlying -
    */ public List listOptionsExpirations(String underlying) throws ApiException { @@ -238,15 +238,15 @@ public List listOptionsExpirations(String underlying) throws ApiException } /** - * List all expiration times. + * List all expiration dates * - * @param underlying Underlying (Obtained by listing underlying endpoint). (required) + * @param underlying Underlying (Obtained by listing underlying endpoint) (required) * @return ApiResponse<List<Long>> * @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 expiration times of specified underlying. -
    200 List expiration dates for specified underlying -
    */ public ApiResponse> listOptionsExpirationsWithHttpInfo(String underlying) throws ApiException { @@ -256,16 +256,16 @@ 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 underlying Underlying (Obtained by listing underlying endpoint) (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 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) + * @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) { @@ -635,7 +635,7 @@ public APIlistOptionsSettlementsRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistOptionsSettlementsRequest */ public APIlistOptionsSettlementsRequest offset(Integer offset) { @@ -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 { @@ -724,14 +724,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _cal } /** - * List settlement history. + * List settlement history * - * @param underlying Underlying (Obtained by listing underlying endpoint). (required) + * @param underlying Underlying (Obtained by listing underlying endpoint) (required) * @return APIlistOptionsSettlementsRequest * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved. -
    200 List retrieved successfully -
    */ public APIlistOptionsSettlementsRequest listOptionsSettlements(String underlying) { @@ -741,7 +741,7 @@ public APIlistOptionsSettlementsRequest listOptionsSettlements(String underlying /** * Build call for getOptionsSettlement * @param contract (required) - * @param underlying Underlying (Obtained by listing underlying endpoint). (required) + * @param underlying Underlying (Obtained by listing underlying endpoint) (required) * @param at (required) * @param _callback Callback for upload/download progress * @return Call to execute @@ -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,17 +812,17 @@ 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) + * @param underlying Underlying (Obtained by listing underlying endpoint) (required) * @param at (required) * @return OptionsSettlement * @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 OptionsSettlement getOptionsSettlement(String contract, String underlying, Long at) throws ApiException { @@ -831,17 +831,17 @@ 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) + * @param underlying Underlying (Obtained by listing underlying endpoint) (required) * @param at (required) * @return ApiResponse<OptionsSettlement> * @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 getOptionsSettlementWithHttpInfo(String contract, String underlying, Long at) throws ApiException { @@ -851,10 +851,10 @@ 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) + * @param underlying Underlying (Obtained by listing underlying endpoint) (required) * @param at (required) * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -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 { @@ -964,7 +964,7 @@ private APIlistMyOptionsSettlementsRequest(String underlying) { /** * Set contract - * @param contract Options contract name. (optional) + * @param contract Options contract name (optional) * @return APIlistMyOptionsSettlementsRequest */ public APIlistMyOptionsSettlementsRequest contract(String contract) { @@ -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) { @@ -984,7 +984,7 @@ public APIlistMyOptionsSettlementsRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistMyOptionsSettlementsRequest */ public APIlistMyOptionsSettlementsRequest offset(Integer offset) { @@ -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) + * @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 to return depth update ID. This ID increments by 1 each time. (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 Depth query successful. -
    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 Depth query successful. -
    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 Depth query successful. -
    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 Depth query successful. -
    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. - * Bids will be sorted by price from high to low, while asks sorted reversely. - * @param contract Options contract name. (required) + * 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 Depth query successful. -
    200 Depth query successful -
    */ public APIlistOptionsOrderBookRequest listOptionsOrderBook(String contract) { @@ -1274,14 +1274,14 @@ public APIlistOptionsOrderBookRequest listOptionsOrderBook(String contract) { /** * Build call for listOptionsTickers - * @param underlying Underlying (Obtained by listing underlying endpoint). (required) + * @param underlying Underlying (Obtained by listing underlying endpoint) (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 listOptionsTickersCall(String underlying, final ApiCallback _callback) throws ApiException { @@ -1329,15 +1329,15 @@ 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) + * @param underlying Underlying (Obtained by listing underlying endpoint) (required) * @return List<OptionsTicker> * @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 listOptionsTickers(String underlying) throws ApiException { @@ -1346,15 +1346,15 @@ 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) + * @param underlying Underlying (Obtained by listing underlying endpoint) (required) * @return ApiResponse<List<OptionsTicker>> * @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> listOptionsTickersWithHttpInfo(String underlying) throws ApiException { @@ -1364,16 +1364,16 @@ 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 underlying Underlying (Obtained by listing underlying endpoint) (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 listOptionsTickersAsync(String underlying, final ApiCallback> _callback) throws ApiException { @@ -1385,14 +1385,14 @@ public okhttp3.Call listOptionsTickersAsync(String underlying, final ApiCallback /** * Build call for listOptionsUnderlyingTickers - * @param underlying Underlying. (required) + * @param underlying Underlying (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 listOptionsUnderlyingTickersCall(String underlying, final ApiCallback _callback) throws ApiException { @@ -1437,15 +1437,15 @@ private okhttp3.Call listOptionsUnderlyingTickersValidateBeforeCall(String under } /** - * Get underlying ticker. + * Query underlying ticker information * - * @param underlying Underlying. (required) + * @param underlying Underlying (required) * @return OptionsUnderlyingTicker * @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 OptionsUnderlyingTicker listOptionsUnderlyingTickers(String underlying) throws ApiException { @@ -1454,15 +1454,15 @@ public OptionsUnderlyingTicker listOptionsUnderlyingTickers(String underlying) t } /** - * Get underlying ticker. + * Query underlying ticker information * - * @param underlying Underlying. (required) + * @param underlying Underlying (required) * @return ApiResponse<OptionsUnderlyingTicker> * @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 listOptionsUnderlyingTickersWithHttpInfo(String underlying) throws ApiException { @@ -1472,16 +1472,16 @@ public ApiResponse listOptionsUnderlyingTickersWithHttp } /** - * Get underlying ticker. (asynchronously) + * Query underlying ticker information (asynchronously) * - * @param underlying Underlying. (required) + * @param underlying Underlying (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 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) { @@ -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) + * @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) { @@ -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) + * @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) { @@ -1977,7 +1977,7 @@ private APIlistOptionsTradesRequest() { /** * Set contract - * @param contract Options contract name. (optional) + * @param contract Options contract name (optional) * @return APIlistOptionsTradesRequest */ public APIlistOptionsTradesRequest contract(String contract) { @@ -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) { @@ -2007,7 +2007,7 @@ public APIlistOptionsTradesRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistOptionsTradesRequest */ public APIlistOptionsTradesRequest offset(Integer offset) { @@ -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) { @@ -2298,7 +2298,7 @@ public APIlistOptionsAccountBookRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistOptionsAccountBookRequest */ public APIlistOptionsAccountBookRequest offset(Integer offset) { @@ -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() { @@ -2471,7 +2471,7 @@ private APIlistOptionsPositionsRequest() { /** * Set underlying - * @param underlying Underlying. (optional) + * @param underlying Underlying (optional) * @return APIlistOptionsPositionsRequest */ public APIlistOptionsPositionsRequest underlying(String underlying) { @@ -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 { @@ -2540,13 +2540,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callb } /** - * List user's positions of specified underlying. + * List user's positions of specified underlying * * @return APIlistOptionsPositionsRequest * @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 { @@ -2607,7 +2607,7 @@ private okhttp3.Call getOptionsPositionValidateBeforeCall(String contract, final } /** - * Get specified contract position. + * Get specified contract position * * @param contract (required) * @return OptionsPosition @@ -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 { @@ -2624,7 +2624,7 @@ public OptionsPosition getOptionsPosition(String contract) throws ApiException { } /** - * Get specified contract position. + * Get specified contract position * * @param contract (required) * @return ApiResponse<OptionsPosition> @@ -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 { @@ -2642,7 +2642,7 @@ public ApiResponse getOptionsPositionWithHttpInfo(String contra } /** - * Get specified contract position. (asynchronously) + * Get specified contract position (asynchronously) * * @param contract (required) * @param _callback The callback to be executed when the API call finishes @@ -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 { @@ -2733,7 +2733,7 @@ private APIlistOptionsPositionCloseRequest(String underlying) { /** * Set contract - * @param contract Options contract name. (optional) + * @param contract Options contract name (optional) * @return APIlistOptionsPositionCloseRequest */ public APIlistOptionsPositionCloseRequest contract(String contract) { @@ -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 { @@ -2802,14 +2802,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _ } /** - * List user's liquidation history of specified underlying. + * List user's liquidation history of specified underlying * - * @param underlying Underlying (Obtained by listing underlying endpoint). (required) + * @param underlying Underlying (Obtained by listing underlying endpoint) (required) * @return APIlistOptionsPositionCloseRequest * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved. -
    200 List retrieved successfully -
    */ public APIlistOptionsPositionCloseRequest listOptionsPositionClose(String underlying) { @@ -2913,7 +2913,7 @@ private APIlistOptionsOrdersRequest(String status) { /** * Set contract - * @param contract Options contract name. (optional) + * @param contract Options contract name (optional) * @return APIlistOptionsOrdersRequest */ public APIlistOptionsOrdersRequest contract(String contract) { @@ -2923,7 +2923,7 @@ public APIlistOptionsOrdersRequest contract(String contract) { /** * Set underlying - * @param underlying Underlying. (optional) + * @param underlying Underlying (optional) * @return APIlistOptionsOrdersRequest */ public APIlistOptionsOrdersRequest underlying(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) { @@ -2943,7 +2943,7 @@ public APIlistOptionsOrdersRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistOptionsOrdersRequest */ public APIlistOptionsOrdersRequest offset(Integer offset) { @@ -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 { @@ -3032,14 +3032,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * List options orders. + * 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) { @@ -3055,7 +3055,7 @@ public APIlistOptionsOrdersRequest listOptionsOrders(String status) { * @http.response.details - +
    Status Code Description Response Headers
    201 Order detail. -
    201 Order detail -
    */ public okhttp3.Call createOptionsOrderCall(OptionsOrder optionsOrder, final ApiCallback _callback) throws ApiException { @@ -3099,7 +3099,7 @@ private okhttp3.Call createOptionsOrderValidateBeforeCall(OptionsOrder optionsOr } /** - * Create an options order. + * Create an options order * * @param optionsOrder (required) * @return OptionsOrder @@ -3107,7 +3107,7 @@ private okhttp3.Call createOptionsOrderValidateBeforeCall(OptionsOrder optionsOr * @http.response.details - +
    Status Code Description Response Headers
    201 Order detail. -
    201 Order detail -
    */ public OptionsOrder createOptionsOrder(OptionsOrder optionsOrder) throws ApiException { @@ -3116,7 +3116,7 @@ public OptionsOrder createOptionsOrder(OptionsOrder optionsOrder) throws ApiExce } /** - * Create an options order. + * Create an options order * * @param optionsOrder (required) * @return ApiResponse<OptionsOrder> @@ -3124,7 +3124,7 @@ public OptionsOrder createOptionsOrder(OptionsOrder optionsOrder) throws ApiExce * @http.response.details - +
    Status Code Description Response Headers
    201 Order detail. -
    201 Order detail -
    */ public ApiResponse createOptionsOrderWithHttpInfo(OptionsOrder optionsOrder) throws ApiException { @@ -3134,7 +3134,7 @@ public ApiResponse createOptionsOrderWithHttpInfo(OptionsOrder opt } /** - * Create an options order. (asynchronously) + * Create an options order (asynchronously) * * @param optionsOrder (required) * @param _callback The callback to be executed when the API call finishes @@ -3143,7 +3143,7 @@ public ApiResponse createOptionsOrderWithHttpInfo(OptionsOrder opt * @http.response.details - +
    Status Code Description Response Headers
    201 Order detail. -
    201 Order detail -
    */ public okhttp3.Call createOptionsOrderAsync(OptionsOrder optionsOrder, final ApiCallback _callback) throws ApiException { @@ -3155,16 +3155,16 @@ 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 contract Options contract name (optional) + * @param underlying Underlying (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 contract Options contract name (optional) + * @param underlying Underlying (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 contract Options contract name (optional) + * @param underlying Underlying (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 contract Options contract name (optional) + * @param underlying Underlying (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,14 +3277,14 @@ 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 * @http.response.details - +
    Status Code Description Response Headers
    200 Order detail. -
    200 Order detail -
    */ public okhttp3.Call getOptionsOrderCall(Long orderId, final ApiCallback _callback) throws ApiException { @@ -3329,15 +3329,15 @@ 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 - +
    Status Code Description Response Headers
    200 Order detail. -
    200 Order detail -
    */ public OptionsOrder getOptionsOrder(Long orderId) throws ApiException { @@ -3346,15 +3346,15 @@ 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 - +
    Status Code Description Response Headers
    200 Order detail. -
    200 Order detail -
    */ public ApiResponse getOptionsOrderWithHttpInfo(Long orderId) throws ApiException { @@ -3364,16 +3364,16 @@ 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 * @http.response.details - +
    Status Code Description Response Headers
    200 Order detail. -
    200 Order detail -
    */ public okhttp3.Call getOptionsOrderAsync(Long orderId, final ApiCallback _callback) throws ApiException { @@ -3385,14 +3385,14 @@ public okhttp3.Call getOptionsOrderAsync(Long orderId, final ApiCallback Status Code Description Response Headers - 200 Order detail. - + 200 Order detail - */ public okhttp3.Call cancelOptionsOrderCall(Long orderId, final ApiCallback _callback) throws ApiException { @@ -3437,15 +3437,15 @@ private okhttp3.Call cancelOptionsOrderValidateBeforeCall(Long orderId, final Ap } /** - * Cancel a single order. + * Cancel single order * - * @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 - +
    Status Code Description Response Headers
    200 Order detail. -
    200 Order detail -
    */ public OptionsOrder cancelOptionsOrder(Long orderId) throws ApiException { @@ -3454,15 +3454,15 @@ public OptionsOrder cancelOptionsOrder(Long orderId) throws ApiException { } /** - * Cancel a single order. + * Cancel single order * - * @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 - +
    Status Code Description Response Headers
    200 Order detail. -
    200 Order detail -
    */ public ApiResponse cancelOptionsOrderWithHttpInfo(Long orderId) throws ApiException { @@ -3472,16 +3472,16 @@ public ApiResponse 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 * @http.response.details - +
    Status Code Description Response Headers
    200 Order detail. -
    200 Order detail -
    */ public okhttp3.Call cancelOptionsOrderAsync(Long orderId, final ApiCallback _callback) throws ApiException { @@ -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 { @@ -3544,7 +3544,7 @@ private okhttp3.Call countdownCancelAllOptionsValidateBeforeCall(CountdownCancel } /** - * Countdown cancel orders. + * Countdown cancel orders * Option order heartbeat detection, when the `timeout` time set by the user is reached, if the existing countdown is not canceled or a new countdown is set, the related `option pending order` will be automatically canceled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at intervals of 30 seconds, with each countdown `timeout` set to 30 (seconds). If this interface is not called again within 30 seconds, all pending orders on the `underlying` `contract` you specified will be automatically cancelled. If `underlying` `contract` is not specified, user will be automatically cancelled If `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the automatic order cancellation function will be cancelled. * @param countdownCancelAllOptionsTask (required) * @return TriggerTime @@ -3552,7 +3552,7 @@ private okhttp3.Call countdownCancelAllOptionsValidateBeforeCall(CountdownCancel * @http.response.details - +
    Status Code Description Response Headers
    200 Set countdown successfully. -
    200 Countdown set successfully -
    */ public TriggerTime countdownCancelAllOptions(CountdownCancelAllOptionsTask countdownCancelAllOptionsTask) throws ApiException { @@ -3561,7 +3561,7 @@ public TriggerTime countdownCancelAllOptions(CountdownCancelAllOptionsTask count } /** - * Countdown cancel orders. + * Countdown cancel orders * Option order heartbeat detection, when the `timeout` time set by the user is reached, if the existing countdown is not canceled or a new countdown is set, the related `option pending order` will be automatically canceled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at intervals of 30 seconds, with each countdown `timeout` set to 30 (seconds). If this interface is not called again within 30 seconds, all pending orders on the `underlying` `contract` you specified will be automatically cancelled. If `underlying` `contract` is not specified, user will be automatically cancelled If `timeout` is set to 0 within 30 seconds, the countdown timer will expire and the automatic order cancellation function will be cancelled. * @param countdownCancelAllOptionsTask (required) * @return ApiResponse<TriggerTime> @@ -3569,7 +3569,7 @@ public TriggerTime countdownCancelAllOptions(CountdownCancelAllOptionsTask count * @http.response.details - +
    Status Code Description Response Headers
    200 Set countdown successfully. -
    200 Countdown set successfully -
    */ public ApiResponse countdownCancelAllOptionsWithHttpInfo(CountdownCancelAllOptionsTask countdownCancelAllOptionsTask) throws ApiException { @@ -3579,7 +3579,7 @@ public ApiResponse countdownCancelAllOptionsWithHttpInfo(CountdownC } /** - * Countdown cancel orders. (asynchronously) + * 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, 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 @@ -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 { @@ -3690,7 +3690,7 @@ private APIlistMyOptionsTradesRequest(String underlying) { /** * Set contract - * @param contract Options contract name. (optional) + * @param contract Options contract name (optional) * @return APIlistMyOptionsTradesRequest */ public APIlistMyOptionsTradesRequest contract(String contract) { @@ -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) { @@ -3710,7 +3710,7 @@ public APIlistMyOptionsTradesRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistMyOptionsTradesRequest */ public APIlistMyOptionsTradesRequest offset(Integer offset) { @@ -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) + * @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) { @@ -3874,7 +3874,7 @@ private APIgetOptionsMMPRequest() { /** * Set underlying - * @param underlying Underlying. (optional) + * @param underlying Underlying (optional) * @return APIgetOptionsMMPRequest */ public APIgetOptionsMMPRequest underlying(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 { @@ -3949,7 +3949,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) * @http.response.details - +
    Status Code Description Response Headers
    200 Successfully retrieved. -
    200 Query successful -
    */ public APIgetOptionsMMPRequest getOptionsMMP() { @@ -3965,7 +3965,7 @@ public APIgetOptionsMMPRequest getOptionsMMP() { * @http.response.details - +
    Status Code Description Response Headers
    200 MMP Information. -
    200 MMP Information -
    */ public okhttp3.Call setOptionsMMPCall(OptionsMMP optionsMMP, final ApiCallback _callback) throws ApiException { @@ -4017,7 +4017,7 @@ private okhttp3.Call setOptionsMMPValidateBeforeCall(OptionsMMP optionsMMP, fina * @http.response.details - +
    Status Code Description Response Headers
    200 MMP Information. -
    200 MMP Information -
    */ public OptionsMMP setOptionsMMP(OptionsMMP optionsMMP) throws ApiException { @@ -4034,7 +4034,7 @@ public OptionsMMP setOptionsMMP(OptionsMMP optionsMMP) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 MMP Information. -
    200 MMP Information -
    */ public ApiResponse setOptionsMMPWithHttpInfo(OptionsMMP optionsMMP) throws ApiException { @@ -4053,7 +4053,7 @@ public ApiResponse setOptionsMMPWithHttpInfo(OptionsMMP optionsMMP) * @http.response.details - +
    Status Code Description Response Headers
    200 MMP Information. -
    200 MMP Information -
    */ public okhttp3.Call setOptionsMMPAsync(OptionsMMP optionsMMP, final ApiCallback _callback) throws ApiException { @@ -4072,7 +4072,7 @@ public okhttp3.Call setOptionsMMPAsync(OptionsMMP optionsMMP, final ApiCallback< * @http.response.details - +
    Status Code Description Response Headers
    200 MMP Information. -
    200 MMP Information -
    */ public okhttp3.Call resetOptionsMMPCall(OptionsMMPReset optionsMMPReset, final ApiCallback _callback) throws ApiException { @@ -4124,7 +4124,7 @@ private okhttp3.Call resetOptionsMMPValidateBeforeCall(OptionsMMPReset optionsMM * @http.response.details - +
    Status Code Description Response Headers
    200 MMP Information. -
    200 MMP Information -
    */ public OptionsMMP resetOptionsMMP(OptionsMMPReset optionsMMPReset) throws ApiException { @@ -4141,7 +4141,7 @@ public OptionsMMP resetOptionsMMP(OptionsMMPReset optionsMMPReset) throws ApiExc * @http.response.details - +
    Status Code Description Response Headers
    200 MMP Information. -
    200 MMP Information -
    */ public ApiResponse resetOptionsMMPWithHttpInfo(OptionsMMPReset optionsMMPReset) throws ApiException { @@ -4160,7 +4160,7 @@ public ApiResponse resetOptionsMMPWithHttpInfo(OptionsMMPReset optio * @http.response.details - +
    Status Code Description Response Headers
    200 MMP Information. -
    200 MMP Information -
    */ public okhttp3.Call resetOptionsMMPAsync(OptionsMMPReset optionsMMPReset, final ApiCallback _callback) throws ApiException { diff --git a/src/main/java/io/gate/gateapi/api/RebateApi.java b/src/main/java/io/gate/gateapi/api/RebateApi.java index 591b747..69eb532 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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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) { @@ -151,7 +151,7 @@ public APIagencyTransactionHistoryRequest currencyPair(String currencyPair) { /** * Set userId - * @param userId User ID. If not specified, all user records will be returned. (optional) + * @param userId User ID. If not specified, all user records will be returned (optional) * @return APIagencyTransactionHistoryRequest */ public APIagencyTransactionHistoryRequest userId(Long userId) { @@ -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) { @@ -191,7 +191,7 @@ public APIagencyTransactionHistoryRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIagencyTransactionHistoryRequest */ public APIagencyTransactionHistoryRequest offset(Integer offset) { @@ -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,13 +260,13 @@ public okhttp3.Call executeAsync(final ApiCallback Status Code Description Response Headers - 200 List retrieved. - + 200 List retrieved successfully - */ public APIagencyTransactionHistoryRequest agencyTransactionHistory() { @@ -359,7 +359,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) { @@ -369,7 +369,7 @@ public APIagencyCommissionsHistoryRequest currency(String currency) { /** * Set userId - * @param userId User ID. If not specified, all user records will be returned. (optional) + * @param userId User ID. If not specified, all user records will be returned (optional) * @return APIagencyCommissionsHistoryRequest */ public APIagencyCommissionsHistoryRequest userId(Long userId) { @@ -379,7 +379,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 +389,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 +399,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) { @@ -409,7 +409,7 @@ public APIagencyCommissionsHistoryRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIagencyCommissionsHistoryRequest */ public APIagencyCommissionsHistoryRequest offset(Integer offset) { @@ -425,7 +425,7 @@ 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 { @@ -439,7 +439,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 { @@ -454,7 +454,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 { @@ -469,7 +469,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 { @@ -478,13 +478,13 @@ public okhttp3.Call executeAsync(final ApiCallback } /** - * 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 +577,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) { @@ -587,7 +587,7 @@ public APIpartnerTransactionHistoryRequest currencyPair(String currencyPair) { /** * Set userId - * @param userId User ID. If not specified, all user records will be returned. (optional) + * @param userId User ID. If not specified, all user records will be returned (optional) * @return APIpartnerTransactionHistoryRequest */ public APIpartnerTransactionHistoryRequest userId(Long userId) { @@ -597,7 +597,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 +607,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 +617,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) { @@ -627,7 +627,7 @@ public APIpartnerTransactionHistoryRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIpartnerTransactionHistoryRequest */ public APIpartnerTransactionHistoryRequest offset(Integer offset) { @@ -643,7 +643,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 +657,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 +672,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 +687,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 +696,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 +795,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) { @@ -805,7 +805,7 @@ public APIpartnerCommissionsHistoryRequest currency(String currency) { /** * Set userId - * @param userId User ID. If not specified, all user records will be returned. (optional) + * @param userId User ID. If not specified, all user records will be returned (optional) * @return APIpartnerCommissionsHistoryRequest */ public APIpartnerCommissionsHistoryRequest userId(Long userId) { @@ -815,7 +815,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 +825,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 +835,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) { @@ -845,7 +845,7 @@ public APIpartnerCommissionsHistoryRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIpartnerCommissionsHistoryRequest */ public APIpartnerCommissionsHistoryRequest offset(Integer offset) { @@ -861,7 +861,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 +875,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 +890,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 +905,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 +914,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() { @@ -998,7 +998,7 @@ private APIpartnerSubListRequest() { /** * Set userId - * @param userId User ID. If not specified, all user records will be returned. (optional) + * @param userId User ID. If not specified, all user records will be returned (optional) * @return APIpartnerSubListRequest */ public APIpartnerSubListRequest userId(Long userId) { @@ -1008,7 +1008,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) { @@ -1018,7 +1018,7 @@ public APIpartnerSubListRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIpartnerSubListRequest */ public APIpartnerSubListRequest offset(Integer offset) { @@ -1034,7 +1034,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 +1048,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 +1063,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 +1078,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 { @@ -1087,13 +1087,13 @@ public okhttp3.Call executeAsync(final ApiCallback _callback) th } /** - * Partner subordinate list. - * Including sub-agents, direct customers, indirect customers. + * Partner subordinate list + * 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 +1181,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) { @@ -1191,7 +1191,7 @@ public APIrebateBrokerCommissionHistoryRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIrebateBrokerCommissionHistoryRequest */ public APIrebateBrokerCommissionHistoryRequest offset(Integer offset) { @@ -1201,7 +1201,7 @@ public APIrebateBrokerCommissionHistoryRequest offset(Integer offset) { /** * Set userId - * @param userId User ID. If not specified, all user records will be returned. (optional) + * @param userId User ID. If not specified, all user records will be returned (optional) * @return APIrebateBrokerCommissionHistoryRequest */ public APIrebateBrokerCommissionHistoryRequest userId(Long userId) { @@ -1211,7 +1211,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 +1221,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 +1237,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 +1251,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 +1266,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 +1281,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 +1290,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 +1384,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) { @@ -1394,7 +1394,7 @@ public APIrebateBrokerTransactionHistoryRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIrebateBrokerTransactionHistoryRequest */ public APIrebateBrokerTransactionHistoryRequest offset(Integer offset) { @@ -1404,7 +1404,7 @@ public APIrebateBrokerTransactionHistoryRequest offset(Integer offset) { /** * Set userId - * @param userId User ID. If not specified, all user records will be returned. (optional) + * @param userId User ID. If not specified, all user records will be returned (optional) * @return APIrebateBrokerTransactionHistoryRequest */ public APIrebateBrokerTransactionHistoryRequest userId(Long userId) { @@ -1414,7 +1414,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 +1424,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 +1440,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 +1454,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 +1469,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 +1484,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 +1493,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 +1514,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 +1553,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 +1569,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 +1586,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 +1594,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 +1606,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 +1661,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 +1678,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 +1696,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 a9a50f0..1b54e32 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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 { @@ -169,14 +169,14 @@ public okhttp3.Call listCurrenciesAsync(final ApiCallback> _callb /** * Build call for getCurrency - * @param currency Currency name. (required) + * @param currency 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 getCurrencyCall(String currency, final ApiCallback _callback) throws ApiException { @@ -221,15 +221,15 @@ private okhttp3.Call getCurrencyValidateBeforeCall(String currency, final ApiCal } /** - * Get details of a specific currency. + * Query single currency information * - * @param currency Currency name. (required) + * @param currency Currency name (required) * @return 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 Successfully retrieved. -
    200 Query successful -
    */ public Currency getCurrency(String currency) throws ApiException { @@ -238,15 +238,15 @@ public Currency getCurrency(String currency) throws ApiException { } /** - * Get details of a specific currency. + * Query single currency information * - * @param currency Currency name. (required) + * @param currency Currency name (required) * @return ApiResponse<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 Successfully retrieved. -
    200 Query successful -
    */ public ApiResponse getCurrencyWithHttpInfo(String currency) throws ApiException { @@ -256,16 +256,16 @@ 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 currency 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 getCurrencyAsync(String currency, final ApiCallback _callback) throws ApiException { @@ -283,7 +283,7 @@ public okhttp3.Call getCurrencyAsync(String currency, final ApiCallback Status Code Description Response Headers - 200 All currency pairs retrieved. - + 200 All currency pairs retrieved - */ public okhttp3.Call listCurrencyPairsCall(final ApiCallback _callback) throws ApiException { @@ -322,14 +322,14 @@ 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 * @http.response.details - +
    Status Code Description Response Headers
    200 All currency pairs retrieved. -
    200 All currency pairs retrieved -
    */ public List listCurrencyPairs() throws ApiException { @@ -338,14 +338,14 @@ 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 * @http.response.details - +
    Status Code Description Response Headers
    200 All currency pairs retrieved. -
    200 All currency pairs retrieved -
    */ public ApiResponse> listCurrencyPairsWithHttpInfo() throws ApiException { @@ -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 @@ -363,7 +363,7 @@ public ApiResponse> listCurrencyPairsWithHttpInfo() throws Ap * @http.response.details - +
    Status Code Description Response Headers
    200 All currency pairs retrieved. -
    200 All currency pairs retrieved -
    */ public okhttp3.Call listCurrencyPairsAsync(final ApiCallback> _callback) throws ApiException { @@ -375,14 +375,14 @@ public okhttp3.Call listCurrencyPairsAsync(final ApiCallback> /** * Build call for getCurrencyPair - * @param currencyPair Currency pair. (required) + * @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 -
    */ public okhttp3.Call getCurrencyPairCall(String currencyPair, final ApiCallback _callback) throws ApiException { @@ -427,15 +427,15 @@ private okhttp3.Call getCurrencyPairValidateBeforeCall(String currencyPair, fina } /** - * Get details of a specifc currency pair. + * Query single currency pair details * - * @param currencyPair Currency pair. (required) + * @param currencyPair Currency pair (required) * @return CurrencyPair * @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 CurrencyPair getCurrencyPair(String currencyPair) throws ApiException { @@ -444,15 +444,15 @@ public CurrencyPair getCurrencyPair(String currencyPair) throws ApiException { } /** - * Get details of a specifc currency pair. + * Query single currency pair details * - * @param currencyPair Currency pair. (required) + * @param currencyPair Currency pair (required) * @return ApiResponse<CurrencyPair> * @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 getCurrencyPairWithHttpInfo(String currencyPair) throws ApiException { @@ -462,16 +462,16 @@ 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 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 -
    */ public okhttp3.Call getCurrencyPairAsync(String currencyPair, final ApiCallback _callback) throws ApiException { @@ -547,7 +547,7 @@ private APIlistTickersRequest() { /** * Set currencyPair - * @param currencyPair Currency pair. (optional) + * @param currencyPair Currency pair (optional) * @return APIlistTickersRequest */ public APIlistTickersRequest currencyPair(String currencyPair) { @@ -557,7 +557,7 @@ public APIlistTickersRequest currencyPair(String currencyPair) { /** * Set timezone - * @param timezone Timezone. (optional) + * @param timezone Timezone (optional) * @return APIlistTickersRequest */ public APIlistTickersRequest timezone(String timezone) { @@ -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. - * Market depth buy orders are sorted by price from high to low, sell orders are reversed - * @param currencyPair Currency pair. (required) + * 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 the currency name to query in batches, and support up to 100 pass parameters at a time. (optional) + * @param lastId Specify the currency name to query in batches, and support up to 100 pass parameters at a time (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) { @@ -971,7 +971,7 @@ public APIlistTradesRequest to(Long to) { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistTradesRequest */ public APIlistTradesRequest page(Integer page) { @@ -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, is the last 30 days. The query method based on `last_id` page turn is no longer recommended. If `last_id` is specified, the time range query parameters will be ignored. The maximum number of pages when searching data using limit&page paging function is 100,0, that is, limit * (page - 1) <= 100,0. - * @param currencyPair Currency pair. (required) + * 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 Specify the end time of the K-line chart, defaults to current time if not specified, note that the time format is Unix timestamp with second precision specified (optional) + * @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) + * @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) { @@ -1783,7 +1783,7 @@ public APIlistSpotAccountBookRequest to(Long to) { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistSpotAccountBookRequest */ public APIlistSpotAccountBookRequest page(Integer page) { @@ -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,0, that is, limit * (page - 1) <= 100,0. + * 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 { @@ -2081,7 +2081,7 @@ private APIlistAllOpenOrdersRequest() { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistAllOpenOrdersRequest */ public APIlistAllOpenOrdersRequest page(Integer page) { @@ -2091,7 +2091,7 @@ public APIlistAllOpenOrdersRequest page(Integer page) { /** * Set limit - * @param limit Maximum number of records returned in one page in each currency pair. (optional, default to 100) + * @param limit Maximum number of records returned in one page in each currency pair (optional, default to 100) * @return APIlistAllOpenOrdersRequest */ public APIlistAllOpenOrdersRequest limit(Integer limit) { @@ -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 { @@ -2170,13 +2170,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) } /** - * List all open orders. + * List all open orders * Query the current order list of all trading pairs. Please note that the paging parameter controls the number of pending orders in each trading pair. There is no paging control trading pairs. All trading pairs with pending orders will be returned. * @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 { @@ -2398,7 +2398,7 @@ private APIlistOrdersRequest(String currencyPair, String status) { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistOrdersRequest */ public APIlistOrdersRequest page(Integer page) { @@ -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 { @@ -2517,15 +2517,15 @@ 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` 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) + * List orders + * 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 { @@ -2590,8 +2590,8 @@ 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 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 + * Create an order + * 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 { @@ -2608,8 +2608,8 @@ 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 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 + * Create an order + * 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 { @@ -2627,8 +2627,8 @@ 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 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 + * Create an order (asynchronously) + * 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 { @@ -2649,10 +2649,10 @@ 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: 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 currencyPair Currency pair (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 { @@ -2719,19 +2719,19 @@ 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 transaction pairs are revoked You can specify a certain account separately to cancel all orders under the specified 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: 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) + * Cancel all `open` orders in specified currency pair + * 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 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 { @@ -2740,19 +2740,19 @@ 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 transaction pairs are revoked You can specify a certain account separately to cancel all orders under the specified 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: 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) + * Cancel all `open` orders in specified currency pair + * 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 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 { @@ -2762,12 +2762,12 @@ 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 transaction pairs are revoked You can specify a certain account separately to cancel all orders under the specified 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: 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) + * Cancel all `open` orders in specified currency pair (asynchronously) + * 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 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 { @@ -2795,7 +2795,7 @@ public okhttp3.Call cancelOrdersAsync(String currencyPair, String side, String a * @http.response.details - +
    Status Code Description Response Headers
    200 Batch cancellation completed. -
    200 Batch cancellation completed -
    */ public okhttp3.Call cancelBatchOrdersCall(List cancelBatchOrder, 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) @@ -2852,7 +2852,7 @@ private okhttp3.Call cancelBatchOrdersValidateBeforeCall(List * @http.response.details - +
    Status Code Description Response Headers
    200 Batch cancellation completed. -
    200 Batch cancellation completed -
    */ public List cancelBatchOrders(List cancelBatchOrder, String xGateExptime) throws ApiException { @@ -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) @@ -2870,7 +2870,7 @@ public List cancelBatchOrders(List cancelBa * @http.response.details - +
    Status Code Description Response Headers
    200 Batch cancellation completed. -
    200 Batch cancellation completed -
    */ public ApiResponse> cancelBatchOrdersWithHttpInfo(List cancelBatchOrder, String xGateExptime) throws ApiException { @@ -2880,7 +2880,7 @@ public ApiResponse> cancelBatchOrdersWithHttpInfo(List> cancelBatchOrdersWithHttpInfo(List Status Code Description Response Headers - 200 Batch cancellation completed. - + 200 Batch cancellation completed - */ public okhttp3.Call cancelBatchOrdersAsync(List cancelBatchOrder, String xGateExptime, final ApiCallback> _callback) throws ApiException { @@ -2903,15 +2903,15 @@ public okhttp3.Call cancelBatchOrdersAsync(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 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 * @http.response.details - +
    Status Code Description Response Headers
    200 Detail retrieved. -
    200 Detail retrieved -
    */ public okhttp3.Call getOrderCall(String orderId, String currencyPair, String account, final ApiCallback _callback) throws ApiException { @@ -2969,17 +2969,17 @@ 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 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 - +
    Status Code Description Response Headers
    200 Detail retrieved. -
    200 Detail retrieved -
    */ public Order getOrder(String orderId, String currencyPair, String account) throws ApiException { @@ -2988,17 +2988,17 @@ 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 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 - +
    Status Code Description Response Headers
    200 Detail retrieved. -
    200 Detail retrieved -
    */ public ApiResponse getOrderWithHttpInfo(String orderId, String currencyPair, String account) throws ApiException { @@ -3008,18 +3008,18 @@ 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 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 * @http.response.details - +
    Status Code Description Response Headers
    200 Detail retrieved. -
    200 Detail retrieved -
    */ public okhttp3.Call getOrderAsync(String orderId, String currencyPair, String account, final ApiCallback _callback) throws ApiException { @@ -3032,9 +3032,9 @@ 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 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 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 @@ -3042,7 +3042,7 @@ public okhttp3.Call getOrderAsync(String orderId, String currencyPair, String ac * @http.response.details - +
    Status Code Description Response Headers
    200 Order cancelled. -
    200 Order cancelled -
    */ public okhttp3.Call cancelOrderCall(String orderId, String currencyPair, String account, String actionMode, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -3108,19 +3108,19 @@ 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 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 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 Order cancelled. -
    200 Order cancelled -
    */ public Order cancelOrder(String orderId, String currencyPair, String account, String actionMode, String xGateExptime) throws ApiException { @@ -3129,19 +3129,19 @@ 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 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 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 Order cancelled. -
    200 Order cancelled -
    */ public ApiResponse cancelOrderWithHttpInfo(String orderId, String currencyPair, String account, String actionMode, String xGateExptime) throws ApiException { @@ -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 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 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 @@ -3164,7 +3164,7 @@ public ApiResponse cancelOrderWithHttpInfo(String orderId, String currenc * @http.response.details - +
    Status Code Description Response Headers
    200 Order cancelled. -
    200 Order cancelled -
    */ public okhttp3.Call cancelOrderAsync(String orderId, String currencyPair, String account, String actionMode, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -3178,8 +3178,8 @@ public okhttp3.Call cancelOrderAsync(String orderId, String currencyPair, String * Build call for amendOrder * @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 currencyPair Currency pair (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. + * 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 currencyPair Currency pair (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. + * 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 currencyPair Currency pair (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) + * 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 currencyPair Currency pair (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 { @@ -3406,7 +3406,7 @@ private APIlistMyTradesRequest() { /** * Set currencyPair - * @param currencyPair Retrieve results with specified currency pair. (optional) + * @param currencyPair Retrieve results with specified currency pair (optional) * @return APIlistMyTradesRequest */ public APIlistMyTradesRequest currencyPair(String currencyPair) { @@ -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) { @@ -3426,7 +3426,7 @@ public APIlistMyTradesRequest limit(Integer limit) { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistMyTradesRequest */ public APIlistMyTradesRequest page(Integer page) { @@ -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. + * 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 { @@ -3595,14 +3595,14 @@ private okhttp3.Call getSystemTimeValidateBeforeCall(final ApiCallback _callback } /** - * Get server current time. + * Get server current time * * @return SystemTime * @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 SystemTime getSystemTime() throws ApiException { @@ -3611,14 +3611,14 @@ public SystemTime getSystemTime() throws ApiException { } /** - * Get server current time. + * Get server current time * * @return ApiResponse<SystemTime> * @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 getSystemTimeWithHttpInfo() throws ApiException { @@ -3628,7 +3628,7 @@ public ApiResponse getSystemTimeWithHttpInfo() throws ApiException { } /** - * Get server current time. (asynchronously) + * Get server current time (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -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 { @@ -3699,7 +3699,7 @@ private okhttp3.Call countdownCancelAllSpotValidateBeforeCall(CountdownCancelAll } /** - * Countdown cancel orders. + * Countdown cancel orders * Spot order heartbeat detection. If there is no \"cancel existing countdown\" or \"set new countdown\" when the user-set `timeout` time is reached, the related `spot pending orders` will be automatically cancelled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at 30s intervals, setting the countdown `timeout` to `30 (seconds)` each time. If this interface is not called again within 30 seconds, all pending orders on the `market` you specified will be automatically cancelled. If no `market` is specified, all market cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will be terminated and the automatic order cancellation function will be cancelled. * @param countdownCancelAllSpotTask (required) * @return TriggerTime @@ -3707,7 +3707,7 @@ private okhttp3.Call countdownCancelAllSpotValidateBeforeCall(CountdownCancelAll * @http.response.details - +
    Status Code Description Response Headers
    200 Set countdown successfully. -
    200 Countdown set successfully -
    */ public TriggerTime countdownCancelAllSpot(CountdownCancelAllSpotTask countdownCancelAllSpotTask) throws ApiException { @@ -3716,7 +3716,7 @@ public TriggerTime countdownCancelAllSpot(CountdownCancelAllSpotTask countdownCa } /** - * Countdown cancel orders. + * Countdown cancel orders * Spot order heartbeat detection. If there is no \"cancel existing countdown\" or \"set new countdown\" when the user-set `timeout` time is reached, the related `spot pending orders` will be automatically cancelled. This interface can be called repeatedly to set a new countdown or cancel the countdown. Usage example: Repeat this interface at 30s intervals, setting the countdown `timeout` to `30 (seconds)` each time. If this interface is not called again within 30 seconds, all pending orders on the `market` you specified will be automatically cancelled. If no `market` is specified, all market cancelled. If the `timeout` is set to 0 within 30 seconds, the countdown timer will be terminated and the automatic order cancellation function will be cancelled. * @param countdownCancelAllSpotTask (required) * @return ApiResponse<TriggerTime> @@ -3724,7 +3724,7 @@ public TriggerTime countdownCancelAllSpot(CountdownCancelAllSpotTask countdownCa * @http.response.details - +
    Status Code Description Response Headers
    200 Set countdown successfully. -
    200 Countdown set successfully -
    */ public ApiResponse countdownCancelAllSpotWithHttpInfo(CountdownCancelAllSpotTask countdownCancelAllSpotTask) throws ApiException { @@ -3734,7 +3734,7 @@ public ApiResponse countdownCancelAllSpotWithHttpInfo(CountdownCanc } /** - * Countdown cancel orders. (asynchronously) + * Countdown cancel orders (asynchronously) * 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 @@ -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 { @@ -3763,7 +3763,7 @@ public okhttp3.Call countdownCancelAllSpotAsync(CountdownCancelAllSpotTask count * @http.response.details - +
    Status Code Description Response Headers
    200 Order modification executed successfully. -
    200 Order modification executed successfully -
    */ public okhttp3.Call amendBatchOrdersCall(List batchAmendItem, String xGateExptime, final ApiCallback _callback) throws ApiException { @@ -3811,8 +3811,8 @@ private okhttp3.Call amendBatchOrdersValidateBeforeCall(List bat } /** - * Batch modification of orders. - * Modify orders in spot, unified account and isolated margin account by default. Modify uncompleted orders, up to 5 orders can be modified at a time. Request parameters should be passed in array format. If there are order modification failures during the batch modification process, the modification of the next order will continue to be executed, and the execution will return with the corresponding order failure information. The call order of batch modification orders is consistent with the order list order. The return is consistent with the order list order. + * Batch modification of orders + * Modify orders in spot, unified account and isolated margin account by default. Modify uncompleted orders, up to 5 orders can be modified at a time. Request parameters should be passed in array format. If there are order modification failures during the batch modification process, the modification of the next order will continue to be executed, and the execution will return with the corresponding order failure information. The call order of batch modification orders is consistent with the order list order. The return 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> @@ -3820,7 +3820,7 @@ private okhttp3.Call amendBatchOrdersValidateBeforeCall(List bat * @http.response.details - +
    Status Code Description Response Headers
    200 Order modification executed successfully. -
    200 Order modification executed successfully -
    */ public List amendBatchOrders(List batchAmendItem, String xGateExptime) throws ApiException { @@ -3829,8 +3829,8 @@ public List amendBatchOrders(List batchAmendItem, St } /** - * Batch modification of orders. - * Modify orders in spot, unified account and isolated margin account by default. Modify uncompleted orders, up to 5 orders can be modified at a time. Request parameters should be passed in array format. If there are order modification failures during the batch modification process, the modification of the next order will continue to be executed, and the execution will return with the corresponding order failure information. The call order of batch modification orders is consistent with the order list order. The return is consistent with the order list order. + * Batch modification of orders + * Modify orders in spot, unified account and isolated margin account by default. Modify uncompleted orders, up to 5 orders can be modified at a time. Request parameters should be passed in array format. If there are order modification failures during the batch modification process, the modification of the next order will continue to be executed, and the execution will return with the corresponding order failure information. The call order of batch modification orders is consistent with the order list order. The return 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>> @@ -3838,7 +3838,7 @@ public List amendBatchOrders(List batchAmendItem, St * @http.response.details - +
    Status Code Description Response Headers
    200 Order modification executed successfully. -
    200 Order modification executed successfully -
    */ public ApiResponse> amendBatchOrdersWithHttpInfo(List batchAmendItem, String xGateExptime) throws ApiException { @@ -3848,8 +3848,8 @@ public ApiResponse> amendBatchOrdersWithHttpInfo(List> amendBatchOrdersWithHttpInfo(List Status Code Description Response Headers - 200 Order modification executed successfully. - + 200 Order modification executed successfully - */ public okhttp3.Call amendBatchOrdersAsync(List batchAmendItem, String xGateExptime, final ApiCallback> _callback) throws ApiException { @@ -3978,7 +3978,7 @@ private APIgetSpotInsuranceHistoryRequest(String business, String currency, Long /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIgetSpotInsuranceHistoryRequest */ public APIgetSpotInsuranceHistoryRequest page(Integer page) { @@ -3988,7 +3988,7 @@ public APIgetSpotInsuranceHistoryRequest page(Integer page) { /** * Set limit - * @param limit The maximum number of items returned in the list, the default value is 30. (optional, default to 30) + * @param limit The maximum number of items returned in the list, the default value is 30 (optional, default to 30) * @return APIgetSpotInsuranceHistoryRequest */ public APIgetSpotInsuranceHistoryRequest limit(Integer limit) { @@ -4004,7 +4004,7 @@ public APIgetSpotInsuranceHistoryRequest 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 { @@ -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 { @@ -4057,17 +4057,17 @@ public okhttp3.Call executeAsync(final ApiCallback> _ } /** - * Query spot insurance fund historical data. + * Query spot insurance fund historical data * * @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 currency Currency (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) { @@ -4191,7 +4191,7 @@ public APIlistSpotPriceTriggeredOrdersRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistSpotPriceTriggeredOrdersRequest */ public APIlistSpotPriceTriggeredOrdersRequest offset(Integer offset) { @@ -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 b1e79b6..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 { @@ -179,13 +179,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback) } /** - * List sub-accounts. + * List sub-accounts * * @return APIlistSubAccountsRequest * @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 { @@ -245,7 +245,7 @@ private okhttp3.Call createSubAccountsValidateBeforeCall(SubAccount subAccount, } /** - * Create a new sub-account. + * Create a new sub-account * * @param subAccount (required) * @return SubAccount @@ -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 { @@ -262,7 +262,7 @@ public SubAccount createSubAccounts(SubAccount subAccount) throws ApiException { } /** - * Create a new sub-account. + * Create a new sub-account * * @param subAccount (required) * @return ApiResponse<SubAccount> @@ -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 { @@ -280,7 +280,7 @@ public ApiResponse createSubAccountsWithHttpInfo(SubAccount subAccou } /** - * Create a new sub-account. (asynchronously) + * Create a new sub-account (asynchronously) * * @param subAccount (required) * @param _callback The callback to be executed when the API call finishes @@ -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,16 +575,16 @@ 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 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 SubAccountKey createSubAccountKeys(Long userId, SubAccountKey subAccountKey) throws ApiException { @@ -593,16 +593,16 @@ public SubAccountKey createSubAccountKeys(Long userId, SubAccountKey subAccountK } /** - * 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<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 { @@ -612,9 +612,9 @@ public ApiResponse createSubAccountKeysWithHttpInfo(Long userId, } /** - * 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,7 +622,7 @@ public ApiResponse createSubAccountKeysWithHttpInfo(Long userId, * @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 { @@ -634,15 +634,15 @@ public okhttp3.Call createSubAccountKeysAsync(Long userId, SubAccountKey subAcco /** * 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 { @@ -1242,14 +1242,14 @@ 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 + * Get sub-account 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 { @@ -1258,14 +1258,14 @@ 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 + * Get sub-account 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 { @@ -1275,15 +1275,15 @@ 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 + * Get sub-account mode (asynchronously) + * 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 50f3aaa..5e8d716 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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 @@ 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) { @@ -144,7 +144,7 @@ public APIlistUnifiedAccountsRequest currency(String currency) { /** * Set subUid - * @param subUid Sub account user ID. (optional) + * @param subUid Sub account user ID (optional) * @return APIlistUnifiedAccountsRequest */ public APIlistUnifiedAccountsRequest subUid(String subUid) { @@ -160,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 { @@ -174,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 { @@ -189,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 { @@ -204,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 { @@ -213,13 +213,13 @@ 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 + * 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. 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() { @@ -228,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 { @@ -283,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 { @@ -300,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 { @@ -318,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 { @@ -339,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 { @@ -394,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 { @@ -411,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 { @@ -429,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 { @@ -450,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 { @@ -505,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 { @@ -522,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 { @@ -540,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 { @@ -561,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 { @@ -616,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 { @@ -633,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 { @@ -651,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 { @@ -746,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) { @@ -756,7 +756,7 @@ public APIlistUnifiedLoansRequest currency(String currency) { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistUnifiedLoansRequest */ public APIlistUnifiedLoansRequest page(Integer page) { @@ -766,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) { @@ -776,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) { @@ -792,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 { @@ -806,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 { @@ -821,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 { @@ -836,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 { @@ -845,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() { @@ -867,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 { @@ -911,15 +911,15 @@ 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 available by setting the parameter `repaid_all=true` + * Borrow or repay + * 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 { @@ -928,15 +928,15 @@ 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 available by setting the parameter `repaid_all=true` + * Borrow or repay + * 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 { @@ -946,8 +946,8 @@ 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 available by setting the parameter `repaid_all=true` + * Borrow or repay (asynchronously) + * 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 @@ -955,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 { @@ -1041,7 +1041,7 @@ private APIlistUnifiedLoanRecordsRequest() { /** * Set type - * @param type The types of lending records, borrow - indicates the action of borrowing funds, repaying the borrowed funds (optional) + * @param type Loan record type: borrow - borrowing, repay - repayment (optional) * @return APIlistUnifiedLoanRecordsRequest */ public APIlistUnifiedLoanRecordsRequest type(String type) { @@ -1051,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) { @@ -1061,7 +1061,7 @@ public APIlistUnifiedLoanRecordsRequest currency(String currency) { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistUnifiedLoanRecordsRequest */ public APIlistUnifiedLoanRecordsRequest page(Integer page) { @@ -1071,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) { @@ -1087,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 { @@ -1101,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 { @@ -1116,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 { @@ -1131,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 { @@ -1140,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() { @@ -1239,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) { @@ -1249,7 +1249,7 @@ public APIlistUnifiedLoanInterestRecordsRequest currency(String currency) { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistUnifiedLoanInterestRecordsRequest */ public APIlistUnifiedLoanInterestRecordsRequest page(Integer page) { @@ -1259,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) { @@ -1269,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) { @@ -1279,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) { @@ -1289,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) { @@ -1305,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 { @@ -1319,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 { @@ -1334,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 { @@ -1349,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 { @@ -1358,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() { @@ -1379,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 { @@ -1418,14 +1418,14 @@ 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 + * 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 { @@ -1434,14 +1434,14 @@ 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 + * 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 { @@ -1451,15 +1451,15 @@ 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 (asynchronously) + * 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 { @@ -1477,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 { @@ -1516,14 +1516,14 @@ private okhttp3.Call getUnifiedModeValidateBeforeCall(final ApiCallback _callbac } /** - * Query mode of the unified account. + * Query mode of the unified account * Unified account mode: - `classic`: Classic account mode - `multi_currency`: Cross-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single-currency margin mode * @return UnifiedModeSet * @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 UnifiedModeSet getUnifiedMode() throws ApiException { @@ -1532,14 +1532,14 @@ public UnifiedModeSet getUnifiedMode() throws ApiException { } /** - * Query mode of the unified account. + * Query mode of the unified account * Unified account mode: - `classic`: Classic account mode - `multi_currency`: Cross-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single-currency margin mode * @return ApiResponse<UnifiedModeSet> * @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 getUnifiedModeWithHttpInfo() throws ApiException { @@ -1549,7 +1549,7 @@ public ApiResponse getUnifiedModeWithHttpInfo() throws ApiExcept } /** - * Query mode of the unified account. (asynchronously) + * Query mode of the unified account (asynchronously) * Unified account mode: - `classic`: Classic account mode - `multi_currency`: Cross-currency margin mode - `portfolio`: Portfolio margin mode - `single_currency`: Single-currency margin mode * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1557,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 { @@ -1576,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 { @@ -1620,14 +1620,14 @@ private okhttp3.Call setUnifiedModeValidateBeforeCall(UnifiedModeSet unifiedMode } /** - * Set mode of the unified account. + * Set unified account mode * Each account mode switch only requires passing the corresponding account mode parameter, and also supports turning on or off the configuration switches under the corresponding account mode during the switch. - When enabling the classic account mode, mode=classic ``` PUT /unified/unified_mode { \"mode\": \"classic\" } ``` - When enabling the cross-currency margin \"multi_currency\", \"settings\": { \"usdt_futures\": true } } ``` - When enabling the portfolio margin mode, mode=portfolio ``` PUT /unified/unified_mode { \"mode\": \"portfolio\", \"settings\": { \"spot_hedge\": true } } ``` - When enabling the single-currency margin mode, mode=single_currency ``` PUT /unified/unified_mode { \"mode\": \"single_currency\" } ``` * @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 { @@ -1635,7 +1635,7 @@ public void setUnifiedMode(UnifiedModeSet unifiedModeSet) throws ApiException { } /** - * Set mode of the unified account. + * Set unified account mode * Each account mode switch only requires passing the corresponding account mode parameter, and also supports turning on or off the configuration switches under the corresponding account mode during the switch. - When enabling the classic account mode, mode=classic ``` PUT /unified/unified_mode { \"mode\": \"classic\" } ``` - When enabling the cross-currency margin \"multi_currency\", \"settings\": { \"usdt_futures\": true } } ``` - When enabling the portfolio margin mode, mode=portfolio ``` PUT /unified/unified_mode { \"mode\": \"portfolio\", \"settings\": { \"spot_hedge\": true } } ``` - When enabling the single-currency margin mode, mode=single_currency ``` PUT /unified/unified_mode { \"mode\": \"single_currency\" } ``` * @param unifiedModeSet (required) * @return ApiResponse<Void> @@ -1643,7 +1643,7 @@ public void setUnifiedMode(UnifiedModeSet unifiedModeSet) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    204 Success. -
    204 Set successfully -
    */ public ApiResponse setUnifiedModeWithHttpInfo(UnifiedModeSet unifiedModeSet) throws ApiException { @@ -1652,7 +1652,7 @@ public ApiResponse setUnifiedModeWithHttpInfo(UnifiedModeSet unifiedModeSe } /** - * Set mode of the unified account. (asynchronously) + * 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 @@ -1661,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 { @@ -1672,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 { @@ -1727,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 { @@ -1744,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 { @@ -1762,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 { @@ -1789,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 { @@ -1828,14 +1828,14 @@ private okhttp3.Call listCurrencyDiscountTiersValidateBeforeCall(final ApiCallba } /** - * List currency discount tiers. + * Query unified account tiered discount * * @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 { @@ -1844,14 +1844,14 @@ public List listCurrencyDiscountTiers() throws ApiException { } /** - * List currency discount tiers. + * Query unified account tiered discount * * @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 { @@ -1861,7 +1861,7 @@ public ApiResponse> listCurrencyDiscountTiersWithHttpInfo( } /** - * List currency discount tiers. (asynchronously) + * Query unified account tiered discount (asynchronously) * * @param _callback The callback to be executed when the API call finishes * @return The request call @@ -1869,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 { @@ -1887,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 { @@ -1926,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 { @@ -1942,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 { @@ -1959,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 @@ -1967,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 { @@ -1986,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 { @@ -2030,15 +2030,15 @@ 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 of BTC and ETH perpetual contracts, options, and spot markets. Market orders are not included. + * Portfolio margin calculator + * 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 { @@ -2047,15 +2047,15 @@ 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 of BTC and ETH perpetual contracts, options, and spot markets. Market orders are not included. + * Portfolio margin calculator + * 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 { @@ -2065,8 +2065,8 @@ 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 of BTC and ETH perpetual contracts, options, and spot markets. Market orders are not included. + * Portfolio margin calculator (asynchronously) + * 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 @@ -2074,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 { @@ -2086,14 +2086,14 @@ public okhttp3.Call calculatePortfolioMarginAsync(UnifiedPortfolioInput unifiedP /** * Build call for getUserLeverageCurrencyConfig - * @param currency Currency. (required) + * @param currency 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. -
    200 Query successful -
    */ public okhttp3.Call getUserLeverageCurrencyConfigCall(String currency, final ApiCallback _callback) throws ApiException { @@ -2141,15 +2141,15 @@ 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) + * @param currency Currency (required) * @return UnifiedLeverageConfig * @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 UnifiedLeverageConfig getUserLeverageCurrencyConfig(String currency) throws ApiException { @@ -2158,15 +2158,15 @@ 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) + * @param currency Currency (required) * @return ApiResponse<UnifiedLeverageConfig> * @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 getUserLeverageCurrencyConfigWithHttpInfo(String currency) throws ApiException { @@ -2176,16 +2176,16 @@ 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 currency 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. -
    200 Query successful -
    */ public okhttp3.Call getUserLeverageCurrencyConfigAsync(String currency, final ApiCallback _callback) throws ApiException { @@ -2235,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; } @@ -2256,7 +2256,7 @@ private APIgetUserLeverageCurrencySettingRequest() { /** * Set currency - * @param currency Currency. (optional) + * @param currency Currency (optional) * @return APIgetUserLeverageCurrencySettingRequest */ public APIgetUserLeverageCurrencySettingRequest currency(String currency) { @@ -2272,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 { @@ -2281,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); } @@ -2316,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() { @@ -2347,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 { @@ -2391,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 { @@ -2406,7 +2406,7 @@ public void setUserLeverageCurrencySetting(UnifiedLeverageSetting unifiedLeverag } /** - * Set the loan currency leverage. + * Set loan currency leverage * * @param unifiedLeverageSetting (required) * @return ApiResponse<Void> @@ -2414,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 { @@ -2423,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 @@ -2432,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 { @@ -2502,7 +2502,7 @@ private APIlistUnifiedCurrenciesRequest() { /** * Set currency - * @param currency Currency. (optional) + * @param currency Currency (optional) * @return APIlistUnifiedCurrenciesRequest */ public APIlistUnifiedCurrenciesRequest currency(String currency) { @@ -2518,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 { @@ -2532,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 { @@ -2547,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 { @@ -2562,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 { @@ -2571,13 +2571,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callb } /** - * List of loan currencies supported by unified account. + * List of loan currencies supported by unified account * * @return APIlistUnifiedCurrenciesRequest * @http.response.details - +
    Status Code Description Response Headers
    200 List retrieved. -
    200 List retrieved successfully -
    */ public APIlistUnifiedCurrenciesRequest listUnifiedCurrencies() { @@ -2666,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) { @@ -2676,7 +2676,7 @@ public APIgetHistoryLoanRateRequest tier(String tier) { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIgetHistoryLoanRateRequest */ public APIgetHistoryLoanRateRequest page(Integer page) { @@ -2686,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) { @@ -2702,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 { @@ -2716,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 { @@ -2731,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 { @@ -2746,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 { @@ -2755,14 +2755,14 @@ public okhttp3.Call executeAsync(final ApiCallback _call } /** - * get historical lending rates. + * Get historical lending rates * - * @param currency Currency. (required) + * @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) { @@ -2778,7 +2778,7 @@ public APIgetHistoryLoanRateRequest getHistoryLoanRate(String currency) { * @http.response.details - +
    Status Code Description Response Headers
    200 UpdateSuccess. -
    200 Updated successfully -
    */ public okhttp3.Call setUnifiedCollateralCall(UnifiedCollateralReq unifiedCollateralReq, final ApiCallback _callback) throws ApiException { @@ -2822,7 +2822,7 @@ private okhttp3.Call setUnifiedCollateralValidateBeforeCall(UnifiedCollateralReq } /** - * Set Collateral Currency. + * Set collateral currency * * @param unifiedCollateralReq (required) * @return UnifiedCollateralRes @@ -2830,7 +2830,7 @@ private okhttp3.Call setUnifiedCollateralValidateBeforeCall(UnifiedCollateralReq * @http.response.details - +
    Status Code Description Response Headers
    200 UpdateSuccess. -
    200 Updated successfully -
    */ public UnifiedCollateralRes setUnifiedCollateral(UnifiedCollateralReq unifiedCollateralReq) throws ApiException { @@ -2839,7 +2839,7 @@ public UnifiedCollateralRes setUnifiedCollateral(UnifiedCollateralReq unifiedCol } /** - * Set Collateral Currency. + * Set collateral currency * * @param unifiedCollateralReq (required) * @return ApiResponse<UnifiedCollateralRes> @@ -2847,7 +2847,7 @@ public UnifiedCollateralRes setUnifiedCollateral(UnifiedCollateralReq unifiedCol * @http.response.details - +
    Status Code Description Response Headers
    200 UpdateSuccess. -
    200 Updated successfully -
    */ public ApiResponse setUnifiedCollateralWithHttpInfo(UnifiedCollateralReq unifiedCollateralReq) throws ApiException { @@ -2857,7 +2857,7 @@ public ApiResponse setUnifiedCollateralWithHttpInfo(Unifie } /** - * Set Collateral Currency. (asynchronously) + * Set collateral currency (asynchronously) * * @param unifiedCollateralReq (required) * @param _callback The callback to be executed when the API call finishes @@ -2866,7 +2866,7 @@ public ApiResponse setUnifiedCollateralWithHttpInfo(Unifie * @http.response.details - +
    Status Code Description Response Headers
    200 UpdateSuccess. -
    200 Updated successfully -
    */ public okhttp3.Call setUnifiedCollateralAsync(UnifiedCollateralReq unifiedCollateralReq, final ApiCallback _callback) throws ApiException { diff --git a/src/main/java/io/gate/gateapi/api/WalletApi.java b/src/main/java/io/gate/gateapi/api/WalletApi.java index 5f9f0ce..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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,14 +70,14 @@ public void setApiClient(ApiClient apiClient) { /** * Build call for listCurrencyChains - * @param currency Currency name. (required) + * @param currency 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 listCurrencyChainsCall(String currency, final ApiCallback _callback) throws ApiException { @@ -125,15 +125,15 @@ private okhttp3.Call listCurrencyChainsValidateBeforeCall(String currency, final } /** - * List chains supported for specified currency. + * Query chains supported for specified currency * - * @param currency Currency name. (required) + * @param currency Currency name (required) * @return List<CurrencyChain> * @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 listCurrencyChains(String currency) throws ApiException { @@ -142,15 +142,15 @@ public List listCurrencyChains(String currency) throws ApiExcepti } /** - * List chains supported for specified currency. + * Query chains supported for specified currency * - * @param currency Currency name. (required) + * @param currency Currency name (required) * @return ApiResponse<List<CurrencyChain>> * @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> listCurrencyChainsWithHttpInfo(String currency) throws ApiException { @@ -160,16 +160,16 @@ 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 currency 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 listCurrencyChainsAsync(String currency, final ApiCallback> _callback) throws ApiException { @@ -181,14 +181,14 @@ public okhttp3.Call listCurrencyChainsAsync(String currency, final ApiCallback Status Code Description Response Headers - 200 Address successfully generated. - + 200 Address successfully generated - */ public okhttp3.Call getDepositAddressCall(String currency, final ApiCallback _callback) throws ApiException { @@ -236,15 +236,15 @@ private okhttp3.Call getDepositAddressValidateBeforeCall(String currency, final } /** - * Generate currency deposit address. + * Generate currency deposit address * - * @param currency Currency name. (required) + * @param currency Currency name (required) * @return DepositAddress * @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 Address successfully generated. -
    200 Address successfully generated -
    */ public DepositAddress getDepositAddress(String currency) throws ApiException { @@ -253,15 +253,15 @@ public DepositAddress getDepositAddress(String currency) throws ApiException { } /** - * Generate currency deposit address. + * Generate currency deposit address * - * @param currency Currency name. (required) + * @param currency Currency name (required) * @return ApiResponse<DepositAddress> * @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 Address successfully generated. -
    200 Address successfully generated -
    */ public ApiResponse getDepositAddressWithHttpInfo(String currency) throws ApiException { @@ -271,16 +271,16 @@ public ApiResponse getDepositAddressWithHttpInfo(String currency } /** - * Generate currency deposit address. (asynchronously) + * Generate currency deposit address (asynchronously) * - * @param currency Currency name. (required) + * @param currency 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 Address successfully generated. -
    200 Address successfully generated -
    */ public okhttp3.Call getDepositAddressAsync(String currency, final ApiCallback _callback) throws ApiException { @@ -386,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) { @@ -396,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) { @@ -406,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) { @@ -416,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) { @@ -426,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) { @@ -436,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) { @@ -446,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) { @@ -456,7 +456,7 @@ public APIlistWithdrawalsRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistWithdrawalsRequest */ public APIlistWithdrawalsRequest offset(Integer offset) { @@ -472,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 { @@ -486,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 { @@ -501,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 { @@ -516,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 { @@ -525,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() { @@ -619,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) { @@ -629,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) { @@ -639,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) { @@ -649,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) { @@ -659,7 +659,7 @@ public APIlistDepositsRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistDepositsRequest */ public APIlistDepositsRequest offset(Integer offset) { @@ -675,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 { @@ -689,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 { @@ -704,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 { @@ -719,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 { @@ -728,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() { @@ -750,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,15 +794,15 @@ 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. options + * Transfer between trading accounts + * 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,15 +811,15 @@ 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. options + * Transfer between trading accounts + * 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,8 +829,8 @@ 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. options + * Transfer between trading accounts (asynchronously) + * 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 @@ -838,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 { @@ -929,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) { @@ -939,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) { @@ -949,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) { @@ -959,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) { @@ -969,7 +969,7 @@ public APIlistSubAccountTransfersRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistSubAccountTransfersRequest */ public APIlistSubAccountTransfersRequest offset(Integer offset) { @@ -985,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 { @@ -999,7 +999,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 { @@ -1014,7 +1014,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 { @@ -1029,7 +1029,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 { @@ -1038,13 +1038,13 @@ public okhttp3.Call executeAsync(final ApiCallback Status Code Description Response Headers - 200 List retrieved. - + 200 List retrieved successfully - */ public APIlistSubAccountTransfersRequest listSubAccountTransfers() { @@ -1060,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,15 +1104,15 @@ 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. + * Transfer between main and sub accounts + * 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,15 +1121,15 @@ 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. + * Transfer between main and sub accounts + * 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,8 +1139,8 @@ 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. + * Transfer between main and sub accounts (asynchronously) + * 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 @@ -1148,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 { @@ -1167,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 { @@ -1211,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 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 { @@ -1228,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 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 { @@ -1246,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 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 @@ -1255,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 { @@ -1331,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) { @@ -1341,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) { @@ -1357,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 { @@ -1371,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 { @@ -1386,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 { @@ -1401,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,13 +1410,13 @@ 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 + * Transfer status query + * 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() { @@ -1484,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) { @@ -1500,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 { @@ -1514,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 { @@ -1529,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 { @@ -1544,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 { @@ -1553,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() { @@ -1627,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) { @@ -1643,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 { @@ -1657,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 { @@ -1672,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 { @@ -1687,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 { @@ -1696,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() { @@ -1770,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) { @@ -1786,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 { @@ -1800,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 { @@ -1815,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 { @@ -1830,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 { @@ -1839,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() { @@ -1918,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) { @@ -1928,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) { @@ -1944,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 { @@ -1958,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 { @@ -1973,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 { @@ -1988,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 { @@ -1997,13 +1997,13 @@ public okhttp3.Call executeAsync(final ApiCallback Status Code Description Response Headers - 200 List retrieved. - + 200 List retrieved successfully - */ public APIlistSubAccountFuturesBalancesRequest listSubAccountFuturesBalances() { @@ -2071,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) { @@ -2087,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 { @@ -2101,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 { @@ -2116,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 { @@ -2131,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 { @@ -2140,13 +2140,13 @@ public okhttp3.Call executeAsync(final ApiCallback Status Code Description Response Headers - 200 List retrieved. - + 200 List retrieved successfully - */ public APIlistSubAccountCrossMarginBalancesRequest listSubAccountCrossMarginBalances() { @@ -2235,7 +2235,7 @@ private APIlistSavedAddressRequest(String currency) { /** * Set chain - * @param chain Chain name. (optional, default to "") + * @param chain Chain name (optional, default to "") * @return APIlistSavedAddressRequest */ public APIlistSavedAddressRequest chain(String chain) { @@ -2245,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) { @@ -2255,7 +2255,7 @@ public APIlistSavedAddressRequest limit(String limit) { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistSavedAddressRequest */ public APIlistSavedAddressRequest page(Integer page) { @@ -2271,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 { @@ -2285,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 { @@ -2300,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 { @@ -2315,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 { @@ -2324,14 +2324,14 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * Query saved address. + * Query withdrawal address whitelist * - * @param currency Currency. (required) + * @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) { @@ -2404,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) { @@ -2414,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) { @@ -2430,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 { @@ -2444,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 { @@ -2459,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 { @@ -2474,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 { @@ -2483,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() { @@ -2557,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) { @@ -2573,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 { @@ -2587,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 { @@ -2602,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 { @@ -2617,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 { @@ -2626,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` /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() { @@ -2647,7 +2647,7 @@ public APIgetTotalBalanceRequest getTotalBalance() { * @http.response.details - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public okhttp3.Call listSmallBalanceCall(final ApiCallback _callback) throws ApiException { @@ -2686,14 +2686,14 @@ 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 * @http.response.details - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public List listSmallBalance() throws ApiException { @@ -2702,14 +2702,14 @@ 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 * @http.response.details - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public ApiResponse> listSmallBalanceWithHttpInfo() throws ApiException { @@ -2719,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 @@ -2727,7 +2727,7 @@ public ApiResponse> listSmallBalanceWithHttpInfo() throws Api * @http.response.details - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public okhttp3.Call listSmallBalanceAsync(final ApiCallback> _callback) throws ApiException { @@ -2746,7 +2746,7 @@ public okhttp3.Call listSmallBalanceAsync(final ApiCallback> * @http.response.details - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public okhttp3.Call convertSmallBalanceCall(ConvertSmallBalance convertSmallBalance, final ApiCallback _callback) throws ApiException { @@ -2790,14 +2790,14 @@ 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 * @http.response.details - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public void convertSmallBalance(ConvertSmallBalance convertSmallBalance) throws ApiException { @@ -2805,7 +2805,7 @@ public void convertSmallBalance(ConvertSmallBalance convertSmallBalance) throws } /** - * Convert small balance. + * Convert small balance currency * * @param convertSmallBalance (required) * @return ApiResponse<Void> @@ -2813,7 +2813,7 @@ public void convertSmallBalance(ConvertSmallBalance convertSmallBalance) throws * @http.response.details - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public ApiResponse convertSmallBalanceWithHttpInfo(ConvertSmallBalance convertSmallBalance) throws ApiException { @@ -2822,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 @@ -2831,7 +2831,7 @@ public ApiResponse convertSmallBalanceWithHttpInfo(ConvertSmallBalance con * @http.response.details - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public okhttp3.Call convertSmallBalanceAsync(ConvertSmallBalance convertSmallBalance, final ApiCallback _callback) throws ApiException { @@ -2911,7 +2911,7 @@ private APIlistSmallBalanceHistoryRequest() { /** * Set currency - * @param currency Currency. (optional) + * @param currency Currency to convert (optional) * @return APIlistSmallBalanceHistoryRequest */ public APIlistSmallBalanceHistoryRequest currency(String currency) { @@ -2921,7 +2921,7 @@ public APIlistSmallBalanceHistoryRequest currency(String currency) { /** * Set page - * @param page Page number. (optional, default to 1) + * @param page Page number (optional, default to 1) * @return APIlistSmallBalanceHistoryRequest */ public APIlistSmallBalanceHistoryRequest page(Integer page) { @@ -2931,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) { @@ -2947,7 +2947,7 @@ public APIlistSmallBalanceHistoryRequest limit(Integer limit) { * @http.response.details - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -2961,7 +2961,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public List execute() throws ApiException { @@ -2976,7 +2976,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -2991,7 +2991,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiEx * @http.response.details - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -3000,13 +3000,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _c } /** - * List small balance history. + * Get convertible small balance currency history * * @return APIlistSmallBalanceHistoryRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public APIlistSmallBalanceHistoryRequest listSmallBalanceHistory() { @@ -3099,7 +3099,7 @@ private APIlistPushOrdersRequest() { /** * Set id - * @param id Order ID. (optional) + * @param id Order ID (optional) * @return APIlistPushOrdersRequest */ public APIlistPushOrdersRequest id(Integer id) { @@ -3109,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) { @@ -3119,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) { @@ -3129,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) { @@ -3139,7 +3139,7 @@ public APIlistPushOrdersRequest limit(Integer limit) { /** * Set offset - * @param offset List offset, starting from 0. (optional, default to 0) + * @param offset List offset, starting from 0 (optional, default to 0) * @return APIlistPushOrdersRequest */ public APIlistPushOrdersRequest offset(Integer offset) { @@ -3149,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) { @@ -3165,7 +3165,7 @@ public APIlistPushOrdersRequest transactionType(String transactionType) { * @http.response.details - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { @@ -3179,7 +3179,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public List execute() throws ApiException { @@ -3194,7 +3194,7 @@ public List execute() throws ApiException { * @http.response.details - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public ApiResponse> executeWithHttpInfo() throws ApiException { @@ -3209,7 +3209,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiException * @http.response.details - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public okhttp3.Call executeAsync(final ApiCallback> _callback) throws ApiException { @@ -3218,13 +3218,13 @@ public okhttp3.Call executeAsync(final ApiCallback> _callback } /** - * Retrieve the UID transfer history. + * Get UID transfer history * * @return APIlistPushOrdersRequest * @http.response.details - +
    Status Code Description Response Headers
    200 Success. -
    200 Success -
    */ public APIlistPushOrdersRequest listPushOrders() { diff --git a/src/main/java/io/gate/gateapi/api/WithdrawalApi.java b/src/main/java/io/gate/gateapi/api/WithdrawalApi.java index e99f287..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 { @@ -102,15 +102,15 @@ private okhttp3.Call withdrawValidateBeforeCall(LedgerRecord ledgerRecord, final } /** - * Withdraw. - * Withdrawals to Gate addresses do not incur transaction fees. + * Withdraw + * 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 { @@ -119,15 +119,15 @@ public LedgerRecord withdraw(LedgerRecord ledgerRecord) throws ApiException { } /** - * Withdraw. - * Withdrawals to Gate addresses do not incur transaction fees. + * Withdraw + * 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 { @@ -137,8 +137,8 @@ public ApiResponse withdrawWithHttpInfo(LedgerRecord ledgerRecord) } /** - * Withdraw. (asynchronously) - * Withdrawals to Gate addresses do not incur transaction fees. + * Withdraw (asynchronously) + * 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 { @@ -209,15 +209,15 @@ private okhttp3.Call withdrawPushOrderValidateBeforeCall(UidPushWithdrawal uidPu } /** - * UID transfer. - * Transfers between main spot accounts are allowed; however, both parties cannot be sub-accounts + * UID transfer + * 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 { @@ -226,15 +226,15 @@ public UidPushWithdrawalResp withdrawPushOrder(UidPushWithdrawal uidPushWithdraw } /** - * UID transfer. - * Transfers between main spot accounts are allowed; however, both parties cannot be sub-accounts + * UID transfer + * 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 { @@ -244,8 +244,8 @@ public ApiResponse withdrawPushOrderWithHttpInfo(UidPushW } /** - * UID transfer. (asynchronously) - * Transfers between main spot accounts are allowed; however, both parties cannot be sub-accounts + * UID transfer (asynchronously) + * 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 { @@ -317,7 +317,7 @@ private okhttp3.Call cancelWithdrawalValidateBeforeCall(String withdrawalId, fin } /** - * Cancel withdrawal with specified ID. + * Cancel withdrawal with specified ID * * @param withdrawalId (required) * @return LedgerRecord @@ -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 { @@ -334,7 +334,7 @@ public LedgerRecord cancelWithdrawal(String withdrawalId) throws ApiException { } /** - * Cancel withdrawal with specified ID. + * Cancel withdrawal with specified ID * * @param withdrawalId (required) * @return ApiResponse<LedgerRecord> @@ -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 { @@ -352,7 +352,7 @@ public ApiResponse cancelWithdrawalWithHttpInfo(String withdrawalI } /** - * Cancel withdrawal with specified ID. (asynchronously) + * Cancel withdrawal with specified ID (asynchronously) * * @param withdrawalId (required) * @param _callback The callback to be executed when the API call finishes @@ -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 fe23ce7..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 2ae13a2..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 0a02da4..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 5e4f019..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 2dc1180..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 e187ebb..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 balances calculated with specified currency unit. + * Total balances calculated with specified currency unit */ public class AccountBalance { public static final String SERIALIZED_NAME_AMOUNT = "amount"; @@ -28,7 +28,7 @@ public class AccountBalance { private String amount; /** - * Currency. + * Currency */ @JsonAdapter(CurrencyEnum.Adapter.class) public enum CurrencyEnum { @@ -98,7 +98,7 @@ public AccountBalance amount(String amount) { } /** - * Account total balance amount. + * Account total balance amount * @return amount **/ @javax.annotation.Nullable @@ -118,7 +118,7 @@ public AccountBalance currency(CurrencyEnum currency) { } /** - * Currency. + * Currency * @return currency **/ @javax.annotation.Nullable @@ -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 08b9d6d..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 @@ -114,7 +114,7 @@ public AccountDetail userId(Long userId) { } /** - * User ID. + * User ID * @return userId **/ @javax.annotation.Nullable @@ -134,7 +134,7 @@ public AccountDetail tier(Long tier) { } /** - * User VIP level. + * User VIP level * @return tier **/ @javax.annotation.Nullable @@ -174,7 +174,7 @@ public AccountDetail copyTradingRole(Integer copyTradingRole) { } /** - * User role: 0 - Normal user, 1 - Copy trading leader, follower, 3 - Both 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 782f2ef..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 69eb21d..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 @@ -107,7 +107,7 @@ public AccountRateLimit updatedAt(String updatedAt) { } /** - * Update time. + * Update time * @return updatedAt **/ @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 116146c..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 @@ -75,7 +75,7 @@ public AgencyCommission userId(Long userId) { } /** - * User ID. + * User ID * @return userId **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public AgencyCommission groupName(String groupName) { } /** - * Group name. + * Group name * @return groupName **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public AgencyCommission commissionAmount(String commissionAmount) { } /** - * Commission Amount. + * Transaction amount * @return commissionAmount **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public AgencyCommission commissionAsset(String commissionAsset) { } /** - * Commission Asset. + * Commission Asset * @return commissionAsset **/ @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 5e76786..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -46,7 +46,7 @@ public AgencyCommissionHistory currencyPair(String currencyPair) { } /** - * Currency pair. + * Currency pair * @return currencyPair **/ @javax.annotation.Nullable @@ -66,7 +66,7 @@ public AgencyCommissionHistory total(Long total) { } /** - * Total. + * Total * @return total **/ @javax.annotation.Nullable @@ -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 2758e5d..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 AgencyTransaction transactionTime(Long transactionTime) { } /** - * Transaction Time. (unix timestamp). + * Transaction Time. (unix timestamp) * @return transactionTime **/ @javax.annotation.Nullable @@ -87,7 +87,7 @@ public AgencyTransaction userId(Long userId) { } /** - * User ID. + * User ID * @return userId **/ @javax.annotation.Nullable @@ -107,7 +107,7 @@ public AgencyTransaction groupName(String groupName) { } /** - * Group name. + * Group name * @return groupName **/ @javax.annotation.Nullable @@ -127,7 +127,7 @@ public AgencyTransaction fee(String fee) { } /** - * Fee. + * Fee * @return fee **/ @javax.annotation.Nullable @@ -147,7 +147,7 @@ public AgencyTransaction feeAsset(String feeAsset) { } /** - * Fee currency. + * Fee currency * @return feeAsset **/ @javax.annotation.Nullable @@ -167,7 +167,7 @@ public AgencyTransaction currencyPair(String currencyPair) { } /** - * Currency pair. + * Currency pair * @return currencyPair **/ @javax.annotation.Nullable @@ -187,7 +187,7 @@ public AgencyTransaction amount(String amount) { } /** - * Commission Amount. + * Transaction amount * @return amount **/ @javax.annotation.Nullable @@ -207,7 +207,7 @@ public AgencyTransaction amountAsset(String amountAsset) { } /** - * Commission Asset. + * Commission Asset * @return amountAsset **/ @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 369c28b..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -46,7 +46,7 @@ public AgencyTransactionHistory currencyPair(String currencyPair) { } /** - * Currency pair. + * Currency pair * @return currencyPair **/ @javax.annotation.Nullable @@ -66,7 +66,7 @@ public AgencyTransactionHistory total(Long total) { } /** - * Total. + * Total * @return total **/ @javax.annotation.Nullable @@ -94,7 +94,7 @@ public AgencyTransactionHistory addListItem(AgencyTransaction listItem) { } /** - * List of transaction history. + * List of transaction history * @return list **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/AutoRepaySetting.java b/src/main/java/io/gate/gateapi/models/AutoRepaySetting.java index eac5592..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 cae11a1..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Order information that needs to be modified. + * Order information that needs to be modified */ public class BatchAmendItem { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; @@ -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() { @@ -78,7 +78,7 @@ public BatchAmendItem currencyPair(String currencyPair) { } /** - * Currency pair. + * Currency pair * @return currencyPair **/ public String getCurrencyPair() { @@ -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) { } /** - * Trading Quantity. Only one of amountor pricecan 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) { } /** - * Trading Price. Only one of amountor pricecan 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 69a94fc..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Modify contract order parameters. + * Modify contract order parameters */ public class BatchAmendOrderReq { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; @@ -51,7 +51,7 @@ public BatchAmendOrderReq orderId(Long orderId) { } /** - * Order id, order_id and text must contain at least one. + * Order id, order_id and text must contain at least one * @return orderId **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public BatchAmendOrderReq text(String text) { } /** - * User-defined order text, at least one of order_id and text must be passed. + * User-defined order text, at least one of order_id and text must be passed * @return text **/ @javax.annotation.Nullable @@ -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, 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 fbabc3c..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Futures order details. + * Futures order details */ public class BatchFuturesOrder { public static final String SERIALIZED_NAME_SUCCEEDED = "succeeded"; @@ -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 - 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, 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 @@ -420,7 +420,7 @@ public BatchFuturesOrder label(String label) { } /** - * Error label, only exists if execution fails. + * Error label, only exists if execution fails * @return label **/ @javax.annotation.Nullable @@ -454,7 +454,7 @@ public void setDetail(String detail) { } /** - * Futures order ID. + * Futures order ID * @return id **/ @javax.annotation.Nullable @@ -464,7 +464,7 @@ public Long getId() { /** - * User ID. + * User ID * @return user **/ @javax.annotation.Nullable @@ -474,7 +474,7 @@ public Integer getUser() { /** - * Creation time of order. + * Creation time of order * @return createTime **/ @javax.annotation.Nullable @@ -484,7 +484,7 @@ public Double getCreateTime() { /** - * Order finished time. Not returned if order is open. + * Order finished time. Not returned if order is open * @return finishTime **/ @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 - 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 @@ -520,7 +520,7 @@ public BatchFuturesOrder contract(String contract) { } /** - * Futures contract. + * Futures contract * @return contract **/ @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 @@ -600,7 +600,7 @@ public BatchFuturesOrder close(Boolean close) { } /** - * Set as `true` to close the position, with `size` set to 0. + * Set as `true` to close the position, with `size` set to 0 * @return close **/ @javax.annotation.Nullable @@ -614,7 +614,7 @@ public void setClose(Boolean close) { } /** - * Is the order to close position. + * Is the order to close position * @return isClose **/ @javax.annotation.Nullable @@ -630,7 +630,7 @@ public BatchFuturesOrder reduceOnly(Boolean reduceOnly) { } /** - * Set as `true` to be reduce-only order. + * Set as `true` to be reduce-only order * @return reduceOnly **/ @javax.annotation.Nullable @@ -644,7 +644,7 @@ public void setReduceOnly(Boolean reduceOnly) { } /** - * Is the order reduce-only. + * Is the order reduce-only * @return isReduceOnly **/ @javax.annotation.Nullable @@ -654,7 +654,7 @@ public Boolean getIsReduceOnly() { /** - * Is the order for liquidation. + * Is the order for liquidation * @return isLiq **/ @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 @@ -724,7 +724,7 @@ public void setText(String text) { } /** - * Taker fee. + * Taker fee * @return tkfr **/ @javax.annotation.Nullable @@ -734,7 +734,7 @@ public String getTkfr() { /** - * Maker fee. + * Maker fee * @return mkfr **/ @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, 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 c693ca7..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 order details. + * Batch order details */ public class BatchOrder { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; @@ -231,7 +231,7 @@ public AccountEnum read(final JsonReader jsonReader) throws IOException { private AccountEnum account = AccountEnum.SPOT; /** - * Buy or sell order. + * Buy or sell order */ @JsonAdapter(SideEnum.Adapter.class) public enum SideEnum { @@ -528,7 +528,7 @@ public BatchOrder orderId(String orderId) { } /** - * Order ID. + * Order ID * @return orderId **/ @javax.annotation.Nullable @@ -548,7 +548,7 @@ public BatchOrder amendText(String amendText) { } /** - * The custom data that the user remarked when amending the order. + * The custom data that the user remarked when amending the order * @return amendText **/ @javax.annotation.Nullable @@ -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 @@ -608,7 +608,7 @@ public BatchOrder label(String label) { } /** - * Error label, if any, otherwise an empty string. + * Error label, if any, otherwise an empty string * @return label **/ @javax.annotation.Nullable @@ -628,7 +628,7 @@ public BatchOrder message(String message) { } /** - * Detailed error message, if any, otherwise an empty string. + * Detailed error message, if any, otherwise an empty string * @return message **/ @javax.annotation.Nullable @@ -642,7 +642,7 @@ public void setMessage(String message) { } /** - * Order ID. + * Order ID * @return id **/ @javax.annotation.Nullable @@ -652,7 +652,7 @@ public String getId() { /** - * Creation time of order. + * Creation time of order * @return createTime **/ @javax.annotation.Nullable @@ -662,7 +662,7 @@ public String getCreateTime() { /** - * Last modification time of order. + * Last modification time of order * @return updateTime **/ @javax.annotation.Nullable @@ -672,7 +672,7 @@ public String getUpdateTime() { /** - * Creation time of order (in milliseconds). + * Creation time of order (in milliseconds) * @return createTimeMs **/ @javax.annotation.Nullable @@ -682,7 +682,7 @@ public Long getCreateTimeMs() { /** - * Last modification time of order (in milliseconds). + * Last modification time of order (in milliseconds) * @return updateTimeMs **/ @javax.annotation.Nullable @@ -708,7 +708,7 @@ public BatchOrder currencyPair(String currencyPair) { } /** - * Currency pair. + * Currency pair * @return currencyPair **/ @javax.annotation.Nullable @@ -768,7 +768,7 @@ public BatchOrder side(SideEnum side) { } /** - * Buy or sell order. + * Buy or sell order * @return side **/ @javax.annotation.Nullable @@ -788,7 +788,7 @@ public BatchOrder amount(String amount) { } /** - * Trade amount. + * Trade amount * @return amount **/ @javax.annotation.Nullable @@ -808,7 +808,7 @@ public BatchOrder price(String price) { } /** - * Order price. + * Order price * @return price **/ @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 @@ -902,7 +902,7 @@ public void setAutoRepay(Boolean autoRepay) { } /** - * Amount left to fill. + * Amount left to fill * @return left **/ @javax.annotation.Nullable @@ -912,7 +912,7 @@ public String getLeft() { /** - * Amount traded to fill. + * Amount filled * @return filledAmount **/ @javax.annotation.Nullable @@ -922,7 +922,7 @@ public String getFilledAmount() { /** - * Total filled in quote currency. Deprecated in favor of `filled_total`. + * Total filled in quote currency. Deprecated in favor of `filled_total` * @return fillPrice **/ @javax.annotation.Nullable @@ -932,7 +932,7 @@ public String getFillPrice() { /** - * Total filled in quote currency. + * Total filled in quote currency * @return filledTotal **/ @javax.annotation.Nullable @@ -942,7 +942,7 @@ public String getFilledTotal() { /** - * Average fill price. + * Average fill price * @return avgDealPrice **/ @javax.annotation.Nullable @@ -952,7 +952,7 @@ public String getAvgDealPrice() { /** - * Fee deducted. + * Fee deducted * @return fee **/ @javax.annotation.Nullable @@ -962,7 +962,7 @@ public String getFee() { /** - * Fee currency unit. + * Fee currency unit * @return feeCurrency **/ @javax.annotation.Nullable @@ -972,7 +972,7 @@ public String getFeeCurrency() { /** - * Points used to deduct fee. + * Points used to deduct fee * @return pointFee **/ @javax.annotation.Nullable @@ -982,7 +982,7 @@ public String getPointFee() { /** - * GT used to deduct fee. + * GT used to deduct fee * @return gtFee **/ @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 @@ -1002,7 +1002,7 @@ public Boolean getGtDiscount() { /** - * Rebated fee. + * Rebated fee * @return rebatedFee **/ @javax.annotation.Nullable @@ -1012,7 +1012,7 @@ public String getRebatedFee() { /** - * Rebated fee currency unit. + * Rebated fee currency unit * @return rebatedFeeCurrency **/ @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 658a472..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 BorrowCurrencyInfo currency(String currency) { } /** - * Currency. + * Currency * @return currency **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public BorrowCurrencyInfo indexPrice(String indexPrice) { } /** - * Currency Index Price. + * Currency Index Price * @return indexPrice **/ @javax.annotation.Nullable @@ -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 90cd46d..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -42,7 +42,7 @@ public BrokerCommission total(Long total) { } /** - * Total. + * Total * @return total **/ @javax.annotation.Nullable @@ -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 1448f51..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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,7 +76,7 @@ public BrokerCommission1 commissionTime(Long commissionTime) { } /** - * Commission Time. (unix timestamp). + * Commission time (Unix timestamp in seconds) * @return commissionTime **/ @javax.annotation.Nullable @@ -96,7 +96,7 @@ public BrokerCommission1 userId(Long userId) { } /** - * User ID. + * User ID * @return userId **/ @javax.annotation.Nullable @@ -116,7 +116,7 @@ public BrokerCommission1 groupName(String groupName) { } /** - * Group name. + * Group name * @return groupName **/ @javax.annotation.Nullable @@ -136,7 +136,7 @@ public BrokerCommission1 amount(String amount) { } /** - * The amount of commission rebates. + * The amount of commission rebates * @return amount **/ @javax.annotation.Nullable @@ -156,7 +156,7 @@ public BrokerCommission1 fee(String fee) { } /** - * Fee. + * Fee * @return fee **/ @javax.annotation.Nullable @@ -176,7 +176,7 @@ public BrokerCommission1 feeAsset(String feeAsset) { } /** - * Fee currency. + * Fee currency * @return feeAsset **/ @javax.annotation.Nullable @@ -196,7 +196,7 @@ public BrokerCommission1 rebateFee(String rebateFee) { } /** - * The income from rebates, converted to USDT. + * The income from rebates, converted to USDT * @return rebateFee **/ @javax.annotation.Nullable @@ -216,7 +216,7 @@ public BrokerCommission1 source(String source) { } /** - * Rebate Type: Spot、Futures、Options.、Alpha + * Commission transaction type: Spot, Futures, Options, Alpha * @return source **/ @javax.annotation.Nullable @@ -236,7 +236,7 @@ public BrokerCommission1 currencyPair(String currencyPair) { } /** - * Currency pair. + * Currency pair * @return currencyPair **/ @javax.annotation.Nullable @@ -276,7 +276,7 @@ public BrokerCommission1 alphaContractAddr(String alphaContractAddr) { } /** - * Alpha token address + * Alpha contract address * @return alphaContractAddr **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/BrokerCommissionSubBrokerInfo.java b/src/main/java/io/gate/gateapi/models/BrokerCommissionSubBrokerInfo.java index b2ee074..11b720c 100644 --- a/src/main/java/io/gate/gateapi/models/BrokerCommissionSubBrokerInfo.java +++ b/src/main/java/io/gate/gateapi/models/BrokerCommissionSubBrokerInfo.java @@ -1,6 +1,6 @@ /* * Gate API - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 sub broker info. + * Sub-broker information */ public class BrokerCommissionSubBrokerInfo { public static final String SERIALIZED_NAME_USER_ID = "user_id"; @@ -47,7 +47,7 @@ public BrokerCommissionSubBrokerInfo userId(Long userId) { } /** - * The sub broker user ID. + * Sub-broker user ID * @return userId **/ @javax.annotation.Nullable @@ -67,7 +67,7 @@ public BrokerCommissionSubBrokerInfo originalCommissionRate(String originalCommi } /** - * The sub broker original commission rate. + * Sub-broker original commission rate * @return originalCommissionRate **/ @javax.annotation.Nullable @@ -87,7 +87,7 @@ public BrokerCommissionSubBrokerInfo relativeCommissionRate(String relativeCommi } /** - * The sub broker relative commission rate. + * Sub-broker relative commission rate * @return relativeCommissionRate **/ @javax.annotation.Nullable @@ -107,7 +107,7 @@ public BrokerCommissionSubBrokerInfo commissionRate(String commissionRate) { } /** - * The sub broker actual commission rate. + * Sub-broker actual commission rate * @return commissionRate **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/BrokerTransaction.java b/src/main/java/io/gate/gateapi/models/BrokerTransaction.java index dd5d82f..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -42,7 +42,7 @@ public BrokerTransaction total(Long total) { } /** - * Total. + * Total * @return total **/ @javax.annotation.Nullable @@ -70,7 +70,7 @@ public BrokerTransaction addListItem(BrokerTransaction1 listItem) { } /** - * List of transaction history. + * List of transaction history * @return list **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/BrokerTransaction1.java b/src/main/java/io/gate/gateapi/models/BrokerTransaction1.java index 8216825..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 BrokerTransaction1 transactionTime(Long transactionTime) { } /** - * Transaction Time. (unix timestamp). + * Transaction Time. (unix timestamp) * @return transactionTime **/ @javax.annotation.Nullable @@ -92,7 +92,7 @@ public BrokerTransaction1 userId(Long userId) { } /** - * User ID. + * User ID * @return userId **/ @javax.annotation.Nullable @@ -112,7 +112,7 @@ public BrokerTransaction1 groupName(String groupName) { } /** - * Group name. + * Group name * @return groupName **/ @javax.annotation.Nullable @@ -132,7 +132,7 @@ public BrokerTransaction1 fee(String fee) { } /** - * fee (usdt). + * Fee amount (USDT) * @return fee **/ @javax.annotation.Nullable @@ -152,7 +152,7 @@ public BrokerTransaction1 currencyPair(String currencyPair) { } /** - * Currency pair. + * Currency pair * @return currencyPair **/ @javax.annotation.Nullable @@ -172,7 +172,7 @@ public BrokerTransaction1 amount(String amount) { } /** - * Commission Amount. + * Transaction amount * @return amount **/ @javax.annotation.Nullable @@ -192,7 +192,7 @@ public BrokerTransaction1 feeAsset(String feeAsset) { } /** - * Fee currency. + * Fee currency * @return feeAsset **/ @javax.annotation.Nullable @@ -212,7 +212,7 @@ public BrokerTransaction1 source(String source) { } /** - * Rebate Type: Spot、Futures、Options.、Alpha + * Commission transaction type: Spot, Futures, Options, Alpha * @return source **/ @javax.annotation.Nullable @@ -252,7 +252,7 @@ public BrokerTransaction1 alphaContractAddr(String alphaContractAddr) { } /** - * Alpha token address + * Alpha contract address * @return alphaContractAddr **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CancelBatchOrder.java b/src/main/java/io/gate/gateapi/models/CancelBatchOrder.java index c781e8a..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Info of order to be cancelled. + * Info of order to be cancelled */ public class CancelBatchOrder { public static final String SERIALIZED_NAME_CURRENCY_PAIR = "currency_pair"; @@ -47,7 +47,7 @@ public CancelBatchOrder currencyPair(String currencyPair) { } /** - * Order currency pair. + * Order currency pair * @return currencyPair **/ public String getCurrencyPair() { diff --git a/src/main/java/io/gate/gateapi/models/CancelOrderResult.java b/src/main/java/io/gate/gateapi/models/CancelOrderResult.java index 6f5c922..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Order cancellation result. + * Order cancellation result */ public class CancelOrderResult { public static final String SERIALIZED_NAME_CURRENCY_PAIR = "currency_pair"; @@ -59,7 +59,7 @@ public CancelOrderResult currencyPair(String currencyPair) { } /** - * Order currency pair. + * Order currency pair * @return currencyPair **/ @javax.annotation.Nullable @@ -79,7 +79,7 @@ public CancelOrderResult id(String id) { } /** - * Order ID. + * Order ID * @return id **/ @javax.annotation.Nullable @@ -99,7 +99,7 @@ public CancelOrderResult text(String text) { } /** - * Custom order information. + * Custom order information * @return text **/ @javax.annotation.Nullable @@ -119,7 +119,7 @@ public CancelOrderResult succeeded(Boolean succeeded) { } /** - * Whether cancellation succeeded. + * Whether cancellation succeeded * @return succeeded **/ @javax.annotation.Nullable @@ -139,7 +139,7 @@ public CancelOrderResult label(String label) { } /** - * Error label when failed to cancel the order; emtpy if succeeded. + * Error label when failed to cancel the order; emtpy if succeeded * @return label **/ @javax.annotation.Nullable @@ -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 @@ -179,7 +179,7 @@ public CancelOrderResult account(String account) { } /** - * Default is empty (deprecated). + * Default is empty (deprecated) * @return account **/ @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 a2c0246..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -46,7 +46,7 @@ public CollateralAdjust orderId(Long orderId) { } /** - * Order ID. + * Order ID * @return orderId **/ public Long getOrderId() { @@ -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 6d071c8..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -42,7 +42,7 @@ public CollateralAdjustRes orderId(Long orderId) { } /** - * Order ID. + * Order ID * @return orderId **/ @javax.annotation.Nullable @@ -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 26a51df..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 CollateralAlign orderId(Long orderId) { } /** - * Order ID. + * Order ID * @return orderId **/ public Long getOrderId() { @@ -66,7 +66,7 @@ public CollateralAlign collateralCurrency(String collateralCurrency) { } /** - * Collateral. + * Collateral currency * @return collateralCurrency **/ public String getCollateralCurrency() { @@ -85,7 +85,7 @@ public CollateralAlign collateralAmount(String collateralAmount) { } /** - * Collateral amount. + * Collateral amount * @return collateralAmount **/ public String getCollateralAmount() { @@ -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 6151f12..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 CollateralCurrency currency(String currency) { } /** - * Currency. + * Currency * @return currency **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public CollateralCurrency amount(String amount) { } /** - * Size. + * Size * @return amount **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CollateralCurrencyInfo.java b/src/main/java/io/gate/gateapi/models/CollateralCurrencyInfo.java index 5a4878b..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 CollateralCurrencyInfo currency(String currency) { } /** - * Currency. + * Currency * @return currency **/ @javax.annotation.Nullable @@ -67,7 +67,7 @@ public CollateralCurrencyInfo indexPrice(String indexPrice) { } /** - * Currency Index Price. + * Currency Index Price * @return indexPrice **/ @javax.annotation.Nullable @@ -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 6ac6830..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 CollateralCurrencyRes succeeded(Boolean succeeded) { } /** - * Update success status. + * Update success status * @return succeeded **/ @javax.annotation.Nullable @@ -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 @@ -111,7 +111,7 @@ public CollateralCurrencyRes currency(String currency) { } /** - * Currency. + * Currency * @return currency **/ @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 1508a7f..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -39,7 +39,7 @@ public CollateralCurrentRate currency(String currency) { } /** - * Currency. + * Currency * @return currency **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public CollateralCurrentRate currentRate(String currentRate) { } /** - * Currency current interest rate. + * Currency current interest rate * @return currentRate **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CollateralFixRate.java b/src/main/java/io/gate/gateapi/models/CollateralFixRate.java index 6e9c923..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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-collateral fixed interest rate. + * Multi-collateral fixed interest rate */ public class CollateralFixRate { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -47,7 +47,7 @@ public CollateralFixRate currency(String currency) { } /** - * Currency. + * Currency * @return currency **/ @javax.annotation.Nullable @@ -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 fff881f..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Supported borrowing and collateral currencies. + * Supported borrowing and collateral currencies */ public class CollateralLoanCurrency { public static final String SERIALIZED_NAME_LOAN_CURRENCY = "loan_currency"; @@ -41,7 +41,7 @@ public CollateralLoanCurrency loanCurrency(String loanCurrency) { } /** - * Borrowed currency. + * Borrowed currency * @return loanCurrency **/ @javax.annotation.Nullable @@ -69,7 +69,7 @@ public CollateralLoanCurrency addCollateralCurrencyItem(String collateralCurrenc } /** - * List of supported collateral currencies. + * List of supported collateral currencies * @return collateralCurrency **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CollateralLtv.java b/src/main/java/io/gate/gateapi/models/CollateralLtv.java index e52660f..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 086b275..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -95,7 +95,7 @@ public CollateralOrder orderId(Long orderId) { } /** - * Order ID. + * Order ID * @return orderId **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public CollateralOrder collateralCurrency(String collateralCurrency) { } /** - * Collateral. + * Collateral currency * @return collateralCurrency **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public CollateralOrder collateralAmount(String collateralAmount) { } /** - * Collateral amount. + * Collateral amount * @return collateralAmount **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public CollateralOrder borrowCurrency(String borrowCurrency) { } /** - * Borrowed currency. + * Borrowed currency * @return borrowCurrency **/ @javax.annotation.Nullable @@ -175,7 +175,7 @@ public CollateralOrder borrowAmount(String borrowAmount) { } /** - * Borrowing amount. + * Borrowed amount * @return borrowAmount **/ @javax.annotation.Nullable @@ -195,7 +195,7 @@ public CollateralOrder repaidAmount(String repaidAmount) { } /** - * Repaid amount. + * Repaid amount * @return repaidAmount **/ @javax.annotation.Nullable @@ -215,7 +215,7 @@ public CollateralOrder repaidPrincipal(String repaidPrincipal) { } /** - * Repaid principal. + * Repaid principal * @return repaidPrincipal **/ @javax.annotation.Nullable @@ -235,7 +235,7 @@ public CollateralOrder repaidInterest(String repaidInterest) { } /** - * Repaid interest. + * Repaid interest * @return repaidInterest **/ @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 @@ -335,7 +335,7 @@ public CollateralOrder borrowTime(Long borrowTime) { } /** - * Borrowing time, timestamp in seconds. + * Borrowing time, timestamp in seconds * @return borrowTime **/ @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 810c4d9..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 record. + * Collateral record */ public class CollateralRecord { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; @@ -71,7 +71,7 @@ public CollateralRecord orderId(Long orderId) { } /** - * Order ID. + * Order ID * @return orderId **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public CollateralRecord recordId(Long recordId) { } /** - * Collateral record ID. + * Collateral record ID * @return recordId **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public CollateralRecord borrowCurrency(String borrowCurrency) { } /** - * Borrowed currency. + * Borrowed currency * @return borrowCurrency **/ @javax.annotation.Nullable @@ -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 93aa8f3..2750ffe 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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Futures contract details. + * Futures contract details */ public class Contract { public static final String SERIALIZED_NAME_NAME = "name"; @@ -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, external index price + * Mark price type: internal - internal trading price, index - external index price */ @JsonAdapter(MarkTypeEnum.Adapter.class) public enum MarkTypeEnum { @@ -277,7 +277,7 @@ public Contract name(String name) { } /** - * Futures contract. + * Futures contract * @return name **/ @javax.annotation.Nullable @@ -297,7 +297,7 @@ public Contract type(TypeEnum type) { } /** - * Futures contract type. + * Contract type: inverse - inverse contract, direct - direct contract * @return type **/ @javax.annotation.Nullable @@ -317,7 +317,7 @@ public Contract quantoMultiplier(String quantoMultiplier) { } /** - * Multiplier used in converting from invoicing to settlement currency. + * Multiplier used in converting from invoicing to settlement currency * @return quantoMultiplier **/ @javax.annotation.Nullable @@ -337,7 +337,7 @@ public Contract leverageMin(String leverageMin) { } /** - * Minimum leverage. + * Minimum leverage * @return leverageMin **/ @javax.annotation.Nullable @@ -357,7 +357,7 @@ public Contract leverageMax(String leverageMax) { } /** - * Maximum leverage. + * Maximum leverage * @return leverageMax **/ @javax.annotation.Nullable @@ -377,7 +377,7 @@ public Contract maintenanceRate(String maintenanceRate) { } /** - * Maintenance rate of margin. + * Maintenance rate of margin * @return maintenanceRate **/ @javax.annotation.Nullable @@ -397,7 +397,7 @@ public Contract markType(MarkTypeEnum markType) { } /** - * Mark price type, internal - based on internal trading, external index price + * Mark price type: internal - internal trading price, index - external index price * @return markType **/ @javax.annotation.Nullable @@ -417,7 +417,7 @@ public Contract markPrice(String markPrice) { } /** - * Current mark price. + * Current mark price * @return markPrice **/ @javax.annotation.Nullable @@ -437,7 +437,7 @@ public Contract indexPrice(String indexPrice) { } /** - * Current index price. + * Current index price * @return indexPrice **/ @javax.annotation.Nullable @@ -457,7 +457,7 @@ public Contract lastPrice(String lastPrice) { } /** - * Last trading price. + * Last trading price * @return lastPrice **/ @javax.annotation.Nullable @@ -477,7 +477,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 @@ -497,7 +497,7 @@ public Contract takerFeeRate(String takerFeeRate) { } /** - * Taker fee rate. + * Taker fee rate * @return takerFeeRate **/ @javax.annotation.Nullable @@ -517,7 +517,7 @@ public Contract orderPriceRound(String orderPriceRound) { } /** - * Minimum order price increment. + * Minimum order price increment * @return orderPriceRound **/ @javax.annotation.Nullable @@ -537,7 +537,7 @@ public Contract markPriceRound(String markPriceRound) { } /** - * Minimum mark price increment. + * Minimum mark price increment * @return markPriceRound **/ @javax.annotation.Nullable @@ -557,7 +557,7 @@ public Contract fundingRate(String fundingRate) { } /** - * Current funding rate. + * Current funding rate * @return fundingRate **/ @javax.annotation.Nullable @@ -577,7 +577,7 @@ public Contract fundingInterval(Integer fundingInterval) { } /** - * Funding application interval, unit in seconds. + * Funding application interval, unit in seconds * @return fundingInterval **/ @javax.annotation.Nullable @@ -597,7 +597,7 @@ public Contract fundingNextApply(Double fundingNextApply) { } /** - * Next funding time. + * Next funding time * @return fundingNextApply **/ @javax.annotation.Nullable @@ -617,7 +617,7 @@ public Contract riskLimitBase(String riskLimitBase) { } /** - * Risk limit base,deprecated. + * Base risk limit (deprecated) * @return riskLimitBase **/ @javax.annotation.Nullable @@ -637,7 +637,7 @@ public Contract riskLimitStep(String riskLimitStep) { } /** - * Step of adjusting risk limit,deprecated. + * Risk limit adjustment step (deprecated) * @return riskLimitStep **/ @javax.annotation.Nullable @@ -657,7 +657,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 @@ -677,7 +677,7 @@ public Contract orderSizeMin(Long orderSizeMin) { } /** - * Minimum order size the contract allowed. + * Minimum order size allowed by the contract * @return orderSizeMin **/ @javax.annotation.Nullable @@ -697,7 +697,7 @@ public Contract orderSizeMax(Long orderSizeMax) { } /** - * Maximum order size the contract allowed. + * Maximum order size allowed by the contract * @return orderSizeMax **/ @javax.annotation.Nullable @@ -717,7 +717,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 @@ -737,7 +737,7 @@ public Contract refDiscountRate(String refDiscountRate) { } /** - * Referral fee rate discount. + * Trading fee discount for referred users * @return refDiscountRate **/ @javax.annotation.Nullable @@ -757,7 +757,7 @@ public Contract refRebateRate(String refRebateRate) { } /** - * Referrer commission rate. + * Commission rate for referrers * @return refRebateRate **/ @javax.annotation.Nullable @@ -777,7 +777,7 @@ public Contract orderbookId(Long orderbookId) { } /** - * Current orderbook ID. + * Orderbook update ID * @return orderbookId **/ @javax.annotation.Nullable @@ -797,7 +797,7 @@ public Contract tradeId(Long tradeId) { } /** - * Current trade ID. + * Current trade ID * @return tradeId **/ @javax.annotation.Nullable @@ -817,7 +817,7 @@ public Contract tradeSize(Long tradeSize) { } /** - * Historical accumulated trade size. + * Historical cumulative trading volume * @return tradeSize **/ @javax.annotation.Nullable @@ -837,7 +837,7 @@ public Contract positionSize(Long positionSize) { } /** - * Current total long position size. + * Current total long position size * @return positionSize **/ @javax.annotation.Nullable @@ -857,7 +857,7 @@ public Contract configChangeTime(Double configChangeTime) { } /** - * Last changed time of configuration. + * Last configuration update time * @return configChangeTime **/ @javax.annotation.Nullable @@ -877,7 +877,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` 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 @@ -897,7 +897,7 @@ public Contract ordersLimit(Integer ordersLimit) { } /** - * Maximum number of open orders. + * Maximum number of pending orders * @return ordersLimit **/ @javax.annotation.Nullable @@ -917,7 +917,7 @@ public Contract enableBonus(Boolean enableBonus) { } /** - * Whether bouns is enabled. + * Whether bonus is enabled * @return enableBonus **/ @javax.annotation.Nullable @@ -937,7 +937,7 @@ public Contract enableCredit(Boolean enableCredit) { } /** - * Whether portfolio margin account is enabled. + * Whether portfolio margin account is enabled * @return enableCredit **/ @javax.annotation.Nullable @@ -957,7 +957,7 @@ public Contract createTime(Double createTime) { } /** - * Created time of the contract. + * Created time of the contract * @return createTime **/ @javax.annotation.Nullable @@ -997,7 +997,7 @@ public Contract status(String status) { } /** - * Contract Status Types include: prelaunch, trading, delisting, delisted. + * Contract status types include: prelaunch (pre-launch), trading (active), delisting (delisting), delisted (delisted) * @return status **/ @javax.annotation.Nullable @@ -1017,7 +1017,7 @@ public Contract launchTime(Long launchTime) { } /** - * Contract expiry timestamp. + * Contract expiry timestamp * @return launchTime **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/ContractStat.java b/src/main/java/io/gate/gateapi/models/ContractStat.java index b679604..a35ac3d 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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -84,7 +84,7 @@ public ContractStat time(Long time) { } /** - * Stat timestamp. + * Stat timestamp * @return time **/ @javax.annotation.Nullable @@ -104,7 +104,7 @@ public ContractStat lsrTaker(BigDecimal lsrTaker) { } /** - * Long/short account number ratio. + * Long/short taker ratio * @return lsrTaker **/ @javax.annotation.Nullable @@ -124,7 +124,7 @@ public ContractStat lsrAccount(BigDecimal lsrAccount) { } /** - * Long/short taker size ratio. + * Long/short position user ratio * @return lsrAccount **/ @javax.annotation.Nullable @@ -144,7 +144,7 @@ public ContractStat longLiqSize(Long longLiqSize) { } /** - * Long liquidation size. + * Long liquidation size (contracts) * @return longLiqSize **/ @javax.annotation.Nullable @@ -164,7 +164,7 @@ public ContractStat longLiqAmount(Double longLiqAmount) { } /** - * Long liquidation amount(base currency). + * Long liquidation amount (base currency) * @return longLiqAmount **/ @javax.annotation.Nullable @@ -184,7 +184,7 @@ public ContractStat longLiqUsd(Double longLiqUsd) { } /** - * Long liquidation volume(quote currency). + * Long liquidation volume (quote currency) * @return longLiqUsd **/ @javax.annotation.Nullable @@ -204,7 +204,7 @@ public ContractStat shortLiqSize(Long shortLiqSize) { } /** - * Short liquidation size. + * Short liquidation size (contracts) * @return shortLiqSize **/ @javax.annotation.Nullable @@ -224,7 +224,7 @@ public ContractStat shortLiqAmount(Double shortLiqAmount) { } /** - * Short liquidation amount(base currency). + * Short liquidation amount (base currency) * @return shortLiqAmount **/ @javax.annotation.Nullable @@ -244,7 +244,7 @@ public ContractStat shortLiqUsd(Double shortLiqUsd) { } /** - * Short liquidation volume(quote currency). + * Short liquidation volume (quote currency) * @return shortLiqUsd **/ @javax.annotation.Nullable @@ -264,7 +264,7 @@ public ContractStat openInterest(Long openInterest) { } /** - * Open interest size. + * Total open interest size (contracts) * @return openInterest **/ @javax.annotation.Nullable @@ -284,7 +284,7 @@ public ContractStat openInterestUsd(Double openInterestUsd) { } /** - * Open interest volume(quote currency). + * Total open interest volume (quote currency) * @return openInterestUsd **/ @javax.annotation.Nullable @@ -304,7 +304,7 @@ public ContractStat topLsrAccount(Double topLsrAccount) { } /** - * Top trader long/short account ratio. + * Top trader long/short account ratio * @return topLsrAccount **/ @javax.annotation.Nullable @@ -324,7 +324,7 @@ public ContractStat topLsrSize(Double topLsrSize) { } /** - * Top trader long/short position ratio. + * Top trader long/short position ratio * @return topLsrSize **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/ConvertSmallBalance.java b/src/main/java/io/gate/gateapi/models/ConvertSmallBalance.java index d59305b..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 fda8184..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -58,7 +58,7 @@ public CountdownCancelAllFuturesTask contract(String contract) { } /** - * Futures contract. + * Futures contract * @return contract **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CountdownCancelAllOptionsTask.java b/src/main/java/io/gate/gateapi/models/CountdownCancelAllOptionsTask.java index 17456bf..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -62,7 +62,7 @@ public CountdownCancelAllOptionsTask contract(String contract) { } /** - * Options contract name. + * Options contract name * @return contract **/ @javax.annotation.Nullable @@ -82,7 +82,7 @@ public CountdownCancelAllOptionsTask underlying(String underlying) { } /** - * Underlying. + * Underlying * @return underlying **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CountdownCancelAllSpotTask.java b/src/main/java/io/gate/gateapi/models/CountdownCancelAllSpotTask.java index 91f6ddb..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -58,7 +58,7 @@ public CountdownCancelAllSpotTask currencyPair(String currencyPair) { } /** - * Currency pair. + * Currency pair * @return currencyPair **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CreateCollateralOrder.java b/src/main/java/io/gate/gateapi/models/CreateCollateralOrder.java index 835ccb2..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 CreateCollateralOrder collateralAmount(String collateralAmount) { } /** - * Collateral amount. + * Collateral amount * @return collateralAmount **/ public String getCollateralAmount() { @@ -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() { @@ -104,7 +104,7 @@ public CreateCollateralOrder borrowCurrency(String borrowCurrency) { } /** - * Borrowed currency. + * Borrowed currency * @return borrowCurrency **/ public String getBorrowCurrency() { diff --git a/src/main/java/io/gate/gateapi/models/CreateMultiCollateralOrder.java b/src/main/java/io/gate/gateapi/models/CreateMultiCollateralOrder.java index bc6d8d9..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 CreateMultiCollateralOrder orderId(String orderId) { } /** - * Order ID. + * Order ID * @return orderId **/ @javax.annotation.Nullable @@ -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 @@ -190,7 +190,7 @@ public CreateMultiCollateralOrder borrowCurrency(String borrowCurrency) { } /** - * Borrowed currency. + * Borrowed currency * @return borrowCurrency **/ public String getBorrowCurrency() { @@ -209,7 +209,7 @@ public CreateMultiCollateralOrder borrowAmount(String borrowAmount) { } /** - * Borrowing amount. + * Borrowed amount * @return borrowAmount **/ public String getBorrowAmount() { @@ -236,7 +236,7 @@ public CreateMultiCollateralOrder addCollateralCurrenciesItem(CollateralCurrency } /** - * Collateral currency and amount. + * Collateral currency and amount * @return collateralCurrencies **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CreateUniLend.java b/src/main/java/io/gate/gateapi/models/CreateUniLend.java index 31aff38..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 { @@ -94,7 +94,7 @@ public CreateUniLend currency(String currency) { } /** - * Currency name. + * Currency name * @return currency **/ public String getCurrency() { @@ -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 cf488ce..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Borrow or repay. + * Borrow or repay */ public class CreateUniLoan { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -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 { @@ -98,7 +98,7 @@ public CreateUniLoan currency(String currency) { } /** - * Currency. + * Currency * @return currency **/ public String getCurrency() { @@ -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 repaid in full. + * Full repayment. For repayment operations only. When `true`, overrides `amount` and repays the full amount * @return repaidAll **/ @javax.annotation.Nullable @@ -175,7 +175,7 @@ public CreateUniLoan currencyPair(String currencyPair) { } /** - * Currency pair. + * Currency pair * @return currencyPair **/ public String getCurrencyPair() { diff --git a/src/main/java/io/gate/gateapi/models/CrossMarginBalance.java b/src/main/java/io/gate/gateapi/models/CrossMarginBalance.java index 0dcfe34..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 CrossMarginBalance available(String available) { } /** - * Available amount. + * Available balance * @return available **/ @javax.annotation.Nullable @@ -67,7 +67,7 @@ public CrossMarginBalance freeze(String freeze) { } /** - * Locked amount. + * Locked balance * @return freeze **/ @javax.annotation.Nullable @@ -87,7 +87,7 @@ public CrossMarginBalance borrowed(String borrowed) { } /** - * Borrowed amount. + * Borrowed balance * @return borrowed **/ @javax.annotation.Nullable @@ -107,7 +107,7 @@ public CrossMarginBalance interest(String interest) { } /** - * Unpaid interests. + * Unpaid interest * @return interest **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CrossMarginLoan.java b/src/main/java/io/gate/gateapi/models/CrossMarginLoan.java index 8eb7a8f..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -114,7 +114,7 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { /** - * Loan record ID. + * Loan record ID * @return id **/ @javax.annotation.Nullable @@ -124,7 +124,7 @@ public String getId() { /** - * Creation timestamp, in milliseconds. + * Creation timestamp, in milliseconds * @return createTime **/ @javax.annotation.Nullable @@ -134,7 +134,7 @@ public Long getCreateTime() { /** - * Update timestamp, in milliseconds. + * Update timestamp, in milliseconds * @return updateTime **/ @javax.annotation.Nullable @@ -150,7 +150,7 @@ public CrossMarginLoan currency(String currency) { } /** - * Currency name. + * Currency name * @return currency **/ public String getCurrency() { @@ -169,7 +169,7 @@ public CrossMarginLoan amount(String amount) { } /** - * Borrowed amount. + * Borrowed amount * @return amount **/ public String getAmount() { @@ -188,7 +188,7 @@ public CrossMarginLoan text(String text) { } /** - * User defined custom ID. + * User defined custom ID * @return text **/ @javax.annotation.Nullable @@ -212,7 +212,7 @@ public StatusEnum getStatus() { /** - * Repaid amount. + * Repaid amount * @return repaid **/ @javax.annotation.Nullable @@ -222,7 +222,7 @@ public String getRepaid() { /** - * Repaid interest. + * Repaid interest * @return repaidInterest **/ @javax.annotation.Nullable @@ -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/CrossMarginRepayment.java b/src/main/java/io/gate/gateapi/models/CrossMarginRepayment.java index 3d15608..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 CrossMarginRepayment id(String id) { } /** - * Loan record ID. + * Loan record ID * @return id **/ @javax.annotation.Nullable @@ -79,7 +79,7 @@ public CrossMarginRepayment createTime(Long createTime) { } /** - * Repayment time. + * Repayment time * @return createTime **/ @javax.annotation.Nullable @@ -99,7 +99,7 @@ public CrossMarginRepayment loanId(String loanId) { } /** - * Loan record ID. + * Loan record ID * @return loanId **/ @javax.annotation.Nullable @@ -119,7 +119,7 @@ public CrossMarginRepayment currency(String currency) { } /** - * Currency name. + * Currency name * @return currency **/ @javax.annotation.Nullable @@ -139,7 +139,7 @@ public CrossMarginRepayment principal(String principal) { } /** - * Repaid principal. + * Repaid principal * @return principal **/ @javax.annotation.Nullable @@ -159,7 +159,7 @@ public CrossMarginRepayment interest(String interest) { } /** - * Repaid interest. + * Repaid interest * @return interest **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/Currency.java b/src/main/java/io/gate/gateapi/models/Currency.java index d464bb5..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 Currency currency(String currency) { } /** - * Currency symbol. + * Currency symbol * @return currency **/ @javax.annotation.Nullable @@ -94,7 +94,7 @@ public Currency name(String name) { } /** - * Currency name. + * Currency name * @return name **/ @javax.annotation.Nullable @@ -114,7 +114,7 @@ public Currency delisted(Boolean delisted) { } /** - * Whether currency is de-listed. + * Whether currency is de-listed * @return delisted **/ @javax.annotation.Nullable @@ -134,7 +134,7 @@ public Currency withdrawDisabled(Boolean withdrawDisabled) { } /** - * Whether currency's withdrawal is disabled (deprecated). + * Whether currency's withdrawal is disabled (deprecated) * @return withdrawDisabled **/ @javax.annotation.Nullable @@ -154,7 +154,7 @@ public Currency withdrawDelayed(Boolean withdrawDelayed) { } /** - * Whether currency's withdrawal is delayed (deprecated). + * Whether currency's withdrawal is delayed (deprecated) * @return withdrawDelayed **/ @javax.annotation.Nullable @@ -174,7 +174,7 @@ public Currency depositDisabled(Boolean depositDisabled) { } /** - * Whether currency's deposit is disabled (deprecated). + * Whether currency's deposit is disabled (deprecated) * @return depositDisabled **/ @javax.annotation.Nullable @@ -194,7 +194,7 @@ public Currency tradeDisabled(Boolean tradeDisabled) { } /** - * Whether currency's trading is disabled. + * Whether currency's trading is disabled * @return tradeDisabled **/ @javax.annotation.Nullable @@ -234,7 +234,7 @@ public Currency chain(String chain) { } /** - * The main chain corresponding to the coin. + * The main chain corresponding to the coin * @return chain **/ @javax.annotation.Nullable @@ -262,7 +262,7 @@ public Currency addChainsItem(SpotCurrencyChain chainsItem) { } /** - * All links corresponding to coins. + * All links corresponding to coins * @return chains **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CurrencyChain.java b/src/main/java/io/gate/gateapi/models/CurrencyChain.java index 1a3f6f0..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 CurrencyChain chain(String chain) { } /** - * Chain name. + * Chain name * @return chain **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public CurrencyChain nameCn(String nameCn) { } /** - * Chain name in Chinese. + * Chain name in Chinese * @return nameCn **/ @javax.annotation.Nullable @@ -103,7 +103,7 @@ public CurrencyChain nameEn(String nameEn) { } /** - * Chain name in English. + * Chain name in English * @return nameEn **/ @javax.annotation.Nullable @@ -143,7 +143,7 @@ public CurrencyChain isDisabled(Integer isDisabled) { } /** - * If it is disabled. 0 means NOT being disabled. + * If it is disabled. 0 means NOT being disabled * @return isDisabled **/ @javax.annotation.Nullable @@ -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 @@ -203,7 +203,7 @@ public CurrencyChain decimal(String decimal) { } /** - * Withdrawal precision. + * Withdrawal precision * @return decimal **/ @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 2f21c8e..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Spot currency pair. + * Spot currency pair */ public class CurrencyPair { public static final String SERIALIZED_NAME_ID = "id"; @@ -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: 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 { @@ -158,7 +158,7 @@ public CurrencyPair id(String id) { } /** - * Currency pair. + * Currency pair * @return id **/ @javax.annotation.Nullable @@ -178,7 +178,7 @@ public CurrencyPair base(String base) { } /** - * Base currency. + * Base currency * @return base **/ @javax.annotation.Nullable @@ -198,7 +198,7 @@ public CurrencyPair baseName(String baseName) { } /** - * Transaction currency name. + * Base currency name * @return baseName **/ @javax.annotation.Nullable @@ -218,7 +218,7 @@ public CurrencyPair quote(String quote) { } /** - * Quote currency. + * Quote currency * @return quote **/ @javax.annotation.Nullable @@ -238,7 +238,7 @@ public CurrencyPair quoteName(String quoteName) { } /** - * Name of the denominated currency. + * Quote currency name * @return quoteName **/ @javax.annotation.Nullable @@ -258,7 +258,7 @@ public CurrencyPair fee(String fee) { } /** - * Trading fee. + * Trading fee rate * @return fee **/ @javax.annotation.Nullable @@ -278,7 +278,7 @@ public CurrencyPair minBaseAmount(String minBaseAmount) { } /** - * Minimum amount of base currency to trade, `null` means no limit. + * Minimum amount of base currency to trade, `null` means no limit * @return minBaseAmount **/ @javax.annotation.Nullable @@ -298,7 +298,7 @@ public CurrencyPair minQuoteAmount(String minQuoteAmount) { } /** - * Minimum amount of quote currency to trade, `null` means no limit. + * Minimum amount of quote currency to trade, `null` means no limit * @return minQuoteAmount **/ @javax.annotation.Nullable @@ -318,7 +318,7 @@ public CurrencyPair maxBaseAmount(String maxBaseAmount) { } /** - * Maximum amount of base currency to trade, `null` means no limit. + * Maximum amount of base currency to trade, `null` means no limit * @return maxBaseAmount **/ @javax.annotation.Nullable @@ -338,7 +338,7 @@ public CurrencyPair maxQuoteAmount(String maxQuoteAmount) { } /** - * Maximum amount of quote currency to trade, `null` means no limit. + * Maximum amount of quote currency to trade, `null` means no limit * @return maxQuoteAmount **/ @javax.annotation.Nullable @@ -358,7 +358,7 @@ public CurrencyPair amountPrecision(Integer amountPrecision) { } /** - * Amount scale. + * Amount scale * @return amountPrecision **/ @javax.annotation.Nullable @@ -378,7 +378,7 @@ public CurrencyPair precision(Integer precision) { } /** - * Price scale. + * Price scale * @return precision **/ @javax.annotation.Nullable @@ -398,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: 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 @@ -418,7 +418,7 @@ public CurrencyPair sellStart(Long sellStart) { } /** - * Sell start unix timestamp in seconds. + * Sell start unix timestamp in seconds * @return sellStart **/ @javax.annotation.Nullable @@ -438,7 +438,7 @@ public CurrencyPair buyStart(Long buyStart) { } /** - * Buy start unix timestamp in seconds. + * Buy start unix timestamp in seconds * @return buyStart **/ @javax.annotation.Nullable @@ -458,7 +458,7 @@ public CurrencyPair delistingTime(Long delistingTime) { } /** - * Expected time to remove the shelves, Unix timestamp in seconds. + * Expected time to remove the shelves, Unix timestamp in seconds * @return delistingTime **/ @javax.annotation.Nullable @@ -478,7 +478,7 @@ public CurrencyPair type(String type) { } /** - * Trading pair type, normal: normal, premarket: pre-market. + * Trading pair type, normal: normal, premarket: pre-market * @return type **/ @javax.annotation.Nullable @@ -498,7 +498,7 @@ public CurrencyPair tradeUrl(String tradeUrl) { } /** - * Transaction link. + * Transaction link * @return tradeUrl **/ @javax.annotation.Nullable @@ -518,7 +518,7 @@ public CurrencyPair stTag(Boolean stTag) { } /** - * Whether the trading pair is in ST risk assessment, false - No, true - Yes. + * Whether the trading pair is in ST risk assessment, false - No, true - Yes * @return stTag **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/CurrencyQuota.java b/src/main/java/io/gate/gateapi/models/CurrencyQuota.java index 83874cb..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Currency Quota. + * Currency Quota */ public class CurrencyQuota { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -51,7 +51,7 @@ public CurrencyQuota currency(String currency) { } /** - * Currency. + * Currency * @return currency **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public CurrencyQuota indexPrice(String indexPrice) { } /** - * Currency Index Price. + * Currency Index Price * @return indexPrice **/ @javax.annotation.Nullable @@ -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 @@ -131,7 +131,7 @@ public CurrencyQuota leftQuoteUsdt(String leftQuoteUsdt) { } /** - * Remaining currency limit converted to USDT. + * Remaining currency limit converted to USDT * @return leftQuoteUsdt **/ @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 fe583fe..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 60ef32f..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * data point in every timestamp. + * data point in every timestamp */ public class DeliveryCandlestick { public static final String SERIALIZED_NAME_T = "t"; @@ -55,7 +55,7 @@ public DeliveryCandlestick t(Double t) { } /** - * Unix timestamp in seconds. + * Unix timestamp in seconds * @return t **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public DeliveryCandlestick v(Long v) { } /** - * size volume (contract size). Only returned if `contract` is not prefixed. + * size volume (contract size). Only returned if `contract` is not prefixed * @return v **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public DeliveryCandlestick c(String c) { } /** - * Close price (quote currency). + * Close price (quote currency) * @return c **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public DeliveryCandlestick h(String h) { } /** - * Highest price (quote currency). + * Highest price (quote currency) * @return h **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public DeliveryCandlestick l(String l) { } /** - * Lowest price (quote currency). + * Lowest price (quote currency) * @return l **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public DeliveryCandlestick o(String o) { } /** - * Open price (quote currency). + * Open price (quote currency) * @return o **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/DeliveryContract.java b/src/main/java/io/gate/gateapi/models/DeliveryContract.java index b34021c..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Futures contract details. + * Futures contract details */ public class DeliveryContract { public static final String SERIALIZED_NAME_NAME = "name"; @@ -32,7 +32,7 @@ public class DeliveryContract { private String underlying; /** - * Cycle type, e.g. WEEKLY, QUARTERLY. + * Cycle type, e.g. WEEKLY, QUARTERLY */ @JsonAdapter(CycleEnum.Adapter.class) public enum CycleEnum { @@ -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, external index price + * Mark price type: internal - internal trading price, index - external index price */ @JsonAdapter(MarkTypeEnum.Adapter.class) public enum MarkTypeEnum { @@ -328,7 +328,7 @@ public DeliveryContract name(String name) { } /** - * Futures contract. + * Futures contract * @return name **/ @javax.annotation.Nullable @@ -348,7 +348,7 @@ public DeliveryContract underlying(String underlying) { } /** - * Underlying. + * Underlying * @return underlying **/ @javax.annotation.Nullable @@ -368,7 +368,7 @@ public DeliveryContract cycle(CycleEnum cycle) { } /** - * Cycle type, e.g. WEEKLY, QUARTERLY. + * Cycle type, e.g. WEEKLY, QUARTERLY * @return cycle **/ @javax.annotation.Nullable @@ -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 @@ -408,7 +408,7 @@ public DeliveryContract quantoMultiplier(String quantoMultiplier) { } /** - * Multiplier used in converting from invoicing to settlement currency. + * Multiplier used in converting from invoicing to settlement currency * @return quantoMultiplier **/ @javax.annotation.Nullable @@ -428,7 +428,7 @@ public DeliveryContract leverageMin(String leverageMin) { } /** - * Minimum leverage. + * Minimum leverage * @return leverageMin **/ @javax.annotation.Nullable @@ -448,7 +448,7 @@ public DeliveryContract leverageMax(String leverageMax) { } /** - * Maximum leverage. + * Maximum leverage * @return leverageMax **/ @javax.annotation.Nullable @@ -468,7 +468,7 @@ public DeliveryContract maintenanceRate(String maintenanceRate) { } /** - * Maintenance rate of margin. + * Maintenance rate of margin * @return maintenanceRate **/ @javax.annotation.Nullable @@ -488,7 +488,7 @@ public DeliveryContract markType(MarkTypeEnum markType) { } /** - * Mark price type, internal - based on internal trading, external index price + * Mark price type: internal - internal trading price, index - external index price * @return markType **/ @javax.annotation.Nullable @@ -508,7 +508,7 @@ public DeliveryContract markPrice(String markPrice) { } /** - * Current mark price. + * Current mark price * @return markPrice **/ @javax.annotation.Nullable @@ -528,7 +528,7 @@ public DeliveryContract indexPrice(String indexPrice) { } /** - * Current index price. + * Current index price * @return indexPrice **/ @javax.annotation.Nullable @@ -548,7 +548,7 @@ public DeliveryContract lastPrice(String lastPrice) { } /** - * Last trading price. + * Last trading price * @return lastPrice **/ @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 @@ -588,7 +588,7 @@ public DeliveryContract takerFeeRate(String takerFeeRate) { } /** - * Taker fee rate. + * Taker fee rate * @return takerFeeRate **/ @javax.annotation.Nullable @@ -608,7 +608,7 @@ public DeliveryContract orderPriceRound(String orderPriceRound) { } /** - * Minimum order price increment. + * Minimum order price increment * @return orderPriceRound **/ @javax.annotation.Nullable @@ -628,7 +628,7 @@ public DeliveryContract markPriceRound(String markPriceRound) { } /** - * Minimum mark price increment. + * Minimum mark price increment * @return markPriceRound **/ @javax.annotation.Nullable @@ -648,7 +648,7 @@ public DeliveryContract basisRate(String basisRate) { } /** - * Fair basis rate. + * Fair basis rate * @return basisRate **/ @javax.annotation.Nullable @@ -668,7 +668,7 @@ public DeliveryContract basisValue(String basisValue) { } /** - * Fair basis value. + * Fair basis value * @return basisValue **/ @javax.annotation.Nullable @@ -688,7 +688,7 @@ public DeliveryContract basisImpactValue(String basisImpactValue) { } /** - * Funding used for calculating impact bid, ask price. + * Funding used for calculating impact bid, ask price * @return basisImpactValue **/ @javax.annotation.Nullable @@ -708,7 +708,7 @@ public DeliveryContract settlePrice(String settlePrice) { } /** - * Settle price. + * Settle price * @return settlePrice **/ @javax.annotation.Nullable @@ -728,7 +728,7 @@ public DeliveryContract settlePriceInterval(Integer settlePriceInterval) { } /** - * Settle price update interval. + * Settle price update interval * @return settlePriceInterval **/ @javax.annotation.Nullable @@ -748,7 +748,7 @@ public DeliveryContract settlePriceDuration(Integer settlePriceDuration) { } /** - * Settle price update duration in seconds. + * Settle price update duration in seconds * @return settlePriceDuration **/ @javax.annotation.Nullable @@ -768,7 +768,7 @@ public DeliveryContract expireTime(Long expireTime) { } /** - * Contract expiry timestamp. + * Contract expiry timestamp * @return expireTime **/ @javax.annotation.Nullable @@ -788,7 +788,7 @@ public DeliveryContract riskLimitBase(String riskLimitBase) { } /** - * Risk limit base. + * Risk limit base * @return riskLimitBase **/ @javax.annotation.Nullable @@ -808,7 +808,7 @@ public DeliveryContract riskLimitStep(String riskLimitStep) { } /** - * Step of adjusting risk limit. + * Step of adjusting risk limit * @return riskLimitStep **/ @javax.annotation.Nullable @@ -828,7 +828,7 @@ public DeliveryContract riskLimitMax(String riskLimitMax) { } /** - * Maximum risk limit the contract allowed. + * Maximum risk limit the contract allowed * @return riskLimitMax **/ @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 @@ -968,7 +968,7 @@ public DeliveryContract tradeId(Long tradeId) { } /** - * Current trade ID. + * Current trade ID * @return tradeId **/ @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 @@ -1008,7 +1008,7 @@ public DeliveryContract positionSize(Long positionSize) { } /** - * Current total long position size. + * Current total long position size * @return positionSize **/ @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 @@ -1048,7 +1048,7 @@ public DeliveryContract inDelisting(Boolean inDelisting) { } /** - * Contract is delisting. + * Contract is delisting * @return inDelisting **/ @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 5303f22..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -61,7 +61,7 @@ public class DeliverySettlement { /** - * Liquidation time. + * Liquidation time * @return time **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public Long getTime() { /** - * Futures contract. + * Futures contract * @return contract **/ @javax.annotation.Nullable @@ -81,7 +81,7 @@ public String getContract() { /** - * Position leverage. + * Position leverage * @return leverage **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public String getLeverage() { /** - * Position size. + * Position size * @return size **/ @javax.annotation.Nullable @@ -101,7 +101,7 @@ public Long getSize() { /** - * Position margin. + * Position margin * @return margin **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public String getMargin() { /** - * Average entry price. + * Average entry price * @return entryPrice **/ @javax.annotation.Nullable @@ -121,7 +121,7 @@ public String getEntryPrice() { /** - * Settled price. + * Settled price * @return settlePrice **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public String getSettlePrice() { /** - * Profit. + * Profit * @return profit **/ @javax.annotation.Nullable @@ -141,7 +141,7 @@ public String getProfit() { /** - * Fee deducted. + * Fee deducted * @return fee **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/DeliveryTicker.java b/src/main/java/io/gate/gateapi/models/DeliveryTicker.java index 9c5b761..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -123,7 +123,7 @@ public DeliveryTicker contract(String contract) { } /** - * Futures contract. + * Futures contract * @return contract **/ @javax.annotation.Nullable @@ -143,7 +143,7 @@ public DeliveryTicker last(String last) { } /** - * Last trading price. + * Last trading price * @return last **/ @javax.annotation.Nullable @@ -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 @@ -183,7 +183,7 @@ public DeliveryTicker totalSize(String totalSize) { } /** - * Contract total size. + * Contract total size * @return totalSize **/ @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 @@ -363,7 +363,7 @@ public DeliveryTicker markPrice(String markPrice) { } /** - * Recent mark price. + * Recent mark price * @return markPrice **/ @javax.annotation.Nullable @@ -383,7 +383,7 @@ public DeliveryTicker fundingRate(String fundingRate) { } /** - * Funding rate. + * Funding rate * @return fundingRate **/ @javax.annotation.Nullable @@ -403,7 +403,7 @@ public DeliveryTicker fundingRateIndicative(String fundingRateIndicative) { } /** - * Indicative Funding rate in next period. (deprecated. use `funding_rate`). + * Indicative Funding rate in next period. (deprecated. use `funding_rate`) * @return fundingRateIndicative **/ @javax.annotation.Nullable @@ -423,7 +423,7 @@ public DeliveryTicker indexPrice(String indexPrice) { } /** - * Index price. + * Index price * @return indexPrice **/ @javax.annotation.Nullable @@ -463,7 +463,7 @@ public DeliveryTicker basisRate(String basisRate) { } /** - * Basis rate. + * Basis rate * @return basisRate **/ @javax.annotation.Nullable @@ -483,7 +483,7 @@ public DeliveryTicker basisValue(String basisValue) { } /** - * Basis value. + * Basis value * @return basisValue **/ @javax.annotation.Nullable @@ -503,7 +503,7 @@ public DeliveryTicker lowestAsk(String lowestAsk) { } /** - * Recent lowest ask. + * Recent lowest ask * @return lowestAsk **/ @javax.annotation.Nullable @@ -523,7 +523,7 @@ public DeliveryTicker lowestSize(String lowestSize) { } /** - * The latest seller's lowest price order quantity. + * The latest seller's lowest price order quantity * @return lowestSize **/ @javax.annotation.Nullable @@ -543,7 +543,7 @@ public DeliveryTicker highestBid(String highestBid) { } /** - * Recent highest bid. + * Recent highest bid * @return highestBid **/ @javax.annotation.Nullable @@ -563,7 +563,7 @@ public DeliveryTicker highestSize(String highestSize) { } /** - * The latest buyer's highest price order volume. + * The latest buyer's highest price order volume * @return highestSize **/ @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 eb8c2d6..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -46,7 +46,7 @@ public DepositAddress currency(String currency) { } /** - * Currency detail. + * Currency detail * @return currency **/ public String getCurrency() { @@ -65,7 +65,7 @@ public DepositAddress address(String address) { } /** - * Deposit address. + * Deposit address * @return address **/ public String getAddress() { diff --git a/src/main/java/io/gate/gateapi/models/DepositRecord.java b/src/main/java/io/gate/gateapi/models/DepositRecord.java index 99c3b4f..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 class DepositRecord { /** - * Record ID. + * Record ID * @return id **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public String getId() { /** - * Hash record of the withdrawal. + * Hash record of the withdrawal * @return txid **/ @javax.annotation.Nullable @@ -105,7 +105,7 @@ public void setWithdrawOrderId(String withdrawOrderId) { } /** - * Operation time. + * Operation time * @return timestamp **/ @javax.annotation.Nullable @@ -121,7 +121,7 @@ public DepositRecord amount(String amount) { } /** - * Currency amount. + * Token amount * @return amount **/ public String getAmount() { @@ -140,7 +140,7 @@ public DepositRecord currency(String currency) { } /** - * Currency name. + * Currency name * @return currency **/ public String getCurrency() { @@ -159,7 +159,7 @@ public DepositRecord address(String address) { } /** - * Withdrawal address. Required for withdrawals. + * Withdrawal address. Required for withdrawals * @return address **/ @javax.annotation.Nullable @@ -179,7 +179,7 @@ public DepositRecord memo(String memo) { } /** - * Additional remarks with regards to the withdrawal. + * Additional remarks with regards to the withdrawal * @return memo **/ @javax.annotation.Nullable @@ -209,7 +209,7 @@ public DepositRecord chain(String chain) { } /** - * Name of the chain used in withdrawals. + * Name of the chain used in withdrawals * @return chain **/ public String getChain() { diff --git a/src/main/java/io/gate/gateapi/models/DualGetOrders.java b/src/main/java/io/gate/gateapi/models/DualGetOrders.java index ee253ee..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 DualGetOrders id(Integer id) { } /** - * Order ID. + * Order ID * @return id **/ @javax.annotation.Nullable @@ -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 @@ -299,7 +299,7 @@ public DualGetOrders exercisePrice(String exercisePrice) { } /** - * Strike price. + * Strike price * @return exercisePrice **/ @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 @@ -399,7 +399,7 @@ public DualGetOrders deliveryTime(Integer deliveryTime) { } /** - * Settlement time. + * Settlement time * @return deliveryTime **/ @javax.annotation.Nullable @@ -419,7 +419,7 @@ public DualGetOrders text(String text) { } /** - * Custom order information. + * Custom order information * @return text **/ @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 5e645c1..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 @@ -163,7 +163,7 @@ public DualGetPlans exercisePrice(Double exercisePrice) { } /** - * Strike price. + * Strike price * @return exercisePrice **/ @javax.annotation.Nullable @@ -183,7 +183,7 @@ public DualGetPlans deliveryTime(Integer deliveryTime) { } /** - * Settlement time. + * Settlement time * @return deliveryTime **/ @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 73a3e21..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 @@ -63,7 +63,7 @@ public Eth2RateList date(String date) { } /** - * Date. + * Date * @return date **/ @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 2b00696..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 index dff91bd..cc6f287 100644 --- a/src/main/java/io/gate/gateapi/models/FindCoin.java +++ b/src/main/java/io/gate/gateapi/models/FindCoin.java @@ -1,6 +1,6 @@ /* * Gate API - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 FindCoin coin(String coin) { } /** - * Currency. + * Currency * @return coin **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public FindCoin cointype(String cointype) { } /** - * Coin Type swap-Voucher lock-Locked. + * Token Type: swap-Voucher, lock-Locked * @return cointype **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FlashSwapCurrencyPair.java b/src/main/java/io/gate/gateapi/models/FlashSwapCurrencyPair.java index c5e5f1f..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * List all supported currencies in flash swap. + * List all supported currencies in flash swap */ public class FlashSwapCurrencyPair { public static final String SERIALIZED_NAME_CURRENCY_PAIR = "currency_pair"; @@ -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 cf63289..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Flash swap order. + * Flash swap order */ public class FlashSwapOrder { public static final String SERIALIZED_NAME_ID = "id"; @@ -61,7 +61,7 @@ public class FlashSwapOrder { /** - * Flash swap order ID. + * Flash swap order ID * @return id **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public Long getId() { /** - * Creation time of order (in milliseconds). + * Creation time of order (in milliseconds) * @return createTime **/ @javax.annotation.Nullable @@ -81,7 +81,7 @@ public Long getCreateTime() { /** - * User ID. + * User ID * @return userId **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public Long getUserId() { /** - * Currency to sell. + * Currency to sell * @return sellCurrency **/ @javax.annotation.Nullable @@ -101,7 +101,7 @@ public String getSellCurrency() { /** - * Amount to sell. + * Amount to sell * @return sellAmount **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public String getSellAmount() { /** - * Currency to buy. + * Currency to buy * @return buyCurrency **/ @javax.annotation.Nullable @@ -121,7 +121,7 @@ public String getBuyCurrency() { /** - * Amount to buy. + * Amount to buy * @return buyAmount **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public String getBuyAmount() { /** - * Price. + * Price * @return price **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FlashSwapOrderPreview.java b/src/main/java/io/gate/gateapi/models/FlashSwapOrderPreview.java index fa0a671..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -55,7 +55,7 @@ public FlashSwapOrderPreview previewId(String previewId) { } /** - * Preview result ID. + * Preview result ID * @return previewId **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public FlashSwapOrderPreview sellAmount(String sellAmount) { } /** - * Amount to sell. + * Amount to sell * @return sellAmount **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public FlashSwapOrderPreview buyAmount(String buyAmount) { } /** - * Amount to buy. + * Amount to buy * @return buyAmount **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public FlashSwapOrderPreview price(String price) { } /** - * Price. + * Price * @return price **/ @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 f4f477a..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Parameters of flash swap order creation. + * Parameters of flash swap order creation */ public class FlashSwapOrderRequest { public static final String SERIALIZED_NAME_PREVIEW_ID = "preview_id"; @@ -51,7 +51,7 @@ public FlashSwapOrderRequest previewId(String previewId) { } /** - * Preview result ID. + * Preview result ID * @return previewId **/ public String getPreviewId() { @@ -89,7 +89,7 @@ public FlashSwapOrderRequest sellAmount(String sellAmount) { } /** - * Amount to sell (based on the preview result). + * Amount to sell (based on the preview result) * @return sellAmount **/ public String getSellAmount() { @@ -127,7 +127,7 @@ public FlashSwapOrderRequest buyAmount(String buyAmount) { } /** - * Amount to buy (based on the preview result). + * Amount to buy (based on the preview result) * @return buyAmount **/ public String getBuyAmount() { diff --git a/src/main/java/io/gate/gateapi/models/FlashSwapPreviewRequest.java b/src/main/java/io/gate/gateapi/models/FlashSwapPreviewRequest.java index 9999cd4..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Parameters of flash swap order creation. + * Parameters of flash swap order creation */ public class FlashSwapPreviewRequest { public static final String SERIALIZED_NAME_SELL_CURRENCY = "sell_currency"; @@ -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 af0a1c8..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 FundingAccount currency(String currency) { } /** - * Currency name. + * Currency name * @return currency **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public FundingAccount available(String available) { } /** - * Available assets to lend, which is identical to spot account `available`. + * Available assets to lend, which is identical to spot account `available` * @return available **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public FundingAccount locked(String locked) { } /** - * Locked amount. i.e. amount in `open` loans. + * Locked amount. i.e. amount in `open` loans * @return locked **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public FundingAccount lent(String lent) { } /** - * Outstanding loan amount yet to be repaid. + * Outstanding loan amount yet to be repaid * @return lent **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public FundingAccount totalLent(String totalLent) { } /** - * Amount used for lending. total_lent = lent + locked. + * Amount used for lending. total_lent = lent + locked * @return totalLent **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FundingRateRecord.java b/src/main/java/io/gate/gateapi/models/FundingRateRecord.java index bd701b1..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 FundingRateRecord t(Long t) { } /** - * Unix timestamp in seconds. + * Unix timestamp in seconds * @return t **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public FundingRateRecord r(String r) { } /** - * Funding rate. + * Funding rate * @return r **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FutureCancelOrderResult.java b/src/main/java/io/gate/gateapi/models/FutureCancelOrderResult.java index b9a5fa8..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Order cancellation result. + * Order cancellation result */ public class FutureCancelOrderResult { public static final String SERIALIZED_NAME_ID = "id"; @@ -47,7 +47,7 @@ public FutureCancelOrderResult id(String id) { } /** - * Order ID. + * Order ID * @return id **/ @javax.annotation.Nullable @@ -67,7 +67,7 @@ public FutureCancelOrderResult userId(Long userId) { } /** - * User ID. + * User ID * @return userId **/ @javax.annotation.Nullable @@ -87,7 +87,7 @@ public FutureCancelOrderResult succeeded(Boolean succeeded) { } /** - * Whether cancellation succeeded. + * Whether cancellation succeeded * @return succeeded **/ @javax.annotation.Nullable @@ -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 2e71819..38db71e 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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -156,7 +156,7 @@ public FuturesAccount unrealisedPnl(String unrealisedPnl) { } /** - * Unrealized PNL. + * Unrealized PNL * @return unrealisedPnl **/ @javax.annotation.Nullable @@ -176,7 +176,7 @@ public FuturesAccount positionMargin(String positionMargin) { } /** - * Position margin. + * Position margin * @return positionMargin **/ @javax.annotation.Nullable @@ -196,7 +196,7 @@ public FuturesAccount orderMargin(String orderMargin) { } /** - * Order margin of unfinished orders. + * Order margin of unfinished orders * @return orderMargin **/ @javax.annotation.Nullable @@ -216,7 +216,7 @@ public FuturesAccount available(String available) { } /** - * The available balance for transferring or trading(including bonus. Bonus can't 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 @@ -236,7 +236,7 @@ public FuturesAccount point(String point) { } /** - * POINT amount. + * Point card amount * @return point **/ @javax.annotation.Nullable @@ -256,7 +256,7 @@ public FuturesAccount currency(String currency) { } /** - * Settle currency. + * Settlement currency * @return currency **/ @javax.annotation.Nullable @@ -276,7 +276,7 @@ public FuturesAccount inDualMode(Boolean inDualMode) { } /** - * Whether dual mode is enabled. + * Whether dual mode is enabled * @return inDualMode **/ @javax.annotation.Nullable @@ -296,7 +296,7 @@ public FuturesAccount enableCredit(Boolean enableCredit) { } /** - * Whether portfolio margin account mode is enabled. + * Whether portfolio margin account mode is enabled * @return enableCredit **/ @javax.annotation.Nullable @@ -316,7 +316,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 @@ -336,7 +336,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 @@ -356,7 +356,7 @@ public FuturesAccount bonus(String bonus) { } /** - * Perpetual Contract Bonus. + * Bonus * @return bonus **/ @javax.annotation.Nullable @@ -376,7 +376,7 @@ public FuturesAccount enableEvolvedClassic(Boolean enableEvolvedClassic) { } /** - * Classic account margin mode, true-new mode, false-old mode. + * Classic account margin mode, true-new mode, false-old mode * @return enableEvolvedClassic **/ @javax.annotation.Nullable @@ -396,7 +396,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 @@ -416,7 +416,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 @@ -436,7 +436,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 @@ -456,7 +456,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 @@ -476,7 +476,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 @@ -496,7 +496,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 @@ -516,7 +516,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 @@ -536,7 +536,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 @@ -556,7 +556,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 @@ -576,7 +576,7 @@ public FuturesAccount enableNewDualMode(Boolean enableNewDualMode) { } /** - * Whether to open a new two-way position mode. + * Whether to open a new two-way position mode * @return enableNewDualMode **/ @javax.annotation.Nullable @@ -616,7 +616,7 @@ public FuturesAccount enableTieredMm(Boolean enableTieredMm) { } /** - * Whether to enable tiered maintenance margin calculation. + * Whether to enable tiered maintenance margin calculation * @return enableTieredMm **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesAccountBook.java b/src/main/java/io/gate/gateapi/models/FuturesAccountBook.java index a77c950..3121baf 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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -124,7 +124,7 @@ public FuturesAccountBook time(Double time) { } /** - * Change time. + * Change time * @return time **/ @javax.annotation.Nullable @@ -144,7 +144,7 @@ public FuturesAccountBook change(String change) { } /** - * Change amount. + * Change amount * @return change **/ @javax.annotation.Nullable @@ -164,7 +164,7 @@ public FuturesAccountBook balance(String balance) { } /** - * Balance after change. + * Balance after change * @return balance **/ @javax.annotation.Nullable @@ -204,7 +204,7 @@ public FuturesAccountBook text(String text) { } /** - * Comment. + * Comment * @return text **/ @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 @@ -244,7 +244,7 @@ public FuturesAccountBook tradeId(String tradeId) { } /** - * trade id. + * trade id * @return tradeId **/ @javax.annotation.Nullable @@ -264,7 +264,7 @@ public FuturesAccountBook id(String id) { } /** - * Account change record 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 745c1fb..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Statistical data. + * Statistical data */ public class FuturesAccountHistory { public static final String SERIALIZED_NAME_DNW = "dnw"; @@ -71,7 +71,7 @@ public FuturesAccountHistory dnw(String dnw) { } /** - * total amount of deposit and withdraw. + * total amount of deposit and withdraw * @return dnw **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public FuturesAccountHistory pnl(String pnl) { } /** - * total amount of trading profit and loss. + * total amount of trading profit and loss * @return pnl **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public FuturesAccountHistory fee(String fee) { } /** - * total amount of fee. + * total amount of fee * @return fee **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public FuturesAccountHistory refr(String refr) { } /** - * total amount of referrer rebates. + * total amount of referrer rebates * @return refr **/ @javax.annotation.Nullable @@ -151,7 +151,7 @@ public FuturesAccountHistory fund(String fund) { } /** - * total amount of funding costs. + * total amount of funding costs * @return fund **/ @javax.annotation.Nullable @@ -171,7 +171,7 @@ public FuturesAccountHistory pointDnw(String pointDnw) { } /** - * total amount of point deposit and withdraw. + * total amount of point deposit and withdraw * @return pointDnw **/ @javax.annotation.Nullable @@ -191,7 +191,7 @@ public FuturesAccountHistory pointFee(String pointFee) { } /** - * total amount of point fee. + * total amount of point fee * @return pointFee **/ @javax.annotation.Nullable @@ -211,7 +211,7 @@ public FuturesAccountHistory pointRefr(String pointRefr) { } /** - * total amount of referrer rebates of point fee. + * total amount of referrer rebates of point fee * @return pointRefr **/ @javax.annotation.Nullable @@ -231,7 +231,7 @@ public FuturesAccountHistory bonusDnw(String bonusDnw) { } /** - * total amount of perpetual contract bonus transfer. + * total amount of perpetual contract bonus transfer * @return bonusDnw **/ @javax.annotation.Nullable @@ -251,7 +251,7 @@ public FuturesAccountHistory bonusOffset(String bonusOffset) { } /** - * total amount of perpetual contract bonus deduction. + * total amount of perpetual contract bonus deduction * @return bonusOffset **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesAutoDeleverage.java b/src/main/java/io/gate/gateapi/models/FuturesAutoDeleverage.java index aefca70..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 class FuturesAutoDeleverage { /** - * Automatic deleveraging time. + * Automatic deleveraging time * @return time **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public Long getTime() { /** - * User ID. + * User ID * @return user **/ @javax.annotation.Nullable @@ -85,7 +85,7 @@ public Long getUser() { /** - * Order ID. Order IDs before 2023-02-20 are null. + * Order ID. Order IDs before 2023-02-20 are null * @return orderId **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public Long getOrderId() { /** - * Futures contract. + * Futures contract * @return contract **/ @javax.annotation.Nullable @@ -105,7 +105,7 @@ public String getContract() { /** - * Position leverage. + * Position leverage * @return leverage **/ @javax.annotation.Nullable @@ -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 @@ -125,7 +125,7 @@ public String getCrossLeverageLimit() { /** - * Average entry price. + * Average entry price * @return entryPrice **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public String getEntryPrice() { /** - * Average fill price. + * Average fill price * @return fillPrice **/ @javax.annotation.Nullable @@ -145,7 +145,7 @@ public String getFillPrice() { /** - * Trading size. + * Trading size * @return tradeSize **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public Long getTradeSize() { /** - * Positions after auto-deleveraging. + * Positions after auto-deleveraging * @return positionSize **/ @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 75fc5d6..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Modify contract order parameters. + * Modify contract order parameters */ public class FuturesBatchAmendOrderRequest { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; @@ -51,7 +51,7 @@ public FuturesBatchAmendOrderRequest orderId(Long orderId) { } /** - * Order id, order_id and text must contain at least one. + * Order id, order_id and text must contain at least one * @return orderId **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public FuturesBatchAmendOrderRequest text(String text) { } /** - * User-defined order text, at least one of order_id and text must be passed. + * User-defined order text, at least one of order_id and text must be passed * @return text **/ @javax.annotation.Nullable @@ -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, 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 a8258a7..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * data point in every timestamp. + * data point in every timestamp */ public class FuturesCandlestick { public static final String SERIALIZED_NAME_T = "t"; @@ -59,7 +59,7 @@ public FuturesCandlestick t(Double t) { } /** - * Unix timestamp in seconds. + * Unix timestamp in seconds * @return t **/ @javax.annotation.Nullable @@ -79,7 +79,7 @@ public FuturesCandlestick v(Long v) { } /** - * size volume (contract size). Only returned if `contract` is not prefixed. + * size volume (contract size). Only returned if `contract` is not prefixed * @return v **/ @javax.annotation.Nullable @@ -99,7 +99,7 @@ public FuturesCandlestick c(String c) { } /** - * Close price (quote currency). + * Close price (quote currency) * @return c **/ @javax.annotation.Nullable @@ -119,7 +119,7 @@ public FuturesCandlestick h(String h) { } /** - * Highest price (quote currency). + * Highest price (quote currency) * @return h **/ @javax.annotation.Nullable @@ -139,7 +139,7 @@ public FuturesCandlestick l(String l) { } /** - * Lowest price (quote currency). + * Lowest price (quote currency) * @return l **/ @javax.annotation.Nullable @@ -159,7 +159,7 @@ public FuturesCandlestick o(String o) { } /** - * Open price (quote currency). + * Open price (quote currency) * @return o **/ @javax.annotation.Nullable @@ -179,7 +179,7 @@ public FuturesCandlestick sum(String sum) { } /** - * Trading volume (unit: Quote currency). + * Trading volume (unit: Quote currency) * @return sum **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesFee.java b/src/main/java/io/gate/gateapi/models/FuturesFee.java index 134860f..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 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"; @@ -33,7 +33,7 @@ public class FuturesFee { /** - * Taker fee. + * Taker fee * @return takerFee **/ @javax.annotation.Nullable @@ -43,7 +43,7 @@ public String getTakerFee() { /** - * maker fee. + * maker fee * @return makerFee **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesIndexConstituents.java b/src/main/java/io/gate/gateapi/models/FuturesIndexConstituents.java index 186bb5c..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 FuturesIndexConstituents { /** - * Index name. + * Index name * @return index **/ @javax.annotation.Nullable @@ -46,7 +46,7 @@ public String getIndex() { /** - * Constituents. + * Constituents * @return constituents **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesInitialOrder.java b/src/main/java/io/gate/gateapi/models/FuturesInitialOrder.java index 877ef5e..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 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 { @@ -118,7 +118,7 @@ public FuturesInitialOrder contract(String contract) { } /** - * Futures contract. + * Futures contract * @return contract **/ public String getContract() { @@ -157,7 +157,7 @@ public FuturesInitialOrder price(String price) { } /** - * Order price. Set to 0 to use market price. + * Order price. Set to 0 to use market price * @return price **/ public String getPrice() { @@ -196,7 +196,7 @@ public FuturesInitialOrder tif(TifEnum tif) { } /** - * Time in force strategy, default is gtc, market order currently only supports ioc mode 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 @@ -270,7 +270,7 @@ public void setAutoSize(String autoSize) { } /** - * Is the order reduce-only. + * Is the order reduce-only * @return isReduceOnly **/ @javax.annotation.Nullable @@ -280,7 +280,7 @@ public Boolean getIsReduceOnly() { /** - * Is the order to close position. + * Is the order to close position * @return isClose **/ @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 093d3f5..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -59,7 +59,7 @@ public FuturesLimitRiskTiers tier(Integer tier) { } /** - * Tier. + * Tier * @return tier **/ @javax.annotation.Nullable @@ -79,7 +79,7 @@ public FuturesLimitRiskTiers riskLimit(String riskLimit) { } /** - * Position risk limit. + * Position risk limit * @return riskLimit **/ @javax.annotation.Nullable @@ -99,7 +99,7 @@ public FuturesLimitRiskTiers initialRate(String initialRate) { } /** - * Initial margin rate. + * Initial margin rate * @return initialRate **/ @javax.annotation.Nullable @@ -119,7 +119,7 @@ public FuturesLimitRiskTiers maintenanceRate(String maintenanceRate) { } /** - * Maintenance margin rate. + * Maintenance margin rate * @return maintenanceRate **/ @javax.annotation.Nullable @@ -139,7 +139,7 @@ public FuturesLimitRiskTiers leverageMax(String leverageMax) { } /** - * Maximum leverage. + * Maximum leverage * @return leverageMax **/ @javax.annotation.Nullable @@ -159,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 @@ -179,7 +179,7 @@ public FuturesLimitRiskTiers deduction(String deduction) { } /** - * Maintenance margin quick calculation deduction. + * Maintenance margin quick calculation deduction amount * @return deduction **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesLiqOrder.java b/src/main/java/io/gate/gateapi/models/FuturesLiqOrder.java index 7eb3974..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 FuturesLiqOrder { /** - * Liquidation time. + * Liquidation time * @return time **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public Long getTime() { /** - * Futures contract. + * Futures contract * @return contract **/ @javax.annotation.Nullable @@ -73,7 +73,7 @@ public String getContract() { /** - * User position size. + * User position size * @return size **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public Long getSize() { /** - * Number of forced liquidation orders. + * Number of forced liquidation orders * @return orderSize **/ @javax.annotation.Nullable @@ -93,7 +93,7 @@ public Long getOrderSize() { /** - * Liquidation order price. + * Liquidation order price * @return orderPrice **/ @javax.annotation.Nullable @@ -103,7 +103,7 @@ public String getOrderPrice() { /** - * Liquidation order average taker price. + * Liquidation order average taker price * @return fillPrice **/ @javax.annotation.Nullable @@ -113,7 +113,7 @@ public String getFillPrice() { /** - * System liquidation order maker size. + * System liquidation order maker size * @return left **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesLiquidate.java b/src/main/java/io/gate/gateapi/models/FuturesLiquidate.java index ff6e9fe..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -73,7 +73,7 @@ public class FuturesLiquidate { /** - * Liquidation time. + * Liquidation time * @return time **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public Long getTime() { /** - * Futures contract. + * Futures contract * @return contract **/ @javax.annotation.Nullable @@ -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 @@ -103,7 +103,7 @@ public String getLeverage() { /** - * Position size. + * Position size * @return size **/ @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 @@ -163,7 +163,7 @@ public Long getOrderId() { /** - * Liquidation order price. + * Liquidation order price * @return orderPrice **/ @javax.annotation.Nullable @@ -173,7 +173,7 @@ public String getOrderPrice() { /** - * Liquidation order average taker price. + * Liquidation order average taker price * @return fillPrice **/ @javax.annotation.Nullable @@ -183,7 +183,7 @@ public String getFillPrice() { /** - * Liquidation order maker size. + * Liquidation order maker size * @return left **/ @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 9d83897..754ab5d 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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Futures order details. + * Futures order details */ public class FuturesOrder { public static final String SERIALIZED_NAME_ID = "id"; @@ -40,7 +40,7 @@ public class FuturesOrder { 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 - 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 +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 { @@ -326,7 +326,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, 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 { @@ -386,7 +386,7 @@ public StpActEnum read(final JsonReader jsonReader) throws IOException { /** - * Futures order ID. + * Futures order ID * @return id **/ @javax.annotation.Nullable @@ -396,7 +396,7 @@ public Long getId() { /** - * User ID. + * User ID * @return user **/ @javax.annotation.Nullable @@ -406,7 +406,7 @@ public Integer getUser() { /** - * Creation time of order. + * Creation time of order * @return createTime **/ @javax.annotation.Nullable @@ -416,7 +416,7 @@ public Double getCreateTime() { /** - * Order finished time. Not returned if order is open. + * Order finished time. Not returned if order is open * @return finishTime **/ @javax.annotation.Nullable @@ -426,7 +426,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 - 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 @@ -436,7 +436,7 @@ public FinishAsEnum getFinishAs() { /** - * Order status - `open`: waiting to be traded - `finished`: finished + * Order status - `open`: Pending - `finished`: Completed * @return status **/ @javax.annotation.Nullable @@ -452,7 +452,7 @@ public FuturesOrder contract(String contract) { } /** - * Futures contract. + * Futures contract * @return contract **/ public String getContract() { @@ -471,7 +471,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() { @@ -490,7 +490,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 @@ -510,7 +510,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 @@ -530,7 +530,7 @@ public FuturesOrder close(Boolean close) { } /** - * Set as `true` to close the position, with `size` set to 0. + * Set as `true` to close the position, with `size` set to 0 * @return close **/ @javax.annotation.Nullable @@ -544,7 +544,7 @@ public void setClose(Boolean close) { } /** - * Is the order to close position. + * Is the order to close position * @return isClose **/ @javax.annotation.Nullable @@ -560,7 +560,7 @@ public FuturesOrder reduceOnly(Boolean reduceOnly) { } /** - * Set as `true` to be reduce-only order. + * Set as `true` to be reduce-only order * @return reduceOnly **/ @javax.annotation.Nullable @@ -574,7 +574,7 @@ public void setReduceOnly(Boolean reduceOnly) { } /** - * Is the order reduce-only. + * Is the order reduce-only * @return isReduceOnly **/ @javax.annotation.Nullable @@ -584,7 +584,7 @@ public Boolean getIsReduceOnly() { /** - * Is the order for liquidation. + * Is the order for liquidation * @return isLiq **/ @javax.annotation.Nullable @@ -614,7 +614,7 @@ public void setTif(TifEnum tif) { } /** - * Size left to be traded. + * Unfilled quantity * @return left **/ @javax.annotation.Nullable @@ -624,7 +624,7 @@ public Long getLeft() { /** - * Fill price of the order. + * Fill price * @return fillPrice **/ @javax.annotation.Nullable @@ -640,7 +640,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-x: new liquidation mode (isolated, cross margin one-way mode, non-hedging part of cross margin hedge mode) b. Liquidation under isolated margin in unified account single currency margin mode - hedge-liq-x: Liquidation under the new liquidation mode of the classic account hedge mode, the cross margin hedged part undergoes liquidation, meaning both long and short positions are liquidated simultaneously. - pm_liquidate: Unified account multi-currency margin mode liquidation - comb_margin_liquidate: Unified account portfolio margin mode liquidation - scm_liquidate: Unified account single currency margin mode liquidation - insurance: insurance + * 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 @@ -654,7 +654,7 @@ public void setText(String text) { } /** - * Taker fee. + * Taker fee * @return tkfr **/ @javax.annotation.Nullable @@ -664,7 +664,7 @@ public String getTkfr() { /** - * Maker fee. + * Maker fee * @return mkfr **/ @javax.annotation.Nullable @@ -674,7 +674,7 @@ public String getMkfr() { /** - * Reference user ID. + * Referrer user ID * @return refu **/ @javax.annotation.Nullable @@ -720,7 +720,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, 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 @@ -734,7 +734,7 @@ public void setStpAct(StpActEnum stpAct) { } /** - * The custom data that the user remarked when amending the order. + * The custom data that the user remarked when amending the order * @return amendText **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesOrderAmendment.java b/src/main/java/io/gate/gateapi/models/FuturesOrderAmendment.java index e77611f..17b5a39 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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 FuturesOrderAmendment price(String price) { } /** - * New order price. + * New order price * @return price **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public FuturesOrderAmendment 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/FuturesOrderBook.java b/src/main/java/io/gate/gateapi/models/FuturesOrderBook.java index d4680d5..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 FuturesOrderBook current(Double current) { } /** - * Response data generation timestamp. + * Response data generation timestamp * @return current **/ @javax.annotation.Nullable @@ -94,7 +94,7 @@ public FuturesOrderBook update(Double update) { } /** - * Order book changed timestamp. + * Order book changed timestamp * @return update **/ @javax.annotation.Nullable @@ -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 90eabec..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 FuturesOrderBookItem p(String p) { } /** - * Price (quote currency). + * Price (quote currency) * @return p **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public FuturesOrderBookItem s(Long s) { } /** - * Size. + * Size * @return s **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesPositionCrossMode.java b/src/main/java/io/gate/gateapi/models/FuturesPositionCrossMode.java index 97f00c8..36cb173 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesPositionCrossMode.java +++ b/src/main/java/io/gate/gateapi/models/FuturesPositionCrossMode.java @@ -1,6 +1,6 @@ /* * Gate API - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 FuturesPositionCrossMode 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 FuturesPositionCrossMode contract(String contract) { } /** - * Contract Market. + * Futures market * @return contract **/ public String getContract() { diff --git a/src/main/java/io/gate/gateapi/models/FuturesPremiumIndex.java b/src/main/java/io/gate/gateapi/models/FuturesPremiumIndex.java index 78542ad..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * data point in every timestamp. + * data point in every timestamp */ public class FuturesPremiumIndex { public static final String SERIALIZED_NAME_T = "t"; @@ -51,7 +51,7 @@ public FuturesPremiumIndex t(Double t) { } /** - * Unix timestamp in seconds. + * Unix timestamp in seconds * @return t **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public FuturesPremiumIndex c(String c) { } /** - * Close price. + * Close price * @return c **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public FuturesPremiumIndex h(String h) { } /** - * Highest price. + * Highest price * @return h **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public FuturesPremiumIndex l(String l) { } /** - * Lowest price`. + * Lowest price * @return l **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public FuturesPremiumIndex o(String o) { } /** - * Open price. + * Open price * @return o **/ @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 da15a80..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 - 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 - 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 13eee5d..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 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 { @@ -215,7 +215,7 @@ public void setTrigger(FuturesPriceTrigger trigger) { } /** - * Auto order ID. + * Auto order ID * @return id **/ @javax.annotation.Nullable @@ -225,7 +225,7 @@ public Long getId() { /** - * User ID. + * User ID * @return user **/ @javax.annotation.Nullable @@ -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 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`: 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 index 2d8ad4a..9b5f387 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesRiskLimitTier.java +++ b/src/main/java/io/gate/gateapi/models/FuturesRiskLimitTier.java @@ -1,6 +1,6 @@ /* * Gate API - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Information for each tier of the risk limit ladder. + * Information for each tier of the gradient risk limit table */ public class FuturesRiskLimitTier { public static final String SERIALIZED_NAME_TIER = "tier"; @@ -55,7 +55,7 @@ public FuturesRiskLimitTier tier(Integer tier) { } /** - * Tier. + * Tier * @return tier **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public FuturesRiskLimitTier riskLimit(String riskLimit) { } /** - * Position risk limit. + * Position risk limit * @return riskLimit **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public FuturesRiskLimitTier initialRate(String initialRate) { } /** - * Initial margin rate. + * Initial margin rate * @return initialRate **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public FuturesRiskLimitTier maintenanceRate(String maintenanceRate) { } /** - * Maintenance margin rate. + * Maintenance margin rate * @return maintenanceRate **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public FuturesRiskLimitTier leverageMax(String leverageMax) { } /** - * Maximum leverage. + * Maximum leverage * @return leverageMax **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public FuturesRiskLimitTier deduction(String deduction) { } /** - * Maintenance margin quick calculation deduction. + * Maintenance margin quick calculation deduction amount * @return deduction **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesTicker.java b/src/main/java/io/gate/gateapi/models/FuturesTicker.java index 74cd510..72ad076 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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 FuturesTicker contract(String contract) { } /** - * Futures contract. + * Futures contract * @return contract **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public FuturesTicker last(String last) { } /** - * Last trading price. + * Last trading price * @return last **/ @javax.annotation.Nullable @@ -155,7 +155,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 @@ -175,7 +175,7 @@ public FuturesTicker totalSize(String totalSize) { } /** - * Contract total size. + * Contract total size * @return totalSize **/ @javax.annotation.Nullable @@ -195,7 +195,7 @@ public FuturesTicker low24h(String low24h) { } /** - * Lowest trading price in recent 24h. + * 24-hour lowest price * @return low24h **/ @javax.annotation.Nullable @@ -215,7 +215,7 @@ public FuturesTicker high24h(String high24h) { } /** - * Highest trading price in recent 24h. + * 24-hour highest price * @return high24h **/ @javax.annotation.Nullable @@ -235,7 +235,7 @@ public FuturesTicker volume24h(String volume24h) { } /** - * Trade size in recent 24h. + * 24-hour trading volume * @return volume24h **/ @javax.annotation.Nullable @@ -255,7 +255,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 +275,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 +295,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 +315,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 +335,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 @@ -355,7 +355,7 @@ public FuturesTicker markPrice(String markPrice) { } /** - * Recent mark price. + * Recent mark price * @return markPrice **/ @javax.annotation.Nullable @@ -375,7 +375,7 @@ public FuturesTicker fundingRate(String fundingRate) { } /** - * Funding rate. + * Funding rate * @return fundingRate **/ @javax.annotation.Nullable @@ -395,7 +395,7 @@ public FuturesTicker fundingRateIndicative(String fundingRateIndicative) { } /** - * Indicative Funding rate in next period. (deprecated. use `funding_rate`). + * Indicative Funding rate in next period. (deprecated. use `funding_rate`) * @return fundingRateIndicative **/ @javax.annotation.Nullable @@ -415,7 +415,7 @@ public FuturesTicker indexPrice(String indexPrice) { } /** - * Index price. + * Index price * @return indexPrice **/ @javax.annotation.Nullable @@ -455,7 +455,7 @@ public FuturesTicker lowestAsk(String lowestAsk) { } /** - * Recent lowest ask. + * Recent lowest ask * @return lowestAsk **/ @javax.annotation.Nullable @@ -475,7 +475,7 @@ public FuturesTicker lowestSize(String lowestSize) { } /** - * The latest seller's lowest price order quantity. + * The latest seller's lowest price order quantity * @return lowestSize **/ @javax.annotation.Nullable @@ -495,7 +495,7 @@ public FuturesTicker highestBid(String highestBid) { } /** - * Recent highest bid. + * Recent highest bid * @return highestBid **/ @javax.annotation.Nullable @@ -515,7 +515,7 @@ public FuturesTicker highestSize(String highestSize) { } /** - * The latest buyer's highest price order volume. + * The latest buyer's highest price order volume * @return highestSize **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/FuturesTrade.java b/src/main/java/io/gate/gateapi/models/FuturesTrade.java index bb5f6da..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 @@ -119,7 +119,7 @@ public FuturesTrade contract(String contract) { } /** - * Futures contract. + * Futures contract * @return contract **/ @javax.annotation.Nullable @@ -139,7 +139,7 @@ public FuturesTrade size(Long size) { } /** - * Trading size. + * Trading size * @return size **/ @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. 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 036c948..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -41,7 +41,7 @@ public IndexConstituent exchange(String exchange) { } /** - * Exchange. + * Exchange * @return exchange **/ @javax.annotation.Nullable @@ -69,7 +69,7 @@ public IndexConstituent addSymbolsItem(String symbolsItem) { } /** - * Symbol list. + * Symbol list * @return symbols **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/InlineObject.java b/src/main/java/io/gate/gateapi/models/InlineObject.java index 4d89454..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 f534026..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 c286e53..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 InlineResponse2001 estRate(String estRate) { } /** - * Unconverted percentage. + * Unconverted percentage * @return estRate **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/InsuranceRecord.java b/src/main/java/io/gate/gateapi/models/InsuranceRecord.java index 61e7ec5..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 InsuranceRecord t(Long t) { } /** - * Unix timestamp in seconds. + * Unix timestamp in seconds * @return t **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public InsuranceRecord b(String b) { } /** - * Insurance balance. + * Insurance balance * @return b **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/LedgerRecord.java b/src/main/java/io/gate/gateapi/models/LedgerRecord.java index 2ac93ba..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -73,7 +73,7 @@ public class LedgerRecord { /** - * Record ID. + * Record ID * @return id **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public String getId() { /** - * Hash record of the withdrawal. + * Hash record of the withdrawal * @return txid **/ @javax.annotation.Nullable @@ -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 @@ -113,7 +113,7 @@ public void setWithdrawOrderId(String withdrawOrderId) { } /** - * Operation time. + * Operation time * @return timestamp **/ @javax.annotation.Nullable @@ -129,7 +129,7 @@ public LedgerRecord amount(String amount) { } /** - * Currency amount. + * Token amount * @return amount **/ public String getAmount() { @@ -148,7 +148,7 @@ public LedgerRecord currency(String currency) { } /** - * Currency name. + * Currency name * @return currency **/ public String getCurrency() { @@ -167,7 +167,7 @@ public LedgerRecord address(String address) { } /** - * Withdrawal address. Required for withdrawals. + * Withdrawal address. Required for withdrawals * @return address **/ @javax.annotation.Nullable @@ -187,7 +187,7 @@ public LedgerRecord memo(String memo) { } /** - * Additional remarks with regards to the withdrawal. + * Additional remarks with regards to the withdrawal * @return memo **/ @javax.annotation.Nullable @@ -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 @@ -257,7 +257,7 @@ public LedgerRecord chain(String chain) { } /** - * Name of the chain used in withdrawals. + * Name of the chain used in withdrawals * @return chain **/ public String getChain() { diff --git a/src/main/java/io/gate/gateapi/models/LiquidateOrder.java b/src/main/java/io/gate/gateapi/models/LiquidateOrder.java index b5515fc..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 @@ -71,7 +71,7 @@ public LiquidateOrder currencyPair(String currencyPair) { } /** - * Currency pair. + * Currency pair * @return currencyPair **/ public String getCurrencyPair() { @@ -90,7 +90,7 @@ public LiquidateOrder amount(String amount) { } /** - * Trade amount. + * Trade amount * @return amount **/ public String getAmount() { @@ -109,7 +109,7 @@ public LiquidateOrder price(String price) { } /** - * Order price. + * Order price * @return price **/ public String getPrice() { @@ -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 ff64872..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -64,7 +64,7 @@ public MarginAccount currencyPair(String currencyPair) { } /** - * Currency pair. + * Currency pair * @return currencyPair **/ @javax.annotation.Nullable @@ -84,7 +84,7 @@ public MarginAccount accountType(String accountType) { } /** - * Account type, risk - risk rate account, mmr - maintenance margin 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 diff --git a/src/main/java/io/gate/gateapi/models/MarginAccountBook.java b/src/main/java/io/gate/gateapi/models/MarginAccountBook.java index 215c2a2..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 MarginAccountBook id(String id) { } /** - * Balance change record ID. + * Balance change record ID * @return id **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public MarginAccountBook time(String time) { } /** - * Balance changed timestamp. + * Account change timestamp * @return time **/ @javax.annotation.Nullable @@ -103,7 +103,7 @@ public MarginAccountBook timeMs(Long timeMs) { } /** - * The timestamp of the change (in milliseconds). + * The timestamp of the change (in milliseconds) * @return timeMs **/ @javax.annotation.Nullable @@ -123,7 +123,7 @@ public MarginAccountBook currency(String currency) { } /** - * Currency changed. + * Currency changed * @return currency **/ @javax.annotation.Nullable @@ -143,7 +143,7 @@ public MarginAccountBook currencyPair(String currencyPair) { } /** - * Account currency pair. + * Account trading pair * @return currencyPair **/ @javax.annotation.Nullable @@ -163,7 +163,7 @@ public MarginAccountBook change(String change) { } /** - * Amount changed. Positive value means transferring in, while negative out. + * Amount changed. Positive value means transferring in, while negative out * @return change **/ @javax.annotation.Nullable @@ -183,7 +183,7 @@ public MarginAccountBook balance(String balance) { } /** - * Balance after change. + * Balance after change * @return balance **/ @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 aae616f..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -51,7 +51,7 @@ public MarginAccountCurrency currency(String currency) { } /** - * Currency name. + * Currency name * @return currency **/ @javax.annotation.Nullable @@ -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 225c2f5..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Market gradient information. + * Market gradient information */ public class MarginLeverageTier { public static final String SERIALIZED_NAME_UPPER_LIMIT = "upper_limit"; @@ -43,7 +43,7 @@ public MarginLeverageTier upperLimit(String upperLimit) { } /** - * Maximum loan limit. + * Maximum loan limit * @return upperLimit **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public MarginLeverageTier mmr(String mmr) { } /** - * Maintenance margin rate. + * Maintenance margin rate * @return mmr **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public MarginLeverageTier leverage(String leverage) { } /** - * Maximum leverage multiple. + * Maximum leverage multiple * @return leverage **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MarginMarketLeverage.java b/src/main/java/io/gate/gateapi/models/MarginMarketLeverage.java index abd5b69..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Market leverage settings. + * Market leverage settings */ public class MarginMarketLeverage { public static final String SERIALIZED_NAME_CURRENCY_PAIR = "currency_pair"; @@ -39,7 +39,7 @@ public MarginMarketLeverage currencyPair(String currencyPair) { } /** - * Currency pair. + * Market * @return currencyPair **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public MarginMarketLeverage leverage(String leverage) { } /** - * Position leverage. + * Position leverage * @return leverage **/ public String getLeverage() { diff --git a/src/main/java/io/gate/gateapi/models/MarginTiers.java b/src/main/java/io/gate/gateapi/models/MarginTiers.java index 08fc7fd..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 MarginTiers tier(String tier) { } /** - * Tier. + * Tier * @return tier **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public MarginTiers marginRate(String marginRate) { } /** - * Discount. + * Discount * @return marginRate **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public MarginTiers lowerLimit(String lowerLimit) { } /** - * Lower limit. + * Lower limit * @return lowerLimit **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public MarginTiers upperLimit(String upperLimit) { } /** - * Upper limit, \"\" indicates greater than (the last tier). + * Upper limit, \"\" indicates greater than (the last tier) * @return upperLimit **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public MarginTiers leverage(String leverage) { } /** - * Position leverage. + * Position leverage * @return leverage **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MarginTransferable.java b/src/main/java/io/gate/gateapi/models/MarginTransferable.java index 6badb24..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 MarginTransferable currency(String currency) { } /** - * Currency detail. + * Currency detail * @return currency **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public MarginTransferable currencyPair(String currencyPair) { } /** - * Currency pair. + * Currency pair * @return currencyPair **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public MarginTransferable amount(String amount) { } /** - * Max transferable amount. + * Max transferable amount * @return amount **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MaxUniBorrowable.java b/src/main/java/io/gate/gateapi/models/MaxUniBorrowable.java index b4fb683..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -37,7 +37,7 @@ public class MaxUniBorrowable { /** - * Currency. + * Currency * @return currency **/ public String getCurrency() { @@ -46,7 +46,7 @@ public String getCurrency() { /** - * Currency pair. + * Currency pair * @return currencyPair **/ @javax.annotation.Nullable @@ -56,7 +56,7 @@ public String getCurrencyPair() { /** - * Maximum borrowable. + * Maximum borrowable * @return borrowable **/ public String getBorrowable() { diff --git a/src/main/java/io/gate/gateapi/models/MockFuturesOrder.java b/src/main/java/io/gate/gateapi/models/MockFuturesOrder.java index eb2bd49..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Futures order. + * Futures order */ public class MockFuturesOrder { public static final String SERIALIZED_NAME_CONTRACT = "contract"; @@ -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() { @@ -81,7 +81,7 @@ public MockFuturesOrder left(String left) { } /** - * Unfilled contract quantity, involved in actual calculation. + * Unfilled contract quantity, involved in actual calculation * @return left **/ public String getLeft() { diff --git a/src/main/java/io/gate/gateapi/models/MockFuturesPosition.java b/src/main/java/io/gate/gateapi/models/MockFuturesPosition.java index 5805cb2..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Futures positions. + * Futures positions */ public class MockFuturesPosition { public static final String SERIALIZED_NAME_CONTRACT = "contract"; @@ -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 6430ad1..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Margin result. + * Margin result */ public class MockMarginResult { public static final String SERIALIZED_NAME_TYPE = "type"; @@ -62,7 +62,7 @@ public MockMarginResult type(String type) { } /** - * Position combination type `original_position` - Original position `long_delta_original_position` - Positive delta + Original position `short_delta_original_position` position + * Position combination type `original_position` - Original position `long_delta_original_position` - Positive delta + Original position `short_delta_original_position` - Negative delta + Original position * @return type **/ @javax.annotation.Nullable @@ -90,7 +90,7 @@ public MockMarginResult addProfitLossRangesItem(ProfitLossRange profitLossRanges } /** - * The results of 3 pressure scenarios for MR1. + * Results of 33 stress scenarios for MR1 * @return profitLossRanges **/ @javax.annotation.Nullable @@ -130,7 +130,7 @@ public MockMarginResult mr1(String mr1) { } /** - * Stress testing. + * Stress testing * @return mr1 **/ @javax.annotation.Nullable @@ -150,7 +150,7 @@ public MockMarginResult mr2(String mr2) { } /** - * Basis spread risk. + * Basis spread risk * @return mr2 **/ @javax.annotation.Nullable @@ -170,7 +170,7 @@ public MockMarginResult mr3(String mr3) { } /** - * Volatility spread risk. + * Volatility spread risk * @return mr3 **/ @javax.annotation.Nullable @@ -190,7 +190,7 @@ public MockMarginResult mr4(String mr4) { } /** - * Option short risk. + * Option short risk * @return mr4 **/ @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 87dd16d..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Option orders. + * Option orders */ public class MockOptionsOrder { public static final String SERIALIZED_NAME_OPTIONS_NAME = "options_name"; @@ -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() { @@ -62,7 +62,7 @@ public MockOptionsOrder size(String size) { } /** - * Initial order quantity, not involved in actual calculation. + * Initial order quantity, not involved in actual calculation * @return size **/ public String getSize() { @@ -81,7 +81,7 @@ public MockOptionsOrder left(String left) { } /** - * Unfilled contract quantity, involved in actual calculation. + * Unfilled contract quantity, involved in actual calculation * @return left **/ public String getLeft() { diff --git a/src/main/java/io/gate/gateapi/models/MockOptionsPosition.java b/src/main/java/io/gate/gateapi/models/MockOptionsPosition.java index dcf2a44..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 positions. + * Options positions */ public class MockOptionsPosition { public static final String SERIALIZED_NAME_OPTIONS_NAME = "options_name"; @@ -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 afa5aa8..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Risk unit. + * Risk unit */ public class MockRiskUnit { public static final String SERIALIZED_NAME_SYMBOL = "symbol"; @@ -70,7 +70,7 @@ public MockRiskUnit symbol(String symbol) { } /** - * Risk unit name. + * Risk unit name * @return symbol **/ @javax.annotation.Nullable @@ -90,7 +90,7 @@ public MockRiskUnit spotInUse(String spotInUse) { } /** - * Spot usage. + * Spot hedge usage * @return spotInUse **/ @javax.annotation.Nullable @@ -110,7 +110,7 @@ public MockRiskUnit maintainMargin(String maintainMargin) { } /** - * Maintenance margin. + * Maintenance margin * @return maintainMargin **/ @javax.annotation.Nullable @@ -130,7 +130,7 @@ public MockRiskUnit initialMargin(String initialMargin) { } /** - * Initial margin. + * Initial margin * @return initialMargin **/ @javax.annotation.Nullable @@ -158,7 +158,7 @@ public MockRiskUnit addMarginResultItem(MockMarginResult marginResultItem) { } /** - * Margin result. + * Margin result * @return marginResult **/ @javax.annotation.Nullable @@ -178,7 +178,7 @@ public MockRiskUnit delta(String delta) { } /** - * Total Delta of risk unit. + * Total Delta of risk unit * @return delta **/ @javax.annotation.Nullable @@ -198,7 +198,7 @@ public MockRiskUnit gamma(String gamma) { } /** - * Total Gamma of risk unit. + * Total Gamma of risk unit * @return gamma **/ @javax.annotation.Nullable @@ -218,7 +218,7 @@ public MockRiskUnit theta(String theta) { } /** - * Total Theta of risk unit. + * Total Theta of risk unit * @return theta **/ @javax.annotation.Nullable @@ -238,7 +238,7 @@ public MockRiskUnit vega(String vega) { } /** - * Total Vega of risk unit. + * Total Vega of risk unit * @return vega **/ @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 1bbd03b..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Spot. + * Spot */ public class MockSpotBalance { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -39,7 +39,7 @@ public MockSpotBalance currency(String currency) { } /** - * Currency name. + * Currency name * @return currency **/ public String getCurrency() { @@ -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 095a9e1..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Spot orders. + * Spot orders */ public class MockSpotOrder { public static final String SERIALIZED_NAME_CURRENCY_PAIRS = "currency_pairs"; @@ -51,7 +51,7 @@ public MockSpotOrder currencyPairs(String currencyPairs) { } /** - * Currency pair. + * Market * @return currencyPairs **/ public String getCurrencyPairs() { @@ -70,7 +70,7 @@ public MockSpotOrder orderPrice(String orderPrice) { } /** - * Price. + * Price * @return orderPrice **/ public String getOrderPrice() { @@ -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 7134c4c..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 MultiChainAddressItem chain(String chain) { } /** - * Name of the chain. + * Name of the chain * @return chain **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public MultiChainAddressItem address(String address) { } /** - * Deposit address. + * Deposit address * @return address **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public MultiChainAddressItem paymentId(String paymentId) { } /** - * Notes that some currencies required(e.g., Tag, Memo) when depositing. + * Notes that some currencies required(e.g., Tag, Memo) when depositing * @return paymentId **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public MultiChainAddressItem paymentName(String paymentName) { } /** - * Note type, `Tag` or `Memo`. + * Note type, `Tag` or `Memo` * @return paymentName **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MultiCollateralCurrency.java b/src/main/java/io/gate/gateapi/models/MultiCollateralCurrency.java index f851561..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -51,7 +51,7 @@ public MultiCollateralCurrency addLoanCurrenciesItem(MultiLoanItem loanCurrencie } /** - * List of supported borrowing currencies. + * List of supported borrowing currencies * @return loanCurrencies **/ @javax.annotation.Nullable @@ -79,7 +79,7 @@ public MultiCollateralCurrency addCollateralCurrenciesItem(MultiCollateralItem c } /** - * List of supported collateral currencies. + * List of supported collateral currencies * @return collateralCurrencies **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MultiCollateralItem.java b/src/main/java/io/gate/gateapi/models/MultiCollateralItem.java index cb05a72..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 MultiCollateralItem currency(String currency) { } /** - * Currency. + * Currency * @return currency **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public MultiCollateralItem indexPrice(String indexPrice) { } /** - * Currency Index Price. + * Currency Index Price * @return indexPrice **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public MultiCollateralItem discount(String discount) { } /** - * Discount. + * Discount * @return discount **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MultiCollateralOrder.java b/src/main/java/io/gate/gateapi/models/MultiCollateralOrder.java index 5d433f6..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Multi-Collateral Order. + * Multi-Collateral Order */ public class MultiCollateralOrder { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; @@ -91,7 +91,7 @@ public MultiCollateralOrder orderId(String orderId) { } /** - * Order ID. + * Order ID * @return orderId **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public MultiCollateralOrder orderType(String orderType) { } /** - * current - current, fixed - fixed. + * current - current, fixed - fixed * @return orderType **/ @javax.annotation.Nullable @@ -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 @@ -151,7 +151,7 @@ public MultiCollateralOrder fixedRate(String fixedRate) { } /** - * Fixed interest rate. + * Fixed interest rate * @return fixedRate **/ @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 @@ -271,7 +271,7 @@ public MultiCollateralOrder borrowTime(Long borrowTime) { } /** - * Borrowing time, timestamp in seconds. + * Borrowing time, timestamp in seconds * @return borrowTime **/ @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 @@ -339,7 +339,7 @@ public MultiCollateralOrder addBorrowCurrenciesItem(BorrowCurrencyInfo borrowCur } /** - * Borrowing Currency List. + * Borrowing Currency List * @return borrowCurrencies **/ @javax.annotation.Nullable @@ -367,7 +367,7 @@ public MultiCollateralOrder addCollateralCurrenciesItem(CollateralCurrencyInfo c } /** - * Collateral Currency List. + * Collateral Currency List * @return collateralCurrencies **/ @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 86ad0f7..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -62,7 +62,7 @@ public MultiCollateralRecord orderId(Long orderId) { } /** - * Order ID. + * Order ID * @return orderId **/ @javax.annotation.Nullable @@ -82,7 +82,7 @@ public MultiCollateralRecord recordId(Long recordId) { } /** - * Collateral record ID. + * Collateral record ID * @return recordId **/ @javax.annotation.Nullable @@ -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 @@ -170,7 +170,7 @@ public MultiCollateralRecord addBorrowCurrenciesItem(MultiCollateralRecordCurren } /** - * Borrowing Currency List. + * Borrowing Currency List * @return borrowCurrencies **/ @javax.annotation.Nullable @@ -198,7 +198,7 @@ public MultiCollateralRecord addCollateralCurrenciesItem(MultiCollateralRecordCu } /** - * Collateral Currency List. + * Collateral Currency List * @return collateralCurrencies **/ @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 1679f4c..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 MultiCollateralRecordCurrency currency(String currency) { } /** - * Currency. + * Currency * @return currency **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public MultiCollateralRecordCurrency indexPrice(String indexPrice) { } /** - * Currency Index Price. + * Currency Index Price * @return indexPrice **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public MultiCollateralRecordCurrency beforeAmount(String beforeAmount) { } /** - * Amount before the operation. + * Amount before the operation * @return beforeAmount **/ @javax.annotation.Nullable @@ -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 ddf1773..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 MultiLoanItem currency(String currency) { } /** - * Currency. + * Currency * @return currency **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public MultiLoanItem price(String price) { } /** - * Latest price of the currency. + * Latest price of the currency * @return price **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MultiLoanRepayItem.java b/src/main/java/io/gate/gateapi/models/MultiLoanRepayItem.java index 6aa5dc2..969b275 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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 MultiLoanRepayItem currency(String currency) { } /** - * Repayment currency. + * Repayment currency * @return currency **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public MultiLoanRepayItem amount(String amount) { } /** - * Size. + * Size * @return amount **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ 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 diff --git a/src/main/java/io/gate/gateapi/models/MultiRepayRecord.java b/src/main/java/io/gate/gateapi/models/MultiRepayRecord.java index 3e85841..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -85,7 +85,7 @@ public MultiRepayRecord orderId(Long orderId) { } /** - * Order ID. + * Order ID * @return orderId **/ @javax.annotation.Nullable @@ -105,7 +105,7 @@ public MultiRepayRecord recordId(Long recordId) { } /** - * Repayment record ID. + * Repayment record ID * @return recordId **/ @javax.annotation.Nullable @@ -125,7 +125,7 @@ public MultiRepayRecord initLtv(String initLtv) { } /** - * The initial collateralization rate. + * Initial collateralization rate * @return initLtv **/ @javax.annotation.Nullable @@ -145,7 +145,7 @@ public MultiRepayRecord beforeLtv(String beforeLtv) { } /** - * Ltv before the operation. + * Ltv before the operation * @return beforeLtv **/ @javax.annotation.Nullable @@ -165,7 +165,7 @@ public MultiRepayRecord afterLtv(String afterLtv) { } /** - * Ltv after the operation. + * Ltv after the operation * @return afterLtv **/ @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 @@ -233,7 +233,7 @@ public MultiRepayRecord addBorrowCurrenciesItem(RepayRecordCurrency borrowCurren } /** - * List of borrowing information. + * List of borrowing information * @return borrowCurrencies **/ @javax.annotation.Nullable @@ -261,7 +261,7 @@ public MultiRepayRecord addCollateralCurrenciesItem(RepayRecordCurrency collater } /** - * List of collateral information. + * List of collateral information * @return collateralCurrencies **/ @javax.annotation.Nullable @@ -289,7 +289,7 @@ public MultiRepayRecord addRepaidCurrenciesItem(RepayRecordRepaidCurrency repaid } /** - * Repay Currency List. + * Repay Currency List * @return repaidCurrencies **/ @javax.annotation.Nullable @@ -317,7 +317,7 @@ public MultiRepayRecord addTotalInterestListItem(RepayRecordTotalInterest totalI } /** - * Total Interest List. + * Total Interest List * @return totalInterestList **/ @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 9039643..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -42,7 +42,7 @@ public MultiRepayResp orderId(Long orderId) { } /** - * Order ID. + * Order ID * @return orderId **/ @javax.annotation.Nullable @@ -70,7 +70,7 @@ public MultiRepayResp addRepaidCurrenciesItem(RepayCurrencyRes repaidCurrenciesI } /** - * Repay Currency List. + * Repay Currency List * @return repaidCurrencies **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/MyFuturesTrade.java b/src/main/java/io/gate/gateapi/models/MyFuturesTrade.java index da1d49e..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 @@ -162,7 +162,7 @@ public MyFuturesTrade contract(String contract) { } /** - * Futures contract. + * Futures contract * @return contract **/ @javax.annotation.Nullable @@ -182,7 +182,7 @@ public MyFuturesTrade orderId(String orderId) { } /** - * Order ID related. + * Related order ID * @return orderId **/ @javax.annotation.Nullable @@ -202,7 +202,7 @@ public MyFuturesTrade size(Long size) { } /** - * Trading size. + * Trading size * @return size **/ @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 > 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 44b7594..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 @@ -162,7 +162,7 @@ public MyFuturesTradeTimeRange contract(String contract) { } /** - * Futures contract. + * Futures contract * @return contract **/ @javax.annotation.Nullable @@ -182,7 +182,7 @@ public MyFuturesTradeTimeRange orderId(String orderId) { } /** - * Order ID related. + * Related order ID * @return orderId **/ @javax.annotation.Nullable @@ -202,7 +202,7 @@ public MyFuturesTradeTimeRange size(Long size) { } /** - * Trading size. + * Trading size * @return size **/ @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 > 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 90ff0de..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -46,7 +46,7 @@ public OpenOrders currencyPair(String currencyPair) { } /** - * Currency pair. + * Currency pair * @return currencyPair **/ @javax.annotation.Nullable @@ -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 ac20ea2..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -156,7 +156,7 @@ public OptionsAccount user(Long user) { } /** - * User ID. + * User ID * @return user **/ @javax.annotation.Nullable @@ -176,7 +176,7 @@ public OptionsAccount total(String total) { } /** - * Account balance. + * Account Balance * @return total **/ @javax.annotation.Nullable @@ -216,7 +216,7 @@ public OptionsAccount equity(String equity) { } /** - * Account equity, the sum of account balance and position value. + * Account equity, the sum of account balance and position value * @return equity **/ @javax.annotation.Nullable @@ -236,7 +236,7 @@ public OptionsAccount shortEnabled(Boolean shortEnabled) { } /** - * If the account is allowed to short. + * If the account is allowed to short * @return shortEnabled **/ @javax.annotation.Nullable @@ -256,7 +256,7 @@ public OptionsAccount mmpEnabled(Boolean mmpEnabled) { } /** - * Whether to enable MMP. + * Whether to enable MMP * @return mmpEnabled **/ @javax.annotation.Nullable @@ -276,7 +276,7 @@ public OptionsAccount liqTriggered(Boolean liqTriggered) { } /** - * Whether to trigger position liquidation. + * Whether to trigger position liquidation * @return liqTriggered **/ @javax.annotation.Nullable @@ -316,7 +316,7 @@ public OptionsAccount unrealisedPnl(String unrealisedPnl) { } /** - * Unrealized PNL. + * Unrealized PNL * @return unrealisedPnl **/ @javax.annotation.Nullable @@ -336,7 +336,7 @@ public OptionsAccount initMargin(String initMargin) { } /** - * Initial position margin. + * Initial position margin * @return initMargin **/ @javax.annotation.Nullable @@ -356,7 +356,7 @@ public OptionsAccount maintMargin(String maintMargin) { } /** - * Position maintenance margin. + * Position maintenance margin * @return maintMargin **/ @javax.annotation.Nullable @@ -376,7 +376,7 @@ public OptionsAccount orderMargin(String orderMargin) { } /** - * Order margin of unfinished orders. + * Order margin of unfinished orders * @return orderMargin **/ @javax.annotation.Nullable @@ -396,7 +396,7 @@ public OptionsAccount askOrderMargin(String askOrderMargin) { } /** - * Margin for outstanding sell orders. + * Margin for outstanding sell orders * @return askOrderMargin **/ @javax.annotation.Nullable @@ -416,7 +416,7 @@ public OptionsAccount bidOrderMargin(String bidOrderMargin) { } /** - * Margin for outstanding buy orders. + * Margin for outstanding buy orders * @return bidOrderMargin **/ @javax.annotation.Nullable @@ -436,7 +436,7 @@ public OptionsAccount available(String available) { } /** - * Available balance to transfer out or trade. + * Available balance to transfer out or trade * @return available **/ @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 @@ -496,7 +496,7 @@ public OptionsAccount ordersLimit(Integer ordersLimit) { } /** - * Maximum number of outstanding orders. + * Maximum number of outstanding orders * @return ordersLimit **/ @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 e5ef05f..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 OptionsAccountBook time(Double time) { } /** - * Change time. + * Change time * @return time **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public OptionsAccountBook change(String change) { } /** - * Amount changed (USDT). + * Amount changed (USDT) * @return change **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public OptionsAccountBook balance(String balance) { } /** - * Account total balance after change (USDT). + * Account total balance after change (USDT) * @return balance **/ @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 9e1affd..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * data point in every timestamp. + * data point in every timestamp */ public class OptionsCandlestick { public static final String SERIALIZED_NAME_T = "t"; @@ -55,7 +55,7 @@ public OptionsCandlestick t(Double t) { } /** - * Unix timestamp in seconds. + * Unix timestamp in seconds * @return t **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public OptionsCandlestick v(Long v) { } /** - * size volume (contract size). Only returned if `contract` is not prefixed. + * size volume (contract size). Only returned if `contract` is not prefixed * @return v **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public OptionsCandlestick c(String c) { } /** - * Close price (quote currency, unit: underlying corresponding option price). + * Close price (quote currency, unit: underlying corresponding option price) * @return c **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public OptionsCandlestick l(String l) { } /** - * Lowest price (quote currency, unit: underlying corresponding option price). + * Lowest price (quote currency, unit: underlying corresponding option price) * @return l **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public OptionsCandlestick o(String o) { } /** - * Open price (quote currency, unit: underlying corresponding option price). + * Open price (quote currency, unit: underlying corresponding option price) * @return o **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/OptionsContract.java b/src/main/java/io/gate/gateapi/models/OptionsContract.java index d60d67f..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -131,7 +131,7 @@ public OptionsContract name(String name) { } /** - * Options contract name. + * Options contract name * @return name **/ @javax.annotation.Nullable @@ -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 @@ -191,7 +191,7 @@ public OptionsContract expirationTime(Double expirationTime) { } /** - * Expiration time. + * Expiration time * @return expirationTime **/ @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 @@ -231,7 +231,7 @@ public OptionsContract multiplier(String multiplier) { } /** - * Multiplier used in converting from invoicing to settlement currency. + * Multiplier used in converting from invoicing to settlement currency * @return multiplier **/ @javax.annotation.Nullable @@ -251,7 +251,7 @@ public OptionsContract underlying(String underlying) { } /** - * Underlying. + * Underlying * @return underlying **/ @javax.annotation.Nullable @@ -271,7 +271,7 @@ public OptionsContract underlyingPrice(String underlyingPrice) { } /** - * Underlying price (quote currency). + * Underlying price (quote currency) * @return underlyingPrice **/ @javax.annotation.Nullable @@ -291,7 +291,7 @@ public OptionsContract lastPrice(String lastPrice) { } /** - * Last trading price. + * Last trading price * @return lastPrice **/ @javax.annotation.Nullable @@ -311,7 +311,7 @@ public OptionsContract markPrice(String markPrice) { } /** - * Current mark price (quote currency). + * Current mark price (quote currency) * @return markPrice **/ @javax.annotation.Nullable @@ -331,7 +331,7 @@ public OptionsContract indexPrice(String indexPrice) { } /** - * Current index price (quote currency). + * Current index price (quote currency) * @return indexPrice **/ @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 @@ -371,7 +371,7 @@ public OptionsContract takerFeeRate(String takerFeeRate) { } /** - * Taker fee rate. + * Taker fee rate * @return takerFeeRate **/ @javax.annotation.Nullable @@ -391,7 +391,7 @@ public OptionsContract orderPriceRound(String orderPriceRound) { } /** - * Minimum order price increment. + * Minimum order price increment * @return orderPriceRound **/ @javax.annotation.Nullable @@ -411,7 +411,7 @@ public OptionsContract markPriceRound(String markPriceRound) { } /** - * Minimum mark price increment. + * Minimum mark price increment * @return markPriceRound **/ @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 `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 @@ -551,7 +551,7 @@ public OptionsContract tradeId(Long tradeId) { } /** - * Current trade ID. + * Current trade ID * @return tradeId **/ @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 @@ -591,7 +591,7 @@ public OptionsContract positionSize(Long positionSize) { } /** - * Current total long position size. + * Current total long position size * @return positionSize **/ @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 6e54d69..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 OptionsMMP underlying(String underlying) { } /** - * Underlying. + * Underlying * @return underlying **/ public String getUnderlying() { @@ -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() { @@ -116,7 +116,7 @@ public OptionsMMP qtyLimit(String qtyLimit) { } /** - * Trading volume upper limit (positive number, up to 2 decimal places). + * Trading volume upper limit (positive number, up to 2 decimal places) * @return qtyLimit **/ public String getQtyLimit() { @@ -135,7 +135,7 @@ public OptionsMMP deltaLimit(String deltaLimit) { } /** - * Upper limit of net delta value (positive number, up to 2 decimal places). + * Upper limit of net delta value (positive number, up to 2 decimal places) * @return deltaLimit **/ public String getDeltaLimit() { @@ -148,7 +148,7 @@ public void setDeltaLimit(String deltaLimit) { } /** - * Trigger freeze time (milliseconds), 0 means no freeze is triggered. + * Trigger freeze time (milliseconds), 0 means no freeze is triggered * @return triggerTimeMs **/ @javax.annotation.Nullable @@ -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 8a883ed..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 OptionsMMPReset underlying(String underlying) { } /** - * Underlying. + * Underlying * @return underlying **/ public String getUnderlying() { @@ -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 @@ -92,7 +92,7 @@ public Integer getFrozenPeriod() { /** - * Trading volume upper limit (positive number, up to 2 decimal places). + * Trading volume upper limit (positive number, up to 2 decimal places) * @return qtyLimit **/ @javax.annotation.Nullable @@ -102,7 +102,7 @@ public String getQtyLimit() { /** - * Upper limit of net delta value (positive number, up to 2 decimal places). + * Upper limit of net delta value (positive number, up to 2 decimal places) * @return deltaLimit **/ @javax.annotation.Nullable @@ -112,7 +112,7 @@ public String getDeltaLimit() { /** - * Trigger freeze time (milliseconds), 0 means no freeze is triggered. + * Trigger freeze time (milliseconds), 0 means no freeze is triggered * @return triggerTimeMs **/ @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 b04b1f7..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 OptionsMySettlements time(Double time) { } /** - * Settlement time. + * Settlement time * @return time **/ @javax.annotation.Nullable @@ -87,7 +87,7 @@ public OptionsMySettlements underlying(String underlying) { } /** - * Underlying. + * Underlying * @return underlying **/ @javax.annotation.Nullable @@ -107,7 +107,7 @@ public OptionsMySettlements contract(String contract) { } /** - * Options contract name. + * Options contract name * @return contract **/ @javax.annotation.Nullable @@ -127,7 +127,7 @@ public OptionsMySettlements strikePrice(String strikePrice) { } /** - * Strike price (quote currency). + * Strike price (quote currency) * @return strikePrice **/ @javax.annotation.Nullable @@ -147,7 +147,7 @@ public OptionsMySettlements settlePrice(String settlePrice) { } /** - * Settlement price (quote currency). + * Settlement price (quote currency) * @return settlePrice **/ @javax.annotation.Nullable @@ -167,7 +167,7 @@ public OptionsMySettlements size(Long size) { } /** - * Size. + * Settlement size * @return size **/ @javax.annotation.Nullable @@ -187,7 +187,7 @@ public OptionsMySettlements settleProfit(String settleProfit) { } /** - * Settlement profit (quote currency). + * Settlement profit (quote currency) * @return settleProfit **/ @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 ab38327..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 @@ -150,7 +150,7 @@ public OptionsMyTrade contract(String contract) { } /** - * Options contract name. + * Options contract name * @return contract **/ @javax.annotation.Nullable @@ -170,7 +170,7 @@ public OptionsMyTrade orderId(Integer orderId) { } /** - * Order ID related. + * Related order ID * @return orderId **/ @javax.annotation.Nullable @@ -190,7 +190,7 @@ public OptionsMyTrade size(Long size) { } /** - * Trading size. + * Trading size * @return size **/ @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 @@ -230,7 +230,7 @@ public OptionsMyTrade underlyingPrice(String underlyingPrice) { } /** - * Underlying price (quote currency). + * Underlying price (quote currency) * @return underlyingPrice **/ @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 f2128e6..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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, 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 { @@ -282,7 +282,7 @@ public TifEnum read(final JsonReader jsonReader) throws IOException { /** - * Options order ID. + * Options order ID * @return id **/ @javax.annotation.Nullable @@ -292,7 +292,7 @@ public Long getId() { /** - * User ID. + * User ID * @return user **/ @javax.annotation.Nullable @@ -302,7 +302,7 @@ public Integer getUser() { /** - * Creation time of order. + * Creation time of order * @return createTime **/ @javax.annotation.Nullable @@ -312,7 +312,7 @@ public Double getCreateTime() { /** - * Order finished time. Not returned if order is open. + * Order finished time. Not returned if order is open * @return finishTime **/ @javax.annotation.Nullable @@ -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, 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 @@ -426,7 +426,7 @@ public OptionsOrder close(Boolean close) { } /** - * Set as `true` to close the position, with `size` set to 0. + * Set as `true` to close the position, with `size` set to 0 * @return close **/ @javax.annotation.Nullable @@ -440,7 +440,7 @@ public void setClose(Boolean close) { } /** - * Is the order to close position. + * Is the order to close position * @return isClose **/ @javax.annotation.Nullable @@ -456,7 +456,7 @@ public OptionsOrder reduceOnly(Boolean reduceOnly) { } /** - * Set as `true` to be reduce-only order. + * Set as `true` to be reduce-only order * @return reduceOnly **/ @javax.annotation.Nullable @@ -470,7 +470,7 @@ public void setReduceOnly(Boolean reduceOnly) { } /** - * Is the order reduce-only. + * Is the order reduce-only * @return isReduceOnly **/ @javax.annotation.Nullable @@ -480,7 +480,7 @@ public Boolean getIsReduceOnly() { /** - * Is the order for liquidation. + * Is the order for liquidation * @return isLiq **/ @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 @@ -580,7 +580,7 @@ public void setText(String text) { } /** - * Taker fee. + * Taker fee * @return tkfr **/ @javax.annotation.Nullable @@ -590,7 +590,7 @@ public String getTkfr() { /** - * Maker fee. + * Maker fee * @return mkfr **/ @javax.annotation.Nullable @@ -600,7 +600,7 @@ public String getMkfr() { /** - * Reference user ID. + * Referrer user ID * @return refu **/ @javax.annotation.Nullable @@ -610,7 +610,7 @@ public Integer getRefu() { /** - * Referrer rebate. + * Referrer rebate * @return refr **/ @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 cee393e..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -90,7 +90,7 @@ public class OptionsPosition { /** - * User ID. + * User ID * @return user **/ @javax.annotation.Nullable @@ -100,7 +100,7 @@ public Integer getUser() { /** - * Underlying. + * Underlying * @return underlying **/ @javax.annotation.Nullable @@ -110,7 +110,7 @@ public String getUnderlying() { /** - * Underlying price (quote currency). + * Underlying price (quote currency) * @return underlyingPrice **/ @javax.annotation.Nullable @@ -120,7 +120,7 @@ public String getUnderlyingPrice() { /** - * Options contract name. + * Options contract name * @return contract **/ @javax.annotation.Nullable @@ -130,7 +130,7 @@ public String getContract() { /** - * Position size (contract size). + * Position size (contract quantity) * @return size **/ @javax.annotation.Nullable @@ -140,7 +140,7 @@ public Long getSize() { /** - * Entry size (quote currency). + * Entry size (quote currency) * @return entryPrice **/ @javax.annotation.Nullable @@ -150,7 +150,7 @@ public String getEntryPrice() { /** - * Current mark price (quote currency). + * Current mark price (quote currency) * @return markPrice **/ @javax.annotation.Nullable @@ -160,7 +160,7 @@ public String getMarkPrice() { /** - * Implied volatility. + * Implied volatility * @return markIv **/ @javax.annotation.Nullable @@ -170,7 +170,7 @@ public String getMarkIv() { /** - * Realized PNL. + * Realized PnL * @return realisedPnl **/ @javax.annotation.Nullable @@ -180,7 +180,7 @@ public String getRealisedPnl() { /** - * Unrealized PNL. + * Unrealized PNL * @return unrealisedPnl **/ @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 b8e3147..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 { @@ -96,7 +96,7 @@ public SideEnum read(final JsonReader jsonReader) throws IOException { /** - * Position close time. + * Position close time * @return time **/ @javax.annotation.Nullable @@ -106,7 +106,7 @@ public Double getTime() { /** - * Options contract name. + * Options contract name * @return contract **/ @javax.annotation.Nullable @@ -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 e9162c5..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 476532a..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 @@ -75,7 +75,7 @@ public OptionsSettlement contract(String contract) { } /** - * Options contract name. + * Options contract name * @return contract **/ @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 @@ -135,7 +135,7 @@ public OptionsSettlement strikePrice(String strikePrice) { } /** - * Strike price (quote currency). + * Strike price (quote currency) * @return strikePrice **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public OptionsSettlement settlePrice(String settlePrice) { } /** - * Settlement price (quote currency). + * Settlement price (quote currency) * @return settlePrice **/ @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 2f3a904..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -103,7 +103,7 @@ public OptionsTicker name(String name) { } /** - * Options contract name. + * Options contract name * @return name **/ @javax.annotation.Nullable @@ -123,7 +123,7 @@ public OptionsTicker lastPrice(String lastPrice) { } /** - * Last trading price (quote currency). + * Last trade price (quote currency) * @return lastPrice **/ @javax.annotation.Nullable @@ -143,7 +143,7 @@ public OptionsTicker markPrice(String markPrice) { } /** - * Current mark price (quote currency). + * Current mark price (quote currency) * @return markPrice **/ @javax.annotation.Nullable @@ -163,7 +163,7 @@ public OptionsTicker indexPrice(String indexPrice) { } /** - * Current index price (quote currency). + * Current index price (quote currency) * @return indexPrice **/ @javax.annotation.Nullable @@ -183,7 +183,7 @@ public OptionsTicker ask1Size(Long ask1Size) { } /** - * Best ask size. + * Best ask size * @return ask1Size **/ @javax.annotation.Nullable @@ -203,7 +203,7 @@ public OptionsTicker ask1Price(String ask1Price) { } /** - * Best ask price. + * Best ask price * @return ask1Price **/ @javax.annotation.Nullable @@ -223,7 +223,7 @@ public OptionsTicker bid1Size(Long bid1Size) { } /** - * Best bid size. + * Best bid size * @return bid1Size **/ @javax.annotation.Nullable @@ -243,7 +243,7 @@ public OptionsTicker bid1Price(String bid1Price) { } /** - * Best bid price. + * Best bid price * @return bid1Price **/ @javax.annotation.Nullable @@ -263,7 +263,7 @@ public OptionsTicker positionSize(Long positionSize) { } /** - * Current total long position size. + * Current total long position size * @return positionSize **/ @javax.annotation.Nullable @@ -283,7 +283,7 @@ public OptionsTicker markIv(String markIv) { } /** - * Implied volatility. + * Implied volatility * @return markIv **/ @javax.annotation.Nullable @@ -303,7 +303,7 @@ public OptionsTicker bidIv(String bidIv) { } /** - * Bid side implied volatility. + * Bid side implied volatility * @return bidIv **/ @javax.annotation.Nullable @@ -323,7 +323,7 @@ public OptionsTicker askIv(String askIv) { } /** - * Ask side implied volatility. + * Ask side implied volatility * @return askIv **/ @javax.annotation.Nullable @@ -343,7 +343,7 @@ public OptionsTicker leverage(String leverage) { } /** - * Current leverage. Formula: underlying_price / mark_price * delta. + * Current leverage. Formula: underlying_price / mark_price * delta * @return leverage **/ @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 @@ -443,7 +443,7 @@ public OptionsTicker rho(String rho) { } /** - * Rho. + * Rho * @return rho **/ @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 7dc0b15..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 OptionsUnderlying name(String name) { } /** - * Underlying name. + * Underlying name * @return name **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public OptionsUnderlying indexPrice(String indexPrice) { } /** - * Spot index price (quote currency). + * Spot index price (quote currency) * @return indexPrice **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/OptionsUnderlyingTicker.java b/src/main/java/io/gate/gateapi/models/OptionsUnderlyingTicker.java index d819cc8..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 underlying detail. + * Options underlying detail */ public class OptionsUnderlyingTicker { public static final String SERIALIZED_NAME_TRADE_PUT = "trade_put"; @@ -43,7 +43,7 @@ public OptionsUnderlyingTicker tradePut(Long tradePut) { } /** - * Total put options trades amount in last 24h. + * Total put options trades amount in last 24h * @return tradePut **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public OptionsUnderlyingTicker tradeCall(Long tradeCall) { } /** - * Total call options trades amount in last 24h. + * Total call options trades amount in last 24h * @return tradeCall **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public OptionsUnderlyingTicker indexPrice(String indexPrice) { } /** - * Index price (quote currency). + * Index price (quote currency) * @return indexPrice **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/Order.java b/src/main/java/io/gate/gateapi/models/Order.java index 3b5d0f1..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Spot order details. + * Spot order details */ public class Order { public static final String SERIALIZED_NAME_ID = "id"; @@ -164,7 +164,7 @@ public TypeEnum read(final JsonReader jsonReader) throws IOException { private String account = "spot"; /** - * Buy or sell order. + * 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, 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 { @@ -481,7 +481,7 @@ public FinishAsEnum read(final JsonReader jsonReader) throws IOException { /** - * Order ID. + * Order ID * @return id **/ @javax.annotation.Nullable @@ -511,7 +511,7 @@ public void setText(String text) { } /** - * The custom data that the user remarked when amending the order. + * The custom data that the user remarked when amending the order * @return amendText **/ @javax.annotation.Nullable @@ -521,7 +521,7 @@ public String getAmendText() { /** - * Creation time of order. + * Creation time of order * @return createTime **/ @javax.annotation.Nullable @@ -531,7 +531,7 @@ public String getCreateTime() { /** - * Last modification time of order. + * Last modification time of order * @return updateTime **/ @javax.annotation.Nullable @@ -541,7 +541,7 @@ public String getUpdateTime() { /** - * Creation time of order (in milliseconds). + * Creation time of order (in milliseconds) * @return createTimeMs **/ @javax.annotation.Nullable @@ -551,7 +551,7 @@ public Long getCreateTimeMs() { /** - * Last modification time of order (in milliseconds). + * Last modification time of order (in milliseconds) * @return updateTimeMs **/ @javax.annotation.Nullable @@ -577,7 +577,7 @@ public Order currencyPair(String currencyPair) { } /** - * Currency pair. + * Currency pair * @return currencyPair **/ public String getCurrencyPair() { @@ -636,7 +636,7 @@ public Order side(SideEnum side) { } /** - * Buy or sell order. + * 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 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 @@ -768,7 +768,7 @@ public void setAutoRepay(Boolean autoRepay) { } /** - * Amount left to fill. + * Amount left to fill * @return left **/ @javax.annotation.Nullable @@ -778,7 +778,7 @@ public String getLeft() { /** - * Amount traded to fill. + * Amount filled * @return filledAmount **/ @javax.annotation.Nullable @@ -788,7 +788,7 @@ public String getFilledAmount() { /** - * Total filled in quote currency. Deprecated in favor of `filled_total`. + * Total filled in quote currency. Deprecated in favor of `filled_total` * @return fillPrice **/ @javax.annotation.Nullable @@ -798,7 +798,7 @@ public String getFillPrice() { /** - * Total filled in quote currency. + * Total filled in quote currency * @return filledTotal **/ @javax.annotation.Nullable @@ -808,7 +808,7 @@ public String getFilledTotal() { /** - * Average fill price. + * Average fill price * @return avgDealPrice **/ @javax.annotation.Nullable @@ -818,7 +818,7 @@ public String getAvgDealPrice() { /** - * Fee deducted. + * Fee deducted * @return fee **/ @javax.annotation.Nullable @@ -828,7 +828,7 @@ public String getFee() { /** - * Fee currency unit. + * Fee currency unit * @return feeCurrency **/ @javax.annotation.Nullable @@ -838,7 +838,7 @@ public String getFeeCurrency() { /** - * Points used to deduct fee. + * Points used to deduct fee * @return pointFee **/ @javax.annotation.Nullable @@ -848,7 +848,7 @@ public String getPointFee() { /** - * GT used to deduct fee. + * GT used to deduct fee * @return gtFee **/ @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 @@ -888,7 +888,7 @@ public Boolean getGtDiscount() { /** - * Rebated fee. + * Rebated fee * @return rebatedFee **/ @javax.annotation.Nullable @@ -898,7 +898,7 @@ public String getRebatedFee() { /** - * Rebated fee currency unit. + * Rebated fee currency unit * @return rebatedFeeCurrency **/ @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, 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/OrderBook.java b/src/main/java/io/gate/gateapi/models/OrderBook.java index afee3fb..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -73,7 +73,7 @@ public OrderBook current(Long current) { } /** - * The timestamp of the response data being generated (in milliseconds). + * The timestamp of the response data being generated (in milliseconds) * @return current **/ @javax.annotation.Nullable @@ -93,7 +93,7 @@ public OrderBook update(Long update) { } /** - * The timestamp of when the orderbook last changed (in milliseconds). + * The timestamp of when the orderbook last changed (in milliseconds) * @return update **/ @javax.annotation.Nullable @@ -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 fa72c0b..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Spot order details. + * Spot order details */ public class OrderCancel { public static final String SERIALIZED_NAME_ID = "id"; @@ -176,7 +176,7 @@ public TypeEnum read(final JsonReader jsonReader) throws IOException { private String account = "spot"; /** - * Buy or sell order. + * 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, 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 { @@ -479,7 +479,7 @@ public FinishAsEnum read(final JsonReader jsonReader) throws IOException { /** - * Order ID. + * Order ID * @return id **/ @javax.annotation.Nullable @@ -509,7 +509,7 @@ public void setText(String text) { } /** - * The custom data that the user remarked when amending the order. + * The custom data that the user remarked when amending the order * @return amendText **/ @javax.annotation.Nullable @@ -525,7 +525,7 @@ public OrderCancel succeeded(Boolean succeeded) { } /** - * Whether the batch of orders succeeded. + * Request execution result * @return succeeded **/ @javax.annotation.Nullable @@ -545,7 +545,7 @@ public OrderCancel label(String label) { } /** - * Error label, if any, otherwise an empty string. + * Error label, if any, otherwise an empty string * @return label **/ @javax.annotation.Nullable @@ -565,7 +565,7 @@ public OrderCancel message(String message) { } /** - * Detailed error message, if any, otherwise an empty string. + * Detailed error message, if any, otherwise an empty string * @return message **/ @javax.annotation.Nullable @@ -579,7 +579,7 @@ public void setMessage(String message) { } /** - * Creation time of order. + * Creation time of order * @return createTime **/ @javax.annotation.Nullable @@ -589,7 +589,7 @@ public String getCreateTime() { /** - * Last modification time of order. + * Last modification time of order * @return updateTime **/ @javax.annotation.Nullable @@ -599,7 +599,7 @@ public String getUpdateTime() { /** - * Creation time of order (in milliseconds). + * Creation time of order (in milliseconds) * @return createTimeMs **/ @javax.annotation.Nullable @@ -609,7 +609,7 @@ public Long getCreateTimeMs() { /** - * Last modification time of order (in milliseconds). + * Last modification time of order (in milliseconds) * @return updateTimeMs **/ @javax.annotation.Nullable @@ -635,7 +635,7 @@ public OrderCancel currencyPair(String currencyPair) { } /** - * Currency pair. + * Currency pair * @return currencyPair **/ public String getCurrencyPair() { @@ -694,7 +694,7 @@ public OrderCancel side(SideEnum side) { } /** - * Buy or sell order. + * 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 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 @@ -826,7 +826,7 @@ public void setAutoRepay(Boolean autoRepay) { } /** - * Amount left to fill. + * Amount left to fill * @return left **/ @javax.annotation.Nullable @@ -836,7 +836,7 @@ public String getLeft() { /** - * Amount traded to fill. + * Amount filled * @return filledAmount **/ @javax.annotation.Nullable @@ -846,7 +846,7 @@ public String getFilledAmount() { /** - * Total filled in quote currency. Deprecated in favor of `filled_total`. + * Total filled in quote currency. Deprecated in favor of `filled_total` * @return fillPrice **/ @javax.annotation.Nullable @@ -856,7 +856,7 @@ public String getFillPrice() { /** - * Total filled in quote currency. + * Total filled in quote currency * @return filledTotal **/ @javax.annotation.Nullable @@ -866,7 +866,7 @@ public String getFilledTotal() { /** - * Average fill price. + * Average fill price * @return avgDealPrice **/ @javax.annotation.Nullable @@ -876,7 +876,7 @@ public String getAvgDealPrice() { /** - * Fee deducted. + * Fee deducted * @return fee **/ @javax.annotation.Nullable @@ -886,7 +886,7 @@ public String getFee() { /** - * Fee currency unit. + * Fee currency unit * @return feeCurrency **/ @javax.annotation.Nullable @@ -896,7 +896,7 @@ public String getFeeCurrency() { /** - * Points used to deduct fee. + * Points used to deduct fee * @return pointFee **/ @javax.annotation.Nullable @@ -906,7 +906,7 @@ public String getPointFee() { /** - * GT used to deduct fee. + * GT used to deduct fee * @return gtFee **/ @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 @@ -946,7 +946,7 @@ public Boolean getGtDiscount() { /** - * Rebated fee. + * Rebated fee * @return rebatedFee **/ @javax.annotation.Nullable @@ -956,7 +956,7 @@ public String getRebatedFee() { /** - * Rebated fee currency unit. + * Rebated fee currency unit * @return rebatedFeeCurrency **/ @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, 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 70b77cb..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Spot order details. + * Spot order details */ public class OrderPatch { public static final String SERIALIZED_NAME_CURRENCY_PAIR = "currency_pair"; @@ -55,7 +55,7 @@ public OrderPatch currencyPair(String currencyPair) { } /** - * Currency pair. + * Currency pair * @return currencyPair **/ @javax.annotation.Nullable @@ -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) { } /** - * Trading Quantity. Either amountor pricemust be specified. + * Trading quantity. Either `amount` or `price` must be specified * @return amount **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public OrderPatch price(String price) { } /** - * Trading Price. Either amountor pricemust be specified. + * 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 ba682bb..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 OrderResp orderId(Long orderId) { } /** - * Order ID. + * Order ID * @return orderId **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/PartnerCommissionHistory.java b/src/main/java/io/gate/gateapi/models/PartnerCommissionHistory.java index f6b60df..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -42,7 +42,7 @@ public PartnerCommissionHistory total(Long total) { } /** - * Total. + * Total * @return total **/ @javax.annotation.Nullable @@ -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 699fc3c..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 PartnerSub userId(Long userId) { } /** - * User ID. + * User ID * @return userId **/ @javax.annotation.Nullable @@ -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 943ab12..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -42,7 +42,7 @@ public PartnerSubList total(Long total) { } /** - * Total. + * Total * @return total **/ @javax.annotation.Nullable @@ -70,7 +70,7 @@ public PartnerSubList addListItem(PartnerSub listItem) { } /** - * Subordinate list. + * Subordinate list * @return list **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/PartnerTransactionHistory.java b/src/main/java/io/gate/gateapi/models/PartnerTransactionHistory.java index 38e7c73..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -42,7 +42,7 @@ public PartnerTransactionHistory total(Long total) { } /** - * Total. + * Total * @return total **/ @javax.annotation.Nullable @@ -70,7 +70,7 @@ public PartnerTransactionHistory addListItem(AgencyTransaction listItem) { } /** - * List of transaction history. + * List of transaction history * @return list **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/PatchUniLend.java b/src/main/java/io/gate/gateapi/models/PatchUniLend.java index 13edc4f..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 PatchUniLend currency(String currency) { } /** - * Currency name. + * Currency name * @return currency **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public PatchUniLend minRate(String minRate) { } /** - * Minimum interest rate. + * Minimum interest rate * @return minRate **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/PlaceDualInvestmentOrder.java b/src/main/java/io/gate/gateapi/models/PlaceDualInvestmentOrder.java index 00fe401..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 1859472..8dc6574 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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Futures position details. + * Futures position details */ public class Position { public static final String SERIALIZED_NAME_USER = "user"; @@ -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`: 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 { @@ -207,7 +207,7 @@ public ModeEnum read(final JsonReader jsonReader) throws IOException { /** - * User ID. + * User ID * @return user **/ @javax.annotation.Nullable @@ -217,7 +217,7 @@ public Long getUser() { /** - * Futures contract. + * Futures contract * @return contract **/ @javax.annotation.Nullable @@ -227,7 +227,7 @@ public String getContract() { /** - * Position size. + * Position size * @return size **/ @javax.annotation.Nullable @@ -263,7 +263,7 @@ public Position riskLimit(String riskLimit) { } /** - * Position risk limit. + * Position risk limit * @return riskLimit **/ @javax.annotation.Nullable @@ -277,7 +277,7 @@ public void setRiskLimit(String riskLimit) { } /** - * Maximum leverage under current risk limit. + * Maximum leverage under current risk limit * @return leverageMax **/ @javax.annotation.Nullable @@ -287,7 +287,7 @@ public String getLeverageMax() { /** - * Maintenance rate under current risk limit. + * Maintenance rate under current risk limit * @return maintenanceRate **/ @javax.annotation.Nullable @@ -297,7 +297,7 @@ public String getMaintenanceRate() { /** - * Position value calculated in settlement currency. + * Position value calculated in settlement currency * @return value **/ @javax.annotation.Nullable @@ -313,7 +313,7 @@ public Position margin(String margin) { } /** - * Position margin. + * Position margin * @return margin **/ @javax.annotation.Nullable @@ -327,7 +327,7 @@ public void setMargin(String margin) { } /** - * Entry price. + * Entry price * @return entryPrice **/ @javax.annotation.Nullable @@ -337,7 +337,7 @@ public String getEntryPrice() { /** - * Liquidation price. + * Liquidation price * @return liqPrice **/ @javax.annotation.Nullable @@ -347,7 +347,7 @@ public String getLiqPrice() { /** - * Current mark price. + * Current mark price * @return markPrice **/ @javax.annotation.Nullable @@ -377,7 +377,7 @@ public String getMaintenanceMargin() { /** - * Unrealized PNL. + * Unrealized PNL * @return unrealisedPnl **/ @javax.annotation.Nullable @@ -387,7 +387,7 @@ public String getUnrealisedPnl() { /** - * Realized PNL. + * Realized PnL * @return realisedPnl **/ @javax.annotation.Nullable @@ -397,7 +397,7 @@ public String getRealisedPnl() { /** - * Realized PNL - Position P/L. + * Realized PNL - Position P/L * @return pnlPnl **/ @javax.annotation.Nullable @@ -407,7 +407,7 @@ public String getPnlPnl() { /** - * Realized PNL - Funding Fees. + * Realized PNL - Funding Fees * @return pnlFund **/ @javax.annotation.Nullable @@ -417,7 +417,7 @@ public String getPnlFund() { /** - * Realized PNL - Transaction Fees. + * Realized PNL - Transaction Fees * @return pnlFee **/ @javax.annotation.Nullable @@ -427,7 +427,7 @@ public String getPnlFee() { /** - * History realized PNL. + * Total realized PnL from closed positions * @return historyPnl **/ @javax.annotation.Nullable @@ -437,7 +437,7 @@ public String getHistoryPnl() { /** - * PNL of last position close. + * PNL of last position close * @return lastClosePnl **/ @javax.annotation.Nullable @@ -447,7 +447,7 @@ public String getLastClosePnl() { /** - * Realized POINT PNL. + * Realized POINT PNL * @return realisedPoint **/ @javax.annotation.Nullable @@ -457,7 +457,7 @@ public String getRealisedPoint() { /** - * History realized POINT PNL. + * History realized POINT PNL * @return historyPoint **/ @javax.annotation.Nullable @@ -477,7 +477,7 @@ public Integer getAdlRanking() { /** - * Current open orders. + * Current pending order quantity * @return pendingOrders **/ @javax.annotation.Nullable @@ -513,7 +513,7 @@ public Position mode(ModeEnum mode) { } /** - * Position mode, including: - `single`: dual mode is not enabled- `dual_long`: long position in dual mode- `dual_short`: 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 @@ -533,7 +533,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 @@ -547,7 +547,7 @@ public void setCrossLeverageLimit(String crossLeverageLimit) { } /** - * Last update time. + * Last update time * @return updateTime **/ @javax.annotation.Nullable @@ -557,7 +557,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 @@ -573,7 +573,7 @@ public Position openTime(Long openTime) { } /** - * First Open Time. + * First Open Time * @return openTime **/ @javax.annotation.Nullable @@ -587,7 +587,7 @@ public void setOpenTime(Long openTime) { } /** - * Risk limit table ID. + * Risk limit table ID * @return riskLimitTable **/ @javax.annotation.Nullable @@ -597,7 +597,7 @@ public String getRiskLimitTable() { /** - * Average maintenance margin rate. + * Average maintenance margin rate * @return averageMaintenanceRate **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/PositionClose.java b/src/main/java/io/gate/gateapi/models/PositionClose.java index 37564f6..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 { @@ -124,7 +124,7 @@ public SideEnum read(final JsonReader jsonReader) throws IOException { /** - * Position close time. + * Position close time * @return time **/ @javax.annotation.Nullable @@ -134,7 +134,7 @@ public Double getTime() { /** - * Futures contract. + * Futures contract * @return contract **/ @javax.annotation.Nullable @@ -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 @@ -164,7 +164,7 @@ public String getPnl() { /** - * PNL - Position P/L. + * PNL - Position P/L * @return pnlPnl **/ @javax.annotation.Nullable @@ -174,7 +174,7 @@ public String getPnlPnl() { /** - * PNL - Funding Fees. + * PNL - Funding Fees * @return pnlFund **/ @javax.annotation.Nullable @@ -184,7 +184,7 @@ public String getPnlFund() { /** - * PNL - Transaction Fees. + * PNL - Transaction Fees * @return pnlFee **/ @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 @@ -204,7 +204,7 @@ public String getText() { /** - * Max Trade Size. + * Max Trade Size * @return maxSize **/ @javax.annotation.Nullable @@ -214,7 +214,7 @@ public String getMaxSize() { /** - * Cumulative closed position volume. + * Cumulative closed position volume * @return accumSize **/ @javax.annotation.Nullable @@ -224,7 +224,7 @@ public String getAccumSize() { /** - * First Open Time. + * First Open Time * @return firstOpenTime **/ @javax.annotation.Nullable @@ -234,7 +234,7 @@ public Long getFirstOpenTime() { /** - * When 'side' is 'long,' it indicates the opening average price; when 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 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 9a6bd77..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 5d76911..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Profit and loss range. + * Profit and loss range */ public class ProfitLossRange { public static final String SERIALIZED_NAME_PRICE_PERCENTAGE = "price_percentage"; @@ -43,7 +43,7 @@ public ProfitLossRange pricePercentage(String pricePercentage) { } /** - * Percentage change in price. + * Percentage change in price * @return pricePercentage **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public ProfitLossRange impliedVolatilityPercentage(String impliedVolatilityPerce } /** - * Percentage change in implied volatility. + * Percentage change in implied volatility * @return impliedVolatilityPercentage **/ @javax.annotation.Nullable @@ -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 02941d6..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 user rebate information. + * Retrieve user rebate information */ public class RebateUserInfo { public static final String SERIALIZED_NAME_INVITE_UID = "invite_uid"; @@ -35,7 +35,7 @@ public RebateUserInfo inviteUid(Long inviteUid) { } /** - * My inviter's UID. + * My inviter's UID * @return inviteUid **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/RepayCurrencyRes.java b/src/main/java/io/gate/gateapi/models/RepayCurrencyRes.java index 5385583..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 @@ -115,7 +115,7 @@ public RepayCurrencyRes currency(String currency) { } /** - * Repayment currency. + * Repayment currency * @return currency **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public RepayCurrencyRes repaidPrincipal(String repaidPrincipal) { } /** - * Principal. + * Principal * @return repaidPrincipal **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public RepayCurrencyRes repaidInterest(String repaidInterest) { } /** - * Principal. + * Principal * @return repaidInterest **/ @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 5c63727..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Repay. + * Repay */ public class RepayLoan { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; @@ -43,7 +43,7 @@ public RepayLoan orderId(Long orderId) { } /** - * Order ID. + * Order ID * @return orderId **/ public Long getOrderId() { @@ -62,7 +62,7 @@ public RepayLoan repayAmount(String repayAmount) { } /** - * Repayment amount, it is mandatory when making partial repayments. + * Repayment amount, it is mandatory when making partial repayments * @return repayAmount **/ public String getRepayAmount() { diff --git a/src/main/java/io/gate/gateapi/models/RepayMultiLoan.java b/src/main/java/io/gate/gateapi/models/RepayMultiLoan.java index 5b1bb99..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -42,7 +42,7 @@ public RepayMultiLoan orderId(Long orderId) { } /** - * Order ID. + * Order ID * @return orderId **/ public Long getOrderId() { @@ -66,7 +66,7 @@ public RepayMultiLoan addRepayItemsItem(MultiLoanRepayItem repayItemsItem) { } /** - * Repay Currency Item. + * Repay Currency Item * @return repayItems **/ public List getRepayItems() { diff --git a/src/main/java/io/gate/gateapi/models/RepayRecord.java b/src/main/java/io/gate/gateapi/models/RepayRecord.java index 7ed1f3c..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Repayment record. + * Repayment record */ public class RepayRecord { public static final String SERIALIZED_NAME_ORDER_ID = "order_id"; @@ -83,7 +83,7 @@ public RepayRecord orderId(Long orderId) { } /** - * Order ID. + * Order ID * @return orderId **/ @javax.annotation.Nullable @@ -103,7 +103,7 @@ public RepayRecord recordId(Long recordId) { } /** - * Repayment record ID. + * Repayment record ID * @return recordId **/ @javax.annotation.Nullable @@ -123,7 +123,7 @@ public RepayRecord repaidAmount(String repaidAmount) { } /** - * Repayment amount. + * Repayment amount * @return repaidAmount **/ @javax.annotation.Nullable @@ -143,7 +143,7 @@ public RepayRecord borrowCurrency(String borrowCurrency) { } /** - * Borrowed currency. + * Borrowed currency * @return borrowCurrency **/ @javax.annotation.Nullable @@ -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 @@ -203,7 +203,7 @@ public RepayRecord borrowTime(Long borrowTime) { } /** - * Borrowing time, timestamp. + * Borrowing time, timestamp * @return borrowTime **/ @javax.annotation.Nullable @@ -223,7 +223,7 @@ public RepayRecord repayTime(Long repayTime) { } /** - * Repayment time, timestamp. + * Repayment time, timestamp * @return repayTime **/ @javax.annotation.Nullable @@ -243,7 +243,7 @@ public RepayRecord totalInterest(String totalInterest) { } /** - * Total interest. + * Total interest * @return totalInterest **/ @javax.annotation.Nullable @@ -263,7 +263,7 @@ public RepayRecord beforeLeftPrincipal(String beforeLeftPrincipal) { } /** - * Principal to be repaid before repayment. + * Principal to be repaid before repayment * @return beforeLeftPrincipal **/ @javax.annotation.Nullable @@ -283,7 +283,7 @@ public RepayRecord afterLeftPrincipal(String afterLeftPrincipal) { } /** - * Principal to be repaid after repayment. + * Principal to be repaid after repayment * @return afterLeftPrincipal **/ @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 d0038a1..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 RepayRecordCurrency currency(String currency) { } /** - * Currency. + * Currency * @return currency **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public RepayRecordCurrency indexPrice(String indexPrice) { } /** - * Currency Index Price. + * Currency Index Price * @return indexPrice **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public RepayRecordCurrency beforeAmount(String beforeAmount) { } /** - * Amount before the operation. + * Amount before the operation * @return beforeAmount **/ @javax.annotation.Nullable @@ -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 c8c8445..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 RepayRecordLeftInterest currency(String currency) { } /** - * Currency. + * Currency * @return currency **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public RepayRecordLeftInterest indexPrice(String indexPrice) { } /** - * Currency Index Price. + * Currency Index Price * @return indexPrice **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public RepayRecordLeftInterest beforeAmount(String beforeAmount) { } /** - * Interest amount before repayment. + * Interest amount before repayment * @return beforeAmount **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public RepayRecordLeftInterest beforeAmountUsdt(String beforeAmountUsdt) { } /** - * Converted value of interest before repayment in USDT. + * Converted value of interest before repayment in USDT * @return beforeAmountUsdt **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public RepayRecordLeftInterest afterAmount(String afterAmount) { } /** - * Interest amount after repayment. + * Interest amount after repayment * @return afterAmount **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public RepayRecordLeftInterest afterAmountUsdt(String afterAmountUsdt) { } /** - * Converted value of interest after repayment in USDT. + * Converted value of interest after repayment in USDT * @return afterAmountUsdt **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/RepayRecordRepaidCurrency.java b/src/main/java/io/gate/gateapi/models/RepayRecordRepaidCurrency.java index e5c7976..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 RepayRecordRepaidCurrency currency(String currency) { } /** - * Repayment currency. + * Repayment currency * @return currency **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public RepayRecordRepaidCurrency indexPrice(String indexPrice) { } /** - * Currency Index Price. + * Currency Index Price * @return indexPrice **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public RepayRecordRepaidCurrency repaidAmount(String repaidAmount) { } /** - * Repayment amount. + * Repayment amount * @return repaidAmount **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public RepayRecordRepaidCurrency repaidPrincipal(String repaidPrincipal) { } /** - * Principal. + * Principal * @return repaidPrincipal **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public RepayRecordRepaidCurrency repaidInterest(String repaidInterest) { } /** - * Interest. + * Interest * @return repaidInterest **/ @javax.annotation.Nullable @@ -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 c94dc51..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 RepayRecordTotalInterest currency(String currency) { } /** - * Currency. + * Currency * @return currency **/ @javax.annotation.Nullable @@ -67,7 +67,7 @@ public RepayRecordTotalInterest indexPrice(String indexPrice) { } /** - * Currency Index Price. + * Currency Index Price * @return indexPrice **/ @javax.annotation.Nullable @@ -87,7 +87,7 @@ public RepayRecordTotalInterest amount(String amount) { } /** - * Interest Amount. + * Interest Amount * @return amount **/ @javax.annotation.Nullable @@ -107,7 +107,7 @@ public RepayRecordTotalInterest amountUsdt(String amountUsdt) { } /** - * Interest amount converted to USDT. + * Interest amount converted to USDT * @return amountUsdt **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/RepayResp.java b/src/main/java/io/gate/gateapi/models/RepayResp.java index 5f8cc37..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Repay. + * Repay */ public class RepayResp { public static final String SERIALIZED_NAME_REPAID_PRINCIPAL = "repaid_principal"; @@ -39,7 +39,7 @@ public RepayResp repaidPrincipal(String repaidPrincipal) { } /** - * Principal. + * Principal * @return repaidPrincipal **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public RepayResp repaidInterest(String repaidInterest) { } /** - * Interest. + * Interest * @return repaidInterest **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/RiskUnits.java b/src/main/java/io/gate/gateapi/models/RiskUnits.java index de5c9de..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 RiskUnits symbol(String symbol) { } /** - * Risk unit flag. + * Risk unit flag * @return symbol **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public RiskUnits spotInUse(String spotInUse) { } /** - * Spot hedging utilization. + * Spot hedging occupied amount * @return spotInUse **/ @javax.annotation.Nullable @@ -103,7 +103,7 @@ public RiskUnits maintainMargin(String maintainMargin) { } /** - * Maintenance margin for risk unit. + * Maintenance margin for risk unit * @return maintainMargin **/ @javax.annotation.Nullable @@ -123,7 +123,7 @@ public RiskUnits initialMargin(String initialMargin) { } /** - * Initial margin for risk unit. + * Initial margin for risk unit * @return initialMargin **/ @javax.annotation.Nullable @@ -143,7 +143,7 @@ public RiskUnits delta(String delta) { } /** - * Total Delta of risk unit. + * Total Delta of risk unit * @return delta **/ @javax.annotation.Nullable @@ -163,7 +163,7 @@ public RiskUnits gamma(String gamma) { } /** - * Total Gamma of risk unit. + * Total Gamma of risk unit * @return gamma **/ @javax.annotation.Nullable @@ -183,7 +183,7 @@ public RiskUnits theta(String theta) { } /** - * Total Theta of risk unit. + * Total Theta of risk unit * @return theta **/ @javax.annotation.Nullable @@ -203,7 +203,7 @@ public RiskUnits vega(String vega) { } /** - * Total Vega of risk unit. + * Total Vega of risk unit * @return vega **/ @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 7bb776a..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 SavedAddress currency(String currency) { } /** - * Currency. + * Currency * @return currency **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public SavedAddress chain(String chain) { } /** - * Chain name. + * Chain name * @return chain **/ @javax.annotation.Nullable @@ -95,7 +95,7 @@ public SavedAddress address(String address) { } /** - * Address. + * Address * @return address **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public SavedAddress name(String name) { } /** - * Name. + * Name * @return name **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public SavedAddress tag(String tag) { } /** - * Tag. + * Tag * @return tag **/ @javax.annotation.Nullable @@ -155,7 +155,7 @@ public SavedAddress verified(String verified) { } /** - * Whether to pass the verification 0-unverified, 1-verified. + * Whether to pass the verification 0-unverified, 1-verified * @return verified **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SmallBalance.java b/src/main/java/io/gate/gateapi/models/SmallBalance.java index b8733a6..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -47,7 +47,7 @@ public SmallBalance currency(String currency) { } /** - * Currency. + * Currency * @return currency **/ @javax.annotation.Nullable @@ -67,7 +67,7 @@ public SmallBalance availableBalance(String availableBalance) { } /** - * Available balance. + * Available balance * @return availableBalance **/ @javax.annotation.Nullable @@ -87,7 +87,7 @@ public SmallBalance estimatedAsBtc(String estimatedAsBtc) { } /** - * Estimated as BTC. + * Estimated as BTC * @return estimatedAsBtc **/ @javax.annotation.Nullable @@ -107,7 +107,7 @@ public SmallBalance convertibleToGt(String convertibleToGt) { } /** - * Estimated conversion to GT. + * Estimated conversion to GT * @return convertibleToGt **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SmallBalanceHistory.java b/src/main/java/io/gate/gateapi/models/SmallBalanceHistory.java index 772517f..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -45,7 +45,7 @@ public class SmallBalanceHistory { /** - * Order ID. + * Order ID * @return id **/ @javax.annotation.Nullable @@ -55,7 +55,7 @@ public String getId() { /** - * Currency. + * Currency * @return currency **/ @javax.annotation.Nullable @@ -65,7 +65,7 @@ public String getCurrency() { /** - * amount. + * Swap Amount * @return amount **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public String getAmount() { /** - * GT amount. + * GT amount * @return gtAmount **/ @javax.annotation.Nullable @@ -85,7 +85,7 @@ public String getGtAmount() { /** - * Exchange time (in seconds). + * Exchange time (in seconds) * @return createTime **/ @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 5e6b965..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 SpotAccount currency(String currency) { } /** - * Currency detail. + * Currency detail * @return currency **/ @javax.annotation.Nullable @@ -67,7 +67,7 @@ public SpotAccount available(String available) { } /** - * Available amount. + * Available amount * @return available **/ @javax.annotation.Nullable @@ -87,7 +87,7 @@ public SpotAccount locked(String locked) { } /** - * Locked amount, used in trading. + * Locked amount, used in trading * @return locked **/ @javax.annotation.Nullable @@ -107,7 +107,7 @@ public SpotAccount updateId(Long updateId) { } /** - * Version number. + * Version number * @return updateId **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SpotAccountBook.java b/src/main/java/io/gate/gateapi/models/SpotAccountBook.java index e6b0c5e..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 SpotAccountBook id(String id) { } /** - * Balance change record ID. + * Balance change record ID * @return id **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public SpotAccountBook time(Long time) { } /** - * The timestamp of the change (in milliseconds). + * The timestamp of the change (in milliseconds) * @return time **/ @javax.annotation.Nullable @@ -103,7 +103,7 @@ public SpotAccountBook currency(String currency) { } /** - * Currency changed. + * Currency changed * @return currency **/ @javax.annotation.Nullable @@ -123,7 +123,7 @@ public SpotAccountBook change(String change) { } /** - * Amount changed. Positive value means transferring in, while negative out. + * Amount changed. Positive value means transferring in, while negative out * @return change **/ @javax.annotation.Nullable @@ -143,7 +143,7 @@ public SpotAccountBook balance(String balance) { } /** - * Balance after change. + * Balance after change * @return balance **/ @javax.annotation.Nullable @@ -183,7 +183,7 @@ public SpotAccountBook code(String code) { } /** - * Account change code, see [Asset Record Code] (Asset Record Code). + * Account change code, see [Asset Record Code] (Asset Record Code) * @return code **/ @javax.annotation.Nullable @@ -203,7 +203,7 @@ public SpotAccountBook text(String text) { } /** - * Additional information. + * Additional information * @return text **/ @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 9c3def3..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 @@ -71,7 +71,7 @@ public SpotCurrencyChain addr(String addr) { } /** - * token address. + * token address * @return addr **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public SpotCurrencyChain withdrawDisabled(Boolean withdrawDisabled) { } /** - * Whether currency's withdrawal is disabled. + * Whether currency's withdrawal is disabled * @return withdrawDisabled **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public SpotCurrencyChain withdrawDelayed(Boolean withdrawDelayed) { } /** - * Whether currency's withdrawal is delayed. + * Whether currency's withdrawal is delayed * @return withdrawDelayed **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public SpotCurrencyChain depositDisabled(Boolean depositDisabled) { } /** - * Whether currency's deposit is disabled. + * Whether currency's deposit is disabled * @return depositDisabled **/ @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 c7b862c..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 SpotFee userId(Long userId) { } /** - * User ID. + * User ID * @return userId **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public SpotFee takerFee(String takerFee) { } /** - * taker fee rate. + * taker fee rate * @return takerFee **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public SpotFee makerFee(String makerFee) { } /** - * maker fee rate. + * maker fee rate * @return makerFee **/ @javax.annotation.Nullable @@ -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 @@ -191,7 +191,7 @@ public SpotFee loanFee(String loanFee) { } /** - * Loan fee rate of margin lending. + * Loan fee rate of margin lending * @return loanFee **/ @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 @@ -231,7 +231,7 @@ public SpotFee currencyPair(String currencyPair) { } /** - * Currency pair. + * Currency pair * @return currencyPair **/ @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 9d37499..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 SpotInsuranceHistory currency(String currency) { } /** - * Currency. + * Currency * @return currency **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public SpotInsuranceHistory balance(String balance) { } /** - * balance. + * Balance * @return balance **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public SpotInsuranceHistory time(Long time) { } /** - * Creation time, timestamp, milliseconds. + * Creation time, timestamp, milliseconds * @return time **/ @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 dad7bda..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 { @@ -296,7 +296,7 @@ public SpotPricePutOrder price(String price) { } /** - * Order price. + * Order price * @return price **/ public String getPrice() { @@ -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 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() { @@ -373,7 +373,7 @@ public SpotPricePutOrder autoBorrow(Boolean autoBorrow) { } /** - * Whether to borrow coins automatically. + * Whether to borrow coins automatically * @return autoBorrow **/ @javax.annotation.Nullable @@ -393,7 +393,7 @@ public SpotPricePutOrder autoRepay(Boolean autoRepay) { } /** - * Whether to repay the loan automatically. + * Whether to repay the loan automatically * @return autoRepay **/ @javax.annotation.Nullable @@ -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 5b7c001..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 - `<=`: 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 { @@ -90,7 +90,7 @@ public SpotPriceTrigger price(String price) { } /** - * Trigger price. + * Trigger price * @return price **/ public String getPrice() { @@ -109,7 +109,7 @@ public SpotPriceTrigger rule(RuleEnum rule) { } /** - * Price trigger condition - `>=`: triggered when market price larger than or equal to `price` field - `<=`: 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 c49e6fe..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -105,7 +105,7 @@ public void setPut(SpotPricePutOrder put) { } /** - * Auto order ID. + * Auto order ID * @return id **/ @javax.annotation.Nullable @@ -115,7 +115,7 @@ public Long getId() { /** - * User ID. + * User ID * @return user **/ @javax.annotation.Nullable @@ -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 2c0d872..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 StpGroup id(Long id) { } /** - * STP Group ID. + * STP Group ID * @return id **/ @javax.annotation.Nullable @@ -67,7 +67,7 @@ public StpGroup name(String name) { } /** - * STP Group name. + * STP Group name * @return name **/ public String getName() { @@ -86,7 +86,7 @@ public StpGroup creatorId(Long creatorId) { } /** - * Creator ID. + * Creator ID * @return creatorId **/ @javax.annotation.Nullable @@ -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 7c84e2e..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 StpGroupUser userId(Long userId) { } /** - * User ID. + * User ID * @return userId **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public StpGroupUser stpId(Long stpId) { } /** - * STP Group ID. + * STP Group ID * @return stpId **/ @javax.annotation.Nullable @@ -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 5d73048..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 8845cdc..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 3e7de01..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 order. + * Structured order */ public class StructuredOrderList { public static final String SERIALIZED_NAME_ID = "id"; @@ -59,7 +59,7 @@ public StructuredOrderList id(Integer id) { } /** - * Order ID. + * Order ID * @return id **/ @javax.annotation.Nullable @@ -79,7 +79,7 @@ public StructuredOrderList pid(String pid) { } /** - * Plan ID. + * Product ID * @return pid **/ @javax.annotation.Nullable @@ -99,7 +99,7 @@ public StructuredOrderList lockCoin(String lockCoin) { } /** - * Locked coin. + * Locked coin * @return lockCoin **/ @javax.annotation.Nullable @@ -119,7 +119,7 @@ public StructuredOrderList amount(String amount) { } /** - * Locked amount. + * Locked amount * @return amount **/ @javax.annotation.Nullable @@ -159,7 +159,7 @@ public StructuredOrderList income(String income) { } /** - * Income. + * Income * @return income **/ @javax.annotation.Nullable @@ -179,7 +179,7 @@ public StructuredOrderList createTime(Integer createTime) { } /** - * Created time. + * Created time * @return createTime **/ @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 05df56b..d336c1b 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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 + * 子账户登陆名：仅支持字母、数字、下划线，不可包含其他非法字符。 * @return loginName **/ public String getLoginName() { @@ -102,7 +102,7 @@ public SubAccount password(String password) { } /** - * The sub-account's password. (Default: the same as main account's password). + * The sub-account's password. (Default: the same as main account's password) * @return password **/ @javax.annotation.Nullable @@ -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 @@ -166,7 +166,7 @@ public Long getUserId() { /** - * Created time. + * Created time * @return createTime **/ @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 5815ad6..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -42,7 +42,7 @@ public SubAccountBalance uid(String uid) { } /** - * User ID. + * User ID * @return uid **/ @javax.annotation.Nullable @@ -70,7 +70,7 @@ public SubAccountBalance putAvailableItem(String key, String availableItem) { } /** - * Available balances of currencies. + * Available balances of currencies * @return available **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SubAccountCrossMarginBalance.java b/src/main/java/io/gate/gateapi/models/SubAccountCrossMarginBalance.java index 7dea4d6..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 SubAccountCrossMarginBalance uid(String uid) { } /** - * User ID. + * User ID * @return uid **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SubAccountFuturesBalance.java b/src/main/java/io/gate/gateapi/models/SubAccountFuturesBalance.java index 828a918..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 SubAccountFuturesBalance uid(String uid) { } /** - * User ID. + * User ID * @return uid **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public SubAccountFuturesBalance putAvailableItem(String key, FuturesAccount avai } /** - * Futures account balances. + * Futures account balances * @return available **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SubAccountKey.java b/src/main/java/io/gate/gateapi/models/SubAccountKey.java index f95e5bd..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -68,7 +68,7 @@ public class SubAccountKey { /** - * User ID. + * User ID * @return userId **/ @javax.annotation.Nullable @@ -84,7 +84,7 @@ public SubAccountKey mode(Integer mode) { } /** - * Mode: 1 - classic 2 - portfolio account. + * Mode: 1 - classic 2 - portfolio account * @return mode **/ @javax.annotation.Nullable @@ -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 @@ -174,7 +174,7 @@ public void setIpWhitelist(List ipWhitelist) { } /** - * API Key. + * API Key * @return key **/ @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 0515e84..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 d2b0318..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -42,7 +42,7 @@ public SubAccountMarginBalance uid(String uid) { } /** - * User ID. + * User ID * @return uid **/ @javax.annotation.Nullable @@ -70,7 +70,7 @@ public SubAccountMarginBalance addAvailableItem(MarginAccount availableItem) { } /** - * Margin account balances. + * Margin account balances * @return available **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SubAccountToSubAccount.java b/src/main/java/io/gate/gateapi/models/SubAccountToSubAccount.java index 81692e6..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 SubAccountToSubAccount currency(String currency) { } /** - * Transfer currency name. + * Transfer currency name * @return currency **/ public String getCurrency() { @@ -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 @@ -98,7 +98,7 @@ public SubAccountToSubAccount subAccountFrom(String subAccountFrom) { } /** - * Transfer from the user id of the sub-account. + * Transfer from the user id of the sub-account * @return subAccountFrom **/ public String getSubAccountFrom() { @@ -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() { @@ -136,7 +136,7 @@ public SubAccountToSubAccount subAccountTo(String subAccountTo) { } /** - * Transfer to the user id of the sub-account. + * Transfer to the user id of the sub-account * @return subAccountTo **/ public String getSubAccountTo() { @@ -155,7 +155,7 @@ public SubAccountToSubAccount subAccountToType(String subAccountToType) { } /** - * Transferred sub-account 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() { @@ -174,7 +174,7 @@ public SubAccountToSubAccount amount(String amount) { } /** - * Transfer amount. + * Transfer amount * @return amount **/ public String getAmount() { diff --git a/src/main/java/io/gate/gateapi/models/SubAccountTransfer.java b/src/main/java/io/gate/gateapi/models/SubAccountTransfer.java index cabf82c..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 SubAccountTransfer subAccount(String subAccount) { } /** - * Sub account user ID. + * Sub account user ID * @return subAccount **/ public String getSubAccount() { @@ -74,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 @@ -94,7 +94,7 @@ public SubAccountTransfer currency(String currency) { } /** - * Transfer currency name. + * Transfer currency name * @return currency **/ public String getCurrency() { @@ -113,7 +113,7 @@ public SubAccountTransfer amount(String amount) { } /** - * Transfer amount. + * Transfer amount * @return amount **/ public String getAmount() { @@ -132,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() { @@ -151,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 diff --git a/src/main/java/io/gate/gateapi/models/SubAccountTransferRecordItem.java b/src/main/java/io/gate/gateapi/models/SubAccountTransferRecordItem.java index d9ca1ba..4bdc741 100644 --- a/src/main/java/io/gate/gateapi/models/SubAccountTransferRecordItem.java +++ b/src/main/java/io/gate/gateapi/models/SubAccountTransferRecordItem.java @@ -1,6 +1,6 @@ /* * Gate API - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 class SubAccountTransferRecordItem { /** - * Transfer timestamp. + * Transfer timestamp * @return timest **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public String getTimest() { /** - * Main account user ID. + * Main account user ID * @return uid **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public SubAccountTransferRecordItem subAccount(String subAccount) { } /** - * Sub account user ID. + * Sub account user ID * @return subAccount **/ public String getSubAccount() { @@ -110,7 +110,7 @@ public SubAccountTransferRecordItem 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 @@ -130,7 +130,7 @@ public SubAccountTransferRecordItem currency(String currency) { } /** - * Transfer currency name. + * Transfer currency name * @return currency **/ public String getCurrency() { @@ -149,7 +149,7 @@ public SubAccountTransferRecordItem amount(String amount) { } /** - * Transfer amount. + * Transfer amount * @return amount **/ public String getAmount() { @@ -168,7 +168,7 @@ public SubAccountTransferRecordItem 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() { @@ -181,7 +181,7 @@ public void setDirection(String direction) { } /** - * Where the operation is initiated from. + * Source of the transfer operation * @return source **/ @javax.annotation.Nullable @@ -197,7 +197,7 @@ public SubAccountTransferRecordItem 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 @@ -217,7 +217,7 @@ public SubAccountTransferRecordItem status(String status) { } /** - * Sub-account transfer record status, currently only success. + * Sub-account transfer record status, currently only 'success' * @return status **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SubCrossMarginAccount.java b/src/main/java/io/gate/gateapi/models/SubCrossMarginAccount.java index 7ef52c3..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 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 @@ -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 @@ -227,7 +227,7 @@ public SubCrossMarginAccount net(String net) { } /** - * Total net assets in USDT. + * Total net assets in USDT * @return net **/ @javax.annotation.Nullable @@ -247,7 +247,7 @@ public SubCrossMarginAccount leverage(String leverage) { } /** - * Position leverage. + * Position leverage * @return leverage **/ @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 @@ -307,7 +307,7 @@ public SubCrossMarginAccount totalInitialMargin(String totalInitialMargin) { } /** - * Total initial margin. + * Total initial margin * @return totalInitialMargin **/ @javax.annotation.Nullable @@ -327,7 +327,7 @@ public SubCrossMarginAccount totalMarginBalance(String totalMarginBalance) { } /** - * Total margin balance. + * Total margin balance * @return totalMarginBalance **/ @javax.annotation.Nullable @@ -347,7 +347,7 @@ public SubCrossMarginAccount totalMaintenanceMargin(String totalMaintenanceMargi } /** - * Total maintenance margin. + * Total maintenance margin * @return totalMaintenanceMargin **/ @javax.annotation.Nullable @@ -367,7 +367,7 @@ public SubCrossMarginAccount totalInitialMarginRate(String totalInitialMarginRat } /** - * Total initial margin rate. + * Total initial margin rate * @return totalInitialMarginRate **/ @javax.annotation.Nullable @@ -387,7 +387,7 @@ public SubCrossMarginAccount totalMaintenanceMarginRate(String totalMaintenanceM } /** - * Total maintenance margin rate. + * Total maintenance margin rate * @return totalMaintenanceMarginRate **/ @javax.annotation.Nullable @@ -407,7 +407,7 @@ public SubCrossMarginAccount totalAvailableMargin(String totalAvailableMargin) { } /** - * Total available margin. + * Total available margin * @return totalAvailableMargin **/ @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 0ee26b3..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 SubUserMode userId(Long userId) { } /** - * User ID. + * User ID * @return userId **/ @javax.annotation.Nullable @@ -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 index a598058..0f7fe0a 100644 --- a/src/main/java/io/gate/gateapi/models/SwapCoin.java +++ b/src/main/java/io/gate/gateapi/models/SwapCoin.java @@ -1,6 +1,6 @@ /* * Gate API - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Blockchain Mining. + * Blockchain Mining */ public class SwapCoin { public static final String SERIALIZED_NAME_COIN = "coin"; @@ -47,7 +47,7 @@ public SwapCoin coin(String coin) { } /** - * Currency. + * Currency * @return coin **/ public String getCoin() { @@ -66,7 +66,7 @@ public SwapCoin side(String side) { } /** - * 0 - Stake 1 - Redeem. + * 0 - Stake 1 - Redeem * @return side **/ public String getSide() { @@ -85,7 +85,7 @@ public SwapCoin amount(String amount) { } /** - * Size. + * Size * @return amount **/ public String getAmount() { @@ -104,7 +104,7 @@ public SwapCoin pid(Integer pid) { } /** - * DeFi-type Mining Protocol Identifier. + * DeFi-type Mining Protocol Identifier * @return pid **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SwapCoinStruct.java b/src/main/java/io/gate/gateapi/models/SwapCoinStruct.java index 0eaa806..b6f6720 100644 --- a/src/main/java/io/gate/gateapi/models/SwapCoinStruct.java +++ b/src/main/java/io/gate/gateapi/models/SwapCoinStruct.java @@ -1,6 +1,6 @@ /* * Gate API - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 SwapCoinStruct id(Integer id) { } /** - * Order ID. + * Order ID * @return id **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public SwapCoinStruct pid(Integer pid) { } /** - * Plan ID. + * Product ID * @return pid **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public SwapCoinStruct uid(Integer uid) { } /** - * User ID. + * User ID * @return uid **/ @javax.annotation.Nullable @@ -151,7 +151,7 @@ public SwapCoinStruct coin(String coin) { } /** - * Currency. + * Currency * @return coin **/ @javax.annotation.Nullable @@ -171,7 +171,7 @@ public SwapCoinStruct type(Integer type) { } /** - * 类型 0-质押 1-赎回 + * Type 0-Staking 1-Redemption * @return type **/ @javax.annotation.Nullable @@ -211,7 +211,7 @@ public SwapCoinStruct amount(String amount) { } /** - * Amount. + * Amount * @return amount **/ @javax.annotation.Nullable @@ -231,7 +231,7 @@ public SwapCoinStruct exchangeRate(String exchangeRate) { } /** - * Exchange Ratio. + * Exchange ratio * @return exchangeRate **/ @javax.annotation.Nullable @@ -251,7 +251,7 @@ public SwapCoinStruct exchangeAmount(String exchangeAmount) { } /** - * 兑换金额 + * Redemption Amount * @return exchangeAmount **/ @javax.annotation.Nullable @@ -291,7 +291,7 @@ public SwapCoinStruct createStamp(Integer createStamp) { } /** - * Transaction timestamp. + * Transaction timestamp * @return createStamp **/ @javax.annotation.Nullable @@ -311,7 +311,7 @@ public SwapCoinStruct status(Integer status) { } /** - * status 1-success. + * status 1-success * @return status **/ @javax.annotation.Nullable @@ -331,7 +331,7 @@ public SwapCoinStruct protocolType(Integer protocolType) { } /** - * DEFI协议类型 + * DEFI Protocol Type * @return protocolType **/ @javax.annotation.Nullable @@ -351,7 +351,7 @@ public SwapCoinStruct clientOrderId(String clientOrderId) { } /** - * 参考ID + * Reference ID * @return clientOrderId **/ @javax.annotation.Nullable @@ -371,7 +371,7 @@ public SwapCoinStruct source(String source) { } /** - * Order source. + * Order Origin * @return source **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/SystemTime.java b/src/main/java/io/gate/gateapi/models/SystemTime.java index 0a69c9c..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 SystemTime serverTime(Long serverTime) { } /** - * Server current time(ms). + * Server current time(ms) * @return serverTime **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/Ticker.java b/src/main/java/io/gate/gateapi/models/Ticker.java index a553185..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 Ticker currencyPair(String currencyPair) { } /** - * Currency pair. + * Currency pair * @return currencyPair **/ @javax.annotation.Nullable @@ -119,7 +119,7 @@ public Ticker last(String last) { } /** - * Last trading price. + * Last trading price * @return last **/ @javax.annotation.Nullable @@ -139,7 +139,7 @@ public Ticker lowestAsk(String lowestAsk) { } /** - * Recent lowest ask. + * Recent lowest ask * @return lowestAsk **/ @javax.annotation.Nullable @@ -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 @@ -179,7 +179,7 @@ public Ticker highestBid(String highestBid) { } /** - * Recent highest bid. + * Recent highest bid * @return highestBid **/ @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 @@ -359,7 +359,7 @@ public Ticker etfNetValue(String etfNetValue) { } /** - * ETF net value. + * ETF net value * @return etfNetValue **/ @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 @@ -419,7 +419,7 @@ public Ticker etfLeverage(String etfLeverage) { } /** - * ETF current leverage. + * ETF current leverage * @return etfLeverage **/ @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 ef60cc9..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 191493c..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Buy or sell order. + * 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 @@ -229,7 +229,7 @@ public Trade createTimeMs(String createTimeMs) { } /** - * Trading time, with millisecond precision. + * Trading time, with millisecond precision * @return createTimeMs **/ @javax.annotation.Nullable @@ -249,7 +249,7 @@ public Trade currencyPair(String currencyPair) { } /** - * Currency pair. + * Currency pair * @return currencyPair **/ @javax.annotation.Nullable @@ -269,7 +269,7 @@ public Trade side(SideEnum side) { } /** - * Buy or sell order. + * 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 @@ -309,7 +309,7 @@ public Trade amount(String amount) { } /** - * Trade amount. + * Trade amount * @return amount **/ @javax.annotation.Nullable @@ -329,7 +329,7 @@ public Trade price(String price) { } /** - * Order price. + * Order price * @return price **/ @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 @@ -449,7 +449,7 @@ public Trade amendText(String amendText) { } /** - * The custom data that the user remarked when amending the order. + * The custom data that the user remarked when amending the order * @return amendText **/ @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 987234e..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 TradeFee userId(Long userId) { } /** - * User ID. + * User ID * @return userId **/ @javax.annotation.Nullable @@ -103,7 +103,7 @@ public TradeFee takerFee(String takerFee) { } /** - * taker fee rate. + * taker fee rate * @return takerFee **/ @javax.annotation.Nullable @@ -123,7 +123,7 @@ public TradeFee makerFee(String makerFee) { } /** - * maker fee rate. + * maker fee rate * @return makerFee **/ @javax.annotation.Nullable @@ -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 @@ -203,7 +203,7 @@ public TradeFee loanFee(String loanFee) { } /** - * Loan fee rate of margin lending. + * Loan fee rate of margin lending * @return loanFee **/ @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 db9c877..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 07e0ddc..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 Transfer { private String currency; /** - * Account to transfer from. + * Account to transfer from */ @JsonAdapter(FromEnum.Adapter.class) public enum FromEnum { @@ -85,7 +85,7 @@ public FromEnum read(final JsonReader jsonReader) throws IOException { private FromEnum from; /** - * Account to transfer to. + * Account to transfer to */ @JsonAdapter(ToEnum.Adapter.class) public enum ToEnum { @@ -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() { @@ -180,7 +180,7 @@ public Transfer from(FromEnum from) { } /** - * Account to transfer from. + * Account to transfer from * @return from **/ public FromEnum getFrom() { @@ -199,7 +199,7 @@ public Transfer to(ToEnum to) { } /** - * Account to transfer to. + * Account to transfer to * @return to **/ public ToEnum getTo() { @@ -218,7 +218,7 @@ public Transfer amount(String amount) { } /** - * Transfer amount. + * Transfer amount * @return amount **/ public String getAmount() { @@ -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 6efc026..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 b75eebe..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -39,7 +39,7 @@ public TransferablesResult currency(String currency) { } /** - * Currency detail. + * Currency detail * @return currency **/ @javax.annotation.Nullable @@ -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 cd2ec24..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 TriggerOrderResponse id(Long id) { } /** - * Auto order ID. + * Auto order ID * @return id **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/TriggerTime.java b/src/main/java/io/gate/gateapi/models/TriggerTime.java index e8d7db0..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 1bbec95..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 UidPushOrder id(Long id) { } /** - * Order ID. + * Order ID * @return id **/ @javax.annotation.Nullable @@ -87,7 +87,7 @@ public UidPushOrder pushUid(Long pushUid) { } /** - * Initiator User ID. + * Initiator User ID * @return pushUid **/ @javax.annotation.Nullable @@ -107,7 +107,7 @@ public UidPushOrder receiveUid(Long receiveUid) { } /** - * Recipient User ID. + * Recipient User ID * @return receiveUid **/ @javax.annotation.Nullable @@ -127,7 +127,7 @@ public UidPushOrder currency(String currency) { } /** - * Currency name. + * Currency name * @return currency **/ @javax.annotation.Nullable @@ -147,7 +147,7 @@ public UidPushOrder amount(String amount) { } /** - * Transfer amount. + * Transfer amount * @return amount **/ @javax.annotation.Nullable @@ -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 @@ -227,7 +227,7 @@ public UidPushOrder transactionType(String transactionType) { } /** - * Order Type. + * Order Type * @return transactionType **/ @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 e7ef645..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 UidPushWithdrawal receiveUid(Long receiveUid) { } /** - * Recipient UID. + * Recipient UID * @return receiveUid **/ public Long getReceiveUid() { @@ -62,7 +62,7 @@ public UidPushWithdrawal currency(String currency) { } /** - * Currency name. + * Currency name * @return currency **/ public String getCurrency() { @@ -81,7 +81,7 @@ public UidPushWithdrawal amount(String amount) { } /** - * Transfer amount. + * Transfer amount * @return amount **/ public String getAmount() { diff --git a/src/main/java/io/gate/gateapi/models/UidPushWithdrawalResp.java b/src/main/java/io/gate/gateapi/models/UidPushWithdrawalResp.java index 920aea1..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 UidPushWithdrawalResp id(Long id) { } /** - * Order ID. + * Order ID * @return id **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UniCurrency.java b/src/main/java/io/gate/gateapi/models/UniCurrency.java index e95deaa..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Currency detail. + * Currency detail */ public class UniCurrency { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -45,7 +45,7 @@ public class UniCurrency { /** - * Currency name. + * Currency name * @return currency **/ @javax.annotation.Nullable @@ -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 @@ -65,7 +65,7 @@ public String getMinLendAmount() { /** - * The total maximum lending amount, in USDT. + * The total maximum lending amount, in USDT * @return maxLendAmount **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public String getMaxLendAmount() { /** - * Maximum rate (Hourly). + * Maximum rate (Hourly) * @return maxRate **/ @javax.annotation.Nullable @@ -85,7 +85,7 @@ public String getMaxRate() { /** - * Minimum rate (Hourly). + * Minimum rate (Hourly) * @return minRate **/ @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 c086800..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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,7 +33,7 @@ public class UniCurrencyInterest { /** - * Currency. + * Currency * @return currency **/ @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 d4a37c7..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Currency pair of the loan. + * Currency pair of the loan */ public class UniCurrencyPair { public static final String SERIALIZED_NAME_CURRENCY_PAIR = "currency_pair"; @@ -41,7 +41,7 @@ public class UniCurrencyPair { /** - * Currency pair. + * Currency pair * @return currencyPair **/ @javax.annotation.Nullable @@ -51,7 +51,7 @@ public String getCurrencyPair() { /** - * Minimum borrow amount of base currency. + * Minimum borrow amount of base currency * @return baseMinBorrowAmount **/ @javax.annotation.Nullable @@ -61,7 +61,7 @@ public String getBaseMinBorrowAmount() { /** - * Minimum borrow amount of quote currency. + * Minimum borrow amount of quote currency * @return quoteMinBorrowAmount **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public String getQuoteMinBorrowAmount() { /** - * Position leverage. + * Position leverage * @return leverage **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UniInterestRecord.java b/src/main/java/io/gate/gateapi/models/UniInterestRecord.java index dda7b28..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 Record */ public class UniInterestRecord { public static final String SERIALIZED_NAME_STATUS = "status"; @@ -49,7 +49,7 @@ public class UniInterestRecord { /** - * Status: 0 - fail, 1 - success. + * Status: 0 - fail, 1 - success * @return status **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public Integer getStatus() { /** - * Currency. + * Currency * @return currency **/ @javax.annotation.Nullable @@ -69,7 +69,7 @@ public String getCurrency() { /** - * Actual Rate. + * Actual Rate * @return actualRate **/ @javax.annotation.Nullable @@ -79,7 +79,7 @@ public String getActualRate() { /** - * Interest. + * Interest * @return interest **/ @javax.annotation.Nullable @@ -99,7 +99,7 @@ public String getInterestStatus() { /** - * Created time. + * Created time * @return createTime **/ @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 36b25ae..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 record. + * Loan record */ public class UniLend { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -65,7 +65,7 @@ public class UniLend { /** - * Currency. + * Currency * @return currency **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public String getCurrency() { /** - * Current amount. + * Current amount * @return currentAmount **/ @javax.annotation.Nullable @@ -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 @@ -115,7 +115,7 @@ public String getFrozenAmount() { /** - * Minimum interest rate. + * Minimum interest rate * @return minRate **/ @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 eb5bd4a..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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,7 +33,7 @@ public class UniLendInterest { /** - * Currency. + * Currency * @return currency **/ @javax.annotation.Nullable @@ -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 9dcf431..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -53,7 +53,7 @@ public class UniLendRecord { /** - * Currency name. + * Currency name * @return currency **/ @javax.annotation.Nullable @@ -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 @@ -113,7 +113,7 @@ public String getType() { /** - * Created time. + * Created time * @return createTime **/ @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 8b36e17..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -49,7 +49,7 @@ public class UniLoan { /** - * Currency. + * Currency * @return currency **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public String getCurrency() { /** - * Currency pair. + * Currency pair * @return currencyPair **/ @javax.annotation.Nullable @@ -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 @@ -89,7 +89,7 @@ public String getType() { /** - * Created time. + * Created time * @return createTime **/ @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 7191b13..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -53,7 +53,7 @@ public class UniLoanInterestRecord { /** - * Currency name. + * Currency name * @return currency **/ @javax.annotation.Nullable @@ -63,7 +63,7 @@ public String getCurrency() { /** - * Currency pair. + * Currency pair * @return currencyPair **/ @javax.annotation.Nullable @@ -73,7 +73,7 @@ public String getCurrencyPair() { /** - * Actual rate. + * Actual Rate * @return actualRate **/ @javax.annotation.Nullable @@ -83,7 +83,7 @@ public String getActualRate() { /** - * Interest. + * Interest * @return interest **/ @javax.annotation.Nullable @@ -93,7 +93,7 @@ public String getInterest() { /** - * Status: 0 - fail, 1 - success. + * Status: 0 - fail, 1 - success * @return status **/ @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 @@ -113,7 +113,7 @@ public String getType() { /** - * Created time. + * Created time * @return createTime **/ @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 e4257db..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 @@ -55,7 +55,7 @@ public String getType() { /** - * Currency pair. + * Currency pair * @return currencyPair **/ @javax.annotation.Nullable @@ -65,7 +65,7 @@ public String getCurrencyPair() { /** - * Currency. + * Currency * @return currency **/ @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 @@ -85,7 +85,7 @@ public String getAmount() { /** - * Created time. + * Created time * @return createTime **/ @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 896cf66..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 UnifiedAccount userId(Long userId) { } /** - * User ID. + * User ID * @return userId **/ @javax.annotation.Nullable @@ -135,7 +135,7 @@ public UnifiedAccount refreshTime(Long refreshTime) { } /** - * Time of the most recent refresh. + * Last refresh time * @return refreshTime **/ @javax.annotation.Nullable @@ -203,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 @@ -223,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 @@ -363,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 @@ -383,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 @@ -403,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 @@ -417,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 @@ -453,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 @@ -473,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 @@ -493,7 +493,7 @@ public UnifiedAccount isAllCollateral(Boolean isAllCollateral) { } /** - * Whether all currencies are used as margin, true - false - No + * Whether all currencies are used as margin: true - all currencies as margin, false - no * @return isAllCollateral **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedBalance.java b/src/main/java/io/gate/gateapi/models/UnifiedBalance.java index b5526bf..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 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 @@ -131,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 @@ -151,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 @@ -171,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 @@ -231,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 @@ -251,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 @@ -311,7 +311,7 @@ public UnifiedBalance fundingVersion(String fundingVersion) { } /** - * Funding version. + * Funding version * @return fundingVersion **/ @javax.annotation.Nullable @@ -391,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 @@ -471,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 @@ -491,7 +491,7 @@ public UnifiedBalance enabledCollateral(Boolean enabledCollateral) { } /** - * Currency enabled as margin: true - Enabled, false - Disabled. + * Currency enabled as margin: true - Enabled, false - Disabled * @return enabledCollateral **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedBorrowable.java b/src/main/java/io/gate/gateapi/models/UnifiedBorrowable.java index 3e81d7d..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 UnifiedBorrowable currency(String currency) { } /** - * Currency detail. + * Currency detail * @return currency **/ @javax.annotation.Nullable @@ -59,7 +59,7 @@ public UnifiedBorrowable amount(String amount) { } /** - * Max borrowable amount. + * Max borrowable amount * @return amount **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedBorrowable1.java b/src/main/java/io/gate/gateapi/models/UnifiedBorrowable1.java index 6d19a38..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -39,7 +39,7 @@ public UnifiedBorrowable1 currency(String currency) { } /** - * Currency detail. + * Currency detail * @return currency **/ @javax.annotation.Nullable @@ -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 index 44a80c3..7ed61e3 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedCollateralReq.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedCollateralReq.java @@ -1,6 +1,6 @@ /* * Gate API - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 @@ */ public class UnifiedCollateralReq { /** - * User-set collateral mode0(all)-All currencies used as collateral, collateral; when collateral_type is 0(all), the enable_list and disable_list parameters are invalid + * 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 { @@ -92,7 +92,7 @@ public UnifiedCollateralReq collateralType(CollateralTypeEnum collateralType) { } /** - * User-set collateral mode0(all)-All currencies used as collateral, collateral; when collateral_type is 0(all), the enable_list and disable_list parameters are invalid + * 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 @@ -120,7 +120,7 @@ public UnifiedCollateralReq addEnableListItem(String enableListItem) { } /** - * Currency list, where collateral_type=1(custom) indicates the logic of addition + * Currency list, where collateral_type=1(custom) indicates the addition logic * @return enableList **/ @javax.annotation.Nullable @@ -148,7 +148,7 @@ public UnifiedCollateralReq addDisableListItem(String disableListItem) { } /** - * Cancellation list, indicating the logic of cancellation. + * Disable list, indicating the disable logic * @return disableList **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedCollateralRes.java b/src/main/java/io/gate/gateapi/models/UnifiedCollateralRes.java index 21e3bc5..a1aa90d 100644 --- a/src/main/java/io/gate/gateapi/models/UnifiedCollateralRes.java +++ b/src/main/java/io/gate/gateapi/models/UnifiedCollateralRes.java @@ -1,6 +1,6 @@ /* * Gate API - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Return of unified account collateral mode settings. + * Unified account collateral mode settings response */ public class UnifiedCollateralRes { public static final String SERIALIZED_NAME_IS_SUCCESS = "is_success"; @@ -35,7 +35,7 @@ public UnifiedCollateralRes isSuccess(Boolean isSuccess) { } /** - * Whether the setting was successful. + * Whether the setting was successful * @return isSuccess **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedCurrency.java b/src/main/java/io/gate/gateapi/models/UnifiedCurrency.java index 8bb5c96..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 UnifiedCurrency name(String name) { } /** - * Currency name. + * Currency name * @return name **/ @javax.annotation.Nullable @@ -75,7 +75,7 @@ public UnifiedCurrency prec(String prec) { } /** - * Currency precision. + * Currency precision * @return prec **/ @javax.annotation.Nullable @@ -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 41867e9..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -42,7 +42,7 @@ public UnifiedDiscount currency(String currency) { } /** - * Currency name. + * Currency name * @return currency **/ @javax.annotation.Nullable @@ -70,7 +70,7 @@ public UnifiedDiscount addDiscountTiersItem(UnifiedDiscountTiers discountTiersIt } /** - * Tiered discount. + * Tiered discount * @return discountTiers **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UnifiedDiscountTiers.java b/src/main/java/io/gate/gateapi/models/UnifiedDiscountTiers.java index 0e4b408..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 UnifiedDiscountTiers tier(String tier) { } /** - * Tier. + * Tier * @return tier **/ @javax.annotation.Nullable @@ -71,7 +71,7 @@ public UnifiedDiscountTiers discount(String discount) { } /** - * Discount. + * Discount * @return discount **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public UnifiedDiscountTiers lowerLimit(String lowerLimit) { } /** - * Lower limit. + * Lower limit * @return lowerLimit **/ @javax.annotation.Nullable @@ -111,7 +111,7 @@ public UnifiedDiscountTiers upperLimit(String upperLimit) { } /** - * Upper limit,＋ indicates positive infinity. + * Upper limit, + indicates positive infinity * @return upperLimit **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public UnifiedDiscountTiers leverage(String leverage) { } /** - * Position leverage. + * Position leverage * @return leverage **/ @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 4e9d126..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -50,7 +50,7 @@ public UnifiedHistoryLoanRate currency(String currency) { } /** - * Currency name. + * Currency name * @return currency **/ @javax.annotation.Nullable @@ -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 01accfc..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 f4f858e..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 UnifiedLeverageConfig currentLeverage(String currentLeverage) { } /** - * Current leverage ratio. + * Current leverage ratio * @return currentLeverage **/ @javax.annotation.Nullable @@ -79,7 +79,7 @@ public UnifiedLeverageConfig minLeverage(String minLeverage) { } /** - * Minimum adjustable leverage ratio. + * Minimum adjustable leverage ratio * @return minLeverage **/ @javax.annotation.Nullable @@ -99,7 +99,7 @@ public UnifiedLeverageConfig maxLeverage(String maxLeverage) { } /** - * Maximum adjustable leverage ratio. + * Maximum adjustable leverage ratio * @return maxLeverage **/ @javax.annotation.Nullable @@ -119,7 +119,7 @@ public UnifiedLeverageConfig debit(String debit) { } /** - * Current liabilities. + * Current liabilities * @return debit **/ @javax.annotation.Nullable @@ -139,7 +139,7 @@ public UnifiedLeverageConfig availableMargin(String availableMargin) { } /** - * Available Margin. + * Available Margin * @return availableMargin **/ @javax.annotation.Nullable @@ -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 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 86189da..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -39,7 +39,7 @@ public UnifiedLeverageSetting currency(String currency) { } /** - * Currency name. + * Currency name * @return currency **/ public String getCurrency() { @@ -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 fc03332..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * Borrow or repay. + * Borrow or repay */ public class UnifiedLoan { public static final String SERIALIZED_NAME_CURRENCY = "currency"; @@ -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 { @@ -98,7 +98,7 @@ public UnifiedLoan currency(String currency) { } /** - * Currency. + * Currency * @return currency **/ public String getCurrency() { @@ -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 @@ -175,7 +175,7 @@ public UnifiedLoan text(String text) { } /** - * User defined custom ID. + * User defined custom ID * @return text **/ @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 873c2bc..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 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 @@ -107,7 +107,7 @@ public void setBorrowType(String borrowType) { } /** - * Currency pair. + * Currency pair * @return currencyPair **/ @javax.annotation.Nullable @@ -117,7 +117,7 @@ public String getCurrencyPair() { /** - * Currency. + * Currency * @return currency **/ @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 @@ -137,7 +137,7 @@ public String getAmount() { /** - * Created time. + * Created time * @return createTime **/ @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 64b929c..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 89eb941..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -42,7 +42,7 @@ public UnifiedMarginTiers currency(String currency) { } /** - * Currency name. + * Currency name * @return currency **/ @javax.annotation.Nullable @@ -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 f489dc5..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 64ebfb5..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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"; @@ -75,7 +75,7 @@ public UnifiedPortfolioInput addSpotBalancesItem(MockSpotBalance spotBalancesIte } /** - * Spot. + * Spot * @return spotBalances **/ @javax.annotation.Nullable @@ -103,7 +103,7 @@ public UnifiedPortfolioInput addSpotOrdersItem(MockSpotOrder spotOrdersItem) { } /** - * Spot orders. + * Spot orders * @return spotOrders **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public UnifiedPortfolioInput addFuturesPositionsItem(MockFuturesPosition futures } /** - * Futures positions. + * Futures positions * @return futuresPositions **/ @javax.annotation.Nullable @@ -159,7 +159,7 @@ public UnifiedPortfolioInput addFuturesOrdersItem(MockFuturesOrder futuresOrders } /** - * Futures order. + * Futures order * @return futuresOrders **/ @javax.annotation.Nullable @@ -187,7 +187,7 @@ public UnifiedPortfolioInput addOptionsPositionsItem(MockOptionsPosition options } /** - * Options positions. + * Options positions * @return optionsPositions **/ @javax.annotation.Nullable @@ -215,7 +215,7 @@ public UnifiedPortfolioInput addOptionsOrdersItem(MockOptionsOrder optionsOrders } /** - * Option orders. + * Option orders * @return optionsOrders **/ @javax.annotation.Nullable @@ -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 fbf2ab6..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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, 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 @@ -118,7 +118,7 @@ public UnifiedPortfolioOutput addRiskUnitItem(MockRiskUnit riskUnitItem) { } /** - * Risk unit. + * Risk unit * @return riskUnit **/ @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 b5c6320..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -46,7 +46,7 @@ public UnifiedRiskUnits userId(Long userId) { } /** - * User ID. + * User ID * @return userId **/ @javax.annotation.Nullable @@ -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 @@ -94,7 +94,7 @@ public UnifiedRiskUnits addRiskUnitsItem(RiskUnits riskUnitsItem) { } /** - * Risk unit. + * Risk unit * @return riskUnits **/ @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 6655095..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 d38a906..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 UnifiedTransferable currency(String currency) { } /** - * Currency detail. + * Currency detail * @return currency **/ @javax.annotation.Nullable @@ -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 9e75ca7..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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; /** - * User's currency statistics data. + * User's currency statistics data */ public class UserLtvInfo { public static final String SERIALIZED_NAME_COLLATERAL_CURRENCY = "collateral_currency"; @@ -59,7 +59,7 @@ public UserLtvInfo collateralCurrency(String collateralCurrency) { } /** - * Collateral. + * Collateral currency * @return collateralCurrency **/ @javax.annotation.Nullable @@ -79,7 +79,7 @@ public UserLtvInfo borrowCurrency(String borrowCurrency) { } /** - * Borrowed currency. + * Borrowed currency * @return borrowCurrency **/ @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 @@ -159,7 +159,7 @@ public UserLtvInfo minBorrowAmount(String minBorrowAmount) { } /** - * Minimum borrowable amount for the loan currency. + * Minimum borrowable amount for the loan currency * @return minBorrowAmount **/ @javax.annotation.Nullable @@ -179,7 +179,7 @@ public UserLtvInfo leftBorrowableAmount(String leftBorrowableAmount) { } /** - * Remaining borrowable amount for the loan currency. + * Remaining borrowable amount for the loan currency * @return leftBorrowableAmount **/ @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 bcbafaf..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 UserSub uid(Long uid) { } /** - * User ID. + * User ID * @return uid **/ @javax.annotation.Nullable @@ -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 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 @@ -107,7 +107,7 @@ public UserSub refUid(Long refUid) { } /** - * Inviter user ID. + * Inviter user ID * @return refUid **/ @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 462eff3..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -46,7 +46,7 @@ public UserSubRelation addListItem(UserSub listItem) { } /** - * Subordinate relationship list. + * Subordinate relationship list * @return list **/ @javax.annotation.Nullable diff --git a/src/main/java/io/gate/gateapi/models/UserTotalAmount.java b/src/main/java/io/gate/gateapi/models/UserTotalAmount.java index a1978a7..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 1aca77d..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech @@ -82,7 +82,7 @@ public WithdrawStatus currency(String currency) { } /** - * Currency. + * Currency * @return currency **/ @javax.annotation.Nullable @@ -102,7 +102,7 @@ public WithdrawStatus name(String name) { } /** - * Currency name. + * Currency name * @return name **/ @javax.annotation.Nullable @@ -122,7 +122,7 @@ public WithdrawStatus nameCn(String nameCn) { } /** - * Currency Chinese name. + * Currency Chinese name * @return nameCn **/ @javax.annotation.Nullable @@ -142,7 +142,7 @@ public WithdrawStatus deposit(String deposit) { } /** - * Deposits fee. + * Deposit fee * @return deposit **/ @javax.annotation.Nullable @@ -162,7 +162,7 @@ public WithdrawStatus withdrawPercent(String withdrawPercent) { } /** - * Withdrawal fee rate percentage. + * Withdrawal fee rate percentage * @return withdrawPercent **/ @javax.annotation.Nullable @@ -182,7 +182,7 @@ public WithdrawStatus withdrawFix(String withdrawFix) { } /** - * Fixed withdrawal fee. + * Fixed withdrawal fee * @return withdrawFix **/ @javax.annotation.Nullable @@ -202,7 +202,7 @@ public WithdrawStatus withdrawDayLimit(String withdrawDayLimit) { } /** - * Daily allowed withdrawal amount. + * Daily allowed withdrawal amount * @return withdrawDayLimit **/ @javax.annotation.Nullable @@ -222,7 +222,7 @@ public WithdrawStatus withdrawAmountMini(String withdrawAmountMini) { } /** - * Minimum withdrawal amount. + * Minimum withdrawal amount * @return withdrawAmountMini **/ @javax.annotation.Nullable @@ -242,7 +242,7 @@ public WithdrawStatus withdrawDayLimitRemain(String withdrawDayLimitRemain) { } /** - * Daily withdrawal amount left. + * Daily withdrawal amount left * @return withdrawDayLimitRemain **/ @javax.annotation.Nullable @@ -262,7 +262,7 @@ public WithdrawStatus withdrawEachtimeLimit(String withdrawEachtimeLimit) { } /** - * Maximum amount for each withdrawal. + * Maximum amount for each withdrawal * @return withdrawEachtimeLimit **/ @javax.annotation.Nullable @@ -290,7 +290,7 @@ public WithdrawStatus putWithdrawFixOnChainsItem(String key, String withdrawFixO } /** - * Fixed withdrawal fee on multiple chains. + * Fixed withdrawal fee on multiple chains * @return withdrawFixOnChains **/ @javax.annotation.Nullable @@ -318,7 +318,7 @@ public WithdrawStatus putWithdrawPercentOnChainsItem(String key, String withdraw } /** - * Percentage withdrawal fee on multiple chains. + * Percentage withdrawal fee on multiple chains * @return withdrawPercentOnChains **/ @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 bc5c87e..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 - * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. + * Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private 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 class WithdrawalRecord { /** - * Record ID. + * Record ID * @return id **/ @javax.annotation.Nullable @@ -91,7 +91,7 @@ public String getId() { /** - * Hash record of the withdrawal. + * Hash record of the withdrawal * @return txid **/ @javax.annotation.Nullable @@ -101,7 +101,7 @@ public String getTxid() { /** - * Block Number. + * Block Number * @return blockNumber **/ @javax.annotation.Nullable @@ -131,7 +131,7 @@ public void setWithdrawOrderId(String withdrawOrderId) { } /** - * Operation time. + * Operation time * @return timestamp **/ @javax.annotation.Nullable @@ -147,7 +147,7 @@ public WithdrawalRecord amount(String amount) { } /** - * Currency amount. + * Token amount * @return amount **/ public String getAmount() { @@ -160,7 +160,7 @@ public void setAmount(String amount) { } /** - * fee. + * fee * @return fee **/ @javax.annotation.Nullable @@ -176,7 +176,7 @@ public WithdrawalRecord currency(String currency) { } /** - * Currency name. + * Currency name * @return currency **/ public String getCurrency() { @@ -195,7 +195,7 @@ public WithdrawalRecord address(String address) { } /** - * Withdrawal address. + * Withdrawal address * @return address **/ @javax.annotation.Nullable @@ -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 + * 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 @@ -255,7 +255,7 @@ public WithdrawalRecord memo(String memo) { } /** - * Additional remarks with regards to the withdrawal. + * Additional remarks with regards to the withdrawal * @return memo **/ @javax.annotation.Nullable @@ -285,7 +285,7 @@ public WithdrawalRecord chain(String chain) { } /** - * Name of the chain used in withdrawals. + * Name of the chain used in withdrawals * @return chain **/ public String getChain() { From 08e9a1f6d8a772383e19578b174de1bba5cc5640 Mon Sep 17 00:00:00 2001 From: gateio Date: Thu, 11 Sep 2025 06:24:27 +0000 Subject: [PATCH 13/14] update to v7.1.7 --- README.md | 12 +- build.gradle | 2 +- build.sbt | 2 +- docs/Contract.md | 4 +- docs/ContractStat.md | 1 + docs/DeliveryApi.md | 22 +-- docs/EarnApi.md | 6 +- docs/FindCoin.md | 3 +- docs/FuturesAccount.md | 1 + docs/FuturesAccountBook.md | 2 +- docs/FuturesApi.md | 35 +++-- docs/FuturesOrder.md | 3 + docs/FuturesOrderAmendment.md | 1 + docs/FuturesTicker.md | 5 + docs/MultiCollateralLoanApi.md | 4 +- docs/MultiLoanRepayItem.md | 2 +- docs/Position.md | 1 + docs/RebateApi.md | 5 +- docs/SpotApi.md | 4 +- docs/SubAccount.md | 2 +- docs/SwapCoinStruct.md | 4 +- docs/UnifiedApi.md | 4 +- pom.xml | 2 +- src/main/java/io/gate/gateapi/ApiClient.java | 2 +- .../java/io/gate/gateapi/api/DeliveryApi.java | 12 +- .../java/io/gate/gateapi/api/EarnApi.java | 16 +-- .../java/io/gate/gateapi/api/FuturesApi.java | 113 ++++++++++----- .../gateapi/api/MultiCollateralLoanApi.java | 2 +- .../java/io/gate/gateapi/api/RebateApi.java | 37 +++-- .../java/io/gate/gateapi/api/SpotApi.java | 2 +- .../java/io/gate/gateapi/api/UnifiedApi.java | 6 +- .../java/io/gate/gateapi/models/Contract.java | 58 +++++++- .../io/gate/gateapi/models/ContractStat.java | 30 +++- .../java/io/gate/gateapi/models/FindCoin.java | 32 +---- .../gate/gateapi/models/FuturesAccount.java | 28 +++- .../gateapi/models/FuturesAccountBook.java | 4 +- .../io/gate/gateapi/models/FuturesOrder.java | 72 +++++++++- .../gateapi/models/FuturesOrderAmendment.java | 30 +++- .../io/gate/gateapi/models/FuturesTicker.java | 134 +++++++++++++++++- .../gateapi/models/MultiLoanRepayItem.java | 1 - .../java/io/gate/gateapi/models/Position.java | 20 ++- .../io/gate/gateapi/models/SubAccount.java | 2 +- .../gate/gateapi/models/SwapCoinStruct.java | 4 +- 43 files changed, 564 insertions(+), 168 deletions(-) diff --git a/README.md b/README.md index 9a9b4ca..f5d637a 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ Gate API -- API version: v4.104.3 -- SDK version: 6.104.3 +- API version: v4.105.7 +- SDK version: 7.1.7 Welcome to Gate API APIv4 provides operations related to spot, margin, and contract trading, including public interfaces for querying market data and authenticated private interfaces for implementing API-based automated trading. @@ -52,7 +52,7 @@ Add this dependency to your project's POM: io.gate gate-api - 6.104.3 + 7.1.7 compile ``` @@ -62,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.104.3" +compile "io.gate:gate-api:7.1.7" ``` ### Others @@ -75,7 +75,7 @@ mvn clean package Then manually install the following JARs: -* `target/gate-api-6.104.3.jar` +* `target/gate-api-7.1.7.jar` * `target/lib/*.jar` To install the API client library to your local Maven repository, simply execute: @@ -389,7 +389,7 @@ Class | Method | HTTP request | Description *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 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 discount +*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 | Maximum and minimum currency leverage that can be set diff --git a/build.gradle b/build.gradle index 1d63fbe..f99f5e1 100644 --- a/build.gradle +++ b/build.gradle @@ -3,7 +3,7 @@ apply plugin: 'eclipse' apply plugin: 'java' group = 'io.gate' -version = '6.104.3' +version = '7.1.7' buildscript { repositories { diff --git a/build.sbt b/build.sbt index 43e0e88..3f659c9 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.104.3", + version := "7.1.7", scalaVersion := "2.11.4", scalacOptions ++= Seq("-feature"), javacOptions in compile ++= Seq("-Xlint:deprecation"), diff --git a/docs/Contract.md b/docs/Contract.md index 7fc13c9..2b2b400 100644 --- a/docs/Contract.md +++ b/docs/Contract.md @@ -43,8 +43,10 @@ Name | Type | Description | Notes **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) | [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 ee844d1..8bb0eb6 100644 --- a/docs/ContractStat.md +++ b/docs/ContractStat.md @@ -18,4 +18,5 @@ Name | Type | Description | Notes **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/DeliveryApi.md b/docs/DeliveryApi.md index 6ad3bba..21bb9c4 100644 --- a/docs/DeliveryApi.md +++ b/docs/DeliveryApi.md @@ -269,7 +269,7 @@ public class Example { String settle = "usdt"; // String | Settle currency String contract = "BTC_USDT_20200814"; // String | Futures contract Integer limit = 100; // Integer | Maximum number of records returned in a single list - String lastId = "12345"; // String | 以上个列表的最后一条记录的 ID 作为下个列表的起点。 该字段不再继续支持，新的请求请使用 `from` 和 `to` 字段来限定时间范围 + 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. try { @@ -300,7 +300,7 @@ Name | Type | Description | Notes **settle** | **String**| Settle currency | [enum: usdt] **contract** | **String**| Futures contract | **limit** | **Integer**| Maximum number of records returned in a single list | [optional] [default to 100] - **lastId** | **String**| 以上个列表的最后一条记录的 ID 作为下个列表的起点。 该字段不再继续支持，新的请求请使用 `from` 和 `to` 字段来限定时间范围 | [optional] + **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] @@ -352,7 +352,7 @@ public class Example { 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 | 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 timeTime interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial timeweek, 7d time is aligned with Unix initial time + 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) @@ -383,7 +383,7 @@ Name | Type | Description | Notes **from** | **Long**| Start time of candlesticks, formatted in Unix timestamp in seconds. Default to`to - 100 * interval` if not specified | [optional] **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 timeTime interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial timeweek, 7d time is aligned with Unix initial time | [optional] [default to 5m] [enum: 10s, 30s, 1m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 7d, 1w, 30d] + **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 @@ -638,7 +638,7 @@ public class Example { 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 | Changing Type: - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: point_fee: POINT Trading fee - point_refr: POINT Referrer rebate + 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) @@ -668,7 +668,7 @@ Name | Type | Description | Notes **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**| Changing Type: - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: point_fee: POINT Trading fee - point_refr: POINT Referrer rebate | [optional] [enum: dnw, pnl, fee, refr, fund, point_dnw, point_fee, point_refr] + **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 @@ -1076,7 +1076,7 @@ public class Example { String contract = "BTC_USDT_20200814"; // String | Futures contract 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 currency name to query in batches, and support up to 100 pass parameters at a time + 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) @@ -1109,7 +1109,7 @@ Name | Type | Description | Notes **contract** | **String**| Futures contract | [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] - **lastId** | **String**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time | [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] **countTotal** | **Integer**| Whether to return total number matched, defaults to 0 (no return) | [optional] [default to 0] [enum: 0, 1] ### Return type @@ -1450,7 +1450,7 @@ public class Example { Long order = 12345L; // Long | Futures order ID, return related data only if specified 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 currency name to query in batches, and support up to 100 pass parameters at a time + 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) @@ -1484,7 +1484,7 @@ Name | Type | Description | Notes **order** | **Long**| Futures order ID, return related data only if 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] - **lastId** | **String**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time | [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] **countTotal** | **Integer**| Whether to return total number matched, defaults to 0 (no return) | [optional] [default to 0] [enum: 0, 1] ### Return type @@ -1742,7 +1742,7 @@ Name | Type | Description | Notes Query risk limit tiers -When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets.'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect empty. +When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets. 'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the contract parameter is empty. ### Example diff --git a/docs/EarnApi.md b/docs/EarnApi.md index 1e8ef0f..78e2408 100644 --- a/docs/EarnApi.md +++ b/docs/EarnApi.md @@ -583,7 +583,7 @@ null (empty response body) # **findCoin** -> List<String> findCoin(findCoin) +> Object findCoin(findCoin) Staking coins @@ -610,7 +610,7 @@ public class Example { EarnApi apiInstance = new EarnApi(defaultClient); FindCoin findCoin = new FindCoin(); // FindCoin | try { - List result = apiInstance.findCoin(findCoin); + 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())); @@ -633,7 +633,7 @@ Name | Type | Description | Notes ### Return type -**List<String>** +**Object** ### Authorization diff --git a/docs/FindCoin.md b/docs/FindCoin.md index eda7369..65b8e44 100644 --- a/docs/FindCoin.md +++ b/docs/FindCoin.md @@ -5,6 +5,5 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**coin** | **String** | Currency | [optional] -**cointype** | **String** | Token Type: swap-Voucher, lock-Locked | [optional] +**cointype** | **String** | Currency type: swap - voucher; lock - locked position; debt - US Treasury bond. | [optional] diff --git a/docs/FuturesAccount.md b/docs/FuturesAccount.md index 1910590..0ff4e6d 100644 --- a/docs/FuturesAccount.md +++ b/docs/FuturesAccount.md @@ -13,6 +13,7 @@ Name | Type | Description | Notes **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 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] diff --git a/docs/FuturesAccountBook.md b/docs/FuturesAccountBook.md index 67adf40..46191b9 100644 --- a/docs/FuturesAccountBook.md +++ b/docs/FuturesAccountBook.md @@ -8,7 +8,7 @@ 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_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] **tradeId** | **String** | trade id | [optional] diff --git a/docs/FuturesApi.md b/docs/FuturesApi.md index 8f55a08..3495c30 100644 --- a/docs/FuturesApi.md +++ b/docs/FuturesApi.md @@ -355,7 +355,7 @@ No authorization required # **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(); Futures market K-line chart @@ -384,12 +384,14 @@ public class Example { 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) { @@ -415,6 +417,7 @@ Name | Type | Description | Notes **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 @@ -875,7 +878,7 @@ No authorization required 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 detailsThe time interval between from and to is maximum 3600. Some private fields are not returned by public interfaces, refer to field descriptions for interfaces, refer to field descriptions for details +The time interval between from and to is maximum 3600. Some private fields are not returned by public interfaces, refer to field descriptions for details ### Example @@ -954,7 +957,7 @@ No authorization required Query risk limit tiers -When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets.'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect empty. +When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets. 'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the contract parameter is empty. ### Example @@ -1127,7 +1130,7 @@ public class Example { 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 - 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_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction + 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) @@ -1161,7 +1164,7 @@ Name | Type | Description | Notes **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] - **type** | **String**| Changing Type： - dnw: Deposit & Withdraw - pnl: Profit & Loss by reducing position - fee: Trading fee - refr: Referrer rebate - fund: Funding - point_dnw: point_fee: POINT Trading fee - point_refr: POINT Referrer rebate - bonus_offset: bouns deduction | [optional] + **type** | **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 @@ -1404,7 +1407,7 @@ Name | Type | Description | Notes # **updatePositionLeverage** -> Position updatePositionLeverage(settle, contract, leverage, crossLeverageLimit) +> Position updatePositionLeverage(settle, contract, leverage, crossLeverageLimit, pid) Update position leverage @@ -1433,8 +1436,9 @@ public class Example { 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) + 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())); @@ -1457,6 +1461,7 @@ Name | Type | Description | Notes **contract** | **String**| Futures contract | **leverage** | **String**| New position leverage | **crossLeverageLimit** | **String**| Cross margin leverage (valid only when `leverage` is 0) | [optional] + **pid** | **Integer**| Product ID | [optional] ### Return type @@ -2085,7 +2090,7 @@ public class Example { String contract = "BTC_USDT"; // String | Futures contract, return related data only if specified 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 currency name to query in batches, and support up to 100 pass parameters at a time + 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) @@ -2116,7 +2121,7 @@ Name | Type | Description | Notes **contract** | **String**| Futures contract, return related data only if 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] - **lastId** | **String**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time | [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 @@ -2212,7 +2217,7 @@ Name | Type | Description | Notes # **cancelFuturesOrders** -> List<FuturesOrder> cancelFuturesOrders(settle, contract, xGateExptime, side) +> List<FuturesOrder> cancelFuturesOrders(settle, contract, xGateExptime, side, excludeReduceOnly, text) Cancel all orders with 'open' status @@ -2242,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, both are included if not specified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell orders + 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())); @@ -2266,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, both are included if not specified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell orders | [optional] + **side** | **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 diff --git a/docs/FuturesOrder.md b/docs/FuturesOrder.md index 6299959..7c451b2 100644 --- a/docs/FuturesOrder.md +++ b/docs/FuturesOrder.md @@ -10,6 +10,7 @@ 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 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] @@ -33,6 +34,8 @@ Name | Type | Description | Notes **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 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] +**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 12bc512..8fb2998 100644 --- a/docs/FuturesOrderAmendment.md +++ b/docs/FuturesOrderAmendment.md @@ -8,4 +8,5 @@ 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 order amendment | [optional] +**text** | **String** | Internal users can modify information in the text field. | [optional] diff --git a/docs/FuturesTicker.md b/docs/FuturesTicker.md index 4ee1b26..0a0bab6 100644 --- a/docs/FuturesTicker.md +++ b/docs/FuturesTicker.md @@ -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/MultiCollateralLoanApi.md b/docs/MultiCollateralLoanApi.md index 46a4d93..7724c39 100644 --- a/docs/MultiCollateralLoanApi.md +++ b/docs/MultiCollateralLoanApi.md @@ -48,7 +48,7 @@ public class Example { Integer page = 1; // Integer | Page number 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 specifiedOrder type: current - Query current orders, fixed - Query fixed orders, defaults to current orders if not specified + 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) @@ -77,7 +77,7 @@ Name | Type | Description | Notes **page** | **Integer**| Page number | [optional] [default to 1] **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 specifiedOrder type: current - Query current orders, fixed - Query fixed orders, defaults to current orders if not specified | [optional] + **orderType** | **String**| Order type: current - Query current orders, fixed - Query fixed orders, defaults to current orders if not specified | [optional] ### Return type diff --git a/docs/MultiLoanRepayItem.md b/docs/MultiLoanRepayItem.md index e0268aa..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/Position.md b/docs/Position.md index aa08162..eb133ef 100644 --- a/docs/Position.md +++ b/docs/Position.md @@ -40,6 +40,7 @@ Name | Type | Description | Notes **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/RebateApi.md b/docs/RebateApi.md index fc55277..333e137 100644 --- a/docs/RebateApi.md +++ b/docs/RebateApi.md @@ -104,7 +104,7 @@ Name | Type | Description | Notes # **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(); Broker obtains rebate history of recommended users @@ -132,6 +132,7 @@ public class Example { RebateApi apiInstance = new RebateApi(defaultClient); 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 | 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 @@ -140,6 +141,7 @@ public class Example { try { List result = apiInstance.agencyCommissionsHistory() .currency(currency) + .commissionType(commissionType) .userId(userId) .from(from) .to(to) @@ -165,6 +167,7 @@ public class Example { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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**| 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] diff --git a/docs/SpotApi.md b/docs/SpotApi.md index 36bef7a..a77f802 100644 --- a/docs/SpotApi.md +++ b/docs/SpotApi.md @@ -462,7 +462,7 @@ public class Example { SpotApi apiInstance = new SpotApi(defaultClient); String currencyPair = "BTC_USDT"; // String | Currency pair Integer limit = 100; // Integer | Maximum number of items returned in list. Default: 100, minimum: 1, maximum: 1000 - String lastId = "12345"; // String | Specify the currency name to query in batches, and support up to 100 pass parameters at a time + 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 @@ -496,7 +496,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **currencyPair** | **String**| Currency pair | **limit** | **Integer**| Maximum number of items returned in list. Default: 100, minimum: 1, maximum: 1000 | [optional] [default to 100] - **lastId** | **String**| Specify the currency name to query in batches, and support up to 100 pass parameters at a time | [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] **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] diff --git a/docs/SubAccount.md b/docs/SubAccount.md index 13aee78..277844e 100644 --- a/docs/SubAccount.md +++ b/docs/SubAccount.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **remark** | **String** | Remark | [optional] -**loginName** | **String** | 子账户登陆名：仅支持字母、数字、下划线，不可包含其他非法字符。 | +**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** | Sub-account status: 1-normal, 2-locked | [optional] [readonly] diff --git a/docs/SwapCoinStruct.md b/docs/SwapCoinStruct.md index 4a942e4..2fc1966 100644 --- a/docs/SwapCoinStruct.md +++ b/docs/SwapCoinStruct.md @@ -10,11 +10,11 @@ Name | Type | Description | Notes **uid** | **Integer** | User ID | [optional] **coin** | **String** | Currency | [optional] **type** | **Integer** | Type 0-Staking 1-Redemption | [optional] -**subtype** | **String** | 子类型 | [optional] +**subtype** | **String** | SubType | [optional] **amount** | **String** | Amount | [optional] **exchangeRate** | **String** | Exchange ratio | [optional] **exchangeAmount** | **String** | Redemption Amount | [optional] -**updateStamp** | **Integer** | 更新时间戳 | [optional] +**updateStamp** | **Integer** | UpdateTimestamp | [optional] **createStamp** | **Integer** | Transaction timestamp | [optional] **status** | **Integer** | status 1-success | [optional] **protocolType** | **Integer** | DEFI Protocol Type | [optional] diff --git a/docs/UnifiedApi.md b/docs/UnifiedApi.md index 67dddd1..22186b2 100644 --- a/docs/UnifiedApi.md +++ b/docs/UnifiedApi.md @@ -17,7 +17,7 @@ Method | HTTP request | Description [**getUnifiedMode**](UnifiedApi.md#getUnifiedMode) | **GET** /unified/unified_mode | Query mode of the unified account [**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 discount +[**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 | Maximum and minimum currency leverage that can be set @@ -963,7 +963,7 @@ Name | Type | Description | Notes # **listCurrencyDiscountTiers** > List<UnifiedDiscount> listCurrencyDiscountTiers() -Query unified account tiered discount +Query unified account tiered ### Example diff --git a/pom.xml b/pom.xml index 4b747b3..61df2f4 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ gate-api jar gate-api - 6.104.3 + 7.1.7 https://github.com/gateio/gateapi-java.git Java client for gateapi diff --git a/src/main/java/io/gate/gateapi/ApiClient.java b/src/main/java/io/gate/gateapi/ApiClient.java index abb28f4..08abeb6 100644 --- a/src/main/java/io/gate/gateapi/ApiClient.java +++ b/src/main/java/io/gate/gateapi/ApiClient.java @@ -113,7 +113,7 @@ private void init() { json = new JSON(); // Set default User-Agent. - setUserAgent("OpenAPI-Generator/6.104.3/java"); + setUserAgent("OpenAPI-Generator/7.1.7/java"); authentications = new HashMap(); } diff --git a/src/main/java/io/gate/gateapi/api/DeliveryApi.java b/src/main/java/io/gate/gateapi/api/DeliveryApi.java index a331494..81d8fee 100644 --- a/src/main/java/io/gate/gateapi/api/DeliveryApi.java +++ b/src/main/java/io/gate/gateapi/api/DeliveryApi.java @@ -588,7 +588,7 @@ public APIlistDeliveryTradesRequest limit(Integer limit) { /** * Set lastId - * @param lastId 以上个列表的最后一条记录的 ID 作为下个列表的起点。 该字段不再继续支持，新的请求请使用 `from` 和 `to` 字段来限定时间范围 (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) { @@ -817,7 +817,7 @@ public APIlistDeliveryCandlesticksRequest limit(Integer limit) { /** * Set interval - * @param interval Time interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial timeTime interval between data points, note that 1w represents a natural week, 7d time is aligned with Unix initial timeweek, 7d time is aligned with Unix initial time (optional, default to 5m) + * @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) { @@ -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_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) { @@ -2259,7 +2259,7 @@ public APIlistDeliveryOrdersRequest offset(Integer offset) { /** * Set lastId - * @param lastId Specify the currency name to query in batches, and support up to 100 pass parameters at a time (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) { @@ -2969,7 +2969,7 @@ public APIgetMyDeliveryTradesRequest offset(Integer offset) { /** * Set lastId - * @param lastId Specify the currency name to query in batches, and support up to 100 pass parameters at a time (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) { @@ -3762,7 +3762,7 @@ public okhttp3.Call executeAsync(final ApiCallback> /** * Query risk limit tiers - * When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets.'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect empty. + * When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets. 'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the contract parameter is empty. * @param settle Settle currency (required) * @return APIlistDeliveryRiskLimitTiersRequest * @http.response.details diff --git a/src/main/java/io/gate/gateapi/api/EarnApi.java b/src/main/java/io/gate/gateapi/api/EarnApi.java index 4b5dbad..78ffd05 100644 --- a/src/main/java/io/gate/gateapi/api/EarnApi.java +++ b/src/main/java/io/gate/gateapi/api/EarnApi.java @@ -1224,7 +1224,7 @@ private okhttp3.Call findCoinValidateBeforeCall(FindCoin findCoin, final ApiCall * Staking coins * * @param findCoin (required) - * @return List<String> + * @return Object * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1232,8 +1232,8 @@ private okhttp3.Call findCoinValidateBeforeCall(FindCoin findCoin, final ApiCall
    200 Successfully retrieved -
    */ - public List findCoin(FindCoin findCoin) throws ApiException { - ApiResponse> localVarResp = findCoinWithHttpInfo(findCoin); + public Object findCoin(FindCoin findCoin) throws ApiException { + ApiResponse localVarResp = findCoinWithHttpInfo(findCoin); return localVarResp.getData(); } @@ -1241,7 +1241,7 @@ public List findCoin(FindCoin findCoin) throws ApiException { * Staking coins * * @param findCoin (required) - * @return ApiResponse<List<String>> + * @return ApiResponse<Object> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body * @http.response.details @@ -1249,9 +1249,9 @@ public List findCoin(FindCoin findCoin) throws ApiException {
    200 Successfully retrieved -
    */ - public ApiResponse> findCoinWithHttpInfo(FindCoin findCoin) throws ApiException { + public ApiResponse findCoinWithHttpInfo(FindCoin findCoin) throws ApiException { okhttp3.Call localVarCall = findCoinValidateBeforeCall(findCoin, null); - Type localVarReturnType = new TypeToken>(){}.getType(); + Type localVarReturnType = new TypeToken(){}.getType(); return localVarApiClient.execute(localVarCall, localVarReturnType); } @@ -1268,9 +1268,9 @@ public ApiResponse> findCoinWithHttpInfo(FindCoin findCoin) throws 200 Successfully retrieved - */ - public okhttp3.Call findCoinAsync(FindCoin findCoin, final ApiCallback> _callback) throws ApiException { + public okhttp3.Call findCoinAsync(FindCoin findCoin, final ApiCallback _callback) throws ApiException { okhttp3.Call localVarCall = findCoinValidateBeforeCall(findCoin, _callback); - Type localVarReturnType = new TypeToken>(){}.getType(); + Type localVarReturnType = new TypeToken(){}.getType(); localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } diff --git a/src/main/java/io/gate/gateapi/api/FuturesApi.java b/src/main/java/io/gate/gateapi/api/FuturesApi.java index 1f9bd01..b2d70e3 100644 --- a/src/main/java/io/gate/gateapi/api/FuturesApi.java +++ b/src/main/java/io/gate/gateapi/api/FuturesApi.java @@ -782,7 +782,7 @@ public APIlistFuturesTradesRequest listFuturesTrades(String settle, String contr 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 @@ -811,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(); @@ -833,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)"); @@ -844,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; @@ -869,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; @@ -915,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 @@ -927,7 +942,7 @@ public APIlistFuturesCandlesticksRequest interval(String interval) { */ 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); } /** @@ -941,7 +956,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { */ 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(); } @@ -956,7 +971,7 @@ public List execute() throws ApiException { */ public ApiResponse> executeWithHttpInfo() throws ApiException { - return listFuturesCandlesticksWithHttpInfo(settle, contract, from, to, limit, interval); + return listFuturesCandlesticksWithHttpInfo(settle, contract, from, to, limit, interval, timezone); } /** @@ -971,7 +986,7 @@ public ApiResponse> executeWithHttpInfo() throws ApiExc */ 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); } } @@ -2194,7 +2209,7 @@ public okhttp3.Call executeAsync(final ApiCallback> _callb /** * 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 detailsThe time interval between from and to is maximum 3600. Some private fields are not returned by public interfaces, refer to field descriptions for interfaces, refer to field descriptions for details + * The time interval between from and to is maximum 3600. Some private fields are not returned by public interfaces, refer to field descriptions for details * @param settle Settle currency (required) * @return APIlistLiquidatedOrdersRequest * @http.response.details @@ -2376,7 +2391,7 @@ public okhttp3.Call executeAsync(final ApiCallback> /** * Query risk limit tiers - * When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets.'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect empty. + * When the 'contract' parameter is not passed, the default is to query the risk limits for the top 100 markets. 'Limit' and 'offset' correspond to pagination queries at the market level, not to the length of the returned array. This only takes effect when the contract parameter is empty. * @param settle Settle currency (required) * @return APIlistFuturesRiskLimitTiersRequest * @http.response.details @@ -2641,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_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) { @@ -3189,6 +3204,7 @@ public okhttp3.Call updatePositionMarginAsync(String settle, String contract, St * @param contract Futures contract (required) * @param leverage New position leverage (required) * @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 @@ -3198,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 @@ -3216,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(); @@ -3238,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)"); @@ -3254,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; } @@ -3265,6 +3285,7 @@ private okhttp3.Call updatePositionLeverageValidateBeforeCall(String settle, Str * @param contract Futures contract (required) * @param leverage New position leverage (required) * @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 @@ -3273,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(); } @@ -3285,6 +3306,7 @@ public Position updatePositionLeverage(String settle, String contract, String le * @param contract Futures contract (required) * @param leverage New position leverage (required) * @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 @@ -3293,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); } @@ -3306,6 +3328,7 @@ public ApiResponse updatePositionLeverageWithHttpInfo(String settle, S * @param contract Futures contract (required) * @param leverage New position leverage (required) * @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 @@ -3315,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; @@ -4493,7 +4516,7 @@ public APIlistFuturesOrdersRequest offset(Integer offset) { /** * Set lastId - * @param lastId Specify the currency name to query in batches, and support up to 100 pass parameters at a time (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) { @@ -4707,7 +4730,9 @@ 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, both are included if not specified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell orders (optional) + * @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 @@ -4717,7 +4742,7 @@ public okhttp3.Call createFuturesOrderAsync(String settle, FuturesOrder futuresO 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 @@ -4734,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)); @@ -4760,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)"); @@ -4771,7 +4804,7 @@ 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; } @@ -4781,7 +4814,9 @@ private okhttp3.Call cancelFuturesOrdersValidateBeforeCall(String settle, String * @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, both are included if not specified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell orders (optional) + * @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 @@ -4790,8 +4825,8 @@ private okhttp3.Call cancelFuturesOrdersValidateBeforeCall(String settle, String 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(); } @@ -4801,7 +4836,9 @@ public List cancelFuturesOrders(String settle, String contract, St * @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, both are included if not specified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell orders (optional) + * @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 @@ -4810,8 +4847,8 @@ public List cancelFuturesOrders(String settle, String contract, St 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); } @@ -4822,7 +4859,9 @@ public ApiResponse> cancelFuturesOrdersWithHttpInfo(String se * @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, both are included if not specified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell ordersspecified. Set to bid, set to ask to cancel all sell orders (optional) + * @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 @@ -4832,8 +4871,8 @@ public ApiResponse> cancelFuturesOrdersWithHttpInfo(String se 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; diff --git a/src/main/java/io/gate/gateapi/api/MultiCollateralLoanApi.java b/src/main/java/io/gate/gateapi/api/MultiCollateralLoanApi.java index c9e4270..0dee912 100644 --- a/src/main/java/io/gate/gateapi/api/MultiCollateralLoanApi.java +++ b/src/main/java/io/gate/gateapi/api/MultiCollateralLoanApi.java @@ -166,7 +166,7 @@ public APIlistMultiCollateralOrdersRequest sort(String sort) { /** * Set orderType - * @param orderType Order type: current - Query current orders, fixed - Query fixed orders, defaults to current orders if not specifiedOrder type: current - Query current orders, fixed - Query fixed orders, defaults to current orders if not specified (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) { diff --git a/src/main/java/io/gate/gateapi/api/RebateApi.java b/src/main/java/io/gate/gateapi/api/RebateApi.java index 69eb532..a0a0246 100644 --- a/src/main/java/io/gate/gateapi/api/RebateApi.java +++ b/src/main/java/io/gate/gateapi/api/RebateApi.java @@ -273,7 +273,7 @@ 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; @@ -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) @@ -429,7 +444,7 @@ public APIagencyCommissionsHistoryRequest offset(Integer offset) { */ 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); } /** @@ -443,7 +458,7 @@ public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException { */ 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(); } @@ -458,7 +473,7 @@ public List execute() throws ApiException { */ public ApiResponse> executeWithHttpInfo() throws ApiException { - return agencyCommissionsHistoryWithHttpInfo(currency, userId, from, to, limit, offset); + return agencyCommissionsHistoryWithHttpInfo(currency, commissionType, userId, from, to, limit, offset); } /** @@ -473,7 +488,7 @@ public ApiResponse> executeWithHttpInfo() throws A */ 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); } } diff --git a/src/main/java/io/gate/gateapi/api/SpotApi.java b/src/main/java/io/gate/gateapi/api/SpotApi.java index 1b54e32..7763fa2 100644 --- a/src/main/java/io/gate/gateapi/api/SpotApi.java +++ b/src/main/java/io/gate/gateapi/api/SpotApi.java @@ -931,7 +931,7 @@ public APIlistTradesRequest limit(Integer limit) { /** * Set lastId - * @param lastId Specify the currency name to query in batches, and support up to 100 pass parameters at a time (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) { diff --git a/src/main/java/io/gate/gateapi/api/UnifiedApi.java b/src/main/java/io/gate/gateapi/api/UnifiedApi.java index 5e8d716..baf3a73 100644 --- a/src/main/java/io/gate/gateapi/api/UnifiedApi.java +++ b/src/main/java/io/gate/gateapi/api/UnifiedApi.java @@ -1828,7 +1828,7 @@ private okhttp3.Call listCurrencyDiscountTiersValidateBeforeCall(final ApiCallba } /** - * Query unified account tiered discount + * 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 @@ -1844,7 +1844,7 @@ public List listCurrencyDiscountTiers() throws ApiException { } /** - * Query unified account tiered discount + * 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 @@ -1861,7 +1861,7 @@ public ApiResponse> listCurrencyDiscountTiersWithHttpInfo( } /** - * Query unified account tiered discount (asynchronously) + * Query unified account tiered (asynchronously) * * @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/models/Contract.java b/src/main/java/io/gate/gateapi/models/Contract.java index 2750ffe..f61545c 100644 --- a/src/main/java/io/gate/gateapi/models/Contract.java +++ b/src/main/java/io/gate/gateapi/models/Contract.java @@ -269,6 +269,14 @@ public MarkTypeEnum read(final JsonReader jsonReader) throws IOException { @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) { @@ -997,7 +1005,7 @@ public Contract status(String status) { } /** - * Contract status types include: prelaunch (pre-launch), trading (active), delisting (delisting), delisted (delisted) + * Contract status types include: prelaunch (pre-launch), trading (active), delisting (delisting), delisted (delisted), circuit_breaker (circuit breaker) * @return status **/ @javax.annotation.Nullable @@ -1029,6 +1037,46 @@ public Long getLaunchTime() { 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) { @@ -1075,12 +1123,14 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.createTime, contract.createTime) && Objects.equals(this.fundingCapRatio, contract.fundingCapRatio) && Objects.equals(this.status, contract.status) && - Objects.equals(this.launchTime, contract.launchTime); + 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, status, launchTime); + 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); } @@ -1126,6 +1176,8 @@ public String toString() { 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 a35ac3d..2d948b9 100644 --- a/src/main/java/io/gate/gateapi/models/ContractStat.java +++ b/src/main/java/io/gate/gateapi/models/ContractStat.java @@ -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) { @@ -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/FindCoin.java b/src/main/java/io/gate/gateapi/models/FindCoin.java index cc6f287..829f1d4 100644 --- a/src/main/java/io/gate/gateapi/models/FindCoin.java +++ b/src/main/java/io/gate/gateapi/models/FindCoin.java @@ -23,35 +23,11 @@ * FindCoin */ public class FindCoin { - public static final String SERIALIZED_NAME_COIN = "coin"; - @SerializedName(SERIALIZED_NAME_COIN) - private String coin; - public static final String SERIALIZED_NAME_COINTYPE = "cointype"; @SerializedName(SERIALIZED_NAME_COINTYPE) private String cointype; - public FindCoin 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 FindCoin cointype(String cointype) { this.cointype = cointype; @@ -59,7 +35,7 @@ public FindCoin cointype(String cointype) { } /** - * Token Type: swap-Voucher, lock-Locked + * Currency type: swap - voucher; lock - locked position; debt - US Treasury bond. * @return cointype **/ @javax.annotation.Nullable @@ -80,13 +56,12 @@ public boolean equals(java.lang.Object o) { return false; } FindCoin findCoin = (FindCoin) o; - return Objects.equals(this.coin, findCoin.coin) && - Objects.equals(this.cointype, findCoin.cointype); + return Objects.equals(this.cointype, findCoin.cointype); } @Override public int hashCode() { - return Objects.hash(coin, cointype); + return Objects.hash(cointype); } @@ -94,7 +69,6 @@ public int hashCode() { public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class FindCoin {\n"); - sb.append(" coin: ").append(toIndentedString(coin)).append("\n"); sb.append(" cointype: ").append(toIndentedString(cointype)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/io/gate/gateapi/models/FuturesAccount.java b/src/main/java/io/gate/gateapi/models/FuturesAccount.java index 38db71e..ca7395d 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesAccount.java +++ b/src/main/java/io/gate/gateapi/models/FuturesAccount.java @@ -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; @@ -289,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; @@ -665,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) && @@ -687,7 +712,7 @@ public boolean equals(java.lang.Object o) { @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, enableTieredMm, 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); } @@ -703,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"); diff --git a/src/main/java/io/gate/gateapi/models/FuturesAccountBook.java b/src/main/java/io/gate/gateapi/models/FuturesAccountBook.java index 3121baf..bcf6332 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesAccountBook.java +++ b/src/main/java/io/gate/gateapi/models/FuturesAccountBook.java @@ -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_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_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 diff --git a/src/main/java/io/gate/gateapi/models/FuturesOrder.java b/src/main/java/io/gate/gateapi/models/FuturesOrder.java index 754ab5d..2dcef73 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesOrder.java +++ b/src/main/java/io/gate/gateapi/models/FuturesOrder.java @@ -35,6 +35,10 @@ 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; @@ -384,6 +388,14 @@ public StpActEnum read(final JsonReader jsonReader) throws IOException { @SerializedName(SERIALIZED_NAME_AMEND_TEXT) private String amendText; + 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; + /** * Futures order ID @@ -415,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 @@ -742,6 +764,46 @@ public String getAmendText() { return amendText; } + + 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; + } + + /** + * Position ID + * @return pid + **/ + @javax.annotation.Nullable + public Long getPid() { + return pid; + } + + + public void setPid(Long pid) { + this.pid = pid; + } @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -754,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) && @@ -776,12 +839,14 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.autoSize, futuresOrder.autoSize) && Objects.equals(this.stpId, futuresOrder.stpId) && Objects.equals(this.stpAct, futuresOrder.stpAct) && - Objects.equals(this.amendText, futuresOrder.amendText); + Objects.equals(this.amendText, futuresOrder.amendText) && + 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); + 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); } @@ -792,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"); @@ -815,6 +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(" 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 17b5a39..32f273c 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesOrderAmendment.java +++ b/src/main/java/io/gate/gateapi/models/FuturesOrderAmendment.java @@ -35,6 +35,10 @@ public class FuturesOrderAmendment { @SerializedName(SERIALIZED_NAME_AMEND_TEXT) private String amendText; + public static final String SERIALIZED_NAME_TEXT = "text"; + @SerializedName(SERIALIZED_NAME_TEXT) + private String text; + public FuturesOrderAmendment size(Long size) { @@ -95,6 +99,26 @@ public String getAmendText() { public void setAmendText(String amendText) { this.amendText = amendText; } + + public FuturesOrderAmendment text(String text) { + + this.text = text; + return this; + } + + /** + * Internal users can modify information in the text field. + * @return text + **/ + @javax.annotation.Nullable + public String getText() { + return text; + } + + + public void setText(String text) { + this.text = text; + } @Override public boolean equals(java.lang.Object o) { if (this == o) { @@ -106,12 +130,13 @@ public boolean equals(java.lang.Object o) { FuturesOrderAmendment futuresOrderAmendment = (FuturesOrderAmendment) o; return Objects.equals(this.size, futuresOrderAmendment.size) && Objects.equals(this.price, futuresOrderAmendment.price) && - Objects.equals(this.amendText, futuresOrderAmendment.amendText); + Objects.equals(this.amendText, futuresOrderAmendment.amendText) && + Objects.equals(this.text, futuresOrderAmendment.text); } @Override public int hashCode() { - return Objects.hash(size, price, amendText); + return Objects.hash(size, price, amendText, text); } @@ -122,6 +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(" text: ").append(toIndentedString(text)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/io/gate/gateapi/models/FuturesTicker.java b/src/main/java/io/gate/gateapi/models/FuturesTicker.java index 72ad076..b2ae960 100644 --- a/src/main/java/io/gate/gateapi/models/FuturesTicker.java +++ b/src/main/java/io/gate/gateapi/models/FuturesTicker.java @@ -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) { @@ -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/MultiLoanRepayItem.java b/src/main/java/io/gate/gateapi/models/MultiLoanRepayItem.java index 969b275..3490e27 100644 --- a/src/main/java/io/gate/gateapi/models/MultiLoanRepayItem.java +++ b/src/main/java/io/gate/gateapi/models/MultiLoanRepayItem.java @@ -86,7 +86,6 @@ public MultiLoanRepayItem repaidAll(Boolean repaidAll) { * 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/Position.java b/src/main/java/io/gate/gateapi/models/Position.java index 8dc6574..ea48a8b 100644 --- a/src/main/java/io/gate/gateapi/models/Position.java +++ b/src/main/java/io/gate/gateapi/models/Position.java @@ -205,6 +205,10 @@ public ModeEnum read(final JsonReader jsonReader) throws IOException { @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 @@ -605,6 +609,16 @@ 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) { @@ -646,12 +660,13 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.updateId, position.updateId) && Objects.equals(this.openTime, position.openTime) && Objects.equals(this.riskLimitTable, position.riskLimitTable) && - Objects.equals(this.averageMaintenanceRate, position.averageMaintenanceRate); + 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, riskLimitTable, averageMaintenanceRate); + 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); } @@ -692,6 +707,7 @@ public String toString() { 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/SubAccount.java b/src/main/java/io/gate/gateapi/models/SubAccount.java index d336c1b..29635d8 100644 --- a/src/main/java/io/gate/gateapi/models/SubAccount.java +++ b/src/main/java/io/gate/gateapi/models/SubAccount.java @@ -83,7 +83,7 @@ public SubAccount loginName(String loginName) { } /** - * 子账户登陆名：仅支持字母、数字、下划线，不可包含其他非法字符。 + * Sub-account login name: Only letters, numbers and underscores are supported, cannot contain other invalid characters * @return loginName **/ public String getLoginName() { diff --git a/src/main/java/io/gate/gateapi/models/SwapCoinStruct.java b/src/main/java/io/gate/gateapi/models/SwapCoinStruct.java index b6f6720..f15a430 100644 --- a/src/main/java/io/gate/gateapi/models/SwapCoinStruct.java +++ b/src/main/java/io/gate/gateapi/models/SwapCoinStruct.java @@ -191,7 +191,7 @@ public SwapCoinStruct subtype(String subtype) { } /** - * 子类型 + * SubType * @return subtype **/ @javax.annotation.Nullable @@ -271,7 +271,7 @@ public SwapCoinStruct updateStamp(Integer updateStamp) { } /** - * 更新时间戳 + * UpdateTimestamp * @return updateStamp **/ @javax.annotation.Nullable From dcf0c65da50dceb619f46b17482fdb0511889ebd Mon Sep 17 00:00:00 2001 From: gateio Date: Thu, 11 Sep 2025 06:48:00 +0000 Subject: [PATCH 14/14] update to v7.1.8 --- README.md | 10 +++++----- build.gradle | 2 +- build.sbt | 2 +- pom.xml | 2 +- src/main/java/io/gate/gateapi/ApiClient.java | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index f5d637a..6f1c3fc 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ Gate API -- API version: v4.105.7 -- SDK version: 7.1.7 +- 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. @@ -52,7 +52,7 @@ Add this dependency to your project's POM: io.gate gate-api - 7.1.7 + 7.1.8 compile ``` @@ -62,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:7.1.7" +compile "io.gate:gate-api:7.1.8" ``` ### Others @@ -75,7 +75,7 @@ mvn clean package Then manually install the following JARs: -* `target/gate-api-7.1.7.jar` +* `target/gate-api-7.1.8.jar` * `target/lib/*.jar` To install the API client library to your local Maven repository, simply execute: diff --git a/build.gradle b/build.gradle index f99f5e1..06a0965 100644 --- a/build.gradle +++ b/build.gradle @@ -3,7 +3,7 @@ apply plugin: 'eclipse' apply plugin: 'java' group = 'io.gate' -version = '7.1.7' +version = '7.1.8' buildscript { repositories { diff --git a/build.sbt b/build.sbt index 3f659c9..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 := "7.1.7", + version := "7.1.8", scalaVersion := "2.11.4", scalacOptions ++= Seq("-feature"), javacOptions in compile ++= Seq("-Xlint:deprecation"), diff --git a/pom.xml b/pom.xml index 61df2f4..66fdb7c 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ gate-api jar gate-api - 7.1.7 + 7.1.8 https://github.com/gateio/gateapi-java.git Java client for gateapi diff --git a/src/main/java/io/gate/gateapi/ApiClient.java b/src/main/java/io/gate/gateapi/ApiClient.java index 08abeb6..177103f 100644 --- a/src/main/java/io/gate/gateapi/ApiClient.java +++ b/src/main/java/io/gate/gateapi/ApiClient.java @@ -113,7 +113,7 @@ private void init() { json = new JSON(); // Set default User-Agent. - setUserAgent("OpenAPI-Generator/7.1.7/java"); + setUserAgent("OpenAPI-Generator/7.1.8/java"); authentications = new HashMap(); }