Get account transactions with transfers

Retrieves transactions for a specific account including STX transfers for each transaction.

GET

Parameters

Path Parameters

principal
REQUIRED
string

Query Parameters

limit
integer Results per page
offset
integer Result offset
height
integer Filter for transactions only at this given block height
unanchored
boolean Include data from unanchored (i.e. unconfirmed) microblocks
until_block
string Block hash or block height. Return data representing the state up until that point in time, rather than the current block. Note - Use either of the query parameters but not both at a time.
Status codeDescription
200Default Response
4XXDefault Response
cURL
curl -L \
"https://api.hiro.so/extended/v1/address/{principal}/transactions_with_transfers?limit={limit}&offset={offset}&height={height}&unanchored=true&until_block={until_block}" \
-H 'Accept: application/json'
Response
{
"limit": 20,
"offset": 0,
"total": 1,
"results": [
{
"tx": {
"tx_id": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
"nonce": 1,
"fee_rate": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
"sender_address": "SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP",
"sponsor_nonce": 0,
"sponsored": false,
"sponsor_address": "string",
"post_condition_mode": "allow",
"post_conditions": [
{
"principal": {
"type_id": "principal_origin"
},
"condition_code": "sent_equal_to",
"amount": "string",
"type": "stx"
}
],
"anchor_mode": "on_chain_only",
"block_hash": "0x4839a8b01cfb39ffcc0d07d3db31e848d5adf5279d529ed5062300b9f353ff79",
"block_height": 144000,
"block_time": 144000,
"block_time_iso": "string",
"burn_block_time": 144000,
"burn_block_height": 144000,
"burn_block_time_iso": "string",
"parent_burn_block_time": 144000,
"parent_burn_block_time_iso": "string",
"canonical": false,
"tx_index": 0,
"tx_status": "success",
"tx_result": {
"hex": "0x1234",
"repr": "value representation"
},
"event_count": 0,
"parent_block_hash": "0x4839a8b01cfb39ffcc0d07d3db31e848d5adf5279d529ed5062300b9f353ff79",
"is_unanchored": false,
"microblock_hash": "0x4839a8b01cfb39ffcc0d07d3db31e848d5adf5279d529ed5062300b9f353ff79",
"microblock_sequence": 0,
"microblock_canonical": false,
"execution_cost_read_count": 1,
"execution_cost_read_length": 0,
"execution_cost_runtime": 0,
"execution_cost_write_count": 1,
"execution_cost_write_length": 0,
"vm_error": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
"events": [
{
"event_index": 0,
"event_type": "smart_contract_log",
"tx_id": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
"contract_log": {
"contract_id": "SP000000000000000000002Q6VF78.pox-3",
"topic": "print",
"value": {
"hex": "0x1234",
"repr": "value representation"
}
}
}
],
"tx_type": "token_transfer",
"token_transfer": {
"recipient_address": "string",
"amount": "string",
"memo": ""
}
},
"stx_sent": "SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP",
"stx_received": "SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP",
"stx_transfers": [
{
"amount": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
"sender": "SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP",
"recipient": "SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP"
}
],
"ft_transfers": [
{
"amount": "string",
"asset_identifier": "string",
"sender": "SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP",
"recipient": "SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP"
}
],
"nft_transfers": [
{
"value": {
"hex": "0x1234",
"repr": "value representation"
},
"asset_identifier": "string",
"sender": "SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP",
"recipient": "SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP"
}
]
}
]
}

How is this guide?