Path Parameters
- principalstringREQUIRED
Stacks address or a Contract identifier (e.g. SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info)
Query Parameters
- unanchoredboolean
Include transaction data from unanchored (i.e. unconfirmed) microblocks.
- until_blockstring
returned data representing the state up until that point in time, rather than the current block.
Returns
- objectarray
GET request that returns address balances
- stxobject
The native cryptocurrency
- balancestring
The current balance of STX associated with the principal (address)
- total_sentstring
The total amount of STX sent from the principal's address
- total_receivedstring
The total amount of STX received by the principal's address
- total_fees_sentstring
The total amount of STX used as transaction fees by the principal
- total_miner_rewards_receivedstring
The total amount of STX received as miner rewards by the principal
- lock_tx_idstring
The transaction ID where the lock event occurred. It is empty if no tokens are locked
- lockedstring
The amount of locked STX (quoted in micro-STX). It is zero if no tokens are locked
- lock_heightinteger
The STX chain block height when the lock event occurred. It is zero if no tokens are locked
- burnchain_lock_heightinteger
The burnchain block height when the lock event occurred. It is zero if no tokens are locked
- burnchain_unlock_heightinteger
The burnchain block height when the tokens unlock. It is zero if no tokens are locked
- fungible_tokensobject
Information about the fungible tokens associated with the principal:
- FtBalanceobject
An object containing information about the balance of fungible tokens:
- balancestring
The current balance of the fungible token associated with the principal
- total_sentstring
The total amount of the fungible token sent from the principal's address
- total_receivedstring
The total amount of the fungible token received by the principal's address
- non_fungible_tokensobject
Information about the non-fungible tokens associated with the principal:
- NftBalanceobject
An object containing information about the balance of non-fungible tokens:
- countstring
The total count of non-fungible tokens associated with the principal
- total_sentstring
The total amount of non-fungible tokens sent from the principal's address
- total_receivedstring
The total amount of non-fungible tokens received by the principal's address
- token_offering_lockedobject
Information about token offering locked amounts:
- total_lockedstring
The micro-STX amount still locked at the current block height
- total_unlockedstring
The micro-STX amount still unlocked at the current block height
- unlock_schedulearray
An array containing objects representing the scheduled unlocking of token offering amounts:
- amountstring
The micro-STX amount locked at this block height
- block_heightinteger
The block height when the token offering amount will be unlocked