Merge pull request #381 from JJ-Cro/Update151024

feat(): added Crypto Loan endpoints

README.md

@@ -42,6 +42,7 @@ Node.js & JavaScript SDK for the Bybit REST APIs and WebSockets:
 
 - Issues? Check the [issues tab](https://github.com/tiagosiebler/bybit-api/issues).
 - Discuss & collaborate with other node devs? Join our [Node.js Algo Traders](https://t.me/nodetraders) engineering community on telegram.
+- Follow our announcement channel for real-time updates on [X/Twitter](https://x.com/QuantSDKs)
 
 <!-- template_related_projects -->
 

docs/endpointFunctionList.md

@@ -182,6 +182,17 @@ This table includes all endpoints from the official Exchange API docs and corres
 | `getSpotMarginBorrowOrderDetail()` | :closed_lock_with_key:  | GET | `/v5/spot-cross-margin-trade/orders` |
 | `getSpotMarginRepaymentOrderDetail()` | :closed_lock_with_key:  | GET | `/v5/spot-cross-margin-trade/repay-history` |
 | `toggleSpotCrossMarginTrade()` | :closed_lock_with_key:  | POST | `/v5/spot-cross-margin-trade/switch` |
+| `getCollateralCoins()` |  | GET | `/v5/crypto-loan/collateral-data` |
+| `getBorrowableCoins()` |  | GET | `/v5/crypto-loan/loanable-data` |
+| `getAccountBorrowCollateralLimit()` | :closed_lock_with_key:  | GET | `/v5/crypto-loan/borrowable-collateralisable-number` |
+| `borrowCryptoLoan()` | :closed_lock_with_key:  | POST | `/v5/crypto-loan/borrow` |
+| `repayCryptoLoan()` | :closed_lock_with_key:  | POST | `/v5/crypto-loan/repay` |
+| `getUnpaidLoanOrders()` | :closed_lock_with_key:  | GET | `/v5/crypto-loan/ongoing-orders` |
+| `getRepaymentHistory()` | :closed_lock_with_key:  | GET | `/v5/crypto-loan/repayment-history` |
+| `getCompletedLoanOrderHistory()` | :closed_lock_with_key:  | GET | `/v5/crypto-loan/borrow-history` |
+| `getMaxAllowedReductionCollateralAmount()` | :closed_lock_with_key:  | GET | `/v5/crypto-loan/max-collateral-amount` |
+| `adjustCollateralAmount()` | :closed_lock_with_key:  | POST | `/v5/crypto-loan/adjust-ltv` |
+| `getLoanLTVAdjustmentHistory()` | :closed_lock_with_key:  | GET | `/v5/crypto-loan/adjustment-history` |
 | `getInstitutionalLendingProductInfo()` |  | GET | `/v5/ins-loan/product-infos` |
 | `getInstitutionalLendingMarginCoinInfo()` |  | GET | `/v5/ins-loan/ensure-tokens` |
 | `getInstitutionalLendingMarginCoinInfoWithConversionRate()` |  | GET | `/v5/ins-loan/ensure-tokens-convert` |
@@ -192,4 +203,7 @@ This table includes all endpoints from the official Exchange API docs and corres
 | `bindOrUnbindUID()` | :closed_lock_with_key:  | POST | `/v5/ins-loan/association-uid` |
 | `getExchangeBrokerEarnings()` | :closed_lock_with_key:  | GET | `/v5/broker/earnings-info` |
 | `getExchangeBrokerAccountInfo()` | :closed_lock_with_key:  | GET | `/v5/broker/account-info` |
-| `getBrokerSubAccountDeposits()` | :closed_lock_with_key:  | GET | `/v5/broker/asset/query-sub-member-deposit-record` |
+| `getBrokerSubAccountDeposits()` | :closed_lock_with_key:  | GET | `/v5/broker/asset/query-sub-member-deposit-record` |
+| `getBrokerVoucherSpec()` | :closed_lock_with_key:  | POST | `/v5/broker/award/info` |
+| `issueBrokerVoucher()` | :closed_lock_with_key:  | POST | `/v5/broker/award/distribute-award` |
+| `getBrokerIssuedVoucher()` | :closed_lock_with_key:  | POST | `/v5/broker/award/distribution-record` |

examples/apidoc/V5/Crypto-Loan/adjust-collateral-amount.js

@@ -0,0 +1,20 @@
+const { RestClientV5 } = require('bybit-api');
+
+const client = new RestClientV5({
+  testnet: true,
+  key: 'apikey',
+  secret: 'apisecret',
+});
+
+client
+  .adjustCollateralAmount({
+    orderId: '1794267532472646144',
+    amount: '0.001',
+    direction: '1',
+  })
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/V5/Crypto-Loan/borrow.js

@@ -0,0 +1,22 @@
+const { RestClientV5 } = require('bybit-api');
+
+const client = new RestClientV5({
+  testnet: true,
+  key: 'apikey',
+  secret: 'apisecret',
+});
+
+client
+  .borrowCryptoLoan({
+    loanCurrency: 'USDT',
+    loanAmount: '550',
+    collateralCurrency: 'BTC',
+    loanTerm: null,
+    collateralAmount: null,
+  })
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/V5/Crypto-Loan/get-account-borrow-collateral-limit.js

@@ -0,0 +1,19 @@
+const { RestClientV5 } = require('bybit-api');
+
+const client = new RestClientV5({
+  testnet: true,
+  key: 'apikey',
+  secret: 'apisecret',
+});
+
+client
+  .getAccountBorrowCollateralLimit({
+    loanCurrency: 'USDT',
+    collateralCurrency: 'BTC',
+  })
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/V5/Crypto-Loan/get-borrowable-coins.js

@@ -0,0 +1,19 @@
+const { RestClientV5 } = require('bybit-api');
+
+const client = new RestClientV5({
+  testnet: true,
+  key: 'apikey',
+  secret: 'apisecret',
+});
+
+client
+  .getBorrowableCoins({
+    currency: 'USDT',
+    vipLevel: 'VIP0',
+  })
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/V5/Crypto-Loan/get-collateral-coins.js

@@ -0,0 +1,19 @@
+const { RestClientV5 } = require('bybit-api');
+
+const client = new RestClientV5({
+  testnet: true,
+  key: 'apikey',
+  secret: 'apisecret',
+});
+
+client
+  .getCollateralCoins({
+    currency: 'ETH',
+    vipLevel: 'PRO1',
+  })
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/V5/Crypto-Loan/get-completed-loan-order-history.js

@@ -0,0 +1,16 @@
+const { RestClientV5 } = require('bybit-api');
+
+const client = new RestClientV5({
+  testnet: true,
+  key: 'apikey',
+  secret: 'apisecret',
+});
+
+client
+  .getCompletedLoanOrderHistory({ orderId: '1794267532472646144' })
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/V5/Crypto-Loan/get-loan-LTV-adjustment-history.js

@@ -0,0 +1,16 @@
+const { RestClientV5 } = require('bybit-api');
+
+const client = new RestClientV5({
+  testnet: true,
+  key: 'apikey',
+  secret: 'apisecret',
+});
+
+client
+  .getLoanLTVAdjustmentHistory({ adjustId: '1794271131730737664' })
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/V5/Crypto-Loan/get-max-allowed-reduction-collateral-amount.js

@@ -0,0 +1,16 @@
+const { RestClientV5 } = require('bybit-api');
+
+const client = new RestClientV5({
+  testnet: true,
+  key: 'apikey',
+  secret: 'apisecret',
+});
+
+client
+  .getMaxAllowedReductionCollateralAmount({ orderId: '1794267532472646144' })
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/V5/Crypto-Loan/get-repayment-transaction-history.js

@@ -0,0 +1,16 @@
+const { RestClientV5 } = require('bybit-api');
+
+const client = new RestClientV5({
+  testnet: true,
+  key: 'apikey',
+  secret: 'apisecret',
+});
+
+client
+  .getRepaymentHistory({ repayId: '1794271131730737664' })
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/V5/Crypto-Loan/get-unpaid-loan-orders.js

@@ -0,0 +1,16 @@
+const { RestClientV5 } = require('bybit-api');
+
+const client = new RestClientV5({
+  testnet: true,
+  key: 'apikey',
+  secret: 'apisecret',
+});
+
+client
+  .getUnpaidLoanOrders({ orderId: '1793683005081680384' })
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/V5/Crypto-Loan/repay.js

@@ -0,0 +1,19 @@
+const { RestClientV5 } = require('bybit-api');
+
+const client = new RestClientV5({
+  testnet: true,
+  key: 'apikey',
+  secret: 'apisecret',
+});
+
+client
+  .repayCryptoLoan({
+    orderId: '1794267532472646144',
+    amount: '100',
+  })
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bybit-api",
-  "version": "3.10.19",
+  "version": "3.10.20",
   "description": "Complete & robust Node.js SDK for Bybit's REST APIs and WebSockets, with TypeScript & strong end to end tests.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",