You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+19-20
Original file line number
Diff line number
Diff line change
@@ -7,8 +7,8 @@ APIv4 provides spot, margin and futures trading operations. There are public API
7
7
## Overview
8
8
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.
*MarginApi* | [**GetMarginTransferable**](docs/MarginApi.md#getmargintransferable) | **Get** /margin/transferable | Get the max transferable amount for a specific margin currency
*MarginApi* | [**GetCrossMarginCurrency**](docs/MarginApi.md#getcrossmargincurrency) | **Get** /margin/cross/currencies/{currency} | Retrieve detail of one single currency supported by cross margin
*MarginApi* | [**GetCrossMarginInterestRecords**](docs/MarginApi.md#getcrossmargininterestrecords) | **Get** /margin/cross/interest_records | Interest records for the cross margin account
228
-
*MarginApi* | [**GetCrossMarginTransferable**](docs/MarginApi.md#getcrossmargintransferable) | **Get** /margin/cross/transferable | Get the max transferable amount for a specific cross margin currency
*MarginApi* | [**GetCrossMarginBorrowable**](docs/MarginApi.md#getcrossmarginborrowable) | **Get** /margin/cross/borrowable | Get the max borrowable amount for a specific cross margin currency
*MarginApi* | [**GetCrossMarginCurrency**](docs/MarginApi.md#getcrossmargincurrency) | **Get** /margin/cross/currencies/{currency} | Retrieve detail of one single currency supported by cross margin. (deprecated)
*MarginApi* | [**GetCrossMarginInterestRecords**](docs/MarginApi.md#getcrossmargininterestrecords) | **Get** /margin/cross/interest_records | Interest records for the cross margin account. (deprecated)
228
+
*MarginApi* | [**GetCrossMarginTransferable**](docs/MarginApi.md#getcrossmargintransferable) | **Get** /margin/cross/transferable | Get the max transferable amount for a specific cross margin currency. (deprecated)
*MarginApi* | [**GetCrossMarginBorrowable**](docs/MarginApi.md#getcrossmarginborrowable) | **Get** /margin/cross/borrowable | Get the max borrowable amount for a specific cross margin currency. (deprecated)
231
231
*MarginUniApi* | [**ListUniCurrencyPairs**](docs/MarginUniApi.md#listunicurrencypairs) | **Get** /margin/uni/currency_pairs | List lending markets
232
232
*MarginUniApi* | [**GetUniCurrencyPair**](docs/MarginUniApi.md#getunicurrencypair) | **Get** /margin/uni/currency_pairs/{currency_pair} | Get detail of lending market
*UnifiedApi* | [**CreateUnifiedLoan**](docs/UnifiedApi.md#createunifiedloan) | **Post** /unified/loans | Borrow or repay
336
336
*UnifiedApi* | [**ListUnifiedLoanRecords**](docs/UnifiedApi.md#listunifiedloanrecords) | **Get** /unified/loan_records | Get load records
337
337
*UnifiedApi* | [**ListUnifiedLoanInterestRecords**](docs/UnifiedApi.md#listunifiedloaninterestrecords) | **Get** /unified/interest_records | List interest records
338
-
*UnifiedApi* | [**GetUnifiedRiskUnits**](docs/UnifiedApi.md#getunifiedriskunits) | **Get** /unified/risk_units | Retrieve user risk unit details, only valid in portfolio margin mode
338
+
*UnifiedApi* | [**GetUnifiedRiskUnits**](docs/UnifiedApi.md#getunifiedriskunits) | **Get** /unified/risk_units | Get user risk unit details
339
339
*UnifiedApi* | [**GetUnifiedMode**](docs/UnifiedApi.md#getunifiedmode) | **Get** /unified/unified_mode | Query mode of the unified account
340
340
*UnifiedApi* | [**SetUnifiedMode**](docs/UnifiedApi.md#setunifiedmode) | **Put** /unified/unified_mode | Set mode of the unified account
*UnifiedApi* | [**GetUserLeverageCurrencyConfig**](docs/UnifiedApi.md#getuserleveragecurrencyconfig) | **Get** /unified/leverage/user_currency_config | Minimum currency leverage that can be set
346
-
*UnifiedApi* | [**GetUserLeverageCurrencySetting**](docs/UnifiedApi.md#getuserleveragecurrencysetting) | **Get** /unified/leverage/user_currency_setting | Get the user's currency leverage. If currency is not passed, query all currencies.
346
+
*UnifiedApi* | [**GetUserLeverageCurrencySetting**](docs/UnifiedApi.md#getuserleveragecurrencysetting) | **Get** /unified/leverage/user_currency_setting | Get the leverage multiple of the user currency
347
347
*UnifiedApi* | [**SetUserLeverageCurrencySetting**](docs/UnifiedApi.md#setuserleveragecurrencysetting) | **Post** /unified/leverage/user_currency_setting | Set the loan currency leverage
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
819
819
820
820
@return CrossMarginAccount
@@ -914,7 +914,7 @@ type ListCrossMarginAccountBookOpts struct {
914
914
}
915
915
916
916
/*
917
-
ListCrossMarginAccountBook Retrieve cross margin account change history
917
+
ListCrossMarginAccountBook Retrieve cross margin account change history. (deprecated)
918
918
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.
919
919
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
920
920
- @param optional nil or *ListCrossMarginAccountBookOpts - Optional Parameters:
@@ -1038,7 +1038,7 @@ type ListCrossMarginLoansOpts struct {
1038
1038
}
1039
1039
1040
1040
/*
1041
-
ListCrossMarginLoans List cross margin borrow history
1041
+
ListCrossMarginLoans List cross margin borrow history. (deprecated)
1042
1042
Sort by creation time in descending order by default. Set `reverse=false` to return ascending results.
1043
1043
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
1044
1044
- @param status Filter by status. Supported values are 2 and 3. (deprecated.)
@@ -1148,7 +1148,7 @@ func (a *MarginApiService) ListCrossMarginLoans(ctx context.Context, status int3
1148
1148
}
1149
1149
1150
1150
/*
1151
-
CreateCrossMarginLoan Create a cross margin borrow loan
1151
+
CreateCrossMarginLoan Create a cross margin borrow loan. (deprecated)
1152
1152
Borrow amount cannot be less than currency minimum borrow amount
1153
1153
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
1154
1154
- @param crossMarginLoan
@@ -1242,7 +1242,7 @@ func (a *MarginApiService) CreateCrossMarginLoan(ctx context.Context, crossMargi
1242
1242
}
1243
1243
1244
1244
/*
1245
-
GetCrossMarginLoan Retrieve single borrow loan detail
1245
+
GetCrossMarginLoan Retrieve single borrow loan detail. (deprecated)
1246
1246
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
1247
1247
- @param loanId Borrow loan ID
1248
1248
@@ -1344,7 +1344,7 @@ type ListCrossMarginRepaymentsOpts struct {
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
1461
1461
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
1462
1462
- @param crossMarginRepayRequest
@@ -1559,7 +1559,7 @@ type GetCrossMarginInterestRecordsOpts struct {
1559
1559
}
1560
1560
1561
1561
/*
1562
-
GetCrossMarginInterestRecords Interest records for the cross margin account
1562
+
GetCrossMarginInterestRecords Interest records for the cross margin account. (deprecated)
1563
1563
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
1564
1564
- @param optional nil or *GetCrossMarginInterestRecordsOpts - Optional Parameters:
1565
1565
- @param "Currency" (optional.String) - Retrieve data of the specified currency
@@ -1670,7 +1670,7 @@ func (a *MarginApiService) GetCrossMarginInterestRecords(ctx context.Context, lo
1670
1670
}
1671
1671
1672
1672
/*
1673
-
GetCrossMarginTransferable Get the max transferable amount for a specific cross margin currency
1673
+
GetCrossMarginTransferable Get the max transferable amount for a specific cross margin currency. (deprecated)
1674
1674
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
1675
1675
- @param currency Retrieve data of the specified currency
1676
1676
@@ -1762,7 +1762,7 @@ func (a *MarginApiService) GetCrossMarginTransferable(ctx context.Context, curre
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.
1767
1767
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
1768
1768
- @param currencies An array of up to 10 specifying the currency name
@@ -1871,7 +1871,7 @@ func (a *MarginApiService) GetCrossMarginEstimateRate(ctx context.Context, curre
1871
1871
}
1872
1872
1873
1873
/*
1874
-
GetCrossMarginBorrowable Get the max borrowable amount for a specific cross margin currency
1874
+
GetCrossMarginBorrowable Get the max borrowable amount for a specific cross margin currency. (deprecated)
1875
1875
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
1876
1876
- @param currency Retrieve data of the specified currency
0 commit comments