Get inbound STX transfers

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 a the send-many-memo bulk sending contract.

Path Parameters
principal string — REQUIRED Stacks address or a Contract identifier

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. Note - Use either of the query parameters but not both at a time.

Responses

200 Success Schema — OPTIONAL limit integer Possible values: value ≤ 30 offset integer total integer results object[] sender string Principal that sent this transfer amount string Transfer amount in micro-STX as integer string memo string Hex encoded memo bytes associated with the transfer block_height number Block height at which this transfer occurred tx_id string The transaction ID in which this transfer occurred transfer_type string Possible values: [bulk-send, stx-transfer, stx-transfer-memo] Indicates if the transfer is from a stx-transfer transaction or a contract-call transaction tx_index number Index of the transaction within a block