Skip to main content

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

Retrieves a list of all transactions for a given address or contract identifier.

Updated on
Oct 4, 2023

/extended/v1/address/{principal}/transactions 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
array
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.
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'.
tx_status
string
The status of the transaction. Enum: 'pending', 'dropped_replace_by_fee', 'dropped_replace_across_fork', 'dropped_too_expensive', 'dropped_stale_garbage_collect'.
receipt_time
integer
A Unix timestamp (in seconds) indicating when the transaction broadcast was received by the node.
receipt_time_iso
string
An ISO 8601 timestamp (YYYY-MM-DDTHH:mm:ss.sssZ) indicating when the transaction broadcast was received by the node.
tx_type
string
The type of the transaction.
token_transfer
object
The token transfer object.
recipient_address
string
The recipient address.
amount
string
The transfer amount as an integer string (64-bit unsigned integer).
memo
string
The hex-encoded arbitrary message, up to 34 bytes length (should try decoding to an ASCII string).
Request
1
curl -X 'GET' \
2
    'https://docs-demo.stacks-mainnet.quiknode.pro/extended/v1/address/SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9/transactions' \
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