Get account STX balance
Retrieves the STX token balance for a specified address or contract identifier.
GET
/extended/v1/address/{principal}/stx
Get account STX balance
NOTE: This endpoint is deprecated in favor of Get address STX balance.
Retrieves STX token balance for a given Address or Contract Identifier.
Query Parameters
unanchoredboolean
Include data from unanchored (i.e. unconfirmed) microblocks
Default:falseuntil_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
principalRequiredAny properties in STX Address, Smart Contract ID
| Status code | Description |
|---|---|
200 | GET request that returns address balances |
4XX | Default Response |
curl -X GET "https://api.hiro.so/extended/v1/address/SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP/stx?unanchored=false&until_block=string"
GET request that returns address balances
{"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,"token_offering_locked": {"total_locked": "string","total_unlocked": "string","unlock_schedule": [{"amount": "string","block_height": 0}]}}