Get inbound STX transfers

Retrieves a list of STX transfers with memos to the given principal.

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}/stx_inbound?limit={limit}&offset={offset}&height={height}&unanchored=true&until_block={until_block}" \

  -H 'Accept: application/json'
Response
{

  "limit": 20,

  "offset": 0,

  "total": 1,

  "results": [

    {

      "sender": "SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP",

      "amount": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",

      "memo": "",

      "block_height": 144000,

      "tx_id": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",

      "transfer_type": "bulk-send",

      "tx_index": 144000

    }

  ]

}

How is this guide?