Get account balances

Retrieves account balance information, including STX, fungible, and non-fungible tokens.

GET

Parameters

Path Parameters

principal
REQUIRED
string

Query Parameters

unanchored
boolean Include data from unanchored (i.e. unconfirmed) microblocks
until_block
string Block hash or block height. Return data representing the state up until that point in time, rather than the current block. Note - Use either of the query parameters but not both at a time.
Status codeDescription
200GET request that returns address balances
4XXDefault Response
cURL
curl -L \

  "https://api.hiro.so/extended/v1/address/{principal}/balances?unanchored=true&until_block={until_block}" \

  -H 'Accept: application/json'
Response
{

  "stx": {

    "balance": "string",

    "estimated_balance": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",

    "pending_balance_inbound": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",

    "pending_balance_outbound": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",

    "total_sent": "string",

    "total_received": "string",

    "total_fees_sent": "string",

    "total_miner_rewards_received": "string",

    "lock_tx_id": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",

    "locked": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",

    "lock_height": 144000,

    "burnchain_lock_height": 144000,

    "burnchain_unlock_height": 144000

  },

  "token_offering_locked": {

    "total_locked": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",

    "total_unlocked": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",

    "unlock_schedule": [

      {

        "amount": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",

        "block_height": 144000

      }

    ]

  }

}

How is this guide?