Skip to main content

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

Retrieves a list of STX transfers with memos to the given principal. This includes regular transfers from a stx-transfer transaction type, and transfers from contract-call transactions and the send-many-memo bulk sending contract.

Updated on
Oct 4, 2023

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

Path Parameters

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

Query Parameters

limit
integer
number of items to return.
offset
integer
number of items to skip.
height
number
Filter for transfers 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 a list of inbound STX transfers with a memo
limit
integer
The maximum number of transfers to be returned in the response.
offset
integer
The number of transfers to skip in the result set before starting to return transfers.
total
integer
The total count of inbound transfers associated with the principal (address).
results
array
An array containing the inbound transfers associated with the principal.
sender
string
The principal that sent this transfer.
amount
string
The transfer amount in micro-STX as an integer string.
memo
string
Hex-encoded memo bytes associated with the transfer.
block_height
number
The block height at which this transfer occurred.
tx_id
string
The transaction ID in which this transfer occurred.
transfer_type
string
An enumeration indicating if the transfer is from a stx-transfer transaction or a contract-call transaction. Possible values: 'bulk-send', 'stx-transfer'.
tx_index
number
The index of the transaction within a block.
Request
1
curl -X 'GET' \
2
    'https://docs-demo.stacks-mainnet.quiknode.pro/extended/v1/address/SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9/stx_inbound' \
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