Skip to main content

/extended/v1/address/{principal}/stx REST API Endpoint

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

Updated on
Oct 4, 2023

/extended/v1/address/{principal}/stx REST API Endpoint

Path Parameters

principal
string
REQUIRED
Stacks address or a Contract identifier (e.g. SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info).

Query Parameters

unanchored
boolean
Include transaction data from unanchored (i.e. unconfirmed) microblocks.
until_block
string
returned data representing the state up until that point in time, rather than the current block.

Returns

object
GET request that returns address balances
balance
string
Current balance of STX associated with the principal (address).
total_sent
string
Total amount of STX sent from the principal's address.
total_received
string
Total amount of STX received by the principal's address.
total_fees_sent
string
Total amount of STX used as transaction fees by the principal.
total_miner_rewards_received
string
Total amount of STX received as miner rewards by the principal.
lock_tx_id
string
Transaction ID where the lock event occurred. Empty if no tokens are locked.
locked
string
Amount of locked STX, as string quoted micro-STX. Zero if no tokens are locked.
lock_height
integer
STX chain block height when the lock event occurred. Zero if no tokens are locked.
burnchain_lock_height
integer
Burnchain block height when the lock event occurred. Zero if no tokens are locked.
burnchain_unlock_height
integer
Burnchain block height when the tokens unlock. Zero if no tokens are locked.
token_offering_locked
object
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
array
Array of objects (AddressUnlockSchedule).
amount
string
Micro-STX amount locked at this block height.
block_height
integer
Block height.
Request
1
curl -X 'GET' \
2
    'https://docs-demo.stacks-mainnet.quiknode.pro/extended/v1/address/SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9/stx' \
3
    -H 'Content-Type: application/json'
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free