feat(v3.1.10): Add new API endpoints for liquidations, RPI data, and margin statistics

examples/apidoc/RestClientV3/cancelRealityOrder.js

@@ -0,0 +1,23 @@
+import { RestClientV3 } from 'bitget-api';
+// or, if require is preferred:
+// const { RestClientV3 } = require('bitget-api');
+
+// This example shows how to call this Bitget API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "bitget-api" for Bitget exchange
+// This Bitget API SDK is available on npm via "npm install bitget-api"
+// ENDPOINT: /api/v3/trade/cancel-reality-order
+// METHOD: POST
+// PUBLIC: NO
+
+const client = new RestClientV3({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+  apiPass: 'insert_api_pass_here',
+});
+
+client.cancelRealityOrder(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClientV3/getAllFeeRates.js

@@ -0,0 +1,23 @@
+import { RestClientV3 } from 'bitget-api';
+// or, if require is preferred:
+// const { RestClientV3 } = require('bitget-api');
+
+// This example shows how to call this Bitget API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "bitget-api" for Bitget exchange
+// This Bitget API SDK is available on npm via "npm install bitget-api"
+// ENDPOINT: /api/v3/account/all-fee-rate
+// METHOD: GET
+// PUBLIC: NO
+
+const client = new RestClientV3({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+  apiPass: 'insert_api_pass_here',
+});
+
+client.getAllFeeRates(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClientV3/getCashDividendRecords.js

@@ -0,0 +1,23 @@
+import { RestClientV3 } from 'bitget-api';
+// or, if require is preferred:
+// const { RestClientV3 } = require('bitget-api');
+
+// This example shows how to call this Bitget API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "bitget-api" for Bitget exchange
+// This Bitget API SDK is available on npm via "npm install bitget-api"
+// ENDPOINT: /api/v3/market/cash-dividend-records
+// METHOD: GET
+// PUBLIC: YES
+
+const client = new RestClientV3({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+  apiPass: 'insert_api_pass_here',
+});
+
+client.getCashDividendRecords(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClientV3/getCollateralType.js

@@ -0,0 +1,23 @@
+import { RestClientV3 } from 'bitget-api';
+// or, if require is preferred:
+// const { RestClientV3 } = require('bitget-api');
+
+// This example shows how to call this Bitget API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "bitget-api" for Bitget exchange
+// This Bitget API SDK is available on npm via "npm install bitget-api"
+// ENDPOINT: /api/v3/account/collateral-type
+// METHOD: GET
+// PUBLIC: NO
+
+const client = new RestClientV3({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+  apiPass: 'insert_api_pass_here',
+});
+
+client.getCollateralType(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClientV3/getCustomCollateralCoins.js

@@ -0,0 +1,23 @@
+import { RestClientV3 } from 'bitget-api';
+// or, if require is preferred:
+// const { RestClientV3 } = require('bitget-api');
+
+// This example shows how to call this Bitget API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "bitget-api" for Bitget exchange
+// This Bitget API SDK is available on npm via "npm install bitget-api"
+// ENDPOINT: /api/v3/account/custom-collateral-coins
+// METHOD: GET
+// PUBLIC: YES
+
+const client = new RestClientV3({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+  apiPass: 'insert_api_pass_here',
+});
+
+client.getCustomCollateralCoins(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClientV3/getFuturesAccountLongShort.js

@@ -0,0 +1,23 @@
+import { RestClientV3 } from 'bitget-api';
+// or, if require is preferred:
+// const { RestClientV3 } = require('bitget-api');
+
+// This example shows how to call this Bitget API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "bitget-api" for Bitget exchange
+// This Bitget API SDK is available on npm via "npm install bitget-api"
+// ENDPOINT: /api/v3/market/futures-account-long-short
+// METHOD: GET
+// PUBLIC: YES
+
+const client = new RestClientV3({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+  apiPass: 'insert_api_pass_here',
+});
+
+client.getFuturesAccountLongShort(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClientV3/getFuturesActiveBuySell.js

@@ -0,0 +1,23 @@
+import { RestClientV3 } from 'bitget-api';
+// or, if require is preferred:
+// const { RestClientV3 } = require('bitget-api');
+
+// This example shows how to call this Bitget API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "bitget-api" for Bitget exchange
+// This Bitget API SDK is available on npm via "npm install bitget-api"
+// ENDPOINT: /api/v3/market/futures-active-buy-sell
+// METHOD: GET
+// PUBLIC: YES
+
+const client = new RestClientV3({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+  apiPass: 'insert_api_pass_here',
+});
+
+client.getFuturesActiveBuySell(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClientV3/getFuturesLongShort.js

@@ -0,0 +1,23 @@
+import { RestClientV3 } from 'bitget-api';
+// or, if require is preferred:
+// const { RestClientV3 } = require('bitget-api');
+
+// This example shows how to call this Bitget API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "bitget-api" for Bitget exchange
+// This Bitget API SDK is available on npm via "npm install bitget-api"
+// ENDPOINT: /api/v3/market/futures-long-short
+// METHOD: GET
+// PUBLIC: YES
+
+const client = new RestClientV3({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+  apiPass: 'insert_api_pass_here',
+});
+
+client.getFuturesLongShort(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClientV3/getFuturesPositionLongShort.js

@@ -0,0 +1,23 @@
+import { RestClientV3 } from 'bitget-api';
+// or, if require is preferred:
+// const { RestClientV3 } = require('bitget-api');
+
+// This example shows how to call this Bitget API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "bitget-api" for Bitget exchange
+// This Bitget API SDK is available on npm via "npm install bitget-api"
+// ENDPOINT: /api/v3/market/futures-position-long-short
+// METHOD: GET
+// PUBLIC: YES
+
+const client = new RestClientV3({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+  apiPass: 'insert_api_pass_here',
+});
+
+client.getFuturesPositionLongShort(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClientV3/getLiquidations.js

@@ -0,0 +1,23 @@
+import { RestClientV3 } from 'bitget-api';
+// or, if require is preferred:
+// const { RestClientV3 } = require('bitget-api');
+
+// This example shows how to call this Bitget API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "bitget-api" for Bitget exchange
+// This Bitget API SDK is available on npm via "npm install bitget-api"
+// ENDPOINT: /api/v3/market/liquidations
+// METHOD: GET
+// PUBLIC: YES
+
+const client = new RestClientV3({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+  apiPass: 'insert_api_pass_here',
+});
+
+client.getLiquidations(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClientV3/getLoanData.js

@@ -0,0 +1,23 @@
+import { RestClientV3 } from 'bitget-api';
+// or, if require is preferred:
+// const { RestClientV3 } = require('bitget-api');
+
+// This example shows how to call this Bitget API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "bitget-api" for Bitget exchange
+// This Bitget API SDK is available on npm via "npm install bitget-api"
+// ENDPOINT: /api/v3/trade/loan-data
+// METHOD: GET
+// PUBLIC: NO
+
+const client = new RestClientV3({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+  apiPass: 'insert_api_pass_here',
+});
+
+client.getLoanData(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClientV3/getMarginIsolatedBorrow.js

@@ -0,0 +1,23 @@
+import { RestClientV3 } from 'bitget-api';
+// or, if require is preferred:
+// const { RestClientV3 } = require('bitget-api');
+
+// This example shows how to call this Bitget API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "bitget-api" for Bitget exchange
+// This Bitget API SDK is available on npm via "npm install bitget-api"
+// ENDPOINT: /api/v3/market/margin-isolated-borrow
+// METHOD: GET
+// PUBLIC: YES
+
+const client = new RestClientV3({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+  apiPass: 'insert_api_pass_here',
+});
+
+client.getMarginIsolatedBorrow(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClientV3/getMarginLoanGrowth.js

@@ -0,0 +1,23 @@
+import { RestClientV3 } from 'bitget-api';
+// or, if require is preferred:
+// const { RestClientV3 } = require('bitget-api');
+
+// This example shows how to call this Bitget API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "bitget-api" for Bitget exchange
+// This Bitget API SDK is available on npm via "npm install bitget-api"
+// ENDPOINT: /api/v3/market/margin-loan-growth
+// METHOD: GET
+// PUBLIC: YES
+
+const client = new RestClientV3({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+  apiPass: 'insert_api_pass_here',
+});
+
+client.getMarginLoanGrowth(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClientV3/getMarginLongShort.js

@@ -0,0 +1,23 @@
+import { RestClientV3 } from 'bitget-api';
+// or, if require is preferred:
+// const { RestClientV3 } = require('bitget-api');
+
+// This example shows how to call this Bitget API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "bitget-api" for Bitget exchange
+// This Bitget API SDK is available on npm via "npm install bitget-api"
+// ENDPOINT: /api/v3/market/margin-long-short
+// METHOD: GET
+// PUBLIC: YES
+
+const client = new RestClientV3({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+  apiPass: 'insert_api_pass_here',
+});
+
+client.getMarginLongShort(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClientV3/getMaxWithdrawal.js

@@ -0,0 +1,23 @@
+import { RestClientV3 } from 'bitget-api';
+// or, if require is preferred:
+// const { RestClientV3 } = require('bitget-api');
+
+// This example shows how to call this Bitget API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "bitget-api" for Bitget exchange
+// This Bitget API SDK is available on npm via "npm install bitget-api"
+// ENDPOINT: /api/v3/account/max-withdrawal
+// METHOD: GET
+// PUBLIC: NO
+
+const client = new RestClientV3({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+  apiPass: 'insert_api_pass_here',
+});
+
+client.getMaxWithdrawal(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClientV3/getRpiOrderBook.js

@@ -0,0 +1,23 @@
+import { RestClientV3 } from 'bitget-api';
+// or, if require is preferred:
+// const { RestClientV3 } = require('bitget-api');
+
+// This example shows how to call this Bitget API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "bitget-api" for Bitget exchange
+// This Bitget API SDK is available on npm via "npm install bitget-api"
+// ENDPOINT: /api/v3/market/rpi-orderbook
+// METHOD: GET
+// PUBLIC: YES
+
+const client = new RestClientV3({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+  apiPass: 'insert_api_pass_here',
+});
+
+client.getRpiOrderBook(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });