Skip to main content

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

Retrieves all transactions for an account or contract identifier including STX transfers for each transaction.

Updated on
Oct 4, 2023

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

Path Parameters

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

Query Parameters

limit
integer
max number of account transactions to fetch.
offset
integer
index of first account transaction to fetch.
height
number
Filter for transactions only at this given block height.
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 account transactions
limit
integer
The maximum number of transactions to be returned in the response.
offset
integer
The number of transactions to skip in the result set before starting to return transactions.
total
integer
The total count of transactions associated with the account.
results
array
An array containing the account transactions with transfers.
tx
object
The principal that received the asset.
tx_id
string
The transaction ID.
nonce
integer
The nonce used for ordering transactions originating from and paying from an account.
fee_rate
string
The transaction fee as an integer string (64-bit unsigned integer).
sender_address
string
The address of the transaction initiator.
sponsor_nonce
integer
The sponsor nonce.
sponsored
boolean
Denotes whether the originating account is the same as the paying account.
sponsor_address
string
The sponsor address.
post_condition_mode
string
The post-condition mode. Enum: 'allow', 'deny'.
post_conditions
array
An array containing the post-conditions associated with the transaction.
principal
object
The principal associated with the post-condition.
type_id
string
The string literal of the principal type.
condition_code
string
The condition code. Enum: 'sent_equal_to', 'sent_greater_than', 'sent_greater_than_or_equal_to', 'sent_less_than', 'sent_less_than_or_equal_to'.
amount
string
The amount associated with the post-condition as an integer string.
type
string
The type of the post-condition. Value: 'STX'.
anchor_mode
string
The anchor mode. Enum: 'on_chain_only', 'off_chain_only', 'any'.
block_hash
string
The hash of the block associated with this transaction.
block_height
integer
The height of the block associated with this transaction.
burn_block_time
string
A Unix timestamp (in seconds) indicating when this block was mined.
burn_block_time_iso
string
An ISO 8601 timestamp (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this block was mined.
parent_burn_block_time
string
A Unix timestamp (in seconds) indicating when this parent block was mined.
parent_burn_block_time_iso
string
An ISO 8601 timestamp (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when this parent block was mined.
canonical
array
An array denoting whether the block corresponds to the canonical chain tip.
tx_index
integer
The index of the transaction, indicating the order.
tx_status
string
The status of the transaction. Enum: 'success', 'abort_by_response', 'abort_by_post_condition'.
tx_result
object
The result of the transaction.
hex
string
The hexadecimal representation of the transaction.
repr
string
The string representation of the transaction.
event_count
integer
The number of transaction events.
parent_block_hash
string
The 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. Empty if the transaction was batched in an anchor block.
microblock_sequence
integer
The microblock sequence number that this transaction was streamed in. Max int32 value if the transaction was batched in an anchor block.
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
A list of transaction events.
event_index
integer
The index of the event.
event_type
string
The type of the event.
tx_id
string
The transaction ID.
contract_log
object
The contract log associated with the event.
tx_type
string
The type of the transaction. Value: 'token_transfer'.
token_transfer
object
The token transfer details.
recipient_address
string
The recipient address.
amount
string
The transfer amount as an integer string.
memo
string
The hex-encoded arbitrary message.
stx_sent
string
The total amount sent from the given address, including the transaction fee, in micro-STX as an integer string.
stx_received
string
The total amount received by the given address in micro-STX as an integer string.
stx_transfers
array
An array with the following information:
amount
string
Amount transferred in micro-STX as an integer string.
sender
string
Principal that sent STX. This is unspecified if the STX were minted.
recipient
string
Principal that received STX. This is unspecified if the STX were burned.
ft_transfers
array
An array with the following information:
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
An array with the following information:
asset_identifier
string
Non Fungible Token asset identifier.
value
object
Non Fungible Token asset value.
hex
string
The hex value
repr
string
The representation
sender
string
Principal that sent the asset.
recipient
string
Principal that received the asset.
Request
1
curl -X 'GET' \
2
'https://docs-demo.stacks-mainnet.quiknode.pro/extended/v1/address/SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9/transactions_with_transfers?limit=50&offset=42000' \
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