# User Balances

## Gets user balances by symbol

<mark style="color:blue;">`GET`</mark> `https://api.aquanow.io/users/v1/userbalance`

To view example requests for this endpoint, visit Aquanow's [Postman](https://developer.aquanow.io/#2d8ac552-c96d-44e9-97ad-a681d9222eab) documentation.

#### Query Parameters

| Name   | Type   | Description                                                                                                                                                   |
| ------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| symbol | String | <p><code>BTC</code></p><p>Fetches the user balance for the symbol provided. If symbol is not specified in query parameters, it fetches all user balances.</p> |

#### Headers

| Name                                          | Type   | Description                                                                                                                                                        |
| --------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| x-api-key<mark style="color:red;">\*</mark>   | String | <p><code>{{x-api-key}}</code></p><p>API Auth Key</p>                                                                                                               |
| x-signature<mark style="color:red;">\*</mark> | String | <p><code>49c6260c194f4d7ed5cb917dc70b9821673246b2abc1cf28f05df6a75fd24181e00f8e57b321d15ae45db58b3bffe27a</code></p><p>Signature created using your API secret</p> |
| x-nonce<mark style="color:red;">\*</mark>     | Number | <p><code>1657731573930</code></p><p>Timestamp in millisecond</p>                                                                                                   |

{% tabs %}
{% tab title="200: OK Get balance by currency" %}
Returns a [UserBalancesObject](https://docs.aquanow.io/aquanow/legacy/data-objects-and-statuses/accounts-objects#userbalancesobject).

```json
{
  "availableBalance": 2.4643104026041307,
  "symbol": "BTC",
  "updatedAt": 1656460243147,
  "pendingTransfer": 0.3214,
  "totalBalance": 2.785710402604131,
  "depositAddress": "rPEPPER7kfTD9w2To4CQk6UCfuHM9c6GDY",
  "pending": 0.3214000000000003,
  "available": 2.4643104026041307
}
```

{% endtab %}

{% tab title="200: OK Get balances" %}
Returns an array of [UserBalancesObject](https://docs.aquanow.io/aquanow/legacy/data-objects-and-statuses/accounts-objects#userbalancesobject).

```json
[
  {
    "availableBalance": 0,
    "symbol": "CHZ",
    "updatedAt": 1644558521177,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 90.246913578,
    "symbol": "EOS",
    "updatedAt": 1644943706785,
    "creditBalance": 50,
    "pendingTransfer": 13,
    "totalBalance": 103.246913578,
    "depositAddress": "-",
    "pending": 13,
    "available": 40.246913578
  },
  {
    "availableBalance": 0,
    "symbol": "SUSHI",
    "updatedAt": 1626206689490,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 0,
    "symbol": "SAND",
    "updatedAt": 1657748260730,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "123123",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 0,
    "symbol": "APE",
    "updatedAt": 1647625727758,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 2313.994,
    "symbol": "XRP",
    "updatedAt": 1656621920220,
    "pendingTransfer": 111,
    "totalBalance": 2424.994,
    "tag": "12346",
    "depositAddress": "rPEPPER7kfTD9w2To4CQk6UCfuHM9c6GDH",
    "pending": 111,
    "available": 2313.994
  },
  {
    "availableBalance": 45,
    "symbol": "BAL",
    "updatedAt": 1638223134766,
    "creditBalance": 5,
    "pendingTransfer": 0,
    "totalBalance": 45,
    "depositAddress": "-",
    "pending": 0,
    "available": 40
  },
  {
    "availableBalance": 0,
    "symbol": "QNT",
    "updatedAt": 1650395681897,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 0,
    "symbol": "GALA",
    "updatedAt": 1644558520286,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 5,
    "symbol": "COMP",
    "updatedAt": 1633714861520,
    "creditBalance": 0,
    "pendingTransfer": 0,
    "totalBalance": 5,
    "depositAddress": "-",
    "pending": 0,
    "available": 5
  },
  {
    "availableBalance": 100,
    "symbol": "CRV",
    "updatedAt": 1637284717168,
    "pendingTransfer": 0,
    "totalBalance": 100,
    "depositAddress": "-",
    "pending": 0,
    "available": 100
  },
  {
    "availableBalance": 9897.246912789013,
    "symbol": "USDT",
    "updatedAt": 1656466487707,
    "creditBalance": 0,
    "pendingTransfer": 343,
    "totalBalance": 10240.246912789013,
    "depositAddress": "TUgKfTSmoNmmn8ejMbXYLuKRBhbyDZ1RrY",
    "pending": 343,
    "available": 9897.246912789013
  },
  {
    "availableBalance": 89099.57688187515,
    "symbol": "GBP",
    "updatedAt": 1656539634138,
    "pendingTransfer": 0,
    "totalBalance": 89099.57688187515,
    "depositAddress": "-",
    "pending": 0,
    "available": 89099.57688187515
  },
  {
    "availableBalance": 10,
    "symbol": "AXS",
    "updatedAt": 1644942906815,
    "pendingTransfer": 0,
    "totalBalance": 10,
    "depositAddress": "-",
    "pending": 0,
    "available": 10
  },
  {
    "availableBalance": 0,
    "symbol": "CHR",
    "updatedAt": 1652917457547,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 0,
    "symbol": "BAND",
    "updatedAt": 1652917457395,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 0,
    "symbol": "UMA",
    "updatedAt": 1619485534320,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 2.111,
    "symbol": "AAVE",
    "updatedAt": 1639770349750,
    "pendingTransfer": 0,
    "totalBalance": 2.111,
    "depositAddress": "-",
    "pending": 0,
    "available": 2.111
  },
  {
    "availableBalance": 0,
    "symbol": "BAT",
    "updatedAt": 1612906258984,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 2000,
    "symbol": "EUR",
    "updatedAt": 1654641976605,
    "creditBalance": 500,
    "pendingTransfer": 699,
    "totalBalance": 2699,
    "depositAddress": "-",
    "pending": 699,
    "available": 1500
  },
  {
    "availableBalance": 0,
    "symbol": "ANKR",
    "updatedAt": 1650395681998,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 89088.5936344316,
    "symbol": "USD",
    "updatedAt": 1657747088036,
    "creditBalance": 650,
    "pendingTransfer": 511,
    "totalBalance": 89599.5936344316,
    "depositAddress": "-",
    "pending": 511,
    "available": 88438.5936344316
  },
  {
    "availableBalance": 0,
    "symbol": "OMG",
    "updatedAt": 1644558520781,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 0,
    "symbol": "PAXG",
    "updatedAt": 1652917457166,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 0,
    "symbol": "FTM",
    "updatedAt": 1629008449743,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 2.45272,
    "symbol": "ETH",
    "updatedAt": 1645138225177,
    "creditBalance": 0.1,
    "pendingTransfer": 0,
    "totalBalance": 2.45272,
    "depositAddress": "-",
    "pending": 0,
    "available": 2.35272
  },
  {
    "availableBalance": 0,
    "symbol": "AVAX",
    "updatedAt": 1635926732161,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 0,
    "symbol": "KNC",
    "updatedAt": 1616012436157,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 0.88456,
    "symbol": "LTC",
    "updatedAt": 1639596390736,
    "pendingTransfer": 0.1,
    "totalBalance": 0.98456,
    "depositAddress": "mp1SJGVPqUdaouebV87yTnV75YA6oTAMPp",
    "pending": 0.1,
    "available": 0.88456
  },
  {
    "availableBalance": 606,
    "symbol": "PLN",
    "updatedAt": 1634835429069,
    "creditBalance": 601,
    "pendingTransfer": 0,
    "totalBalance": 606,
    "depositAddress": "-",
    "pending": 0,
    "available": 5
  },
  {
    "availableBalance": 0.6666,
    "symbol": "DAI",
    "updatedAt": 1638237165451,
    "pendingTransfer": 0,
    "totalBalance": 0.6666,
    "depositAddress": "-",
    "pending": 0,
    "available": 0.6666
  },
  {
    "availableBalance": 0,
    "symbol": "ENJ",
    "updatedAt": 1642489498804,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 0,
    "symbol": "CTSI",
    "updatedAt": 1652917457326,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 0,
    "symbol": "AED",
    "updatedAt": 1655929483356,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 0,
    "symbol": "LRC",
    "updatedAt": 1642489498958,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 0,
    "symbol": "DOT",
    "updatedAt": 1613697123103,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 400,
    "symbol": "UNI",
    "updatedAt": 1620425151906,
    "pendingTransfer": 0,
    "totalBalance": 400,
    "depositAddress": "-",
    "pending": 0,
    "available": 400
  },
  {
    "availableBalance": 0,
    "symbol": "STX",
    "updatedAt": 1650395681744,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 500,
    "symbol": "XLM",
    "updatedAt": 1633717531734,
    "pendingTransfer": 50,
    "totalBalance": 550,
    "tag": "tag",
    "depositAddress": "GBH6OYX6A6F6JW47V7CUMUBHV7GA3AEOKFCNGLXO5OKL6Y6252IB4YB7",
    "pending": 50,
    "available": 500
  },
  {
    "availableBalance": 98.997,
    "symbol": "YFI",
    "updatedAt": 1633717558804,
    "pendingTransfer": 1.003,
    "totalBalance": 100,
    "depositAddress": "someYFIaddress",
    "pending": 1.003,
    "available": 98.997
  },
  {
    "availableBalance": 0,
    "symbol": "AMP",
    "updatedAt": 1644558520906,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 5,
    "symbol": "ALGO",
    "updatedAt": 1639770458402,
    "pendingTransfer": 0,
    "totalBalance": 5,
    "depositAddress": "-",
    "pending": 0,
    "available": 5
  },
  {
    "availableBalance": 0.666,
    "symbol": "LINK",
    "updatedAt": 1608667264789,
    "pendingTransfer": 0,
    "totalBalance": 0.666,
    "depositAddress": "-",
    "pending": 0,
    "available": 0.666
  },
  {
    "availableBalance": 0,
    "symbol": "SOL",
    "updatedAt": 1629008450006,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 2.4643104026041307,
    "symbol": "BTC",
    "updatedAt": 1656460243147,
    "pendingTransfer": 0.3214,
    "totalBalance": 2.785710402604131,
    "depositAddress": "rPEPPER7kfTD9w2To4CQk6UCfuHM9c6GDY",
    "pending": 0.3214000000000003,
    "available": 2.4643104026041307
  },
  {
    "availableBalance": 18025.414972979,
    "symbol": "CAD",
    "updatedAt": 1656525914856,
    "pendingTransfer": 882,
    "totalBalance": 18907.414972979,
    "depositAddress": "-",
    "pending": 882,
    "available": 18025.414972979
  },
  {
    "availableBalance": 190,
    "symbol": "ATOM",
    "updatedAt": 1640212358223,
    "pendingTransfer": 0,
    "totalBalance": 190,
    "depositAddress": "-",
    "pending": 0,
    "available": 190
  },
  {
    "availableBalance": 0,
    "symbol": "WNXM",
    "updatedAt": 1619485544558,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 0,
    "symbol": "COTI",
    "updatedAt": 1652917456991,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 10,
    "symbol": "ADA",
    "updatedAt": 1644942637815,
    "pendingTransfer": 0,
    "totalBalance": 10,
    "depositAddress": "-",
    "pending": 0,
    "available": 10
  },
  {
    "availableBalance": 0,
    "symbol": "MANA",
    "updatedAt": 1629008450081,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 0,
    "symbol": "DOGE",
    "updatedAt": 1622481687153,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 0,
    "symbol": "DYDX",
    "updatedAt": 1650395682096,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 4000,
    "symbol": "USDC",
    "updatedAt": 1657747089749,
    "creditBalance": 5000,
    "pendingTransfer": 0,
    "totalBalance": 4000,
    "depositAddress": "JjKnmksnoSKjo8790OASHsffhojhjshfasjfhFH",
    "pending": 0,
    "available": -1000
  },
  {
    "availableBalance": 0,
    "symbol": "REN",
    "updatedAt": 1616012413036,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 2.247912,
    "symbol": "HELLO",
    "updatedAt": 1650481063099,
    "pendingTransfer": 0,
    "totalBalance": 2.247912,
    "depositAddress": "-",
    "pending": 0,
    "available": 2.247912
  },
  {
    "availableBalance": 0,
    "symbol": "STORJ",
    "updatedAt": 1652917457086,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 0,
    "symbol": "FIL",
    "updatedAt": 1619485560898,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 0,
    "symbol": "MATIC",
    "updatedAt": 1626206630797,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 0,
    "symbol": "LUNC",
    "updatedAt": 1653953220613,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 0,
    "symbol": "ZXR",
    "updatedAt": 1619485552485,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 0,
    "symbol": "CELO",
    "updatedAt": 1644558520606,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 39040.485,
    "symbol": "AUD",
    "updatedAt": 1656456665653,
    "creditBalance": 1000,
    "pendingTransfer": 0,
    "totalBalance": 39040.485,
    "depositAddress": "-",
    "pending": 0,
    "available": 38040.485
  },
  {
    "availableBalance": 0,
    "symbol": "SKL",
    "updatedAt": 1652917457250,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 0,
    "symbol": "GRT",
    "updatedAt": 1644558521032,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 0,
    "symbol": "SNX",
    "updatedAt": 1612906289592,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 0,
    "symbol": "BNT",
    "updatedAt": 1652917457470,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 0,
    "symbol": "ZRX",
    "updatedAt": 1619638691888,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  },
  {
    "availableBalance": 100.998,
    "symbol": "1INCH",
    "updatedAt": 1639098685869,
    "pendingTransfer": 0,
    "totalBalance": 100.998,
    "depositAddress": "-",
    "pending": 0,
    "available": 100.998
  },
  {
    "availableBalance": 9.251825,
    "symbol": "BCH",
    "updatedAt": 1638824646190,
    "pendingTransfer": 0.502,
    "totalBalance": 9.753825,
    "depositAddress": "-",
    "pending": 0.502,
    "available": 9.251825
  },
  {
    "availableBalance": 10,
    "symbol": "SHIB",
    "updatedAt": 1644941517572,
    "pendingTransfer": 0,
    "totalBalance": 10,
    "depositAddress": "-",
    "pending": 0,
    "available": 10
  },
  {
    "availableBalance": 10,
    "symbol": "XTZ",
    "updatedAt": 1644941602285,
    "pendingTransfer": 0,
    "totalBalance": 10,
    "depositAddress": "-",
    "pending": 0,
    "available": 10
  },
  {
    "availableBalance": 0,
    "symbol": "MKR",
    "updatedAt": 1616012427290,
    "pendingTransfer": 0,
    "totalBalance": 0,
    "depositAddress": "-",
    "pending": 0,
    "available": 0
  }
]
```

{% endtab %}
{% endtabs %}

## Total aggregate of all balances in USD

<mark style="color:blue;">`GET`</mark> `https://api.aquanow.io/users/v1/totalUB`

To view example requests for this endpoint, visit Aquanow's [Postman](https://developer.aquanow.io/#f165176c-8c98-4d7b-8be0-528af95e2be1) documentation.

#### Headers

| Name                                          | Type   | Description                                                                                                                                                        |
| --------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| x-api-key<mark style="color:red;">\*</mark>   | String | <p><code>{{x-api-key}}</code></p><p>API Auth Key</p>                                                                                                               |
| x-signature<mark style="color:red;">\*</mark> | String | <p><code>49c6260c194f4d7ed5cb917dc70b9821673246b2abc1cf28f05df6a75fd24181e00f8e57b321d15ae45db58b3bffe27a</code></p><p>Signature created using your API secret</p> |
| x-nonce<mark style="color:red;">\*</mark>     | Number | <p><code>1657731573930</code></p><p>Timestamp in millisecond</p>                                                                                                   |

{% tabs %}
{% tab title="200: OK " %}
Returns an [EstimateBalanceUSDObject](https://docs.aquanow.io/aquanow/legacy/data-objects-and-statuses/accounts-objects#estimatebalanceusdobject).

```json
{
    "usdTotal": 8429340.78990256
}
```

{% endtab %}
{% endtabs %}
