Merge branch 'master' into snyk-upgrade-333a1872421e1c336a5456cca9c74648

Author: tiagosiebler

docs/endpointFunctionList.md

@@ -1,11 +1,13 @@
 # Examples
 
 These samples can be executed using `ts-node`:
+
 ```
 ts-node ./examples/rest-spot-public.ts
 ```
 
 Samples that require authentication can be edited directly but also support environmental variables. E.g. on mac/unix:
+
 ```
 API_KEY_COM='yourkeyhere' API_SECRET_COM='yoursecrethere' API_PASS_COM='yourapipasshere' ts-node examples/rest-trade-futures.ts
 ```
@@ -19,7 +21,7 @@ These newer examples are for Bitget's V3 APIs and WebSockets. They can be found
 Refer to the V3 / UTA API documentation for more information on the V3 APIs:
 https://www.bitget.com/api-doc/uta/intro
 
-These APIs require your account to be permanently upgraded to the Unified Trading Account, if you plan on using the account-level REST APIs and WebSockets. Once upgraded, the V2 APIs are no longer available to you.
+These APIs require your account to be upgraded to the Unified Trading Account, if you plan on using the account-level REST APIs and WebSockets. Once upgraded, the V2 APIs are no longer available to you, unless you revert back to Classic Account mode.
 
 ### WebSocket API (WS API)
 
@@ -34,21 +36,19 @@ This integration looks & feels like a REST API client, but uses WebSockets, via
 This is the recommended approach to easily start sending orders via an automatically persisted WebSocket connection. A simple example is below, but for a more thorough example, check the example here: [./V3/ws-api-client-trade.ts](./V3/ws-api-client-trade.ts)
 
 ```typescript
-import { WebsocketAPIClient } from "bitget-api";
+import { WebsocketAPIClient } from 'bitget-api';
 // or if you prefer require:
 // const { WebsocketAPIClient } = require("bitget-api");
 
 // Make an instance of the WS API Client class with your API keys
-const wsClient = new WebsocketAPIClient(
-  {
-    apiKey: API_KEY,
-    apiSecret: API_SECRET,
-    apiPass: API_PASS,
-
-    // Whether to use the demo trading wss connection
-    // demoTrading: true,
-  }
-);
+const wsClient = new WebsocketAPIClient({
+  apiKey: API_KEY,
+  apiSecret: API_SECRET,
+  apiPass: API_PASS,
+
+  // Whether to use the demo trading wss connection
+  // demoTrading: true,
+});
 
 async function start() {
   // Start using it like a REST API. All actions are sent via a persisted WebSocket connection.
@@ -73,7 +73,7 @@ async function start() {
   }
 }
 
-start().catch(e => console.error("Exception in example: ". e));
+start().catch((e) => console.error('Exception in example: '.e));
 ```
 
 #### ws.sendWSAPIRequest(wsKey, command, category, operation)

examples/README.md

@@ -0,0 +1,24 @@
+import { RestClientV2 } from 'bitget-api';
+// or if you want to use the require syntax
+// const { RestClientV2 } = 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/v2/spot/account/upgrade-status
+// METHOD: GET
+// PUBLIC: NO
+
+const client = new RestClientV2({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+  apiPass: 'insert_api_pass_here',
+});
+
+client.getUnifiedAccountSwitchStatus(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClientV2/getUnifiedAccountSwitchStatus.js

@@ -0,0 +1,24 @@
+import { RestClientV2 } from 'bitget-api';
+// or if you want to use the require syntax
+// const { RestClientV2 } = 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/v2/spot/account/upgrade
+// METHOD: POST
+// PUBLIC: NO
+
+const client = new RestClientV2({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+  apiPass: 'insert_api_pass_here',
+});
+
+client.upgradeToUnifiedAccount(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClientV2/upgradeToUnifiedAccount.js

@@ -0,0 +1,24 @@
+import { RestClientV3 } from 'bitget-api';
+// or if you want to use the require syntax
+// 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/switch
+// METHOD: POST
+// PUBLIC: NO
+
+const client = new RestClientV3({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+  apiPass: 'insert_api_pass_here',
+});
+
+client.downgradeAccountToClassic(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClientV3/downgradeAccountToClassic.js

@@ -0,0 +1,24 @@
+import { RestClientV3 } from 'bitget-api';
+// or if you want to use the require syntax
+// 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/position/adlRank
+// METHOD: GET
+// PUBLIC: NO
+
+const client = new RestClientV3({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+  apiPass: 'insert_api_pass_here',
+});
+
+client.getPositionAdlRank(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClientV3/getPositionAdlRank.js

@@ -0,0 +1,24 @@
+import { RestClientV3 } from 'bitget-api';
+// or if you want to use the require syntax
+// 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/proof-of-reserves
+// METHOD: GET
+// PUBLIC: YES
+
+const client = new RestClientV3({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+  apiPass: 'insert_api_pass_here',
+});
+
+client.getProofOfReserves(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClientV3/getProofOfReserves.js

@@ -0,0 +1,24 @@
+import { RestClientV3 } from 'bitget-api';
+// or if you want to use the require syntax
+// 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/switch-status
+// METHOD: GET
+// PUBLIC: NO
+
+const client = new RestClientV3({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+  apiPass: 'insert_api_pass_here',
+});
+
+client.getUnifiedAccountSwitchStatus(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClientV3/getUnifiedAccountSwitchStatus.js

@@ -5,7 +5,7 @@ import { RestClientV3 } from '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/withdrawl-records
+// ENDPOINT: /api/v3/account/withdrawal-records
 // METHOD: GET
 // PUBLIC: NO
 

examples/apidoc/RestClientV3/getWithdrawRecords.js

@@ -0,0 +1,24 @@
+import { RestClientV3 } from 'bitget-api';
+// or if you want to use the require syntax
+// 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/deposit-account
+// METHOD: POST
+// PUBLIC: NO
+
+const client = new RestClientV3({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+  apiPass: 'insert_api_pass_here',
+});
+
+client.setDepositAccount(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });