Merge pull request #67 from vansergen/getnotionalbalances

Getnotionalbalances

README.md

@@ -293,6 +293,13 @@ const account = "primary";
 const balances = await client.getAvailableBalances({ account });
 ```
 
+- [`getNotionalBalances`](https://docs.gemini.com/rest-api/#get-notional-balances)
+
+```typescript
+const account = "primary";
+const balances = await client.getNotionalBalances({ account });
+```
+
 - [`getTransfers`](https://docs.gemini.com/rest-api/#transfers)
 
 ```typescript

src/auth.ts

@@ -230,6 +230,16 @@ export type Balance = {
   availableForWithdrawal: string;
 };
 
+export type NotionalBalance = {
+  currency: string;
+  amount: string;
+  amountNotional: string;
+  available: string;
+  availableNotional: string;
+  availableForWithdrawal: string;
+  availableForWithdrawalNotional: string;
+};
+
 export type Transfer = {
   type: "Deposit" | "Withdrawal";
   status: "Advanced" | "Complete";
@@ -453,6 +463,14 @@ export class AuthenticatedClient extends PublicClient {
     return this.post({ body: { request: "/v1/balances", ...body } });
   }
 
+  /**
+   * Get the available balances in the supported currencies as well as in notional USD.
+   */
+  getNotionalBalances(body?: AccountName): Promise<NotionalBalance[]> {
+    const request = "/v1/notionalbalances/usd";
+    return this.post({ body: { request, ...body } });
+  }
+
   /**
    * Get deposits and withdrawals in the supported currencies.
    */

test/auth.spec.ts

@@ -18,6 +18,7 @@ import {
   ConfirmClearingOptionsResponse,
   Account,
   Balance,
+  NotionalBalance,
   Transfer,
   DepositAddress,
   NewAddress,
@@ -1036,6 +1037,38 @@ suite("AuthenticatedClient", () => {
     assert.deepStrictEqual(data, response);
   });
 
+  test(".getNotionalBalances()", async () => {
+    const request = "/v1/notionalbalances/usd";
+    const account = "primary";
+    const options = { request, account, nonce };
+    const response: NotionalBalance[] = [
+      {
+        currency: "USD",
+        amount: "2.911176035",
+        amountNotional: "2.911176035",
+        available: "2.911176035",
+        availableNotional: "2.911176035",
+        availableForWithdrawal: "2.91",
+        availableForWithdrawalNotional: "2.91"
+      },
+      {
+        currency: "ETH",
+        amount: "0.53",
+        amountNotional: "69.9759",
+        available: "0.523",
+        availableNotional: "69.05169",
+        availableForWithdrawal: "0.523",
+        availableForWithdrawalNotional: "69.05169"
+      }
+    ];
+    nock(ApiUri, { reqheaders: { ...SignRequest({ key, secret, options }) } })
+      .post(request, {})
+      .reply(200, response);
+
+    const data = await client.getNotionalBalances({ account });
+    assert.deepStrictEqual(data, response);
+  });
+
   test(".getTransfers()", async () => {
     const request = "/v1/transfers";
     const account = "primary";