Balance

Get an Account's Balance

Get an array of all AccountBalances for an AccountIdentifier and the BlockIdentifier at which the balance lookup was performed. The BlockIdentifier must always be returned because some consumers of account balance data need to know specifically at which block the balance was calculated to compare balances they compute from operations with the balance returned by the node. It is important to note that making a balance request for an account without populating the SubAccountIdentifier should not result in the balance of all possible SubAccountIdentifiers being returned. Rather, it should result in the balance pertaining to no SubAccountIdentifiers being returned (sometimes called the liquid balance). To get all balances associated with an account, it may be necessary to perform multiple balance requests with unique AccountIdentifiers. It is also possible to perform a historical balance lookup (if the server supports it) by passing in an optional BlockIdentifier.

POST/account/balance

Body

application/json

network_identifier*object

The network_identifier specifies which network a particular object is associated with.

account_identifier*object

The account_identifier uniquely identifies an account within a network. All fields in the account_identifier are utilized to determine this uniqueness (including the metadata field, if populated).

block_identifierobject

When fetching data by BlockIdentifier, it may be possible to only specify the index or hash. If neither property is specified, it is assumed that the client is making a request at the current block.

currenciesarray of object

In some cases, the caller may not want to retrieve all available balances for an AccountIdentifier. If the currencies field is populated, only balances for the specified currencies will be returned. If not populated, all available balances will be returned.

Response

200500

Expected response to a valid request

Body

application/json

block_identifier*object

The block_identifier uniquely identifies a block in a particular network.

balances*array of object

A single account may have a balance in multiple currencies.

metadataobject

Account-based blockchains that utilize a nonce or sequence number should include that number in the metadata. This number could be unique to the identifier or global across the account address.

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/account/balance', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "network_identifier": {
        "blockchain": "bitcoin",
        "network": "mainnet"
      },
      "account_identifier": {
        "address": "0x3a065000ab4183c6bf581dc1e55a605455fc6d61"
      }
    }),
});
const data = await response.json();

Response

200500

{
  "block_identifier": {
    "index": 1123941,
    "hash": "0x1f2cc6c5027d2f201a5453ad1119574d2aed23a392654742ac3c78783c071f85"
  },
  "balances": [
    {
      "value": "1238089899992",
      "currency": {
        "symbol": "BTC",
        "decimals": 8,
        "metadata": {
          "Issuer": "Satoshi"
        }
      }
    }
  ],
  "metadata": {
    "sequence_number": 23
  }
}