Skip to content

Commit baf92ca

Browse files
committed
support total balance API
1 parent 98e2e69 commit baf92ca

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+1066
-498
lines changed

README.md

+17-10
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## gate-api@5.21.6
1+
## gate-api@5.22.1
22

33
TypeScript NodeJS client for gate-api.
44

@@ -8,7 +8,7 @@ APIv4 provides spot, margin and futures trading operations. There are public API
88

99
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
1010

11-
- API version: 4.21.6
11+
- API version: 4.22.1
1212
- Package version:
1313
- Build package: org.openapitools.codegen.languages.TypeScriptNodeClientCodegen
1414
For more information, please visit [https://www.gate.io/page/contacts](https://www.gate.io/page/contacts)
@@ -66,7 +66,7 @@ const client = new GateApi.ApiClient();
6666
// client.basePath = "https://some-other-host"
6767

6868
const api = new GateApi.DeliveryApi(client);
69-
const settle = "usdt"; // 'usdt' | Settle currency
69+
const settle = "usdt"; // 'btc' | 'usdt' | Settle currency
7070
api.listDeliveryContracts(settle)
7171
.then(value => console.log('API called successfully. Returned data: ', value.body),
7272
error => console.error(error));
@@ -155,12 +155,13 @@ Class | Method | HTTP request | Description
155155
*MarginApi* | [**updateLoan**](docs/MarginApi.md#updateLoan) | **PATCH** /margin/loans/{loan_id} | Modify a loan
156156
*MarginApi* | [**listLoanRepayments**](docs/MarginApi.md#listLoanRepayments) | **GET** /margin/loans/{loan_id}/repayment | List loan repayment records
157157
*MarginApi* | [**repayLoan**](docs/MarginApi.md#repayLoan) | **POST** /margin/loans/{loan_id}/repayment | Repay a loan
158-
*MarginApi* | [**listLoanRecords**](docs/MarginApi.md#listLoanRecords) | **GET** /margin/loan_records | List repayment records of specified loan
158+
*MarginApi* | [**listLoanRecords**](docs/MarginApi.md#listLoanRecords) | **GET** /margin/loan_records | List repayment records of a specific loan
159159
*MarginApi* | [**getLoanRecord**](docs/MarginApi.md#getLoanRecord) | **GET** /margin/loan_records/{loan_record_id} | Get one single loan record
160160
*MarginApi* | [**updateLoanRecord**](docs/MarginApi.md#updateLoanRecord) | **PATCH** /margin/loan_records/{loan_record_id} | Modify a loan record
161161
*MarginApi* | [**getAutoRepayStatus**](docs/MarginApi.md#getAutoRepayStatus) | **GET** /margin/auto_repay | Retrieve user auto repayment setting
162162
*MarginApi* | [**setAutoRepay**](docs/MarginApi.md#setAutoRepay) | **POST** /margin/auto_repay | Update user\'s auto repayment setting
163-
*MarginApi* | [**getMarginTransferable**](docs/MarginApi.md#getMarginTransferable) | **GET** /margin/transferable | Max transferable amount for specified margin currency
163+
*MarginApi* | [**getMarginTransferable**](docs/MarginApi.md#getMarginTransferable) | **GET** /margin/transferable | Get the max transferable amount for a specific margin currency
164+
*MarginApi* | [**getMarginBorrowable**](docs/MarginApi.md#getMarginBorrowable) | **GET** /margin/borrowable | Get the max borrowable amount for a specific margin currency
164165
*MarginApi* | [**listCrossMarginCurrencies**](docs/MarginApi.md#listCrossMarginCurrencies) | **GET** /margin/cross/currencies | Currencies supported by cross margin.
165166
*MarginApi* | [**getCrossMarginCurrency**](docs/MarginApi.md#getCrossMarginCurrency) | **GET** /margin/cross/currencies/{currency} | Retrieve detail of one single currency supported by cross margin
166167
*MarginApi* | [**getCrossMarginAccount**](docs/MarginApi.md#getCrossMarginAccount) | **GET** /margin/cross/accounts | Retrieve cross margin account
@@ -170,11 +171,12 @@ Class | Method | HTTP request | Description
170171
*MarginApi* | [**getCrossMarginLoan**](docs/MarginApi.md#getCrossMarginLoan) | **GET** /margin/cross/loans/{loan_id} | Retrieve single borrow loan detail
171172
*MarginApi* | [**listCrossMarginRepayments**](docs/MarginApi.md#listCrossMarginRepayments) | **GET** /margin/cross/repayments | Retrieve cross margin repayments
172173
*MarginApi* | [**repayCrossMarginLoan**](docs/MarginApi.md#repayCrossMarginLoan) | **POST** /margin/cross/repayments | Repay cross margin loan
173-
*MarginApi* | [**getCrossMarginTransferable**](docs/MarginApi.md#getCrossMarginTransferable) | **GET** /margin/cross/transferable | Max transferable amount for specified cross margin currency
174-
*SpotApi* | [**listCurrencies**](docs/SpotApi.md#listCurrencies) | **GET** /spot/currencies | List all currencies\' detail
175-
*SpotApi* | [**getCurrency**](docs/SpotApi.md#getCurrency) | **GET** /spot/currencies/{currency} | Get detail of one particular currency
174+
*MarginApi* | [**getCrossMarginTransferable**](docs/MarginApi.md#getCrossMarginTransferable) | **GET** /margin/cross/transferable | Get the max transferable amount for a specific cross margin currency
175+
*MarginApi* | [**getCrossMarginBorrowable**](docs/MarginApi.md#getCrossMarginBorrowable) | **GET** /margin/cross/borrowable | Get the max borrowable amount for a specific cross margin currency
176+
*SpotApi* | [**listCurrencies**](docs/SpotApi.md#listCurrencies) | **GET** /spot/currencies | List all currencies\' details
177+
*SpotApi* | [**getCurrency**](docs/SpotApi.md#getCurrency) | **GET** /spot/currencies/{currency} | Get details of a specific currency
176178
*SpotApi* | [**listCurrencyPairs**](docs/SpotApi.md#listCurrencyPairs) | **GET** /spot/currency_pairs | List all currency pairs supported
177-
*SpotApi* | [**getCurrencyPair**](docs/SpotApi.md#getCurrencyPair) | **GET** /spot/currency_pairs/{currency_pair} | Get detail of one single order
179+
*SpotApi* | [**getCurrencyPair**](docs/SpotApi.md#getCurrencyPair) | **GET** /spot/currency_pairs/{currency_pair} | Get details of a specifc order
178180
*SpotApi* | [**listTickers**](docs/SpotApi.md#listTickers) | **GET** /spot/tickers | Retrieve ticker information
179181
*SpotApi* | [**listOrderBook**](docs/SpotApi.md#listOrderBook) | **GET** /spot/order_book | Retrieve order book
180182
*SpotApi* | [**listTrades**](docs/SpotApi.md#listTrades) | **GET** /spot/trades | Retrieve market trades
@@ -199,17 +201,19 @@ Class | Method | HTTP request | Description
199201
*WalletApi* | [**listWithdrawals**](docs/WalletApi.md#listWithdrawals) | **GET** /wallet/withdrawals | Retrieve withdrawal records
200202
*WalletApi* | [**listDeposits**](docs/WalletApi.md#listDeposits) | **GET** /wallet/deposits | Retrieve deposit records
201203
*WalletApi* | [**transfer**](docs/WalletApi.md#transfer) | **POST** /wallet/transfers | Transfer between trading accounts
202-
*WalletApi* | [**listSubAccountTransfers**](docs/WalletApi.md#listSubAccountTransfers) | **GET** /wallet/sub_account_transfers | Transfer records between main and sub accounts
204+
*WalletApi* | [**listSubAccountTransfers**](docs/WalletApi.md#listSubAccountTransfers) | **GET** /wallet/sub_account_transfers | Retrieve transfer records between main and sub accounts
203205
*WalletApi* | [**transferWithSubAccount**](docs/WalletApi.md#transferWithSubAccount) | **POST** /wallet/sub_account_transfers | Transfer between main and sub accounts
204206
*WalletApi* | [**listWithdrawStatus**](docs/WalletApi.md#listWithdrawStatus) | **GET** /wallet/withdraw_status | Retrieve withdrawal status
205207
*WalletApi* | [**listSubAccountBalances**](docs/WalletApi.md#listSubAccountBalances) | **GET** /wallet/sub_account_balances | Retrieve sub account balances
206208
*WalletApi* | [**getTradeFee**](docs/WalletApi.md#getTradeFee) | **GET** /wallet/fee | Retrieve personal trading fee
209+
*WalletApi* | [**getTotalBalance**](docs/WalletApi.md#getTotalBalance) | **GET** /wallet/total_balance | Retrieve user\'s total balances
207210
*WithdrawalApi* | [**withdraw**](docs/WithdrawalApi.md#withdraw) | **POST** /withdrawals | Withdraw
208211
*WithdrawalApi* | [**cancelWithdrawal**](docs/WithdrawalApi.md#cancelWithdrawal) | **DELETE** /withdrawals/{withdrawal_id} | Cancel withdrawal with specified ID
209212

210213

211214
## Documentation for Models
212215

216+
- [AccountBalance](docs/AccountBalance.md)
213217
- [AutoRepaySetting](docs/AutoRepaySetting.md)
214218
- [BatchOrder](docs/BatchOrder.md)
215219
- [CancelOrder](docs/CancelOrder.md)
@@ -219,6 +223,7 @@ Class | Method | HTTP request | Description
219223
- [CrossMarginAccount](docs/CrossMarginAccount.md)
220224
- [CrossMarginAccountBook](docs/CrossMarginAccountBook.md)
221225
- [CrossMarginBalance](docs/CrossMarginBalance.md)
226+
- [CrossMarginBorrowable](docs/CrossMarginBorrowable.md)
222227
- [CrossMarginCurrency](docs/CrossMarginCurrency.md)
223228
- [CrossMarginLoan](docs/CrossMarginLoan.md)
224229
- [CrossMarginRepayRequest](docs/CrossMarginRepayRequest.md)
@@ -252,6 +257,7 @@ Class | Method | HTTP request | Description
252257
- [MarginAccount](docs/MarginAccount.md)
253258
- [MarginAccountBook](docs/MarginAccountBook.md)
254259
- [MarginAccountCurrency](docs/MarginAccountCurrency.md)
260+
- [MarginBorrowable](docs/MarginBorrowable.md)
255261
- [MarginCurrencyPair](docs/MarginCurrencyPair.md)
256262
- [MarginTransferable](docs/MarginTransferable.md)
257263
- [MultiChainAddressItem](docs/MultiChainAddressItem.md)
@@ -271,6 +277,7 @@ Class | Method | HTTP request | Description
271277
- [SubAccountBalance](docs/SubAccountBalance.md)
272278
- [SubAccountTransfer](docs/SubAccountTransfer.md)
273279
- [Ticker](docs/Ticker.md)
280+
- [TotalBalance](docs/TotalBalance.md)
274281
- [Trade](docs/Trade.md)
275282
- [TradeFee](docs/TradeFee.md)
276283
- [Transfer](docs/Transfer.md)

0 commit comments

Comments
 (0)