Skip to main content

/extended/v1/address/{principal}/{tx_id}/with_transfers REST API Endpoint

Retrieves transaction details for a given Transcation Id tx_id, for a given account or contract Identifier.

Updated on
Oct 4, 2023

/extended/v1/address/{principal}/{tx_id}/with_transfers REST API Endpoint

Path Parameters

principal
string
REQUIRED
Stacks address or a contract identifier.
tx_id
string
REQUIRED
Transaction id.

Returns

object
Transaction with STX transfers for a given address
tx
object
Transaction object.
tx_id
string
Transaction ID.
nonce
integer
Used for ordering the transactions originating from and paying from an account. The nonce ensures that a transaction is processed at most once. The nonce counts the number of times an account's owner(s) have authorized a transaction. The first transaction from an account will have a nonce value equal to 0, the second will have a nonce value equal to 1, and so on.
fee_rate
string
Transaction fee as Integer string (64-bit unsigned integer).
sender_address
string
Address of the transaction initiator.
sponsor_nonce
integer
The nonce value
sponsored
boolean
Denotes whether the originating account is the same as the paying account.
sponsor_address
string
The sponsor address
post_condition_mode
string
Enum: 'allow', 'deny'
post_conditions
array
Array of post conditions.
principal
object
Principal object.
type_id
string
String literal of type - PostConditionPrincipalType.
condition_code
string
Enum: 'sent_equal_to', 'sent_greater_than', 'sent_greater_than_or_equal_to', 'sent_less_than', 'sent_less_than_or_equal_to'. A fungible condition code encodes a statement being made for either STX or a fungible token, with respect to the originating account.
amount
string
Amount as an integer string.
type
string
Value: 'STX'
anchor_mode
string
Enum: 'on_chain_only', 'off_chain_only', 'any'. The transaction MUST be included in an anchored block, the transaction MUST be included in a microblock, or the leader can choose where to include the transaction.
block_hash
string
Hash of the block this transaction was associated with.
block_height
integer
Height of the block this transaction was associated with.
burn_block_time
string
Unix timestamp (in seconds) indicating when this block was mined.
burn_block_time_iso
string
An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this block was mined.
parent_burn_block_time
string
Unix timestamp (in seconds) indicating when this parent block was mined.
parent_burn_block_time_iso
string
An ISO 8601 (YYYY-MM-DDTHH:mm:ss.sssZ) timestamp indicating when this parent block was mined.
canonical
array
Set to true if the block corresponds to the canonical chain tip.
tx_index
integer
Index of the transaction, indicating the order. Starts at 0 and increases with each transaction.
tx_status
string
Enum: 'success', 'abort_by_response', 'abort_by_post_condition'. Status of the transaction.
tx_result
object
Result of the transaction.
event_count
integer
Number of transaction events.
parent_block_hash
string
Hash of the previous block.
is_unanchored
boolean
True if the transaction is included in a microblock that has not been confirmed by an anchor block.
microblock_hash
string
The microblock hash that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock), then this value will be an empty string.
microblock_sequence
integer
The microblock sequence number that this transaction was streamed in. If the transaction was batched in an anchor block (not included within a microblock), then this value will be 2147483647 (0x7fffffff, the max int32 value). This value preserves logical transaction ordering on (block_height, microblock_sequence, tx_index).
microblock_canonical
boolean
Set to true if the microblock is anchored in the canonical chain tip, false if the transaction was orphaned in a micro-fork.
execution_cost_read_count
integer
The execution cost read count.
execution_cost_read_length
integer
The execution cost read length.
execution_cost_runtime
integer
The execution cost runtime.
execution_cost_write_count
integer
The execution cost write count.
execution_cost_write_length
integer
The execution cost write length.
events
array
Array of transaction events.
event_index
integer
Index of the event, indicating the order. Starts at 0 and increases with each event.
event_type
string
Enum: 'token_transfer', 'fungible_token_asset', 'non_fungible_token_asset', 'contract_call'. Type of event.
events
array
List of transaction events.
event_index
integer
Index of the event, indicating the order. Starts at 0 and increases with each event.
event_type
string
Type of the event.
tx_id
string
Transaction ID associated with the event.
contract_log
object
Details about the contract log.
tx_type
string
Type of the transaction (e.g., 'token_transfer').
token_transfer
object
Details about the token transfer.
recipient_address
string
The recipient address for the transfer.
amount
string
Transfer amount as an integer string.
memo
string
Hex encoded arbitrary message.
stx_sent
string
Total amount of STX sent from the given address, including the transaction fee, in micro-STX as an integer string.
stx_received
string
Total amount of STX received by the given address in micro-STX as an integer string.
stx_transfers
array
List of STX transfers.
amount
string
Amount transferred in micro-STX as an integer string.
sender
string
Principal that sent STX. Unspecified if the STX were minted.
recipient
string
Principal that received STX. Unspecified if the STX were burned.
ft_transfers
array
List of fungible token transfers.
asset_identifier
string
Fungible token asset identifier.
amount
string
Amount transferred as an integer string. This balance does not factor in possible SIP-010 decimals.
sender
string
Principal that sent the asset.
recipient
string
Principal that received the asset.
nft_transfers
array
List of non-fungible token transfers.
asset_identifier
string
Non-fungible token asset identifier.
value
object
Non-fungible token asset value.
hex
string
Hexadecimal representation of the asset value.
repr
string
String representation of the asset value.
Request
1
curl -X 'GET' \
2
    'https://docs-demo.stacks-mainnet.quiknode.pro/extended/v1/address/SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9/0x1e01488d26904013db088dc5710726fd789c34556cce4024c19cc35f4e8f6254/with_transfers' \
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