Get inbound STX transfers

GET

https://stacks.nownodes.io/extended/v1/address/{principal}/stx_inbound

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

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.

Parameters

limitinteger[0, 50]20query

Results per page

offsetinteger>= 00query

Result offset

heightintegerquery

Filter for transactions only at this given block height

unanchoredbooleanfalsequery

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

until_blockstringquery

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.

principalstring | stringrequiredpath

Response

200OK

Default Response

400Bad Request

Error Response

Get inbound STX transfers

curl -X GET 'https://stacks.nownodes.io/extended/v1/address/{principal}/stx_inbound'

const response = await fetch('https://stacks.nownodes.io/extended/v1/address/{principal}/stx_inbound', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/address/{principal}/stx_inbound')
request = Net::HTTP::Get.new(uri)

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

import requests

response = requests.get('https://stacks.nownodes.io/extended/v1/address/{principal}/stx_inbound')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v1/address/{principal}/stx_inbound', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/address/{principal}/stx_inbound";
const apiKey = "YOUR_API_KEY";

async function nownodesRequest(payload) {
  const response = await fetch(endpoint, {
    method: "GET",
    headers: {
      "Content-Type": "application/json",
      "api-key": apiKey,
    },
    body: JSON.stringify(payload),
  });

  return response.json();
}

const result = await nownodesRequest({});
console.log(result);

const response = await fetch('https://stacks.nownodes.io/extended/v1/address/{principal}/stx_inbound', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v1/address/{principal}/stx_inbound')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/address/{principal}/stx_inbound')
request = Net::HTTP::Get.new(uri)

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

{
  "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"
}