Get inbound STX transfers

GET
/extended/v1/address/{principal}/stx_inbound

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.

Path parameters

`principal`
Required
string

Stacks address or a contract identifier

Example: "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0"

Query parameters

`limit`integer

Number of items to return

`offset`integer

Number of items to skip

Example: 42000

`height`number

Filter for transfers only at this given block height

`unanchored`boolean

Include transaction data from unanchored (i.e. unconfirmed) microblocks

Example: trueDefault: false

`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.

Example: 60000

Status code	Description
`200`	Success

Terminal

curl -X GET "https://api.mainnet.hiro.so/extended/v1/address/SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0/stx_inbound"

GET request that returns a list of inbound STX transfers with a memo

Example response

{
  "limit": 30,
  "offset": 0,
  "total": 0,
  "results": [
    {
      "sender": "string",
      "amount": "string",
      "memo": "string",
      "block_height": 0,
      "tx_id": "string",
      "transfer_type": "bulk-send",
      "tx_index": 0
    }
  ]
}

Get inbound STX transfers

GET/extended/v1/address/{principal}/stx_inbound

Path parameters

principalRequiredstring

Query parameters

limitinteger

offsetinteger

heightnumber

unanchoredboolean

until_blockstring

Schema