Skip to main content

Get account STX balance

Retrieves STX token balance for a given Address or Contract Identifier.

Path Parameters
principal string REQUIRED

Stacks address or a Contract identifier.

Example: SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0
Query Parameters
unanchored boolean

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

Example: true
until_block string

returned 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.

Example: 60000
Responses
200

Success

Schema OPTIONAL
balance string
total_sent string
total_received string
total_fees_sent string
total_miner_rewards_received string
lock_tx_id string

The transaction where the lock event occurred. Empty if no tokens are locked.

locked string

The amount of locked STX, as string quoted micro-STX. Zero if no tokens are locked.

lock_height integer

The STX chain block height of when the lock event occurred. Zero if no tokens are locked.

burnchain_lock_height integer

The burnchain block height of when the lock event occurred. Zero if no tokens are locked.

burnchain_unlock_height integer

The burnchain block height of when the tokens unlock. Zero if no tokens are locked.

token_offering_locked object OPTIONAL

Token Offering Locked

total_locked string

Micro-STX amount still locked at current block height.

total_unlocked string

Micro-STX amount unlocked at current block height.

unlock_schedule object[]
amount string

Micro-STX amount locked at this block height.

block_height number