Get user balances

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


GET
/extended/v1/address/{principal}/balances

Get account balances

NOTE: This endpoint is deprecated in favor of Get address FT balances.

Retrieves total account balance information for a given Address or Contract Identifier. This includes the balances of STX Tokens, Fungible Tokens and Non-Fungible Tokens for the account.

Query Parameters

unanchoredboolean

Include data from unanchored (i.e. unconfirmed) microblocks

Default: false

until_blockstring

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.

Path Parameters

principal
Required
Any properties in STX Address, Smart Contract ID

Status codeDescription
200GET request that returns address balances
4XXDefault Response
curl -X GET "https://api.hiro.so/extended/v1/address/SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP/balances?unanchored=false&until_block=string"

GET request that returns address balances

{
"stx": {
"balance": "string",
"estimated_balance": "string",
"pending_balance_inbound": "string",
"pending_balance_outbound": "string",
"total_sent": "string",
"total_received": "string",
"total_fees_sent": "string",
"total_miner_rewards_received": "string",
"lock_tx_id": "string",
"locked": "string",
"lock_height": 0,
"burnchain_lock_height": 0,
"burnchain_unlock_height": 0
},
"fungible_tokens": {
"property1": {
"balance": "string",
"total_sent": "string",
"total_received": "string"
},
"property2": {
"balance": "string",
"total_sent": "string",
"total_received": "string"
}
},
"non_fungible_tokens": {
"property1": {
"count": "string",
"total_sent": "string",
"total_received": "string"
},
"property2": {
"count": "string",
"total_sent": "string",
"total_received": "string"
}
},
"token_offering_locked": {
"total_locked": "string",
"total_unlocked": "string",
"unlock_schedule": [
{
"amount": "string",
"block_height": 0
}
]
}
}