Stacks Blockchain API

vv8.11.4

Base URL

https://stacks.nownodes.io

Authentication

api-keyAuthapiKey

API Key: api-key in header

Node

Accounts

Read-only endpoints to obtain Stacks account details

Get account assets

GET

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

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a list of all assets events associated with an account or a Contract Identifier. This includes Transfers, Mints.

Parameters

limitinteger[0, 100]20query

Results per page

offsetinteger>= 00query

Result offset

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 account assets

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

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/address/{principal}/assets')
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}/assets')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/address/{principal}/assets";
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}/assets', {
  method: 'GET',
});

const data = await response.json();

import requests

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

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/address/{principal}/assets')
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": [
    {
      "event_index": 0,
      "event_type": "smart_contract_log",
      "tx_id": "string",
      "contract_log": {
        "contract_id": "string",
        "topic": "string",
        "value": {
          "hex": "string",
          "repr": "string"
        }
      }
    }
  ]
}

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

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

Get the latest nonce used by an account

GET

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

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves the latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions.

Parameters

block_heightinteger>= 1query

Optionally get the nonce at a given block height.

block_hashstringquery

Optionally get the nonce at a given block hash. Note - Use either of the query parameters but not both at a time.

principalstring | stringrequiredpath

Response

200OK

The latest nonce values used by an account by inspecting the mempool, microblock transactions, and anchored transactions

400Bad Request

Error Response

Get the latest nonce used by an account

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

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/address/{principal}/nonces')
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}/nonces')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/address/{principal}/nonces";
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}/nonces', {
  method: 'GET',
});

const data = await response.json();

import requests

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

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/address/{principal}/nonces')
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)

{
  "last_mempool_tx_nonce": 0,
  "last_executed_tx_nonce": 0,
  "possible_next_nonce": 0,
  "detected_missing_nonces": [
    0
  ],
  "detected_mempool_nonces": [
    0
  ]
}

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

Get principal STX balance

GET

https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/stx

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves STX account balance information for a given Address or Contract Identifier.

Parameters

include_mempoolbooleanfalsequery

Include pending mempool transactions in the balance calculation

principalstring | stringrequiredpath

Response

200OK

Default Response

400Bad Request

Error Response

Get principal STX balance

curl -X GET 'https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/stx'

const response = await fetch('https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/stx', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/stx')
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/v2/addresses/{principal}/balances/stx')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/stx', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/stx";
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/v2/addresses/{principal}/balances/stx', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/stx')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/stx')
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)

{
  "balance": "string",
  "estimated_balance": "string",
  "pending_balance_inbound": "string",
  "pending_balance_outbound": "string",
  "total_sent": "string",
  "total_received": "string",
  "total_fees_sent": "string",
  "total_miner_rewards_received": "string",
  "lock_tx_id": "string",
  "locked": "string",
  "lock_height": 0,
  "burnchain_lock_height": 0,
  "burnchain_unlock_height": 0
}

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

Get principal FT balances

GET

https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/ft

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves Fungible-token account balance information for a given Address or Contract Identifier.

Parameters

limitinteger[0, 200]100query

Results per page

offsetinteger>= 00query

Result offset

principalstring | stringrequiredpath

Response

200OK

Default Response

400Bad Request

Error Response

Get principal FT balances

curl -X GET 'https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/ft'

const response = await fetch('https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/ft', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/ft')
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/v2/addresses/{principal}/balances/ft')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/ft', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/ft";
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/v2/addresses/{principal}/balances/ft', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/ft')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/ft')
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": [
    {
      "token": "string",
      "balance": "string"
    }
  ]
}

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

Get principal FT balance

GET

https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/ft/{token}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a specific fungible-token balance for a given principal.

Parameters

principalstring | stringrequiredpath

tokenstringrequiredpath

fungible token identifier

Response

200OK

Default Response

400Bad Request

Error Response

Get principal FT balance

curl -X GET 'https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/ft/{token}'

const response = await fetch('https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/ft/{token}', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/ft/{token}')
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/v2/addresses/{principal}/balances/ft/{token}')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/ft/{token}', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/ft/{token}";
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/v2/addresses/{principal}/balances/ft/{token}', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/ft/{token}')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/addresses/{principal}/balances/ft/{token}')
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)

{
  "balance": "string"
}

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

Blocks

Read-only endpoints to obtain Stacks block details

Get blocks

GET

https://stacks.nownodes.io/extended/v2/blocks

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a list of recently mined blocks

Parameters

limitinteger[0, 30]20query

Results per page

offsetinteger[-300, 300]0query

Result offset

cursorstringquery

Cursor for block pagination

Response

200OK

Default Response

400Bad Request

Error Response

Get blocks

curl -X GET 'https://stacks.nownodes.io/extended/v2/blocks/'

const response = await fetch('https://stacks.nownodes.io/extended/v2/blocks/', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/blocks/')
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/v2/blocks/')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v2/blocks/', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v2/blocks/";
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/v2/blocks/', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v2/blocks/')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/blocks/')
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,
  "next_cursor": "string",
  "prev_cursor": "string",
  "cursor": "string",
  "results": [
    {
      "canonical": true,
      "height": 0,
      "hash": "string",
      "block_time": 0,
      "block_time_iso": "string",
      "tenure_height": 0,
      "index_block_hash": "string",
      "parent_block_hash": "string",
      "parent_index_block_hash": "string",
      "burn_block_time": 0,
      "burn_block_time_iso": "string",
      "burn_block_hash": "string",
      "burn_block_height": 0,
      "miner_txid": "string",
      "tx_count": 0,
      "execution_cost_read_count": 0,
      "execution_cost_read_length": 0,
      "execution_cost_runtime": 0,
      "execution_cost_write_count": 0,
      "execution_cost_write_length": 0
    }
  ]
}

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

Get average block times

GET

https://stacks.nownodes.io/extended/v2/blocks/average-times

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves average block times (in seconds)

Response

200OK

Default Response

400Bad Request

Error Response

Get average block times

curl -X GET 'https://stacks.nownodes.io/extended/v2/blocks/average-times'

const response = await fetch('https://stacks.nownodes.io/extended/v2/blocks/average-times', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/blocks/average-times')
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/v2/blocks/average-times')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v2/blocks/average-times', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v2/blocks/average-times";
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/v2/blocks/average-times', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v2/blocks/average-times')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/blocks/average-times')
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)

{
  "last_1h": 0,
  "last_24h": 0,
  "last_7d": 0,
  "last_30d": 0
}

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

Get block

GET

https://stacks.nownodes.io/extended/v2/blocks/{height_or_hash}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a single block

Parameters

height_or_hashstring | string | integerrequiredpath

Response

200OK

Default Response

400Bad Request

Error Response

Get block

curl -X GET 'https://stacks.nownodes.io/extended/v2/blocks/{height_or_hash}'

const response = await fetch('https://stacks.nownodes.io/extended/v2/blocks/{height_or_hash}', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/blocks/{height_or_hash}')
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/v2/blocks/{height_or_hash}')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v2/blocks/{height_or_hash}', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v2/blocks/{height_or_hash}";
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/v2/blocks/{height_or_hash}', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v2/blocks/{height_or_hash}')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/blocks/{height_or_hash}')
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)

{
  "canonical": true,
  "height": 0,
  "hash": "string",
  "block_time": 0,
  "block_time_iso": "string",
  "tenure_height": 0,
  "index_block_hash": "string",
  "parent_block_hash": "string",
  "parent_index_block_hash": "string",
  "burn_block_time": 0,
  "burn_block_time_iso": "string",
  "burn_block_hash": "string",
  "burn_block_height": 0,
  "miner_txid": "string",
  "tx_count": 0,
  "execution_cost_read_count": 0,
  "execution_cost_read_length": 0,
  "execution_cost_runtime": 0,
  "execution_cost_write_count": 0,
  "execution_cost_write_length": 0
}

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

Get signer signatures for block

GET

https://stacks.nownodes.io/extended/v2/blocks/{height_or_hash}/signer-signatures

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves the signer signatures (an array of signature byte strings) in a single block

Parameters

limitinteger[0, 1000]500query

Results per page

offsetinteger>= 00query

Result offset

height_or_hashstring | string | integerrequiredpath

Response

200OK

Default Response

400Bad Request

Error Response

Get signer signatures for block

curl -X GET 'https://stacks.nownodes.io/extended/v2/blocks/{height_or_hash}/signer-signatures'

const response = await fetch('https://stacks.nownodes.io/extended/v2/blocks/{height_or_hash}/signer-signatures', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/blocks/{height_or_hash}/signer-signatures')
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/v2/blocks/{height_or_hash}/signer-signatures')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v2/blocks/{height_or_hash}/signer-signatures', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v2/blocks/{height_or_hash}/signer-signatures";
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/v2/blocks/{height_or_hash}/signer-signatures', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v2/blocks/{height_or_hash}/signer-signatures')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/blocks/{height_or_hash}/signer-signatures')
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": [
    "string"
  ]
}

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

Get blocks by tenure

GET

https://stacks.nownodes.io/extended/v2/block-tenures/{tenure_height}/blocks

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves blocks confirmed in a block tenure

Parameters

limitinteger[0, 30]20query

Results per page

offsetinteger[-300, 300]0query

Result offset

cursorstringquery

Cursor for block pagination

tenure_heightinteger>= 0requiredpath

Block tenure height

Response

200OK

Default Response

400Bad Request

Error Response

Get blocks by tenure

curl -X GET 'https://stacks.nownodes.io/extended/v2/block-tenures/{tenure_height}/blocks'

const response = await fetch('https://stacks.nownodes.io/extended/v2/block-tenures/{tenure_height}/blocks', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/block-tenures/{tenure_height}/blocks')
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/v2/block-tenures/{tenure_height}/blocks')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v2/block-tenures/{tenure_height}/blocks', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v2/block-tenures/{tenure_height}/blocks";
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/v2/block-tenures/{tenure_height}/blocks', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v2/block-tenures/{tenure_height}/blocks')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/block-tenures/{tenure_height}/blocks')
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,
  "next_cursor": "string",
  "prev_cursor": "string",
  "cursor": "string",
  "results": [
    {
      "canonical": true,
      "height": 0,
      "hash": "string",
      "block_time": 0,
      "block_time_iso": "string",
      "tenure_height": 0,
      "index_block_hash": "string",
      "parent_block_hash": "string",
      "parent_index_block_hash": "string",
      "burn_block_time": 0,
      "burn_block_time_iso": "string",
      "burn_block_hash": "string",
      "burn_block_height": 0,
      "miner_txid": "string",
      "tx_count": 0,
      "execution_cost_read_count": 0,
      "execution_cost_read_length": 0,
      "execution_cost_runtime": 0,
      "execution_cost_write_count": 0,
      "execution_cost_write_length": 0
    }
  ]
}

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

Burn Blocks

Read-only endpoints to obtain burn block details

Get burn blocks

GET

https://stacks.nownodes.io/extended/v2/burn-blocks

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a list of recent burn blocks

Parameters

limitinteger[0, 30]20query

Results per page

offsetinteger>= 00query

Result offset

Response

200OK

Default Response

400Bad Request

Error Response

Get burn blocks

curl -X GET 'https://stacks.nownodes.io/extended/v2/burn-blocks/'

const response = await fetch('https://stacks.nownodes.io/extended/v2/burn-blocks/', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/burn-blocks/')
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/v2/burn-blocks/')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v2/burn-blocks/', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v2/burn-blocks/";
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/v2/burn-blocks/', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v2/burn-blocks/')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/burn-blocks/')
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": [
    {
      "burn_block_time": 0,
      "burn_block_time_iso": "string",
      "burn_block_hash": "string",
      "burn_block_height": 0,
      "stacks_blocks": [
        "string"
      ],
      "avg_block_time": 0,
      "total_tx_count": 0
    }
  ]
}

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

Get burn block

GET

https://stacks.nownodes.io/extended/v2/burn-blocks/{height_or_hash}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a single burn block

Parameters

height_or_hashstring | string | integerrequiredpath

Response

200OK

Default Response

400Bad Request

Error Response

Get burn block

curl -X GET 'https://stacks.nownodes.io/extended/v2/burn-blocks/{height_or_hash}'

const response = await fetch('https://stacks.nownodes.io/extended/v2/burn-blocks/{height_or_hash}', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/burn-blocks/{height_or_hash}')
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/v2/burn-blocks/{height_or_hash}')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v2/burn-blocks/{height_or_hash}', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v2/burn-blocks/{height_or_hash}";
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/v2/burn-blocks/{height_or_hash}', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v2/burn-blocks/{height_or_hash}')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/burn-blocks/{height_or_hash}')
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)

{
  "burn_block_time": 0,
  "burn_block_time_iso": "string",
  "burn_block_hash": "string",
  "burn_block_height": 0,
  "stacks_blocks": [
    "string"
  ],
  "avg_block_time": 0,
  "total_tx_count": 0
}

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

Get blocks by burn block

GET

https://stacks.nownodes.io/extended/v2/burn-blocks/{height_or_hash}/blocks

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a list of blocks confirmed by a specific burn block

Parameters

limitinteger[0, 30]20query

Results per page

offsetinteger>= 00query

Result offset

height_or_hashstring | string | integerrequiredpath

Response

200OK

Default Response

400Bad Request

Error Response

Get blocks by burn block

curl -X GET 'https://stacks.nownodes.io/extended/v2/burn-blocks/{height_or_hash}/blocks'

const response = await fetch('https://stacks.nownodes.io/extended/v2/burn-blocks/{height_or_hash}/blocks', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/burn-blocks/{height_or_hash}/blocks')
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/v2/burn-blocks/{height_or_hash}/blocks')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v2/burn-blocks/{height_or_hash}/blocks', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v2/burn-blocks/{height_or_hash}/blocks";
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/v2/burn-blocks/{height_or_hash}/blocks', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v2/burn-blocks/{height_or_hash}/blocks')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/burn-blocks/{height_or_hash}/blocks')
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": [
    {
      "canonical": true,
      "height": 0,
      "hash": "string",
      "block_time": 0,
      "block_time_iso": "string",
      "tenure_height": 0,
      "index_block_hash": "string",
      "parent_block_hash": "string",
      "parent_index_block_hash": "string",
      "burn_block_time": 0,
      "burn_block_time_iso": "string",
      "burn_block_hash": "string",
      "burn_block_height": 0,
      "miner_txid": "string",
      "tx_count": 0,
      "execution_cost_read_count": 0,
      "execution_cost_read_length": 0,
      "execution_cost_runtime": 0,
      "execution_cost_write_count": 0,
      "execution_cost_write_length": 0
    }
  ]
}

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

Faucets

Endpoints to request STX or BTC tokens (not possible on Mainnet)

Add regtest BTC tokens to address

POST

https://stacks.nownodes.io/extended/v1/faucets/btc

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Add 0.01 BTC token to the specified regtest BTC address.

Copied!

    The endpoint returns the transaction ID, which you can use to view the transaction in a regtest Bitcoin block
    explorer. The tokens are delivered once the transaction has been included in a block.

    **Note:** This is a Bitcoin regtest-only endpoint. This endpoint will not work on the Bitcoin mainnet.

Body

application/json

Any of

addressstring

A valid regtest BTC address

Parameters

addressstringquery

A valid regtest BTC address

largebooleanfalsequery

Request a large amount of regtest BTC than the default

xlargebooleanfalsequery

Request an extra large amount of regtest BTC than the default

Response

200OK

POST request that initiates a transfer of tokens to a specified Bitcoin regtest address

400Bad Request

Error Response

Add regtest BTC tokens to address

curl -X POST 'https://stacks.nownodes.io/extended/v1/faucets/btc' \
  -H 'Content-Type: application/json' \
  -d '{
    "address": [
      "2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts"
    ]
  }'

const response = await fetch('https://stacks.nownodes.io/extended/v1/faucets/btc', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "address": [
        "2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts"
      ]
    }),
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/faucets/btc')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "address": [
      "2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts"
    ]
  }'

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

import requests

payload = {
  "address": [
    "2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts"
  ]
}

response = requests.post('https://stacks.nownodes.io/extended/v1/faucets/btc', json=payload)
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v1/faucets/btc', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "address": [
        "2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts"
      ]
    }),
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/faucets/btc";
const apiKey = "YOUR_API_KEY";

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

  return response.json();
}

const result = await nownodesRequest({
    "address": [
      "2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts"
    ]
  });
console.log(result);

const response = await fetch('https://stacks.nownodes.io/extended/v1/faucets/btc', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "address": [
        "2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts"
      ]
    }),
});

const data = await response.json();

import requests

payload = {
  "address": [
    "2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts"
  ]
}

response = requests.post('https://stacks.nownodes.io/extended/v1/faucets/btc', json=payload)
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/faucets/btc')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "address": [
      "2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts"
    ]
  }'

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

Request Body

{
  "address": [
    "2N4M94S1ZPt8HfxydXzL2P7qyzgVq7MHWts"
  ]
}

{
  "success": true,
  "txid": "string",
  "raw_tx": "string"
}

{
  "success": false,
  "error": "string"
}

Get BTC balance for address

GET

https://stacks.nownodes.io/extended/v1/faucets/btc/{address}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Parameters

addressstringrequiredpath

A valid regtest BTC address

Response

200OK

Default Response

400Bad Request

Error Response

Get BTC balance for address

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

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/faucets/btc/{address}')
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/faucets/btc/{address}')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/faucets/btc/{address}";
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/faucets/btc/{address}', {
  method: 'GET',
});

const data = await response.json();

import requests

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

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/faucets/btc/{address}')
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)

{
  "balance": 0
}

{
  "success": false,
  "error": "string"
}

Get STX testnet tokens

POST

https://stacks.nownodes.io/extended/v1/faucets/stx

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Add 500 STX tokens to the specified testnet address. Testnet STX addresses begin with ST. If the stacking parameter is set to true, the faucet will add the required number of tokens for individual stacking to the specified testnet address.

Copied!

    The endpoint returns the transaction ID, which you can use to view the transaction in the
    [Stacks Explorer](https://explorer.hiro.so/?chain=testnet). The tokens are delivered once the transaction has
    been included in an anchor block.

    A common reason for failed faucet transactions is that the faucet has run out of tokens. If you are experiencing
    failed faucet transactions to a testnet address, you can get help in [Discord](https://stacks.chat).

    **Note:** This is a testnet only endpoint. This endpoint will not work on the mainnet.

Body

application/json

Any of

addressstring

[Deprecated -- use query param rather than POST body] A valid testnet STX address

Parameters

addressstringquery

A valid testnet STX address

stackingbooleanfalsequery

Request the amount of STX tokens needed for individual address stacking

Response

200OK

POST request that initiates a transfer of tokens to a specified testnet address

400Bad Request

Error Response

Get STX testnet tokens

curl -X POST 'https://stacks.nownodes.io/extended/v1/faucets/stx' \
  -H 'Content-Type: application/json' \
  -d '{
    "address": [
      "ST3M7N9Q9HDRM7RVP1Q26P0EE69358PZZAZD7KMXQ"
    ]
  }'

const response = await fetch('https://stacks.nownodes.io/extended/v1/faucets/stx', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "address": [
        "ST3M7N9Q9HDRM7RVP1Q26P0EE69358PZZAZD7KMXQ"
      ]
    }),
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/faucets/stx')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "address": [
      "ST3M7N9Q9HDRM7RVP1Q26P0EE69358PZZAZD7KMXQ"
    ]
  }'

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

import requests

payload = {
  "address": [
    "ST3M7N9Q9HDRM7RVP1Q26P0EE69358PZZAZD7KMXQ"
  ]
}

response = requests.post('https://stacks.nownodes.io/extended/v1/faucets/stx', json=payload)
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v1/faucets/stx', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "address": [
        "ST3M7N9Q9HDRM7RVP1Q26P0EE69358PZZAZD7KMXQ"
      ]
    }),
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/faucets/stx";
const apiKey = "YOUR_API_KEY";

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

  return response.json();
}

const result = await nownodesRequest({
    "address": [
      "ST3M7N9Q9HDRM7RVP1Q26P0EE69358PZZAZD7KMXQ"
    ]
  });
console.log(result);

const response = await fetch('https://stacks.nownodes.io/extended/v1/faucets/stx', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "address": [
        "ST3M7N9Q9HDRM7RVP1Q26P0EE69358PZZAZD7KMXQ"
      ]
    }),
});

const data = await response.json();

import requests

payload = {
  "address": [
    "ST3M7N9Q9HDRM7RVP1Q26P0EE69358PZZAZD7KMXQ"
  ]
}

response = requests.post('https://stacks.nownodes.io/extended/v1/faucets/stx', json=payload)
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/faucets/stx')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "address": [
      "ST3M7N9Q9HDRM7RVP1Q26P0EE69358PZZAZD7KMXQ"
    ]
  }'

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

Request Body

{
  "address": [
    "ST3M7N9Q9HDRM7RVP1Q26P0EE69358PZZAZD7KMXQ"
  ]
}

{
  "success": true,
  "txId": "string",
  "txRaw": "string"
}

{
  "success": false,
  "error": "string",
  "help": "string"
}

Info

Read-only endpoints to obtain network, Proof-of-Transfer, Stacking, STX token, and node information

API status

GET

https://stacks.nownodes.io/extended

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves the running status of the Stacks Blockchain API, including the server version and current chain tip information.

Response

200OK

Default Response

400Bad Request

Error Response

API status

curl -X GET 'https://stacks.nownodes.io/extended'

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended')
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')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended";
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', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended')
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)

{
  "server_version": "string",
  "status": "string",
  "pox_v1_unlock_height": 0,
  "pox_v2_unlock_height": 0,
  "pox_v3_unlock_height": 0,
  "chain_tip": {
    "block_height": 0,
    "block_hash": "string",
    "index_block_hash": "string",
    "microblock_hash": "string",
    "microblock_sequence": 0,
    "burn_block_height": 0
  }
}

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

Get total and unlocked STX supply

GET

https://stacks.nownodes.io/extended/v1/stx_supply

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves the total and unlocked STX supply. More information on Stacking can be found [here] (https://docs.stacks.co/understand-stacks/stacking).

Parameters

heightinteger>= 0query

Supply details are queried from specified block height. If the block height is not specified, the latest block height is taken as default value. Note that the block height is referred to the stacks blockchain.

unanchoredbooleanfalsequery

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

Response

200OK

GET request that returns network target block times

400Bad Request

Error Response

Get total and unlocked STX supply

curl -X GET 'https://stacks.nownodes.io/extended/v1/stx_supply/'

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/stx_supply/')
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/stx_supply/')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/stx_supply/";
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/stx_supply/', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v1/stx_supply/')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/stx_supply/')
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)

{
  "unlocked_percent": "string",
  "total_stx": "string",
  "total_stx_year_2050": "string",
  "unlocked_stx": "string",
  "block_height": 0
}

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

Get the network target block time

GET

https://stacks.nownodes.io/extended/v1/info/network_block_times

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves the target block times for mainnet and testnet. The block time is hardcoded and will change throughout the implementation phases of the testnet.

Response

200OK

GET request that returns network target block times

400Bad Request

Error Response

Get the network target block time

curl -X GET 'https://stacks.nownodes.io/extended/v1/info/network_block_times'

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/info/network_block_times')
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/info/network_block_times')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/info/network_block_times";
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/info/network_block_times', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v1/info/network_block_times')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/info/network_block_times')
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)

{
  "mainnet": {
    "target_block_time": 0
  },
  "testnet": {
    "target_block_time": 0
  }
}

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

Get a given network's target block time

GET

https://stacks.nownodes.io/extended/v1/info/network_block_time/{network}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves the target block time for a given network. The network can be mainnet or testnet. The block time is hardcoded and will change throughout the implementation phases of the testnet.

Parameters

networkstring | stringrequiredpath

Response

200OK

GET request that target block time for a given network

400Bad Request

Error Response

Get a given network's target block time

curl -X GET 'https://stacks.nownodes.io/extended/v1/info/network_block_time/{network}'

const response = await fetch('https://stacks.nownodes.io/extended/v1/info/network_block_time/{network}', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/info/network_block_time/{network}')
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/info/network_block_time/{network}')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v1/info/network_block_time/{network}', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/info/network_block_time/{network}";
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/info/network_block_time/{network}', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v1/info/network_block_time/{network}')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/info/network_block_time/{network}')
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)

{
  "target_block_time": 0
}

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

Microblocks

Read-only endpoints to obtain microblocks details

Get recent microblocks

GET

https://stacks.nownodes.io/extended/v1/microblock

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a list of microblocks.

Copied!

      If you need to actively monitor new microblocks, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.

Parameters

limitinteger[0, 200]20query

Max number of microblocks to fetch

offsetinteger>= 00query

Result offset

Response

200OK

GET request that returns microblocks

400Bad Request

Error Response

Get recent microblocks

curl -X GET 'https://stacks.nownodes.io/extended/v1/microblock/'

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/microblock/')
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/microblock/')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/microblock/";
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/microblock/', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v1/microblock/')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/microblock/')
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": [
    {
      "canonical": true,
      "microblock_canonical": true,
      "microblock_hash": "string",
      "microblock_sequence": 0,
      "microblock_parent_hash": "string",
      "block_height": 0,
      "parent_block_height": 0,
      "parent_block_hash": "string",
      "parent_burn_block_hash": "string",
      "parent_burn_block_time": 0,
      "parent_burn_block_time_iso": "string",
      "parent_burn_block_height": 0,
      "block_hash": "string",
      "txs": [
        "string"
      ]
    }
  ]
}

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

Get microblock

GET

https://stacks.nownodes.io/extended/v1/microblock/{hash}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a specific microblock by hash

Parameters

hashstringrequiredpath

Hash of the microblock

Response

200OK

A microblock

400Bad Request

Error Response

Get microblock

curl -X GET 'https://stacks.nownodes.io/extended/v1/microblock/{hash}'

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/microblock/{hash}')
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/microblock/{hash}')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/microblock/{hash}";
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/microblock/{hash}', {
  method: 'GET',
});

const data = await response.json();

import requests

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

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/microblock/{hash}')
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)

{
  "canonical": true,
  "microblock_canonical": true,
  "microblock_hash": "string",
  "microblock_sequence": 0,
  "microblock_parent_hash": "string",
  "block_height": 0,
  "parent_block_height": 0,
  "parent_block_hash": "string",
  "parent_burn_block_hash": "string",
  "parent_burn_block_time": 0,
  "parent_burn_block_time_iso": "string",
  "parent_burn_block_height": 0,
  "block_hash": "string",
  "txs": [
    "string"
  ]
}

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

Get the list of current transactions that belong to unanchored microblocks

GET

https://stacks.nownodes.io/extended/v1/microblock/unanchored/txs

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves transactions that have been streamed in microblocks but not yet accepted or rejected in an anchor block

Response

200OK

Default Response

400Bad Request

Error Response

Get the list of current transactions that belong to unanchored microblocks

curl -X GET 'https://stacks.nownodes.io/extended/v1/microblock/unanchored/txs'

const response = await fetch('https://stacks.nownodes.io/extended/v1/microblock/unanchored/txs', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/microblock/unanchored/txs')
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/microblock/unanchored/txs')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v1/microblock/unanchored/txs', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/microblock/unanchored/txs";
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/microblock/unanchored/txs', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v1/microblock/unanchored/txs')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/microblock/unanchored/txs')
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)

{
  "total": 0,
  "results": [
    {
      "tx_id": "string",
      "nonce": 0,
      "fee_rate": "string",
      "sender_address": "string",
      "sponsor_nonce": 0,
      "sponsored": true,
      "sponsor_address": "string",
      "post_condition_mode": "allow",
      "post_conditions": [
        {
          "principal": {
            "type_id": "principal_origin"
          },
          "condition_code": "sent_equal_to",
          "amount": "string",
          "type": "stx"
        }
      ],
      "anchor_mode": "on_chain_only",
      "block_hash": "string",
      "block_height": 0,
      "block_time": 0,
      "block_time_iso": "string",
      "burn_block_time": 0,
      "burn_block_height": 0,
      "burn_block_time_iso": "string",
      "parent_burn_block_time": 0,
      "parent_burn_block_time_iso": "string",
      "canonical": true,
      "tx_index": 0,
      "tx_status": "success",
      "tx_result": {
        "hex": "string",
        "repr": "string"
      },
      "event_count": 0,
      "parent_block_hash": "string",
      "is_unanchored": true,
      "microblock_hash": "string",
      "microblock_sequence": 0,
      "microblock_canonical": true,
      "execution_cost_read_count": 0,
      "execution_cost_read_length": 0,
      "execution_cost_runtime": 0,
      "execution_cost_write_count": 0,
      "execution_cost_write_length": 0,
      "vm_error": "string",
      "events": [
        {
          "event_index": 0,
          "event_type": "smart_contract_log",
          "tx_id": "string",
          "contract_log": {
            "contract_id": "string",
            "topic": "string",
            "value": {
              "hex": "string",
              "repr": "string"
            }
          }
        }
      ],
      "tx_type": "token_transfer",
      "token_transfer": {
        "recipient_address": "string",
        "amount": "string",
        "memo": "string"
      }
    }
  ]
}

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

Names

Read-only endpoints realted to the Blockchain Naming System on Stacks

Get Historical Zone File

GET

https://stacks.nownodes.io/v1/names/{name}/zonefile/{zoneFileHash}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves the historical zonefile specified by the username and zone hash.

Parameters

unanchoredbooleanfalsequery

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

namestringrequiredpath

fully-qualified name

zoneFileHashstringrequiredpath

zone file hash

Response

200OK

Fetches the historical zonefile specified by the username and zone hash.

400Bad Request

Error

Get Historical Zone File

curl -X GET 'https://stacks.nownodes.io/v1/names/{name}/zonefile/{zoneFileHash}'

const response = await fetch('https://stacks.nownodes.io/v1/names/{name}/zonefile/{zoneFileHash}', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/v1/names/{name}/zonefile/{zoneFileHash}')
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/v1/names/{name}/zonefile/{zoneFileHash}')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/v1/names/{name}/zonefile/{zoneFileHash}', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/v1/names/{name}/zonefile/{zoneFileHash}";
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/v1/names/{name}/zonefile/{zoneFileHash}', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v1/names/{name}/zonefile/{zoneFileHash}')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/v1/names/{name}/zonefile/{zoneFileHash}')
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)

{
  "zonefile": "string"
}

{
  "error": "string"
}

Get Name Subdomains

GET

https://stacks.nownodes.io/v1/names/{name}/subdomains

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves the list of subdomains for a specific name

Parameters

unanchoredbooleanfalsequery

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

namestringrequiredpath

fully-qualified name

Response

200OK

Fetch a list of subdomains in a name.

400Bad Request

Error Response

Get Name Subdomains

curl -X GET 'https://stacks.nownodes.io/v1/names/{name}/subdomains'

const response = await fetch('https://stacks.nownodes.io/v1/names/{name}/subdomains', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/v1/names/{name}/subdomains')
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/v1/names/{name}/subdomains')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/v1/names/{name}/subdomains', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/v1/names/{name}/subdomains";
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/v1/names/{name}/subdomains', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v1/names/{name}/subdomains')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/v1/names/{name}/subdomains')
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)

[
  "address_test.id.blockstack",
  "previous_subdomain.id.blockstack",
  "subdomain.id.blockstack",
  "zonefile_test.id.blockstack",
  "zone_test.id.blockstack"
]

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

Get Zone File

GET

https://stacks.nownodes.io/v1/names/{name}/zonefile

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a user's raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files.

Parameters

unanchoredbooleanfalsequery

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

namestringrequiredpath

fully-qualified name

Response

200OK

Fetch a user's raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files.

400Bad Request

Error

Get Zone File

curl -X GET 'https://stacks.nownodes.io/v1/names/{name}/zonefile'

const response = await fetch('https://stacks.nownodes.io/v1/names/{name}/zonefile', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/v1/names/{name}/zonefile')
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/v1/names/{name}/zonefile')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/v1/names/{name}/zonefile', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/v1/names/{name}/zonefile";
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/v1/names/{name}/zonefile', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v1/names/{name}/zonefile')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/v1/names/{name}/zonefile')
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)

{
  "zonefile": "$ORIGIN bar.test\n$TTL 3600\n_https._tcp URI 10 1 \"https://gaia.blockstack.org/hub/17Zijx61Sp7SbVfRTdETo7PhizJHYEUxbY/profile.json\"\n"
}

{
  "error": "Invalid name or subdomain"
}

Get All Names

GET

https://stacks.nownodes.io/v1/names

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a list of all names known to the node.

Parameters

unanchoredbooleanfalsequery

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

pageinteger>= 00query

names are defaulted to page 1 with 100 results. You can query specific page results by using the 'page' query parameter.

Response

200OK

Fetch a list of all names known to the node.

400Bad Request

Error

Get All Names

curl -X GET 'https://stacks.nownodes.io/v1/names/'

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/v1/names/')
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/v1/names/')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/v1/names/";
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/v1/names/', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v1/names/')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/v1/names/')
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)

{
  "aldenquimby.id": {
    "value": "aldenquimby.id"
  },
  "aldeoryn.id": {
    "value": "aldeoryn.id"
  },
  "alderete.id": {
    "value": "alderete.id"
  },
  "aldert.id": {
    "value": "aldert.id"
  },
  "aldi.id": {
    "value": "aldi.id"
  },
  "aldighieri.id": {
    "value": "aldighieri.id"
  }
}

{
  "error": "string"
}

Get Name Details

GET

https://stacks.nownodes.io/v1/names/{name}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves details of a given name including the address, status and last transaction id - last_txid.

Parameters

unanchoredbooleanfalsequery

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

namestringrequiredpath

fully-qualified name

Response

200OK

Get name details

400Bad Request

Error Response

Get Name Details

curl -X GET 'https://stacks.nownodes.io/v1/names/{name}'

const response = await fetch('https://stacks.nownodes.io/v1/names/{name}', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/v1/names/{name}')
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/v1/names/{name}')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/v1/names/{name}', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/v1/names/{name}";
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/v1/names/{name}', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v1/names/{name}')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/v1/names/{name}')
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)

{
  "address": "1J3PUxY5uDShUnHRrMyU6yKtoHEUPhKULs",
  "blockchain": "stacks",
  "expire_block": 599266,
  "grace_period": false,
  "last_txid": "1edfa419f7b83f33e00830bc9409210da6c6d1db60f99eda10c835aa339cad6b",
  "renewal_deadline": 604266,
  "resolver": null,
  "status": "registered",
  "zonefile": "$ORIGIN muneeb.id\n$TTL 3600\n_http._tcp IN URI 10 1 \"https://gaia.blockstack.org/hub/1J3PUxY5uDShUnHRrMyU6yKtoHEUPhKULs/0/profile.json\"\n",
  "zonefile_hash": "37aecf837c6ae9bdc9dbd98a268f263dacd00361"
}

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

Get All Namespaces

GET

https://stacks.nownodes.io/v1/namespaces

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a list of all namespaces known to the node.

Parameters

unanchoredbooleanfalsequery

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

Response

200OK

Default Response

400Bad Request

Error Response

Get All Namespaces

curl -X GET 'https://stacks.nownodes.io/v1/namespaces/'

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/v1/namespaces/')
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/v1/namespaces/')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/v1/namespaces/";
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/v1/namespaces/', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v1/namespaces/')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/v1/namespaces/')
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)

{
  "namespaces": [
    "string"
  ]
}

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

Get Namespace Names

GET

https://stacks.nownodes.io/v1/namespaces/{tld}/names

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a list of names within a given namespace.

Parameters

pagenumberquery

namespace values are defaulted to page 1 with 100 results. You can query specific page results by using the 'page' query parameter.

unanchoredbooleanfalsequery

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

tldstringrequiredpath

the namespace to fetch names from.

Response

200OK

Fetch a list of names from the namespace.

400Bad Request

Error Response

Get Namespace Names

curl -X GET 'https://stacks.nownodes.io/v1/namespaces/{tld}/names'

const response = await fetch('https://stacks.nownodes.io/v1/namespaces/{tld}/names', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/v1/namespaces/{tld}/names')
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/v1/namespaces/{tld}/names')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/v1/namespaces/{tld}/names', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/v1/namespaces/{tld}/names";
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/v1/namespaces/{tld}/names', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v1/namespaces/{tld}/names')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/v1/namespaces/{tld}/names')
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)

[
  "aldenquimby.id",
  "aldeoryn.id",
  "alderete.id",
  "aldert.id",
  "aldi.id",
  "aldighieri.id"
]

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

Get Names Owned by Address

GET

https://stacks.nownodes.io/v1/addresses/{blockchain}/{address}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a list of names owned by the address provided.

Parameters

unanchoredbooleanfalsequery

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

blockchainstringrequiredpath

the layer-1 blockchain for the address

addressstringrequiredpath

the address to lookup

Response

200OK

Retrieves a list of names owned by the address provided.

400Bad Request

Error Response

Get Names Owned by Address

curl -X GET 'https://stacks.nownodes.io/v1/addresses/{blockchain}/{address}'

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/v1/addresses/{blockchain}/{address}')
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/v1/addresses/{blockchain}/{address}')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/v1/addresses/{blockchain}/{address}";
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/v1/addresses/{blockchain}/{address}', {
  method: 'GET',
});

const data = await response.json();

import requests

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

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/v1/addresses/{blockchain}/{address}')
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)

{
  "names": [
    "muneeb.id"
  ]
}

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

Get Namespace Price

GET

https://stacks.nownodes.io/v2/prices/namespaces/{tld}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves the price of a namespace. The amount given will be in the smallest possible units of the currency.

Parameters

tldstringrequiredpath

the namespace to fetch price for

Response

200OK

Fetch price for namespace.

400Bad Request

Error Response

Get Namespace Price

curl -X GET 'https://stacks.nownodes.io/v2/prices/namespaces/{tld}'

const response = await fetch('https://stacks.nownodes.io/v2/prices/namespaces/{tld}', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/v2/prices/namespaces/{tld}')
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/v2/prices/namespaces/{tld}')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/v2/prices/namespaces/{tld}', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/v2/prices/namespaces/{tld}";
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/v2/prices/namespaces/{tld}', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v2/prices/namespaces/{tld}')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/v2/prices/namespaces/{tld}')
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)

{
  "units": "string",
  "amount": "string"
}

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

Get Name Price

GET

https://stacks.nownodes.io/v2/prices/names/{name}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves the price of a name. The amount given will be in the smallest possible units of the currency.

Parameters

namestringrequiredpath

the name to query price information for

Response

200OK

Fetch price for name.

400Bad Request

Error Response

Get Name Price

curl -X GET 'https://stacks.nownodes.io/v2/prices/names/{name}'

const response = await fetch('https://stacks.nownodes.io/v2/prices/names/{name}', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/v2/prices/names/{name}')
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/v2/prices/names/{name}')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/v2/prices/names/{name}', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/v2/prices/names/{name}";
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/v2/prices/names/{name}', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v2/prices/names/{name}')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/v2/prices/names/{name}')
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)

{
  "units": "string",
  "amount": "string"
}

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

Non-Fungible Tokens

Read-only endpoints to obtain non-fungible token details

Non-Fungible Token holdings

GET

https://stacks.nownodes.io/extended/v1/tokens/nft/holdings

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves the list of Non-Fungible Tokens owned by the given principal (STX address or Smart Contract ID). Results can be filtered by one or more asset identifiers and can include metadata about the transaction that made the principal own each token.

Copied!

    More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).

Parameters

principalstring | stringrequiredquery

asset_identifiersArray<string>query

limitinteger[0, 200]50query

max number of tokens to fetch

offsetinteger>= 00query

index of first tokens to fetch

tx_metadatabooleanfalserequiredquery

whether or not to include the complete transaction metadata instead of just tx_id. Enabling this option can affect performance and response times.

Response

200OK

List of Non-Fungible Token holdings

400Bad Request

Error Response

Non-Fungible Token holdings

curl -X GET 'https://stacks.nownodes.io/extended/v1/tokens/nft/holdings'

const response = await fetch('https://stacks.nownodes.io/extended/v1/tokens/nft/holdings', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/tokens/nft/holdings')
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/tokens/nft/holdings')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v1/tokens/nft/holdings', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/tokens/nft/holdings";
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/tokens/nft/holdings', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v1/tokens/nft/holdings')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/tokens/nft/holdings')
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": [
    {
      "asset_identifier": "string",
      "value": {
        "hex": "string",
        "repr": "string"
      },
      "block_height": 0,
      "tx_id": "string"
    }
  ]
}

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

Non-Fungible Token history

GET

https://stacks.nownodes.io/extended/v1/tokens/nft/history

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves all events relevant to a Non-Fungible Token. Useful to determine the ownership history of a particular asset.

Copied!

    More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).

Parameters

asset_identifierstringrequiredquery

asset class identifier

valuestringrequiredquery

hex representation of the token's unique value

limitinteger[0, 200]50query

max number of events to fetch

offsetinteger>= 00query

index of first event to fetch

unanchoredbooleanfalsequery

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

tx_metadatabooleanfalserequiredquery

whether or not to include the complete transaction metadata instead of just tx_id. Enabling this option can affect performance and response times.

Response

200OK

List of Non-Fungible Token history events

400Bad Request

Error Response

Non-Fungible Token history

curl -X GET 'https://stacks.nownodes.io/extended/v1/tokens/nft/history'

const response = await fetch('https://stacks.nownodes.io/extended/v1/tokens/nft/history', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/tokens/nft/history')
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/tokens/nft/history')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v1/tokens/nft/history', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/tokens/nft/history";
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/tokens/nft/history', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v1/tokens/nft/history')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/tokens/nft/history')
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",
      "recipient": "string",
      "event_index": 0,
      "asset_event_type": "string",
      "tx_id": "string"
    }
  ]
}

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

Non-Fungible Token mints

GET

https://stacks.nownodes.io/extended/v1/tokens/nft/mints

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves all mint events for a Non-Fungible Token asset class. Useful to determine which NFTs of a particular collection have been claimed.

Copied!

    More information on Non-Fungible Tokens on the Stacks blockchain can be found [here](https://docs.stacks.co/write-smart-contracts/tokens#non-fungible-tokens-nfts).

Parameters

asset_identifierstringrequiredquery

asset class identifier

limitinteger[0, 200]50query

max number of events to fetch

offsetinteger>= 00query

index of first event to fetch

unanchoredbooleanfalsequery

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

tx_metadatabooleanfalserequiredquery

whether or not to include the complete transaction metadata instead of just tx_id. Enabling this option can affect performance and response times.

Response

200OK

List of Non-Fungible Token mint events for an asset identifier

400Bad Request

Error Response

Non-Fungible Token mints

curl -X GET 'https://stacks.nownodes.io/extended/v1/tokens/nft/mints'

const response = await fetch('https://stacks.nownodes.io/extended/v1/tokens/nft/mints', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/tokens/nft/mints')
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/tokens/nft/mints')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v1/tokens/nft/mints', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/tokens/nft/mints";
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/tokens/nft/mints', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v1/tokens/nft/mints')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/tokens/nft/mints')
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": [
    {
      "recipient": "string",
      "event_index": 0,
      "value": {
        "hex": "string",
        "repr": "string"
      },
      "tx_id": "string"
    }
  ]
}

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

Search

Read-only endpoints to search for accounts, blocks, smart contracts, and transactions

Search

GET

https://stacks.nownodes.io/extended/v1/search/{id}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Search blocks, transactions, contracts, or accounts by hash/ID

Parameters

include_metadatabooleanfalsequery

This includes the detailed data for purticular hash in the response

idstringrequiredpath

The hex hash string for a block or transaction, account address, or contract address

Response

200OK

Default Response

400Bad Request

Error Response

404Not Found

Default Response

curl -X GET 'https://stacks.nownodes.io/extended/v1/search/{id}'

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/search/{id}')
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/search/{id}')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/search/{id}";
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/search/{id}', {
  method: 'GET',
});

const data = await response.json();

import requests

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

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/search/{id}')
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)

{
  "found": true,
  "result": {
    "entity_id": "string",
    "entity_type": "standard_address",
    "metadata": {
      "balance": "string",
      "estimated_balance": "string",
      "pending_balance_inbound": "string",
      "pending_balance_outbound": "string",
      "total_sent": "string",
      "total_received": "string",
      "total_fees_sent": "string",
      "total_miner_rewards_received": "string",
      "lock_tx_id": "string",
      "locked": "string",
      "lock_height": 0,
      "burnchain_lock_height": 0,
      "burnchain_unlock_height": 0,
      "token_offering_locked": {
        "total_locked": "string",
        "total_unlocked": "string",
        "unlock_schedule": [
          {
            "amount": "string",
            "block_height": 0
          }
        ]
      }
    }
  }
}

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

{
  "found": false,
  "result": {
    "entity_type": "tx_id"
  },
  "error": "string"
}

Smart Contracts

Read-only endpoints to obtain Clarity smart contract details

Get contracts by trait

GET

https://stacks.nownodes.io/extended/v1/contract/by_trait

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a list of contracts based on the following traits listed in JSON format - functions, variables, maps, fungible tokens and non-fungible tokens

Parameters

trait_abistringrequiredquery

JSON abi of the trait.

limitinteger[0, 50]20query

max number of contracts fetch

offsetinteger>= 00query

index of first contract event to fetch

Response

200OK

GET list of contracts

400Bad Request

Error Response

Get contracts by trait

curl -X GET 'https://stacks.nownodes.io/extended/v1/contract/by_trait'

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/contract/by_trait')
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/contract/by_trait')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/contract/by_trait";
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/contract/by_trait', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v1/contract/by_trait')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/contract/by_trait')
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,
  "results": [
    {
      "tx_id": "string",
      "canonical": true,
      "contract_id": "string",
      "block_height": 0,
      "clarity_version": 0,
      "source_code": "string",
      "abi": "string"
    }
  ]
}

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

Get contract info

GET

https://stacks.nownodes.io/extended/v1/contract/{contract_id}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves details of a contract with a given contract_id

Parameters

contract_idstringrequiredpath

Contract identifier formatted as <contract_address>.<contract_name>

Response

200OK

A Smart Contract Detail

400Bad Request

Error Response

Get contract info

curl -X GET 'https://stacks.nownodes.io/extended/v1/contract/{contract_id}'

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/contract/{contract_id}')
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/contract/{contract_id}')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/contract/{contract_id}";
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/contract/{contract_id}', {
  method: 'GET',
});

const data = await response.json();

import requests

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

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/contract/{contract_id}')
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)

{
  "tx_id": "string",
  "canonical": true,
  "contract_id": "string",
  "block_height": 0,
  "clarity_version": 0,
  "source_code": "string",
  "abi": "string"
}

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

Get contract events

GET

https://stacks.nownodes.io/extended/v1/contract/{contract_id}/events

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a list of events that have been triggered by a given contract_id

Parameters

limitinteger[0, 50]20query

max number of events to fetch

offsetinteger>= 00query

Result offset

contract_idstringrequiredpath

Contract identifier formatted as <contract_address>.<contract_name>

Response

200OK

List of events

400Bad Request

Error Response

Get contract events

curl -X GET 'https://stacks.nownodes.io/extended/v1/contract/{contract_id}/events'

const response = await fetch('https://stacks.nownodes.io/extended/v1/contract/{contract_id}/events', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/contract/{contract_id}/events')
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/contract/{contract_id}/events')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v1/contract/{contract_id}/events', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/contract/{contract_id}/events";
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/contract/{contract_id}/events', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v1/contract/{contract_id}/events')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/contract/{contract_id}/events')
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": 0,
  "offset": 0,
  "results": [
    {
      "event_index": 0,
      "event_type": "smart_contract_log",
      "tx_id": "string",
      "contract_log": {
        "contract_id": "string",
        "topic": "string",
        "value": {
          "hex": "string",
          "repr": "string"
        }
      }
    }
  ]
}

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

Get smart contracts status

GET

https://stacks.nownodes.io/extended/v2/smart-contracts/status

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves the deployment status of multiple smart contracts.

Parameters

contract_idArray<string> | stringrequiredquery

Response

200OK

Default Response

400Bad Request

Error Response

Get smart contracts status

curl -X GET 'https://stacks.nownodes.io/extended/v2/smart-contracts/status'

const response = await fetch('https://stacks.nownodes.io/extended/v2/smart-contracts/status', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/smart-contracts/status')
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/v2/smart-contracts/status')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v2/smart-contracts/status', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v2/smart-contracts/status";
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/v2/smart-contracts/status', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v2/smart-contracts/status')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/smart-contracts/status')
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)

{}

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

Stacking Rewards

Read-only endpoints to obtain Stacking reward details

Get recent reward slot holders

GET

https://stacks.nownodes.io/extended/v1/burnchain/reward_slot_holders

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments.

Parameters

limitinteger[0, 250]96query

max number of items to fetch

offsetinteger>= 00query

Result offset

Response

200OK

Default Response

400Bad Request

Error Response

Get recent reward slot holders

curl -X GET 'https://stacks.nownodes.io/extended/v1/burnchain/reward_slot_holders'

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/burnchain/reward_slot_holders')
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/burnchain/reward_slot_holders')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/burnchain/reward_slot_holders";
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/burnchain/reward_slot_holders', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v1/burnchain/reward_slot_holders')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/burnchain/reward_slot_holders')
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": [
    {
      "canonical": true,
      "burn_block_hash": "string",
      "burn_block_height": 0,
      "address": "string",
      "slot_index": 0
    }
  ]
}

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

Get recent reward slot holder entries for the given address

GET

https://stacks.nownodes.io/extended/v1/burnchain/reward_slot_holders/{address}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a list of the Bitcoin addresses that would validly receive Proof-of-Transfer commitments for a given reward slot holder recipient address.

Parameters

limitinteger[0, 250]96query

Results per page

offsetinteger>= 00query

Result offset

addressstringrequiredpath

Reward slot holder recipient address. Should either be in the native burnchain's format (e.g. B58 for Bitcoin), or if a STX principal address is provided it will be encoded as into the equivalent burnchain format

Response

200OK

List of burnchain reward recipients and amounts

400Bad Request

Error Response

Get recent reward slot holder entries for the given address

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

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/burnchain/reward_slot_holders/{address}')
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/burnchain/reward_slot_holders/{address}')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/burnchain/reward_slot_holders/{address}";
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/burnchain/reward_slot_holders/{address}', {
  method: 'GET',
});

const data = await response.json();

import requests

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

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/burnchain/reward_slot_holders/{address}')
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": [
    {
      "canonical": true,
      "burn_block_hash": "string",
      "burn_block_height": 0,
      "address": "string",
      "slot_index": 0
    }
  ]
}

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

Get recent burnchain reward recipients

GET

https://stacks.nownodes.io/extended/v1/burnchain/rewards

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a list of recent burnchain (e.g. Bitcoin) reward recipients with the associated amounts and block info

Parameters

limitinteger[0, 250]96query

Results per page

offsetinteger>= 00query

Result offset

Response

200OK

List of burnchain reward recipients and amounts

400Bad Request

Error Response

Get recent burnchain reward recipients

curl -X GET 'https://stacks.nownodes.io/extended/v1/burnchain/rewards'

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/burnchain/rewards')
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/burnchain/rewards')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/burnchain/rewards";
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/burnchain/rewards', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v1/burnchain/rewards')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/burnchain/rewards')
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": 0,
  "offset": 0,
  "results": [
    {
      "canonical": true,
      "burn_block_hash": "string",
      "burn_block_height": 0,
      "burn_amount": "string",
      "reward_recipient": "string",
      "reward_amount": "string",
      "reward_index": 0
    }
  ]
}

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

Get recent burnchain reward for the given recipient

GET

https://stacks.nownodes.io/extended/v1/burnchain/rewards/{address}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a list of recent burnchain (e.g. Bitcoin) rewards for the given recipient with the associated amounts and block info

Parameters

limitinteger[0, 250]96query

Results per page

offsetinteger>= 00query

Result offset

addressstringrequiredpath

Reward recipient address. Should either be in the native burnchain's format (e.g. B58 for Bitcoin), or if a STX principal address is provided it will be encoded as into the equivalent burnchain format

Response

200OK

List of burnchain reward recipients and amounts

400Bad Request

Error Response

Get recent burnchain reward for the given recipient

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

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/burnchain/rewards/{address}')
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/burnchain/rewards/{address}')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/burnchain/rewards/{address}";
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/burnchain/rewards/{address}', {
  method: 'GET',
});

const data = await response.json();

import requests

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

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/burnchain/rewards/{address}')
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": 0,
  "offset": 0,
  "results": [
    {
      "canonical": true,
      "burn_block_hash": "string",
      "burn_block_height": 0,
      "burn_amount": "string",
      "reward_recipient": "string",
      "reward_amount": "string",
      "reward_index": 0
    }
  ]
}

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

Get total burnchain rewards for the given recipient

GET

https://stacks.nownodes.io/extended/v1/burnchain/rewards/{address}/total

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves the total burnchain (e.g. Bitcoin) rewards for a given recipient address

Parameters

addressstringrequiredpath

Response

200OK

Total burnchain rewards made to a recipient

400Bad Request

Error Response

Get total burnchain rewards for the given recipient

curl -X GET 'https://stacks.nownodes.io/extended/v1/burnchain/rewards/{address}/total'

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/burnchain/rewards/{address}/total')
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/burnchain/rewards/{address}/total')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/burnchain/rewards/{address}/total";
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/burnchain/rewards/{address}/total', {
  method: 'GET',
});

const data = await response.json();

import requests

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

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/burnchain/rewards/{address}/total')
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)

{
  "reward_recipient": "string",
  "reward_amount": "string"
}

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

Transactions

Endpoints to obtain transaction details and to broadcast transactions to the network

Get recent transactions

GET

https://stacks.nownodes.io/extended/v1/tx

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves all recently mined transactions

Parameters

offsetinteger>= 00query

Result offset

limitinteger[0, 50]20query

Results per page

unanchoredbooleanfalsequery

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

orderstring | stringquery

sort_bystring | string | stringblock_heightquery

Option to sort results by block height, timestamp, or fee

from_addressstringquery

Option to filter results by sender address

to_addressstringquery

Option to filter results by recipient address

start_timeintegerquery

Filter by transactions after this timestamp (unix timestamp in seconds)

end_timeintegerquery

Filter by transactions before this timestamp (unix timestamp in seconds)

contract_idstringquery

Option to filter results by contract ID

function_namestringquery

Filter by contract call transactions involving this function name

nonceinteger[0, 9007199254740991]query

Filter by transactions with this nonce

Response

200OK

List of transactions

400Bad Request

Error Response

Get recent transactions

curl -X GET 'https://stacks.nownodes.io/extended/v1/tx/'

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/tx/')
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/tx/')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/tx/";
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/tx/', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v1/tx/')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/tx/')
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": [
    {
      "tx_id": "string",
      "nonce": 0,
      "fee_rate": "string",
      "sender_address": "string",
      "sponsor_nonce": 0,
      "sponsored": true,
      "sponsor_address": "string",
      "post_condition_mode": "allow",
      "post_conditions": [
        {
          "principal": {
            "type_id": "principal_origin"
          },
          "condition_code": "sent_equal_to",
          "amount": "string",
          "type": "stx"
        }
      ],
      "anchor_mode": "on_chain_only",
      "block_hash": "string",
      "block_height": 0,
      "block_time": 0,
      "block_time_iso": "string",
      "burn_block_time": 0,
      "burn_block_height": 0,
      "burn_block_time_iso": "string",
      "parent_burn_block_time": 0,
      "parent_burn_block_time_iso": "string",
      "canonical": true,
      "tx_index": 0,
      "tx_status": "success",
      "tx_result": {
        "hex": "string",
        "repr": "string"
      },
      "event_count": 0,
      "parent_block_hash": "string",
      "is_unanchored": true,
      "microblock_hash": "string",
      "microblock_sequence": 0,
      "microblock_canonical": true,
      "execution_cost_read_count": 0,
      "execution_cost_read_length": 0,
      "execution_cost_runtime": 0,
      "execution_cost_write_count": 0,
      "execution_cost_write_length": 0,
      "vm_error": "string",
      "events": [
        {
          "event_index": 0,
          "event_type": "smart_contract_log",
          "tx_id": "string",
          "contract_log": {
            "contract_id": "string",
            "topic": "string",
            "value": {
              "hex": "string",
              "repr": "string"
            }
          }
        }
      ],
      "tx_type": "token_transfer",
      "token_transfer": {
        "recipient_address": "string",
        "amount": "string",
        "memo": "string"
      }
    }
  ]
}

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

Get list of details for transactions

GET

https://stacks.nownodes.io/extended/v1/tx/multiple

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a list of transactions for a given list of transaction IDs

Parameters

tx_idArray<string>requiredquery

event_limitinteger[0, 100]20query

Results per page

event_offsetinteger>= 00query

Result offset

unanchoredbooleanfalsequery

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

Response

200OK

Default Response

400Bad Request

Error Response

Get list of details for transactions

curl -X GET 'https://stacks.nownodes.io/extended/v1/tx/multiple'

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/tx/multiple')
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/tx/multiple')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/tx/multiple";
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/tx/multiple', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v1/tx/multiple')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/tx/multiple')
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)

{}

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

Get mempool transactions

GET

https://stacks.nownodes.io/extended/v1/tx/mempool

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves all transactions that have been recently broadcast to the mempool. These are pending transactions awaiting confirmation.

Copied!

    If you need to monitor new transactions, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.

Parameters

sender_addressstringquery

STX Address

recipient_addressstringquery

STX Address

addressstringquery

STX Address

order_bystring | string | stringquery

Option to sort results by transaction age, size, or fee rate.

orderstring | stringquery

Results order

unanchoredbooleanfalsequery

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

offsetinteger>= 00query

Result offset

limitinteger[0, 50]20query

Results per page

Response

200OK

List of mempool transactions

400Bad Request

Error Response

Get mempool transactions

curl -X GET 'https://stacks.nownodes.io/extended/v1/tx/mempool'

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/tx/mempool')
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/tx/mempool')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/tx/mempool";
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/tx/mempool', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v1/tx/mempool')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/tx/mempool')
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": [
    {
      "tx_id": "string",
      "nonce": 0,
      "fee_rate": "string",
      "sender_address": "string",
      "sponsor_nonce": 0,
      "sponsored": true,
      "sponsor_address": "string",
      "post_condition_mode": "allow",
      "post_conditions": [
        {
          "principal": {
            "type_id": "principal_origin"
          },
          "condition_code": "sent_equal_to",
          "amount": "string",
          "type": "stx"
        }
      ],
      "anchor_mode": "on_chain_only",
      "tx_status": "pending",
      "receipt_time": 0,
      "receipt_time_iso": "string",
      "tx_type": "token_transfer",
      "token_transfer": {
        "recipient_address": "string",
        "amount": "string",
        "memo": "string"
      }
    }
  ]
}

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

Get statistics for mempool transactions

GET

https://stacks.nownodes.io/extended/v1/tx/mempool/stats

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Queries for transactions counts, age (by block height), fees (simple average), and size. All results broken down by transaction type and percentiles (p25, p50, p75, p95).

Response

200OK

GET request that returns stats on mempool transactions

400Bad Request

Error Response

Get statistics for mempool transactions

curl -X GET 'https://stacks.nownodes.io/extended/v1/tx/mempool/stats'

const response = await fetch('https://stacks.nownodes.io/extended/v1/tx/mempool/stats', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/tx/mempool/stats')
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/tx/mempool/stats')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v1/tx/mempool/stats', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/tx/mempool/stats";
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/tx/mempool/stats', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v1/tx/mempool/stats')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/tx/mempool/stats')
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)

{
  "tx_type_counts": {},
  "tx_simple_fee_averages": {},
  "tx_ages": {},
  "tx_byte_sizes": {}
}

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

Transaction Events

GET

https://stacks.nownodes.io/extended/v1/tx/events

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves the list of events filtered by principal (STX address or Smart Contract ID), transaction id or event types. The list of event types is ('smart_contract_log', 'stx_lock', 'stx_asset', 'fungible_token_asset', 'non_fungible_token_asset').

Parameters

tx_idstringquery

Transaction ID

addressstring | stringquery

typeArray<string | string | string | string | string>query

offsetinteger>= 00query

Result offset

limitinteger[0, 100]20query

Results per page

Response

200OK

Default Response

400Bad Request

Error Response

Transaction Events

curl -X GET 'https://stacks.nownodes.io/extended/v1/tx/events'

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/tx/events')
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/tx/events')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/tx/events";
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/tx/events', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v1/tx/events')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/tx/events')
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,
  "events": [
    {
      "event_index": 0,
      "event_type": "smart_contract_log",
      "tx_id": "string",
      "contract_log": {
        "contract_id": "string",
        "topic": "string",
        "value": {
          "hex": "string",
          "repr": "string"
        }
      }
    }
  ]
}

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

Get transaction

GET

https://stacks.nownodes.io/extended/v1/tx/{tx_id}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves transaction details for a given transaction ID

Parameters

event_limitinteger[0, 100]20query

Results per page

event_offsetinteger>= 00query

Result offset

unanchoredbooleanfalsequery

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

tx_idstringrequiredpath

Transaction ID

Response

200OK

Default Response

400Bad Request

Error Response

Get transaction

curl -X GET 'https://stacks.nownodes.io/extended/v1/tx/{tx_id}'

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/tx/{tx_id}')
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/tx/{tx_id}')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/tx/{tx_id}";
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/tx/{tx_id}', {
  method: 'GET',
});

const data = await response.json();

import requests

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

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/tx/{tx_id}')
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)

{
  "tx_id": "string",
  "nonce": 0,
  "fee_rate": "string",
  "sender_address": "string",
  "sponsor_nonce": 0,
  "sponsored": true,
  "sponsor_address": "string",
  "post_condition_mode": "allow",
  "post_conditions": [
    {
      "principal": {
        "type_id": "principal_origin"
      },
      "condition_code": "sent_equal_to",
      "amount": "string",
      "type": "stx"
    }
  ],
  "anchor_mode": "on_chain_only",
  "block_hash": "string",
  "block_height": 0,
  "block_time": 0,
  "block_time_iso": "string",
  "burn_block_time": 0,
  "burn_block_height": 0,
  "burn_block_time_iso": "string",
  "parent_burn_block_time": 0,
  "parent_burn_block_time_iso": "string",
  "canonical": true,
  "tx_index": 0,
  "tx_status": "success",
  "tx_result": {
    "hex": "string",
    "repr": "string"
  },
  "event_count": 0,
  "parent_block_hash": "string",
  "is_unanchored": true,
  "microblock_hash": "string",
  "microblock_sequence": 0,
  "microblock_canonical": true,
  "execution_cost_read_count": 0,
  "execution_cost_read_length": 0,
  "execution_cost_runtime": 0,
  "execution_cost_write_count": 0,
  "execution_cost_write_length": 0,
  "vm_error": "string",
  "events": [
    {
      "event_index": 0,
      "event_type": "smart_contract_log",
      "tx_id": "string",
      "contract_log": {
        "contract_id": "string",
        "topic": "string",
        "value": {
          "hex": "string",
          "repr": "string"
        }
      }
    }
  ],
  "tx_type": "token_transfer",
  "token_transfer": {
    "recipient_address": "string",
    "amount": "string",
    "memo": "string"
  }
}

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

Get raw transaction

GET

https://stacks.nownodes.io/extended/v1/tx/{tx_id}/raw

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a hex encoded serialized transaction for a given ID

Parameters

event_limitinteger[0, 100]20query

Results per page

event_offsetinteger>= 00query

Result offset

tx_idstringrequiredpath

Transaction ID

Response

200OK

GET raw transaction

400Bad Request

Error Response

Get raw transaction

curl -X GET 'https://stacks.nownodes.io/extended/v1/tx/{tx_id}/raw'

const response = await fetch('https://stacks.nownodes.io/extended/v1/tx/{tx_id}/raw', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/tx/{tx_id}/raw')
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/tx/{tx_id}/raw')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v1/tx/{tx_id}/raw', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/tx/{tx_id}/raw";
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/tx/{tx_id}/raw', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v1/tx/{tx_id}/raw')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/tx/{tx_id}/raw')
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)

{
  "raw_tx": "string"
}

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

Transactions for address

GET

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

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves all transactions for a given address that are currently in mempool

Parameters

limitinteger[0, 50]20query

Results per page

offsetinteger>= 00query

Result offset

unanchoredbooleanfalsequery

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

principalstring | stringrequiredpath

Response

200OK

List of mempool transactions

400Bad Request

Error Response

Transactions for address

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

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/address/{principal}/mempool')
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}/mempool')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/address/{principal}/mempool";
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}/mempool', {
  method: 'GET',
});

const data = await response.json();

import requests

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

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/address/{principal}/mempool')
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": [
    {
      "tx_id": "string",
      "nonce": 0,
      "fee_rate": "string",
      "sender_address": "string",
      "sponsor_nonce": 0,
      "sponsored": true,
      "sponsor_address": "string",
      "post_condition_mode": "allow",
      "post_conditions": [
        {
          "principal": {
            "type_id": "principal_origin"
          },
          "condition_code": "sent_equal_to",
          "amount": "string",
          "type": "stx"
        }
      ],
      "anchor_mode": "on_chain_only",
      "tx_status": "pending",
      "receipt_time": 0,
      "receipt_time_iso": "string",
      "tx_type": "token_transfer",
      "token_transfer": {
        "recipient_address": "string",
        "amount": "string",
        "memo": "string"
      }
    }
  ]
}

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

Get transactions by block

GET

https://stacks.nownodes.io/extended/v2/blocks/{height_or_hash}/transactions

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves transactions confirmed in a single block

Parameters

limitinteger[0, 50]20query

Results per page

offsetinteger>= 00query

Result offset

height_or_hashstring | string | integerrequiredpath

Response

200OK

Default Response

400Bad Request

Error Response

Get transactions by block

curl -X GET 'https://stacks.nownodes.io/extended/v2/blocks/{height_or_hash}/transactions'

const response = await fetch('https://stacks.nownodes.io/extended/v2/blocks/{height_or_hash}/transactions', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/blocks/{height_or_hash}/transactions')
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/v2/blocks/{height_or_hash}/transactions')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v2/blocks/{height_or_hash}/transactions', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v2/blocks/{height_or_hash}/transactions";
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/v2/blocks/{height_or_hash}/transactions', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v2/blocks/{height_or_hash}/transactions')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/blocks/{height_or_hash}/transactions')
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": [
    {
      "tx_id": "string",
      "nonce": 0,
      "fee_rate": "string",
      "sender_address": "string",
      "sponsor_nonce": 0,
      "sponsored": true,
      "sponsor_address": "string",
      "post_condition_mode": "allow",
      "post_conditions": [
        {
          "principal": {
            "type_id": "principal_origin"
          },
          "condition_code": "sent_equal_to",
          "amount": "string",
          "type": "stx"
        }
      ],
      "anchor_mode": "on_chain_only",
      "block_hash": "string",
      "block_height": 0,
      "block_time": 0,
      "block_time_iso": "string",
      "burn_block_time": 0,
      "burn_block_height": 0,
      "burn_block_time_iso": "string",
      "parent_burn_block_time": 0,
      "parent_burn_block_time_iso": "string",
      "canonical": true,
      "tx_index": 0,
      "tx_status": "success",
      "tx_result": {
        "hex": "string",
        "repr": "string"
      },
      "event_count": 0,
      "parent_block_hash": "string",
      "is_unanchored": true,
      "microblock_hash": "string",
      "microblock_sequence": 0,
      "microblock_canonical": true,
      "execution_cost_read_count": 0,
      "execution_cost_read_length": 0,
      "execution_cost_runtime": 0,
      "execution_cost_write_count": 0,
      "execution_cost_write_length": 0,
      "vm_error": "string",
      "events": [
        {
          "event_index": 0,
          "event_type": "smart_contract_log",
          "tx_id": "string",
          "contract_log": {
            "contract_id": "string",
            "topic": "string",
            "value": {
              "hex": "string",
              "repr": "string"
            }
          }
        }
      ],
      "tx_type": "token_transfer",
      "token_transfer": {
        "recipient_address": "string",
        "amount": "string",
        "memo": "string"
      }
    }
  ]
}

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

Get address transactions

GET

https://stacks.nownodes.io/extended/v2/addresses/{address}/transactions

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a paginated list of confirmed transactions sent or received by a STX address or Smart Contract ID, alongside the total amount of STX sent or received and the number of STX, FT and NFT transfers contained within each transaction.

Copied!

    More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).

Parameters

limitinteger[0, 50]20query

Results per page

offsetinteger>= 00query

Result offset

addressstring | stringrequiredpath

Response

200OK

Default Response

400Bad Request

Error Response

Get address transactions

curl -X GET 'https://stacks.nownodes.io/extended/v2/addresses/{address}/transactions'

const response = await fetch('https://stacks.nownodes.io/extended/v2/addresses/{address}/transactions', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/addresses/{address}/transactions')
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/v2/addresses/{address}/transactions')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v2/addresses/{address}/transactions', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v2/addresses/{address}/transactions";
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/v2/addresses/{address}/transactions', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v2/addresses/{address}/transactions')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/addresses/{address}/transactions')
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": [
    {
      "tx": {
        "tx_id": "string",
        "nonce": 0,
        "fee_rate": "string",
        "sender_address": "string",
        "sponsor_nonce": 0,
        "sponsored": true,
        "sponsor_address": "string",
        "post_condition_mode": "allow",
        "post_conditions": [
          {
            "principal": {
              "type_id": "principal_origin"
            },
            "condition_code": "sent_equal_to",
            "amount": "string",
            "type": "stx"
          }
        ],
        "anchor_mode": "on_chain_only",
        "block_hash": "string",
        "block_height": 0,
        "block_time": 0,
        "block_time_iso": "string",
        "burn_block_time": 0,
        "burn_block_height": 0,
        "burn_block_time_iso": "string",
        "parent_burn_block_time": 0,
        "parent_burn_block_time_iso": "string",
        "canonical": true,
        "tx_index": 0,
        "tx_status": "success",
        "tx_result": {
          "hex": "string",
          "repr": "string"
        },
        "event_count": 0,
        "parent_block_hash": "string",
        "is_unanchored": true,
        "microblock_hash": "string",
        "microblock_sequence": 0,
        "microblock_canonical": true,
        "execution_cost_read_count": 0,
        "execution_cost_read_length": 0,
        "execution_cost_runtime": 0,
        "execution_cost_write_count": 0,
        "execution_cost_write_length": 0,
        "vm_error": "string",
        "events": [
          {
            "event_index": 0,
            "event_type": "smart_contract_log",
            "tx_id": "string",
            "contract_log": {
              "contract_id": "string",
              "topic": "string",
              "value": {
                "hex": "string",
                "repr": "string"
              }
            }
          }
        ],
        "tx_type": "token_transfer",
        "token_transfer": {
          "recipient_address": "string",
          "amount": "string",
          "memo": "string"
        }
      },
      "stx_sent": "string",
      "stx_received": "string",
      "events": {
        "stx": {
          "transfer": 0,
          "mint": 0,
          "burn": 0
        },
        "ft": {
          "transfer": 0,
          "mint": 0,
          "burn": 0
        },
        "nft": {
          "transfer": 0,
          "mint": 0,
          "burn": 0
        }
      }
    }
  ]
}

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

Get events for an address transaction

GET

https://stacks.nownodes.io/extended/v2/addresses/{address}/transactions/{tx_id}/events

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a paginated list of all STX, FT and NFT events concerning a STX address or Smart Contract ID within a specific transaction.

Parameters

limitinteger[0, 50]20query

Results per page

offsetinteger>= 00query

Result offset

addressstring | stringrequiredpath

tx_idstringrequiredpath

Transaction ID

Response

200OK

Default Response

400Bad Request

Error Response

Get events for an address transaction

curl -X GET 'https://stacks.nownodes.io/extended/v2/addresses/{address}/transactions/{tx_id}/events'

const response = await fetch('https://stacks.nownodes.io/extended/v2/addresses/{address}/transactions/{tx_id}/events', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/addresses/{address}/transactions/{tx_id}/events')
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/v2/addresses/{address}/transactions/{tx_id}/events')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v2/addresses/{address}/transactions/{tx_id}/events', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v2/addresses/{address}/transactions/{tx_id}/events";
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/v2/addresses/{address}/transactions/{tx_id}/events', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v2/addresses/{address}/transactions/{tx_id}/events')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/addresses/{address}/transactions/{tx_id}/events')
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": [
    {
      "type": "stx",
      "event_index": 0,
      "data": {
        "type": "transfer",
        "amount": "string",
        "sender": "string",
        "recipient": "string"
      }
    }
  ]
}

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

Mempool

Endpoints to obtain Mempool information

Get mempool transaction fee priorities

GET

https://stacks.nownodes.io/extended/v2/mempool/fees

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Returns estimated fee priorities (in micro-STX) for all transactions that are currently in the mempool. Also returns priorities separated by transaction type.

Response

200OK

Default Response

400Bad Request

Error Response

Get mempool transaction fee priorities

curl -X GET 'https://stacks.nownodes.io/extended/v2/mempool/fees'

const response = await fetch('https://stacks.nownodes.io/extended/v2/mempool/fees', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/mempool/fees')
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/v2/mempool/fees')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v2/mempool/fees', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v2/mempool/fees";
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/v2/mempool/fees', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v2/mempool/fees')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/mempool/fees')
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)

{
  "all": {
    "no_priority": 0,
    "low_priority": 0,
    "medium_priority": 0,
    "high_priority": 0
  },
  "token_transfer": {
    "no_priority": 0,
    "low_priority": 0,
    "medium_priority": 0,
    "high_priority": 0
  },
  "contract_call": {
    "no_priority": 0,
    "low_priority": 0,
    "medium_priority": 0,
    "high_priority": 0
  },
  "smart_contract": {
    "no_priority": 0,
    "low_priority": 0,
    "medium_priority": 0,
    "high_priority": 0
  }
}

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

Proof of Transfer

Endpoints to get information about the Proof of Transfer consensus mechanism

Get PoX cycles

GET

https://stacks.nownodes.io/extended/v2/pox/cycles

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a list of PoX cycles

Parameters

limitinteger[0, 60]20query

Results per page

offsetinteger>= 00query

Result offset

Response

200OK

Default Response

400Bad Request

Error Response

Get PoX cycles

curl -X GET 'https://stacks.nownodes.io/extended/v2/pox/cycles'

const response = await fetch('https://stacks.nownodes.io/extended/v2/pox/cycles', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/pox/cycles')
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/v2/pox/cycles')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v2/pox/cycles', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v2/pox/cycles";
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/v2/pox/cycles', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v2/pox/cycles')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/pox/cycles')
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": [
    {
      "block_height": 0,
      "index_block_hash": "string",
      "cycle_number": 0,
      "total_weight": 0,
      "total_stacked_amount": "string",
      "total_signers": 0
    }
  ]
}

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

Get PoX cycle

GET

https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves details for a PoX cycle

Parameters

cycle_numberintegerrequiredpath

PoX cycle number

Response

200OK

Default Response

400Bad Request

Error Response

Get PoX cycle

curl -X GET 'https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}'

const response = await fetch('https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}')
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/v2/pox/cycles/{cycle_number}')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}";
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/v2/pox/cycles/{cycle_number}', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}')
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)

{
  "block_height": 0,
  "index_block_hash": "string",
  "cycle_number": 0,
  "total_weight": 0,
  "total_stacked_amount": "string",
  "total_signers": 0
}

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

Get signers in PoX cycle

GET

https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}/signers

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a list of signers in a PoX cycle

Parameters

limitinteger[0, 250]100query

Results per page

offsetinteger>= 00query

Result offset

cycle_numberintegerrequiredpath

PoX cycle number

Response

200OK

Default Response

400Bad Request

Error Response

Get signers in PoX cycle

curl -X GET 'https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}/signers'

const response = await fetch('https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}/signers', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}/signers')
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/v2/pox/cycles/{cycle_number}/signers')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}/signers', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}/signers";
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/v2/pox/cycles/{cycle_number}/signers', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}/signers')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}/signers')
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": [
    {
      "signing_key": "string",
      "signer_address": "string",
      "weight": 0,
      "stacked_amount": "string",
      "weight_percent": 0,
      "stacked_amount_percent": 0,
      "solo_stacker_count": 0,
      "pooled_stacker_count": 0
    }
  ]
}

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

Get signer in PoX cycle

GET

https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves details for a signer in a PoX cycle

Parameters

cycle_numberintegerrequiredpath

PoX cycle number

signer_keystringrequiredpath

Signer key

Response

200OK

Default Response

400Bad Request

Error Response

Get signer in PoX cycle

curl -X GET 'https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}'

const response = await fetch('https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}')
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/v2/pox/cycles/{cycle_number}/signers/{signer_key}')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}";
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/v2/pox/cycles/{cycle_number}/signers/{signer_key}', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}')
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)

{
  "signing_key": "string",
  "signer_address": "string",
  "weight": 0,
  "stacked_amount": "string",
  "weight_percent": 0,
  "stacked_amount_percent": 0,
  "solo_stacker_count": 0,
  "pooled_stacker_count": 0
}

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

Get stackers for signer in PoX cycle

GET

https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}/stackers

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves a list of stackers for a signer in a PoX cycle

Parameters

limitinteger[0, 200]100query

Results per page

offsetinteger>= 00query

Result offset

cycle_numberintegerrequiredpath

PoX cycle number

signer_keystringrequiredpath

Signer key

Response

200OK

Default Response

400Bad Request

Error Response

Get stackers for signer in PoX cycle

curl -X GET 'https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}/stackers'

const response = await fetch('https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}/stackers', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}/stackers')
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/v2/pox/cycles/{cycle_number}/signers/{signer_key}/stackers')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}/stackers', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}/stackers";
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/v2/pox/cycles/{cycle_number}/signers/{signer_key}/stackers', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}/stackers')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v2/pox/cycles/{cycle_number}/signers/{signer_key}/stackers')
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": [
    {
      "stacker_address": "string",
      "stacked_amount": "string",
      "pox_address": "string",
      "stacker_type": "solo"
    }
  ]
}

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

Fungible Tokens

Fungible token holders

GET

https://stacks.nownodes.io/extended/v1/tokens/ft/{token}/holders

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves the list of Fungible Token holders for a given token ID. Specify stx for the token parameter to get the list of STX holders.

Parameters

limitinteger[0, 200]100query

max number of holders to fetch

offsetinteger>= 00query

index of first holder to fetch

tokenstringrequiredpath

fungible token identifier

Response

200OK

Default Response

400Bad Request

Error Response

Fungible token holders

curl -X GET 'https://stacks.nownodes.io/extended/v1/tokens/ft/{token}/holders'

const response = await fetch('https://stacks.nownodes.io/extended/v1/tokens/ft/{token}/holders', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/tokens/ft/{token}/holders')
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/tokens/ft/{token}/holders')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v1/tokens/ft/{token}/holders', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/tokens/ft/{token}/holders";
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/tokens/ft/{token}/holders', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v1/tokens/ft/{token}/holders')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/tokens/ft/{token}/holders')
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)

{
  "total_supply": "5817609278457",
  "limit": 20,
  "offset": 0,
  "total": 1,
  "results": [
    {
      "address": "SP3G2QZHYDZPJ2FBN2V2MB74T5ZQ6FQK2P5QJ2K6",
      "balance": "174823763"
    }
  ]
}

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

Stacking

Get latest PoX events

GET

https://stacks.nownodes.io/extended/v1/{pox}/events

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Parameters

limitinteger[0, 200]96query

Results per page

offsetinteger>= 00query

Result offset

poxstring | string | stringrequiredpath

Response

200OK

Default Response

Get latest PoX events

curl -X GET 'https://stacks.nownodes.io/extended/v1/{pox}/events'

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/{pox}/events')
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/{pox}/events')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/{pox}/events";
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/{pox}/events', {
  method: 'GET',
});

const data = await response.json();

import requests

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

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/{pox}/events')
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)

Get PoX events for a transaction

GET

https://stacks.nownodes.io/extended/v1/{pox}/tx/{tx_id}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Parameters

poxstring | string | stringrequiredpath

tx_idstringrequiredpath

Response

200OK

Default Response

Get PoX events for a transaction

curl -X GET 'https://stacks.nownodes.io/extended/v1/{pox}/tx/{tx_id}'

const response = await fetch('https://stacks.nownodes.io/extended/v1/{pox}/tx/{tx_id}', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/{pox}/tx/{tx_id}')
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/{pox}/tx/{tx_id}')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v1/{pox}/tx/{tx_id}', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/{pox}/tx/{tx_id}";
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/{pox}/tx/{tx_id}', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v1/{pox}/tx/{tx_id}')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/{pox}/tx/{tx_id}')
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)

Get events for a stacking address

GET

https://stacks.nownodes.io/extended/v1/{pox}/stacker/{principal}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Parameters

poxstring | string | stringrequiredpath

principalstring | stringrequiredpath

Response

200OK

Default Response

Get events for a stacking address

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

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/{pox}/stacker/{principal}')
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/{pox}/stacker/{principal}')
data = response.json()

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

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/{pox}/stacker/{principal}";
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/{pox}/stacker/{principal}', {
  method: 'GET',
});

const data = await response.json();

import requests

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

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/{pox}/stacker/{principal}')
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)

Stacking pool members

GET

https://stacks.nownodes.io/extended/v1/{pox}/{pool_principal}/delegations

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Retrieves the list of stacking pool members for a given delegator principal.

Parameters

limitinteger[0, 200]100query

Results per page

offsetinteger>= 00query

Result offset

after_blockinteger>= 1query

If specified, only delegation events after the given block will be included

heightinteger>= 1query

unanchoredbooleanfalsequery

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

poxstring | string | stringrequiredpath

pool_principalstringrequiredpath

Address principal of the stacking pool delegator

Response

200OK

Default Response

400Bad Request

Error Response

Stacking pool members

curl -X GET 'https://stacks.nownodes.io/extended/v1/{pox}/{pool_principal}/delegations'

const response = await fetch('https://stacks.nownodes.io/extended/v1/{pox}/{pool_principal}/delegations', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/{pox}/{pool_principal}/delegations')
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/{pox}/{pool_principal}/delegations')
data = response.json()

const response = await fetch('https://stacks.nownodes.io/extended/v1/{pox}/{pool_principal}/delegations', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://stacks.nownodes.io/extended/v1/{pox}/{pool_principal}/delegations";
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/{pox}/{pool_principal}/delegations', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/extended/v1/{pox}/{pool_principal}/delegations')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://stacks.nownodes.io/extended/v1/{pox}/{pool_principal}/delegations')
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": [
    {
      "stacker": "string",
      "pox_addr": "string",
      "amount_ustx": "string",
      "burn_block_unlock_height": 0,
      "block_height": 0,
      "tx_id": "string"
    }
  ]
}

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

Documentation

How to migrate to NOWNodes

Authentication

Node

Accounts

Authorizations

Parameters

Response

Authorizations

Parameters

Response

Authorizations

Parameters

Response

Authorizations

Parameters

Response

Authorizations

Parameters

Response

Authorizations

Parameters

Response

Blocks

Authorizations

Parameters

Response

Authorizations

Response

Authorizations

Parameters

Response

Authorizations

Parameters

Response

Authorizations

Parameters

Response

Burn Blocks

Authorizations

Parameters

Response

Authorizations

Parameters

Response

Authorizations

Parameters

Response

Faucets

Authorizations

Body

Parameters

Response

Authorizations

Parameters

Response

Authorizations

Body

Parameters

Response

Info

Authorizations

Response

Authorizations

Parameters

Response

Authorizations

Response

Authorizations

Parameters

Response

Microblocks

Authorizations

Parameters

Response

Authorizations

Parameters

Response

Authorizations

Response