Get principal STX balance

Retrieves STX account balance information for a given Address or Contract Identifier.


GET
/extended/v2/addresses/{principal}/balances/stx

Get principal STX balance

Retrieves STX account balance information for a given Address or Contract Identifier.

Query Parameters

include_mempoolboolean

Include pending mempool transactions in the balance calculation

Default: false

Path Parameters

principal
Required
Any properties in STX Address, Smart Contract ID

Status codeDescription
200Default Response
4XXDefault Response
/extended/v2/addresses/{principal}/balances/stx

curl -X GET "https://api.hiro.so/extended/v2/addresses/SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP/balances/stx?include_mempool=false"

{
"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
}