chore(): updated examples, updated readme

Author: JJ-Cro

README.md

@@ -104,6 +104,48 @@ Create API credentials at okx
   - If the response looks successful (HTTP 200 and "code" in the response body === "0"), only the `data` property is directly (without the `code`, `data` & `msg` properties).
   - If the response looks like an error (HTTP error OR the "code" property in the response does not equal "0"), the full response is thrown (including `code` and `msg` properties). See the interface for [APIResponse<T>](./src/types/rest/shared.ts).
 
+### Example 
+
+```ts
+import { RestClient } from 'okx-api';
+
+const client = new RestClient({
+  apiKey: 'apiKeyHere', 
+  apiSecret: 'apiSecretHere',
+  apiPass: 'apiPassHere',
+});
+
+// Submit a buy and sell market order
+(async () => {
+  try {
+    const allBalances = await client.getBalance();
+    console.log('All balances: ', allBalances);
+
+    const buyResult = await client.submitOrder({
+      instId: 'BTC-USDT',
+      ordType: 'market',
+      side: 'buy',
+      sz: '0.1',
+      tdMode: 'cash',
+      tgtCcy: 'base_ccy',
+    });
+    console.log('buy order result: ', buyResult);
+
+    const sellResult = await client.submitOrder({
+      instId: 'BTC-USDT',
+      ordType: 'market',
+      side: 'sell',
+      sz: '0.1',
+      tdMode: 'cash',
+      tgtCcy: 'base_ccy',
+    });
+    console.log('Sell order result: ', sellResult);
+  } catch (e) {
+    console.error('request failed: ', e);
+  }
+})();
+```
+
 ## Websocket Client
 
 This connector includes a high-performance node.js & typescript websocket client for the OKX public & private websockets.

examples/rest-private-trade-market.ts

@@ -8,13 +8,10 @@ const API_KEY = process.env.API_KEY_COM;
 const API_SECRET = process.env.API_SECRET_COM;
 const API_PASS = process.env.API_PASSPHRASE_COM;
 
-/**
- * Execute this script using ts-node. The above environmental variables can be passed in one command (unix & macOS):
- *
- * API_KEY_COM="yourapikey" API_SECRET_COM="yourapisecret" API_PASSPHRASE_COM="yourapipassphrase" ts-node examples/rest-private-trade-market.ts
- *
- * If you don't have ts-node, install it using npm: https://github.com/TypeStrong/ts-node#installation
- */
+// If running from CLI in unix, you can pass env vars as such:
+// API_KEY_COM=‘lkm12n3-2ba3-1mxf-fn13-lkm12n3a’ API_SECRET_COM='035B2B9637E1BDFFEE2646BFBDDB8CE4' API_PASSPHRASE_COM='ComplexPa$$!23$5^' ts-node examples/rest-private-trade-market.ts
+
+// note the single quotes, preventing special characters such as $ from being incorrectly passed
 
 if (!API_KEY || !API_SECRET || !API_PASS) {
   throw new Error(

examples/rest-private-trade.ts

@@ -9,9 +9,14 @@ const API_KEY = process.env.API_KEY_COM;
 const API_SECRET = process.env.API_SECRET_COM;
 const API_PASS = process.env.API_PASS_COM;
 
+// If running from CLI in unix, you can pass env vars as such:
+// API_KEY_COM=‘lkm12n3-2ba3-1mxf-fn13-lkm12n3a’ API_SECRET_COM='035B2B9637E1BDFFEE2646BFBDDB8CE4' API_PASSPHRASE_COM='ComplexPa$$!23$5^' ts-node examples/rest-private-trade.ts
+
+// note the single quotes, preventing special characters such as $ from being incorrectly passed
+
 if (!API_KEY || !API_SECRET || !API_PASS) {
   throw new Error(
-    `Missing api credentials. Use environmental variables or hard code in the script`
+    'Missing api credentials. Use environmental variables or hard code in the script',
   );
 }
 
@@ -48,7 +53,7 @@ function promiseSleep(milliseconds) {
 // WARNING: for sensitive math you should be using a library such as decimal.js!
 function roundDown(value, decimals) {
   return Number(
-    Math.floor(parseFloat(value + 'e' + decimals)) + 'e-' + decimals
+    Math.floor(parseFloat(value + 'e' + decimals)) + 'e-' + decimals,
   );
 }
 
@@ -74,7 +79,7 @@ function roundDown(value, decimals) {
     const allBalances = await client.getBalance();
     // const balances = allBalances.filter((bal) => Number(bal.available) != 0);
     const usdtBalanceResult = allBalances[0].details.find(
-      (bal) => bal.ccy === 'USDT'
+      (bal) => bal.ccy === 'USDT',
     );
     console.log('BTC balance result: ', usdtBalanceResult);
 

examples/ws-private.ts

@@ -19,6 +19,11 @@ const API_KEY = process.env.API_KEY_COM;
 const API_SECRET = process.env.API_SECRET_COM;
 const API_PASSPHRASE = process.env.API_PASSPHRASE_COM;
 
+// If running from CLI in unix, you can pass env vars as such:
+// API_KEY_COM=‘lkm12n3-2ba3-1mxf-fn13-lkm12n3a’ API_SECRET_COM='035B2B9637E1BDFFEE2646BFBDDB8CE4' API_PASSPHRASE_COM='ComplexPa$$!23$5^' ts-node examples/ws-private.ts
+
+// note the single quotes, preventing special characters such as $ from being incorrectly passed
+
 if (!API_KEY) {
   throw new Error('API_KEY is missing');
 }