Get inbound STX transfers

Path Parameters

principalSTX Address & Smart Contract ID

Query Parameters

limit?Limit

Results per page

Default20

Rangevalue <= 50

offset?Offset

Result offset

Default0

height?integer

Filter for transactions only at this given block height

unanchored?boolean

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

Defaultfalse

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.

Response Body

Default Response

TypeScript Definitions

Use the response body type in TypeScript.

limitinteger

offsetinteger

totalinteger

resultsarray<InboundStxTransfer>

Default Response

TypeScript Definitions

Use the response body type in TypeScript.

errorstring

message?string

[key: string]any

curl -X GET "https://api.hiro.so//extended/v1/address/SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP/stx_inbound?limit=20&offset=0&height=0&unanchored=true&until_block=string"

fetch("https://api.hiro.so//extended/v1/address/SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP/stx_inbound?limit=20&offset=0&height=0&unanchored=true&until_block=string")

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://api.hiro.so//extended/v1/address/SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP/stx_inbound?limit=20&offset=0&height=0&unanchored=true&until_block=string"

  req, _ := http.NewRequest("GET", url, nil)
  
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "https://api.hiro.so//extended/v1/address/SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP/stx_inbound?limit=20&offset=0&height=0&unanchored=true&until_block=string"

response = requests.request("GET", url)

print(response.text)

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

{
  "error": "string",
  "message": "string"
}