/extended/v2/addresses/{address}/balances/stx API Method

Path Parameters

address

string

REQUIRED

The Stacks address to retrieve STX balance information for (must be a valid Stacks address starting with 'SP' or 'SM')

Query Parameters

include_mempool

boolean

Whether to include transactions that are currently in the mempool (unconfirmed) in the balance calculation. Default is true.

Returns

stx_balance_response

object

Comprehensive STX token balance and transaction information for the specified address

balance

string

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_balance

string

Estimated balance taking into account both confirmed and pending transactions, denominated in micro-STX.

pending_balance_inbound

string

The sum of STX tokens from pending incoming transactions that have not yet been confirmed, denominated in micro-STX.

pending_balance_outbound

string

The sum of STX tokens from pending outgoing transactions that have not yet been confirmed, denominated in micro-STX.

total_sent

string

The total amount of STX tokens ever sent from this address, denominated in micro-STX.

total_received

string

The total amount of STX tokens ever received by this address, denominated in micro-STX.

total_fees_sent

string

The total amount of STX tokens spent on transaction fees by this address, denominated in micro-STX.

total_miner_rewards_received

string

The total amount of STX received as mining rewards, denominated in micro-STX.

lock_tx_id

string

The transaction ID of the transaction that locked STX tokens, if any. Empty string if no tokens are locked.

locked

string

The amount of STX tokens currently locked (stacked), denominated in micro-STX.

lock_height

integer

The Stacks block height at which the tokens were locked. 0 if no tokens are locked.

burnchain_lock_height

integer

The Bitcoin (burnchain) block height at which the tokens were locked. 0 if no tokens are locked.

burnchain_unlock_height

integer

The Bitcoin (burnchain) block height at which the locked tokens will become unlocked. 0 if no tokens are locked.

Request

curl -X 'GET' \
    'https://docs-demo.stacks-mainnet.quiknode.pro/extended/v2/addresses/SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP/balances/stx?include_mempool=false' \
    -H 'Content-Type: application/json'

Don't have an account yet?

Create your QuickNode endpoint in seconds and start building

Get started for free