Path Parameters
- addressstringREQUIRED
The Stacks address to retrieve STX balance information for (must be a valid Stacks address starting with 'SP' or 'SM')
Query Parameters
- include_mempoolboolean
Whether to include transactions that are currently in the mempool (unconfirmed) in the balance calculation. Default is true.
Returns
- stx_balance_responseobject
Comprehensive STX token balance and locking information for the specified address
- balancestring
The current confirmed spendable STX balance of the address, denominated in micro-STX (1 STX = 1,000,000 micro-STX). Represented as a string to preserve precision for large numbers.
- estimated_balancestring
Estimated balance taking into account both confirmed and pending transactions, denominated in micro-STX.
- pending_balance_inboundstring
The sum of STX tokens from pending incoming transactions that have not yet been confirmed, denominated in micro-STX.
- pending_balance_outboundstring
The sum of STX tokens from pending outgoing transactions that have not yet been confirmed, denominated in micro-STX.
- total_miner_rewards_receivedstring
The total amount of STX received as mining rewards, denominated in micro-STX.
- lock_tx_idstring
The transaction ID of the transaction that locked STX tokens, if any. Empty string if no tokens are locked.
- lockedstring
The amount of STX tokens currently locked (stacked), denominated in micro-STX.
- lock_heightinteger
The Stacks block height at which the tokens were locked. 0 if no tokens are locked.
- burnchain_lock_heightinteger
The Bitcoin (burnchain) block height at which the tokens were locked. 0 if no tokens are locked.
- burnchain_unlock_heightinteger
The Bitcoin (burnchain) block height at which the locked tokens will become unlocked. 0 if no tokens are locked.