Stacks Blockchain API

vv8.11.4

Base URLs

https://stacks.nownodes.io

https://stacks.nownodes.ioLocal

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

Retrieves average block times (in seconds)

Response

200OK

Default Response

400Bad Request

Error Response

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

Retrieves a single block

Parameters

height_or_hashstring | string | integerrequiredpath

Response

200OK

Default Response

400Bad Request

Error Response

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

Retrieves a single burn block

Parameters

height_or_hashstring | string | integerrequiredpath

Response

200OK

Default Response

400Bad Request

Error Response

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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}

Parameters

addressstringrequiredpath

A valid regtest BTC address

Response

200OK

Default Response

400Bad Request

Error Response

Authorization

api-keyAuthapiKey in header

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();

import requests

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

{
  "balance": 0
}

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

Get STX testnet tokens

POST

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

Retrieves a specific microblock by hash

Parameters

hashstringrequiredpath

Hash of the microblock

Response

200OK

A microblock

400Bad Request

Error Response

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

{
  "zonefile": "string"
}

{
  "error": "string"
}

Get Name Subdomains

GET

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

{
  "namespaces": [
    "string"
  ]
}

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

Get Namespace Names

GET

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Get Namespace Price

GET

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Get Name Price

GET

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

Retrieves the deployment status of multiple smart contracts.

Parameters

contract_idArray<string> | stringrequiredquery

Response

200OK

Default Response

400Bad Request

Error Response

Authorization

api-keyAuthapiKey in header

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();

import requests

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

{}

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

{}

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

Get mempool transactions

GET

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

{
  "raw_tx": "string"
}

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

Transactions for address

GET

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

Retrieves details for a PoX cycle

Parameters

cycle_numberintegerrequiredpath

PoX cycle number

Response

200OK

Default Response

400Bad Request

Error Response

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

Parameters

limitinteger[0, 200]96query

Results per page

offsetinteger>= 00query

Result offset

poxstring | string | stringrequiredpath

Response

200OK

Default Response

Authorization

api-keyAuthapiKey in header

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();

import requests

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

Get PoX events for a transaction

GET

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

Parameters

poxstring | string | stringrequiredpath

tx_idstringrequiredpath

Response

200OK

Default Response

Authorization

api-keyAuthapiKey in header

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();

import requests

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

Get events for a stacking address

GET

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

Parameters

poxstring | string | stringrequiredpath

principalstring | stringrequiredpath

Response

200OK

Default Response

Authorization

api-keyAuthapiKey in header

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();

import requests

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

Stacking pool members

GET

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

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

Authorization

api-keyAuthapiKey in header

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();

import requests

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

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

Stacks

Accounts

Read-only endpoints to obtain Stacks account details

Get account info

GET

https://stacks.nownodes.io/v2/accounts/{principal}

Get the account data for the provided principal

Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is a unsigned 64-bit integer, and the proofs are provided as hex strings.

For non-existent accounts, this does not 404, rather it returns an object with balance and nonce of 0.

Parameters

principalstringrequiredpath

Stacks address or a Contract identifier (e.g. SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info)

proofintegerquery

Returns object without the proof field if set to 0

tipstringquery

The Stacks chain tip to query from. If tip == latest, the query will be run from the latest known tip (includes unconfirmed state).

Response

200OK

Success

Authorization

api-keyAuthapiKey in header

Get account info

curl -X GET 'https://stacks.nownodes.io/v2/accounts/{principal}'

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

const data = await response.json();

import requests

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

200

{
  "balance": "0x0000000000000000000000000007a120",
  "locked": "0x0000000000000000000000000007a120",
  "unlock_height": 126,
  "nonce": 2867,
  "balance_proof": "0xabce",
  "nonce_proof": "0xabcd"
}

Blocks

Read-only endpoints to obtain Stacks block details

Fetch a Nakamoto block

GET

https://stacks.nownodes.io/v3/blocks/{block_id}

Fetch a Nakamoto block by its index block hash.

Parameters

block_idstringrequiredpath

The block's ID hash

Response

200OK

The raw SIP-003-encoded block will be returned.

404Not Found

The block could not be found

Authorization

api-keyAuthapiKey in header

Fetch a Nakamoto block

curl -X GET 'https://stacks.nownodes.io/v3/blocks/{block_id}'

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

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v3/blocks/{block_id}')
data = response.json()

200

"binary"

Fetch a Nakamoto block by its height and optional tip

GET

https://stacks.nownodes.io/v3/blocks/height/{block_height}

Fetch a Nakamoto block by its height and optional tip.

Parameters

block_heightintegerrequiredpath

The block's height

tipstringquery

The Stacks chain tip to query from. If tip == latest or empty, the query will be run from the latest known tip.

Response

200OK

The raw SIP-003-encoded block will be returned.

404Not Found

The block could not be found

Authorization

api-keyAuthapiKey in header

Fetch a Nakamoto block by its height and optional tip

curl -X GET 'https://stacks.nownodes.io/v3/blocks/height/{block_height}'

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

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v3/blocks/height/{block_height}')
data = response.json()

200

"binary"

Simulate a block

POST

https://stacks.nownodes.io/v3/blocks/simulate/{block_hash}

Simulates the processing of a block identified by its hash. The node will apply the block's transactions to the current chain state in a temporary context and return the resulting block information, including the expected state changes and fees, without persisting anything to the actual chain.

Parameters

block_hashstringrequiredpath

The hex-encoded hash of the block to simulate (as typically returned by the miner or proposer).

Response

200OK

Successful simulation response containing the simulated block details.

Authorization

api-keyAuthapiKey in header

Simulate a block

curl -X POST 'https://stacks.nownodes.io/v3/blocks/simulate/{block_hash}'

const response = await fetch('https://stacks.nownodes.io/v3/blocks/simulate/{block_hash}', {
  method: 'POST',
});

const data = await response.json();

import requests

response = requests.post('https://stacks.nownodes.io/v3/blocks/simulate/{block_hash}')
data = response.json()

200

{
  "block_id": "704c38016d2cd14a94bc91095487a85e205b05cee4ae3c2c54621bac63af0684",
  "block_hash": "946ac86cdc03868f365290935f3febda39a42e2f9474e0d461ef332776b7cf8d",
  "block_height": 7352933,
  "parent_block_id": "d1bf095126614db563cb5157803d8d82054139adb2bbe2a2d8689a506ea9ae90",
  "consensus_hash": "e207d4238760d133e52790da76e2dd59567f9b5e",
  "fees": 0,
  "tx_merkle_root": "0000000000000000000000000000000000000000000000000000000000000000",
  "state_index_root": "48f8080ab57712ff4a7018ab4a5446252d51102f255df9c3e4624a2ce3992981",
  "timestamp": 1774546381,
  "miner_signature": "01a708d36bc72a31f6618394e275d2a6a323781000870d7075173ec70746d2e96445623e94708650fc03751e0fbdbf0a8b5d4574a2df2c0e8b4137e9edd89c4bc8",
  "signer_signature": [],
  "transactions": [],
  "valid_merkle_root": false
}

Fetch metadata about the ongoing Nakamoto tenure

GET

https://stacks.nownodes.io/v3/tenures/info

Fetch metadata about the ongoing Nakamoto tenure. This information is sufficient to obtain and authenticate the highest complete tenure, as well as obtain new tenure blocks.

Response

200OK

Metadata about the ongoing tenure

Authorization

api-keyAuthapiKey in header

Fetch metadata about the ongoing Nakamoto tenure

curl -X GET 'https://stacks.nownodes.io/v3/tenures/info'

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

const data = await response.json();

import requests

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

200

{
  "consensus_hash": "4c5a49be0e34dc603b66f090fd07d28a2f76a2ad",
  "parent_consensus_hash": "fa8a04af41957499afdd4082b9b702ffca9a4370",
  "parent_tenure_start_block_id": "0cfec8433849d353ad6b2fe1173da143e3d4a3ab452588a14eb074d0181ac202",
  "reward_cycle": 8,
  "tenure_start_block_id": "0425099d51547c714df6a7864c040c1a605b198ff07f71d19a823139c88a35f8",
  "tip_block_id": "52d64f5e47abc7666c4fed3fe850f381f93f2d588ee2a92a4e07b44f14588d5e",
  "tip_height": 416
}

Fetch a sequence of Nakamoto blocks in a tenure

GET

https://stacks.nownodes.io/v3/tenures/{block_id}

Fetch a sequence of Nakamoto blocks in a tenure. The blocks will be served in order from highest to lowest. The blocks will be encoded in their SIP-003 wire format, and concatenated together.

Parameters

block_idstringrequiredpath

The tenure-start block ID of the tenure to query

stopstringquery

The block ID hash of the highest block in this tenure that is already known to the caller. Neither the corresponding block nor any of its ancestors will be served. This is used to fetch tenure blocks that the caller does not have.

Response

200OK

SIP-003-encoded Nakamoto blocks, concatenated together

Authorization

api-keyAuthapiKey in header

Fetch a sequence of Nakamoto blocks in a tenure

curl -X GET 'https://stacks.nownodes.io/v3/tenures/{block_id}'

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

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v3/tenures/{block_id}')
data = response.json()

200

"binary"

Fetch information about evaluated burnchain blocks (i.e., sortitions).

GET

https://stacks.nownodes.io/v3/sortitions/{lookup_kind}/{lookup}

Fetch sortition information about a burnchain block. If the lookup_kind and lookup parameters are empty, it will return information about the latest burn block.

Parameters

lookup_kindstringpath

The style of lookup that should be performed. If not given, the most recent burn block processed will be returned. Otherwise, the lookup_kind should be one of the following strings:

consensus - find the burn block using the consensus hash supplied in the lookup field.
burn_height - find the burn block using the burn block height supplied in the lookup field.
burn - find the burn block using the burn block hash supplied in the lookup field.
latest_and_last - return information about the latest burn block with a winning miner and the previous such burn block

lookupstringpath

The value to use for the lookup if lookup_kind is consensus, burn_height, or burn

Response

200OK

Information for the burn block or in the case of latest_and_last, multiple burn blocks

Authorization

api-keyAuthapiKey in header

Fetch information about evaluated burnchain blocks (i.e., sortitions).

curl -X GET 'https://stacks.nownodes.io/v3/sortitions/{lookup_kind}/{lookup}'

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

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v3/sortitions/{lookup_kind}/{lookup}')
data = response.json()

200

A single element list is returned when just one sortition is requested

[
  {
    "burn_block_hash": "0x046f54cd1924a5d80fc3b8186d0334b7521acae90f9e136e2bee680c720d0e83",
    "burn_block_height": 231,
    "burn_header_timestamp": 1726797570,
    "sortition_id": "0x8a5116b7b4306dc4f6db290d1adfff9e1347f3e921bb793fc4c33e2ff05056e2",
    "parent_sortition_id": "0xdaf479110cf859e58c56b6ae941f8a14e7c7992c57027183dfbda4a4b820897c",
    "consensus_hash": "0x8d2c51db737597a93191f49bcdc9c7bb44b90892",
    "was_sortition": true,
    "miner_pk_hash160": "0x6bc51b33e9f3626944eb879147e18111581f8f9b",
    "stacks_parent_ch": "0x697357c72da55b759b1d6b721676c92c69f0b490",
    "last_sortition_ch": "0x697357c72da55b759b1d6b721676c92c69f0b490",
    "committed_block_hash": "0xeea47d6d639c565027110e192e308fb11656183d5c077bcd718d830652800183",
    "vrf_seed": "0x48b754acc291a5bfad1354ee19bbc471f14af2b21dc7eccc0f929bd16798defe"
  }
]

Sortition information about the latest burn block with a winning miner, and the previous such burn block.

[
  {
    "burn_block_hash": "0x046f54cd1924a5d80fc3b8186d0334b7521acae90f9e136e2bee680c720d0e83",
    "burn_block_height": 231,
    "burn_header_timestamp": 1726797570,
    "sortition_id": "0x8a5116b7b4306dc4f6db290d1adfff9e1347f3e921bb793fc4c33e2ff05056e2",
    "parent_sortition_id": "0xdaf479110cf859e58c56b6ae941f8a14e7c7992c57027183dfbda4a4b820897c",
    "consensus_hash": "0x8d2c51db737597a93191f49bcdc9c7bb44b90892",
    "was_sortition": true,
    "miner_pk_hash160": "0x6bc51b33e9f3626944eb879147e18111581f8f9b",
    "stacks_parent_ch": "0x697357c72da55b759b1d6b721676c92c69f0b490",
    "last_sortition_ch": "0x697357c72da55b759b1d6b721676c92c69f0b490",
    "committed_block_hash": "0xeea47d6d639c565027110e192e308fb11656183d5c077bcd718d830652800183"
  },
  {
    "burn_block_hash": "0x496ff02cb63a4850d0bdee5fab69284b6eb0392b4538e1c462f82362c5becfa4",
    "burn_block_height": 230,
    "burn_header_timestamp": 1726797570,
    "sortition_id": "0xdaf479110cf859e58c56b6ae941f8a14e7c7992c57027183dfbda4a4b820897c",
    "parent_sortition_id": "0xf9058692055cbd879d7f71e566e44b905a887b2b182407ed596b5d6499ceae2a",
    "consensus_hash": "0x697357c72da55b759b1d6b721676c92c69f0b490",
    "was_sortition": true,
    "miner_pk_hash160": "0x6bc51b33e9f3626944eb879147e18111581f8f9b",
    "stacks_parent_ch": "0xf7d1bd7d9d5c5a5c368402b6ef9510bd014d70f7",
    "last_sortition_ch": "0xf7d1bd7d9d5c5a5c368402b6ef9510bd014d70f7",
    "committed_block_hash": "0x36ee5f7f7271de1c1d4cd830e36320b51e01605547621267ae6e9b4e9b10f95e"
  }
]

Get number of blocks signed by signer during a given reward cycle

GET

https://stacks.nownodes.io/v3/signer/{signer}/{cycle_number}

Get number of blocks signed by signer during a given reward cycle

Parameters

signerstringrequiredpath

Hex-encoded compressed Secp256k1 public key of signer

cycle_numberintegerrequiredpath

Reward cycle number

Response

200OK

Number of blocks signed

Authorization

api-keyAuthapiKey in header

Get number of blocks signed by signer during a given reward cycle

curl -X GET 'https://stacks.nownodes.io/v3/signer/{signer}/{cycle_number}'

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

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v3/signer/{signer}/{cycle_number}')
data = response.json()

200

Get tenure blocks by burn block hash

GET

https://stacks.nownodes.io/v3/tenures/blocks/hash/{hash}

Returns information about Stacks blocks that correspond to a specific Bitcoin burn block hash. Tenures represent the relationship between Stacks blocks and Bitcoin blocks in the Proof of Transfer (PoX) consensus.

Parameters

hashstringrequiredpath

Bitcoin burn block hash in hex format. This is the hash of the Bitcoin block that mined the Stacks blocks.

Response

200OK

Successful response with tenure blocks information

400Bad Request

Bad request - invalid burn block hash format

404Not Found

Tenure not found for the specified burn block hash

500Internal Server Error

Internal server error

Authorization

api-keyAuthapiKey in header

Get tenure blocks by burn block hash

curl -X GET 'https://stacks.nownodes.io/v3/tenures/blocks/hash/{hash}'

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

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v3/tenures/blocks/hash/{hash}')
data = response.json()

{
  "consensus_hash": "41f41ef8fdd222aa0214d6c519374a9500188dbb",
  "burn_block_height": 919368,
  "burn_block_hash": "00000000000000000000bee5d3c310bc8fb7f99092a2d2e610139f641267a6f3",
  "stacks_blocks": [
    {
      "block_id": "8d6771e00f70f6ac306a1f8c5c36dc33c52e863c4e0c273b8b2ee94e5d400578",
      "header_type": "nakamoto",
      "block_hash": "f4d522a4b5929a76d04af8eba83e720479f972a3a28a146586ddebe5acafcd33",
      "parent_block_id": "b3b1d40ea3d34a4fc904986f018434a18ef42f807405a40786a78645a428fbeb",
      "height": 4222539
    }
  ]
}

{
  "error": "Invalid burn block hash format",
  "code": "invalid_hash_format"
}

{
  "error": "Tenure not found for burn block hash",
  "code": "tenure_not_found"
}

{
  "error": "Internal server error while fetching tenure data",
  "code": "internal_server_error"
}

Get tenure blocks by burn block height

GET

https://stacks.nownodes.io/v3/tenures/blocks/height/{height}

Returns information about Stacks blocks that correspond to a specific Bitcoin burn block height. Tenures represent the relationship between Stacks blocks and Bitcoin blocks in the Proof of Transfer (PoX) consensus.

Parameters

heightinteger>= 0requiredpath

Bitcoin burn block height (block number in the Bitcoin blockchain). This specifies the position of the Bitcoin block in the chain.

Response

200OK

Successful response with tenure blocks information

400Bad Request

Bad request - invalid burn block height

404Not Found

Tenure not found for the specified burn block height

500Internal Server Error

Internal server error

Authorization

api-keyAuthapiKey in header

Get tenure blocks by burn block height

curl -X GET 'https://stacks.nownodes.io/v3/tenures/blocks/height/{height}'

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

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v3/tenures/blocks/height/{height}')
data = response.json()

{
  "consensus_hash": "51g52fg9gdd333bb0325e7d629485b9600299ecc",
  "burn_block_height": 919652,
  "burn_block_hash": "0000000000000000000123e5d3c310bc8fb7f99092a2d2e610139f641267a6f4",
  "stacks_blocks": [
    {
      "block_id": "9e7882f11g81g7bd417b2g9d6c47ed44d63f974c5e1d284597c7eea5e511079",
      "header_type": "nakamoto",
      "block_hash": "g5e633b5c683b76e15bf9fcb83f8305908g084b4b39b157687eefc6bdafde344",
      "parent_block_id": "c4c2e51fb4e45b5gd015a997129545b29ff53g918506b50897b89756b539gcec",
      "height": 4222650
    }
  ]
}

{
  "error": "Invalid burn block height",
  "code": "invalid_height"
}

{
  "error": "Tenure not found for burn block height",
  "code": "tenure_not_found"
}

{
  "error": "Internal server error while fetching tenure data",
  "code": "internal_server_error"
}

Get tip metadata for a specific consensus hash

GET

https://stacks.nownodes.io/v3/tenures/tip_metadata/{consensus_hash}

Returns the anchored header and burn view for the specified consensus hash.

Parameters

consensus_hashstringrequiredpath

Consensus hash identifying the block

Response

200OK

Successful response

Authorization

api-keyAuthapiKey in header

Get tip metadata for a specific consensus hash

curl -X GET 'https://stacks.nownodes.io/v3/tenures/tip_metadata/{consensus_hash}'

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

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v3/tenures/tip_metadata/{consensus_hash}')
data = response.json()

200

{
  "anchored_header": {
    "Nakamoto": {
      "version": 0,
      "chain_length": 5859779,
      "burn_spent": 431131502048,
      "consensus_hash": "76aadfcfc5322c035ad7006e81810a43dbf52abf",
      "parent_block_id": "fc2c589ed7b6124c0a86862fb606a27bdb03ebf53f00d44bf8a8ea18d54c1487",
      "tx_merkle_root": "833f67422a4a703a045304c72eec400a27b1d8ca5020073c94d7b6279ee9742e",
      "state_index_root": "1d43fee132a98a49c20ae6298bbea3f67943123a100ddbe666139de1c7cbdc5f",
      "timestamp": 1768312386,
      "miner_signature": "00e4931137cd50701994eba65922d41573ef70cf607a9f16112157bd3a65fdba525d719f46b4718b814c9493301c1c7316d3f015085f1db23c53434700c9379ca3",
      "signer_signature": [
        "0102df4f1414cc1de5f8ed88975dfbf70dbd2e185a93fcd575a524bdbf54e7aacc0db84a373884e89f4f9afed2e82e3ee49ad8ea430e9ff1fc8ef63d9ec9906190"
      ],
      "pox_treatment": "0f8a000001f2ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff03"
    }
  },
  "burn_view": "76aadfcfc5322c035ad7006e81810a43dbf52abf"
}

Info

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

Get Core API info

GET

https://stacks.nownodes.io/v2/info

Get Core API information

Response

200OK

Success

Authorization

api-keyAuthapiKey in header

Get Core API info

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

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

const data = await response.json();

import requests

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

200

{
  "peer_version": 385875968,
  "pox_consensus": "17f76e597bab45646956f38dd39573085d72cbc0",
  "burn_block_height": 16,
  "stable_pox_consensus": "8e0561978fc5506b68a589c402dad97e862edb59",
  "stable_burn_block_height": 15,
  "server_version": "blockstack-core 0.0.1 => 23.0.0.0 (, release build, linux [x86_64])",
  "network_id": 2147483648,
  "parent_network_id": 3669344250,
  "stacks_tip_height": 15,
  "stacks_tip": "b1807a2d3f7f8c7922f7c1d60d7c34145ade05d789640dc7dc9ec1021e07bb54",
  "stacks_tip_consensus_hash": "17f76e597bab45646956f38dd39573085d72cbc0",
  "unanchored_tip": "0000000000000000000000000000000000000000000000000000000000000000",
  "tenure_height": 523,
  "exit_at_block_height": null,
  "is_fully_synced": false
}

Get PoX details

GET

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

Get Proof of Transfer (PoX) information. Can be used for Stacking.

Parameters

tipstringquery

The Stacks chain tip to query from. If tip == latest, the query will be run from the latest known tip (includes unconfirmed state).

Response

200OK

Success

Authorization

api-keyAuthapiKey in header

Get PoX details

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

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

const data = await response.json();

import requests

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

200

{
  "contract_id": "SP000000000000000000002Q6VF78.pox",
  "pox_activation_threshold_ustx": 52329761604388,
  "first_burnchain_block_height": 666050,
  "current_burnchain_block_height": 812345,
  "prepare_phase_block_length": 100,
  "reward_phase_block_length": 2000,
  "reward_slots": 4000,
  "rejection_fraction": 25,
  "total_liquid_supply_ustx": 1046595232087772,
  "current_cycle": {
    "id": 2,
    "min_threshold_ustx": 70000000000,
    "stacked_ustx": 202157971547640,
    "is_pox_active": true
  },
  "next_cycle": {
    "id": 3,
    "min_threshold_ustx": 70000000000,
    "min_increment_ustx": 52329761604,
    "stacked_ustx": 162057034977640,
    "prepare_phase_start_block_height": 672250,
    "blocks_until_prepare_phase": 407,
    "reward_phase_start_block_height": 672350,
    "blocks_until_reward_phase": 507,
    "ustx_until_pox_rejection": 261648808021925
  },
  "min_amount_ustx": 70000000000,
  "prepare_cycle_length": 100,
  "reward_cycle_id": 2,
  "reward_cycle_length": 2100,
  "rejection_votes_left_required": 261648808021925,
  "next_reward_cycle_in": 507,
  "contract_versions": [
    {
      "contract_id": "SP000000000000000000002Q6VF78.pox",
      "activation_burnchain_block_height": 666050,
      "first_reward_cycle_id": 0
    },
    {
      "contract_id": "SP000000000000000000002Q6VF78.pox-2",
      "activation_burnchain_block_height": 712345,
      "first_reward_cycle_id": 123
    }
  ]
}

Smart Contracts

Read-only endpoints to obtain Clarity smart contract details

Get contract interface

GET

https://stacks.nownodes.io/v2/contracts/interface/{contract_address}/{contract_name}

Get contract interface using a contract_address and contract name

Parameters

contract_addressstringrequiredpath

Stacks address

contract_namestringrequiredpath

Contract name

tipstringquery

The Stacks chain tip to query from. If tip == latest, the query will be run from the latest known tip (includes unconfirmed state).

Response

200OK

Contract interface

Authorization

api-keyAuthapiKey in header

Get contract interface

curl -X GET 'https://stacks.nownodes.io/v2/contracts/interface/{contract_address}/{contract_name}'

const response = await fetch('https://stacks.nownodes.io/v2/contracts/interface/{contract_address}/{contract_name}', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v2/contracts/interface/{contract_address}/{contract_name}')
data = response.json()

200

{
  "functions": [
    {
      "name": "get-value",
      "access": "public",
      "args": [
        {
          "name": "key",
          "type": {
            "buffer": {
              "length": 32
            }
          }
        }
      ],
      "outputs": {
        "type": {
          "response": {
            "ok": {
              "buffer": {
                "length": 32
              }
            },
            "error": "int128"
          }
        }
      }
    },
    {
      "name": "set-value",
      "access": "public",
      "args": [
        {
          "name": "key",
          "type": {
            "buffer": {
              "length": 32
            }
          }
        },
        {
          "name": "value",
          "type": {
            "buffer": {
              "length": 32
            }
          }
        }
      ],
      "outputs": {
        "type": {
          "response": {
            "ok": "uint128",
            "error": "none"
          }
        }
      }
    },
    {
      "name": "test-emit-event",
      "access": "public",
      "args": [],
      "outputs": {
        "type": {
          "response": {
            "ok": "uint128",
            "error": "none"
          }
        }
      }
    },
    {
      "name": "test-event-types",
      "access": "public",
      "args": [],
      "outputs": {
        "type": {
          "response": {
            "ok": "uint128",
            "error": "none"
          }
        }
      }
    }
  ],
  "variables": [
    {
      "name": "recipient",
      "type": "principal",
      "access": "constant"
    },
    {
      "name": "sender",
      "type": "principal",
      "access": "constant"
    }
  ],
  "maps": [
    {
      "name": "store",
      "key": [
        {
          "name": "key",
          "type": {
            "buffer": {
              "length": 32
            }
          }
        }
      ],
      "value": [
        {
          "name": "value",
          "type": {
            "buffer": {
              "length": 32
            }
          }
        }
      ]
    }
  ],
  "fungible_tokens": [
    {
      "name": "novel-token-19"
    }
  ],
  "non_fungible_tokens": [
    {
      "name": "hello-nft",
      "type": "uint128"
    }
  ]
}

Get specific data-map inside a contract

POST

https://stacks.nownodes.io/v2/map_entry/{contract_address}/{contract_name}/{map_name}

Attempt to fetch data from a contract data map. The contract is identified with [Stacks Address] and [Contract Name] in the URL path. The map is identified with [Map Name].

The key to lookup in the map is supplied via the POST body. This should be supplied as the hex string serialization of the key (which should be a Clarity value). Note, this is a JSON string atom.

In the response, data is the hex serialization of the map response. Note that map responses are Clarity option types, for non-existent values, this is a serialized none, and for all other responses, it is a serialized (some ...) object.

Body

application/json

Hex string serialization of the lookup key (which should be a Clarity value)

string

Parameters

contract_addressstringrequiredpath

Stacks address

contract_namestringrequiredpath

Contract name

map_namestringrequiredpath

Map name

proofintegerquery

Returns object without the proof field when set to 0

tipstringquery

The Stacks chain tip to query from. If tip == latest, the query will be run from the latest known tip (includes unconfirmed state).

Response

200OK

Success

400Bad Request

Failed loading data map

Authorization

api-keyAuthapiKey in header

Get specific data-map inside a contract

curl -X POST 'https://stacks.nownodes.io/v2/map_entry/{contract_address}/{contract_name}/{map_name}' \
  -H 'Content-Type: application/json' \
  -d '"string"'

const response = await fetch('https://stacks.nownodes.io/v2/map_entry/{contract_address}/{contract_name}/{map_name}', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify("string"),
});

const data = await response.json();

import requests

payload = "string"

response = requests.post('https://stacks.nownodes.io/v2/map_entry/{contract_address}/{contract_name}/{map_name}', json=payload)
data = response.json()

Request Body

"string"

200

{
  "data": "0x0a0c000000010a6d6f6e737465722d69640100000000000000000000000000000001",
  "proof": "0x123..."
}

Get contract source

GET

https://stacks.nownodes.io/v2/contracts/source/{contract_address}/{contract_name}

Returns the Clarity source code of a given contract, along with the block height it was published in, and the MARF proof for the data

Parameters

contract_addressstringrequiredpath

Stacks address

contract_namestringrequiredpath

Contract name

proofintegerquery

Returns object without the proof field if set to 0

tipstringquery

The Stacks chain tip to query from. If tip == latest, the query will be run from the latest known tip (includes unconfirmed state).

Response

200OK

Success

Authorization

api-keyAuthapiKey in header

Get contract source

curl -X GET 'https://stacks.nownodes.io/v2/contracts/source/{contract_address}/{contract_name}'

const response = await fetch('https://stacks.nownodes.io/v2/contracts/source/{contract_address}/{contract_name}', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v2/contracts/source/{contract_address}/{contract_name}')
data = response.json()

200

{
  "source": "(define-constant sender 'SZ2J6ZY48GV1EZ5V2V5RB9MP66SW86PYKKQ9H6DPR)\n(define-constant recipient 'SM2J6ZY48GV1EZ5V2V5RB9MP66SW86PYKKQVX8X0G)\n\n(define-fungible-token novel-token-19)\n(begin (ft-mint? novel-token-19 u12 sender))\n(begin (ft-transfer? novel-token-19 u2 sender recipient))\n\n(define-non-fungible-token hello-nft uint)\n(begin (nft-mint? hello-nft u1 sender))\n(begin (nft-mint? hello-nft u2 sender))\n(begin (nft-transfer? hello-nft u1 sender recipient))\n\n(define-public (test-emit-event)\n    (begin\n        (print \"Event! Hello world\")\n        (ok u1)))\n(begin (test-emit-event))\n\n(define-public (test-event-types)\n    (begin\n        (unwrap-panic (ft-mint? novel-token-19 u3 recipient))\n        (unwrap-panic (nft-mint? hello-nft u2 recipient))\n        (unwrap-panic (stx-transfer? u60 tx-sender 'SZ2J6ZY48GV1EZ5V2V5RB9MP66SW86PYKKQ9H6DPR))\n        (unwrap-panic (stx-burn? u20 tx-sender))\n        (ok u1)))\n\n(define-map store ((key (buff 32))) ((value (buff 32))))\n(define-public (get-value (key (buff 32)))\n    (begin\n        (match (map-get? store ((key key)))\n            entry (ok (get value entry))\n            (err 0))))\n(define-public (set-value (key (buff 32)) (value (buff 32)))\n    (begin\n        (map-set store ((key key)) ((value value)))\n        (ok u1)))",
  "publish_height": 3196,
  "proof": "0000001104060000001ec4e..."
}

Call read-only function

POST

https://stacks.nownodes.io/v2/contracts/call-read/{contract_address}/{contract_name}/{function_name}

Call a read-only public function on a given smart contract.

The smart contract and function are specified using the URL path. The arguments and the simulated tx-sender are supplied via the POST body in the following JSON format:

Body

application/json

map of arguments and the simulated tx-sender where sender is either a Contract identifier or a normal Stacks address, and arguments is an array of hex serialized Clarity values.

Describes representation of a Type-0 Stacks 2.0 transaction. https://github.com/stacksgov/sips/blob/main/sips/sip-005/sip-005-blocks-and-transactions.md#type-0-transferring-an-asset

senderstringrequired

The simulated tx-sender

argumentsArray<string>required

An array of hex serialized Clarity values

Parameters

contract_addressstringrequiredpath

Stacks address

contract_namestringrequiredpath

Contract name

function_namestringrequiredpath

Function name

tipstringquery

The Stacks chain tip to query from. If tip == latest, the query will be run from the latest known tip (includes unconfirmed state).

Response

200OK

Success

Authorization

api-keyAuthapiKey in header

Call read-only function

curl -X POST 'https://stacks.nownodes.io/v2/contracts/call-read/{contract_address}/{contract_name}/{function_name}' \
  -H 'Content-Type: application/json' \
  -d '{
    "sender": "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info",
    "arguments": [
      "0x0011...",
      "0x00231..."
    ]
  }'

const response = await fetch('https://stacks.nownodes.io/v2/contracts/call-read/{contract_address}/{contract_name}/{function_name}', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "sender": "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info",
      "arguments": [
        "0x0011...",
        "0x00231..."
      ]
    }),
});

const data = await response.json();

import requests

payload = {
  "sender": "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info",
  "arguments": [
    "0x0011...",
    "0x00231..."
  ]
}

response = requests.post('https://stacks.nownodes.io/v2/contracts/call-read/{contract_address}/{contract_name}/{function_name}', json=payload)
data = response.json()

Request Body

{
  "sender": "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info",
  "arguments": [
    "0x0011...",
    "0x00231..."
  ]
}

200

{
  "okay": true,
  "result": "0x111..."
}

{
  "okay": false,
  "cause": "Unchecked(PublicFunctionNotReadOnly(..."
}

Get trait implementation details

GET

https://stacks.nownodes.io/v2/traits/{contract_address}/{contract_name}/{trait_contract_address}/{trait_contract_name}/{trait_name}

Determine whether or not a specified trait is implemented (either explicitly or implicitly) within a given contract.

Parameters

contract_addressstringrequiredpath

Stacks address

contract_namestringrequiredpath

Contract name

trait_contract_addressstringrequiredpath

Trait Stacks address

trait_contract_namestringrequiredpath

Trait contract name

trait_namestringrequiredpath

Trait name

tipstringquery

The Stacks chain tip to query from. If tip == "latest", the query will be run from the latest known tip (includes unconfirmed state). If the tip is left unspecified, the stacks chain tip will be selected (only includes confirmed state).

Response

200OK

Success

Authorization

api-keyAuthapiKey in header

Get trait implementation details

curl -X GET 'https://stacks.nownodes.io/v2/traits/{contract_address}/{contract_name}/{trait_contract_address}/{trait_contract_name}/{trait_name}'

const response = await fetch('https://stacks.nownodes.io/v2/traits/{contract_address}/{contract_name}/{trait_contract_address}/{trait_contract_name}/{trait_name}', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v2/traits/{contract_address}/{contract_name}/{trait_contract_address}/{trait_contract_name}/{trait_name}')
data = response.json()

200

{
  "is_implemented": true
}

Get the MARF value for a given key

POST

https://stacks.nownodes.io/v2/clarity/marf/{clarity_marf_key}

Attempt to fetch the value of a MARF key.

In the response, data is the hex serialization of the value.

Parameters

clarity_marf_keystringrequiredpath

MARF key

proofintegerquery

Returns object without the proof field when set to 0

tipstringquery

The Stacks chain tip to query from. If tip == latest, the query will be run from the latest known tip (includes unconfirmed state).

Response

200OK

Success

400Bad Request

Failed to retrieve MARF key

Authorization

api-keyAuthapiKey in header

Get the MARF value for a given key

curl -X POST 'https://stacks.nownodes.io/v2/clarity/marf/{clarity_marf_key}'

const response = await fetch('https://stacks.nownodes.io/v2/clarity/marf/{clarity_marf_key}', {
  method: 'POST',
});

const data = await response.json();

import requests

response = requests.post('https://stacks.nownodes.io/v2/clarity/marf/{clarity_marf_key}')
data = response.json()

200

{
  "data": "0x0a0c000000010a6d6f6e737465722d69640100000000000000000000000000000001",
  "proof": "0x123..."
}

Get the contract metadata for the metadata key

POST

https://stacks.nownodes.io/v2/clarity/metadata/{contract_address}/{contract_name}/{clarity_metadata_key}

Attempt to fetch the metadata of a contract. The contract is identified with [Contract Address] and [Contract Name] in the URL path. The metadata key is identified with [Clarity Metadata Key].

In the response, data is formatted as JSON.

Parameters

contract_addressstringrequiredpath

Stacks address

contract_namestringrequiredpath

Contract name

clarity_metadata_keystringrequiredpath

Metadata key

tipstringquery

The Stacks chain tip to query from. If tip == latest, the query will be run from the latest known tip (includes unconfirmed state).

Response

200OK

Success

400Bad Request

Failed to retrieve constant value from contract

Authorization

api-keyAuthapiKey in header

Get the contract metadata for the metadata key

curl -X POST 'https://stacks.nownodes.io/v2/clarity/metadata/{contract_address}/{contract_name}/{clarity_metadata_key}'

const response = await fetch('https://stacks.nownodes.io/v2/clarity/metadata/{contract_address}/{contract_name}/{clarity_metadata_key}', {
  method: 'POST',
});

const data = await response.json();

import requests

response = requests.post('https://stacks.nownodes.io/v2/clarity/metadata/{contract_address}/{contract_name}/{clarity_metadata_key}')
data = response.json()

200

{
  "data": "'{\"contract_identifier\":{...}, \"private_function_types\":{...}'"
}

Get the value of a constant inside a contract

POST

https://stacks.nownodes.io/v2/constant_val/{contract_address}/{contract_name}/{constant_name}

Attempt to fetch the value of a constant inside a contract. The contract is identified with [Stacks Address] and [Contract Name] in the URL path. The constant is identified with [Constant Name].

In the response, data is the hex serialization of the constant value.

Parameters

contract_addressstringrequiredpath

Stacks address

contract_namestringrequiredpath

Contract name

constant_namestringrequiredpath

Constant name

tipstringquery

The Stacks chain tip to query from. If tip == latest, the query will be run from the latest known tip (includes unconfirmed state).

Response

200OK

Success

400Bad Request

Failed to retrieve constant value from contract

Authorization

api-keyAuthapiKey in header

Get the value of a constant inside a contract

curl -X POST 'https://stacks.nownodes.io/v2/constant_val/{contract_address}/{contract_name}/{constant_name}'

const response = await fetch('https://stacks.nownodes.io/v2/constant_val/{contract_address}/{contract_name}/{constant_name}', {
  method: 'POST',
});

const data = await response.json();

import requests

response = requests.post('https://stacks.nownodes.io/v2/constant_val/{contract_address}/{contract_name}/{constant_name}')
data = response.json()

200

{
  "data": "0x01ce..."
}

Transactions

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

Broadcast raw transaction

POST

https://stacks.nownodes.io/v2/transactions

Broadcast raw transactions on the network. You can use the @stacks/transactions project to generate a raw transaction payload.

Body

application/octet-stream

string<binary>

Response

200OK

Transaction ID of successful post of a raw tx to the node's mempool

400Bad Request

Rejections result in a 400 error

Authorization

api-keyAuthapiKey in header

Broadcast raw transaction

curl -X POST 'https://stacks.nownodes.io/v2/transactions' \
  -H 'Content-Type: application/octet-stream' \
  -d '"binary format of 00000000010400bed38c2aadffa348931bcb542880ff79d607afec000000000000000000000000000000c800012b0b1fff6cccd0974966dcd665835838f0985be508e1322e09fb3d751eca132c492bda720f9ef1768d14fdabed6127560ba52d5e3ac470dcb60b784e97dc88c9030200000000000516df0ba3e79792be7be5e50a370289accfc8c9e032000000000000303974657374206d656d6f00000000000000000000000000000000000000000000000000"'

const response = await fetch('https://stacks.nownodes.io/v2/transactions', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/octet-stream',
  },
  body: JSON.stringify("binary format of 00000000010400bed38c2aadffa348931bcb542880ff79d607afec000000000000000000000000000000c800012b0b1fff6cccd0974966dcd665835838f0985be508e1322e09fb3d751eca132c492bda720f9ef1768d14fdabed6127560ba52d5e3ac470dcb60b784e97dc88c9030200000000000516df0ba3e79792be7be5e50a370289accfc8c9e032000000000000303974657374206d656d6f00000000000000000000000000000000000000000000000000"),
});

const data = await response.json();

import requests

payload = "binary format of 00000000010400bed38c2aadffa348931bcb542880ff79d607afec000000000000000000000000000000c800012b0b1fff6cccd0974966dcd665835838f0985be508e1322e09fb3d751eca132c492bda720f9ef1768d14fdabed6127560ba52d5e3ac470dcb60b784e97dc88c9030200000000000516df0ba3e79792be7be5e50a370289accfc8c9e032000000000000303974657374206d656d6f00000000000000000000000000000000000000000000000000"

response = requests.post('https://stacks.nownodes.io/v2/transactions', json=payload)
data = response.json()

Request Body

"binary format of 00000000010400bed38c2aadffa348931bcb542880ff79d607afec000000000000000000000000000000c800012b0b1fff6cccd0974966dcd665835838f0985be508e1322e09fb3d751eca132c492bda720f9ef1768d14fdabed6127560ba52d5e3ac470dcb60b784e97dc88c9030200000000000516df0ba3e79792be7be5e50a370289accfc8c9e032000000000000303974657374206d656d6f00000000000000000000000000000000000000000000000000"

"e161978626f216b2141b156ade10501207ae535fa365a13ef5d7a7c9310a09f2"

{
  "error": "transaction rejected",
  "reason": "BadNonce",
  "reason_data": {
    "actual": 4,
    "expected": 0,
    "is_origin": true,
    "principal": "ST2ZRX0K27GW0SP3GJCEMHD95TQGJMKB7G9Y0X1MH"
  },
  "txid": "caf6fd60ae05b0c2d19ef14ab6a7670b1095d117fa7c80224c74e76214d0a791"
}

Retrieve transaction details by TXID

POST

https://stacks.nownodes.io/v3/transaction/{txid}

Returns detailed information about a specific Stacks transaction, including the raw transaction bytes, execution result, and block metadata.

Parameters

tx_idstringrequiredpath

The transaction ID (hash) identifying the Stacks transaction.

Response

200OK

Transaction successfully retrieved

Authorization

api-keyAuthapiKey in header

Retrieve transaction details by TXID

curl -X POST 'https://stacks.nownodes.io/v3/transaction/{txid}'

const response = await fetch('https://stacks.nownodes.io/v3/transaction/{txid}', {
  method: 'POST',
});

const data = await response.json();

import requests

response = requests.post('https://stacks.nownodes.io/v3/transaction/{txid}')
data = response.json()

200

{
  "index_block_hash": "0e9db41c95f3d940483f3ad515078e8f93cf401d07fffbe09b4a9cc1313e1f71",
  "tx": "00000000010400f2bba6df751755ab9ac1df8b387d981cfe265cdf000000000020499f00000000000000b400018588430962cdc46929f7474d9bb1ba00cc61874fd8a2a1a60273bf3c4519de852632e0dbc5931509af496229124de6e45db31071b58a3726cfbf7b57850fd8b7030200000000000516fbd9a1702f4ecc44fc01f1894c72fcbb23a53ce8000000000000000100000000000000000000000000000000000000000000000000000000000000000000",
  "result": "(ok true)",
  "block_height": 5641143,
  "is_canonical": true
}

Fees

Read-only endpoints to obtain fee details

Get approximate fees for the given transaction

POST

https://stacks.nownodes.io/v2/fees/transaction

Get an estimated fee for the supplied transaction. This estimates the execution cost of the transaction, the current fee rate of the network, and returns estimates for fee amounts.

transaction_payload is a hex-encoded serialization of the TransactionPayload for the transaction.
estimated_len is an optional argument that provides the endpoint with an estimation of the final length (in bytes) of the transaction, including any post-conditions and signatures

If the node cannot provide an estimate for the transaction (e.g., if the node has never seen a contract-call for the given contract and function) or if estimation is not configured on this node, a 400 response is returned. The 400 response will be a JSON error containing a reason field which can be one of the following:

DatabaseError - this Stacks node has had an internal database error while trying to estimate the costs of the supplied transaction.
NoEstimateAvailable - this Stacks node has not seen this kind of contract-call before, and it cannot provide an estimate yet.
CostEstimationDisabled - this Stacks node does not perform fee or cost estimation, and it cannot respond on this endpoint.

The 200 response contains the following data:

estimated_cost - the estimated multi-dimensional cost of executing the Clarity VM on the provided transaction.
estimated_cost_scalar - a unitless integer that the Stacks node uses to compare how much of the block limit is consumed by different transactions. This value incorporates the estimated length of the transaction and the estimated execution cost of the transaction. The range of this integer may vary between different Stacks nodes. In order to compute an estimate of total fee amount for the transaction, this value is multiplied by the same Stacks node's estimated fee rate.
cost_scalar_change_by_byte - a float value that indicates how much the estimated_cost_scalar value would increase for every additional byte in the final transaction.
estimations - an array of estimated fee rates and total fees to pay in microSTX for the transaction. This array provides a range of estimates (default: 3) that may be used. Each element of the array contains the following fields:
- fee_rate - the estimated value for the current fee rates in the network
- fee - the estimated value for the total fee in microSTX that the given transaction should pay. These values are the result of computing: fee_rate x estimated_cost_scalar. If the estimated fees are less than the minimum relay fee (1 ustx x estimated_len), then that minimum relay fee will be returned here instead.

Note: If the final transaction's byte size is larger than supplied to estimated_len, then applications should increase this fee amount by:

fee_rate x cost_scalar_change_by_byte x (final_size - estimated_size)

Body

application/json

POST request for estimated fee

transaction_payloadstringrequired

estimated_leninteger

Response

200OK

Estimated fees for the transaction

Authorization

api-keyAuthapiKey in header

Get approximate fees for the given transaction

curl -X POST 'https://stacks.nownodes.io/v2/fees/transaction' \
  -H 'Content-Type: application/json' \
  -d '{
    "estimated_len": 350,
    "transaction_payload": "021af942874ce525e87f21bbe8c121b12fac831d02f4086765742d696e666f0b7570646174652d696e666f00000000"
  }'

const response = await fetch('https://stacks.nownodes.io/v2/fees/transaction', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "estimated_len": 350,
      "transaction_payload": "021af942874ce525e87f21bbe8c121b12fac831d02f4086765742d696e666f0b7570646174652d696e666f00000000"
    }),
});

const data = await response.json();

import requests

payload = {
  "estimated_len": 350,
  "transaction_payload": "021af942874ce525e87f21bbe8c121b12fac831d02f4086765742d696e666f0b7570646174652d696e666f00000000"
}

response = requests.post('https://stacks.nownodes.io/v2/fees/transaction', json=payload)
data = response.json()

Request Body

{
  "estimated_len": 350,
  "transaction_payload": "021af942874ce525e87f21bbe8c121b12fac831d02f4086765742d696e666f0b7570646174652d696e666f00000000"
}

200

{
  "cost_scalar_change_by_byte": 0.00476837158203125,
  "estimated_cost": {
    "read_count": 19,
    "read_length": 4814,
    "runtime": 7175000,
    "write_count": 2,
    "write_length": 1020
  },
  "estimated_cost_scalar": 14,
  "estimations": [
    {
      "fee": 17,
      "fee_rate": 1.2410714285714286
    },
    {
      "fee": 125,
      "fee_rate": 8.958333333333332
    },
    {
      "fee": 140,
      "fee_rate": 10
    }
  ]
}

Get estimated fee

GET

https://stacks.nownodes.io/v2/fees/transfer

Get an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer

Response

200OK

Success

Authorization

api-keyAuthapiKey in header

Get estimated fee

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

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

const data = await response.json();

import requests

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

200

Mining

Validate a proposed Stacks block

POST

https://stacks.nownodes.io/v3/block_proposal

Used by stackers to validate a proposed Stacks block from a miner.

This API endpoint requires a basic Authorization header.

Body

application/json

Response

202Accepted

Block proposal has been accepted for processing. The result will be returned via the event observer.

400Bad Request

Endpoint not enabled.

401Unauthorized

Unauthorized.

429Too Many Requests

There is an ongoing proposal validation being processed, the new request cannot be accepted until the prior request has been processed.

Authorization

api-keyAuthapiKey in header

Validate a proposed Stacks block

curl -X POST 'https://stacks.nownodes.io/v3/block_proposal' \
  -H 'Content-Type: application/json' \
  -d '{
    "block": "00000000000000001f00000000000927c08fb5ae5bf80e39e4168f6a3fddb0407a069d21ee68465e6856393254d2a66194f44bb01070666d5effcfb2436e209a75878fe80a04b4258a8cd34ab97c38a8dde331a2a509dd7e4b90590726866172cc138c18e80567737667f55d3f9817ce4714c91d1adfd36101141829dc0b5ea0c4944668c0005ddb6f9e2718f60014f21932a42a36ffaf58e88e77b217b2af366c15dd59e6b136ca773729832dcfc5875ec0830d04012dd5a4fa77a196646ea2b356289116fd02558c034b62d63f8a65bdd20d7ffc3fec6c266cd974be776a9e92759b90f288dcc2525b6b6bd5622c5f02e0922440e9ad1095c19b4467fd94566caa9755669d8e0000000180800000000400f64081ae6209dce9245753a4f764d6f168aae1af00000000000000000000000000000064000041dbcc7391991c1a18371eb49b879240247a3ec7f281328f53976c1218ffd65421dbb101e59370e2c972b29f48dc674b2de5e1b65acbd41d5d2689124d42c16c01010000000000051a346048df62be3a52bb6236e11394e8600229e27b000000000000271000000000000000000000000000000000000000000000000000000000000000000000",
    "chain_id": 2147483648
  }'

const response = await fetch('https://stacks.nownodes.io/v3/block_proposal', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "block": "00000000000000001f00000000000927c08fb5ae5bf80e39e4168f6a3fddb0407a069d21ee68465e6856393254d2a66194f44bb01070666d5effcfb2436e209a75878fe80a04b4258a8cd34ab97c38a8dde331a2a509dd7e4b90590726866172cc138c18e80567737667f55d3f9817ce4714c91d1adfd36101141829dc0b5ea0c4944668c0005ddb6f9e2718f60014f21932a42a36ffaf58e88e77b217b2af366c15dd59e6b136ca773729832dcfc5875ec0830d04012dd5a4fa77a196646ea2b356289116fd02558c034b62d63f8a65bdd20d7ffc3fec6c266cd974be776a9e92759b90f288dcc2525b6b6bd5622c5f02e0922440e9ad1095c19b4467fd94566caa9755669d8e0000000180800000000400f64081ae6209dce9245753a4f764d6f168aae1af00000000000000000000000000000064000041dbcc7391991c1a18371eb49b879240247a3ec7f281328f53976c1218ffd65421dbb101e59370e2c972b29f48dc674b2de5e1b65acbd41d5d2689124d42c16c01010000000000051a346048df62be3a52bb6236e11394e8600229e27b000000000000271000000000000000000000000000000000000000000000000000000000000000000000",
      "chain_id": 2147483648
    }),
});

const data = await response.json();

import requests

payload = {
  "block": "00000000000000001f00000000000927c08fb5ae5bf80e39e4168f6a3fddb0407a069d21ee68465e6856393254d2a66194f44bb01070666d5effcfb2436e209a75878fe80a04b4258a8cd34ab97c38a8dde331a2a509dd7e4b90590726866172cc138c18e80567737667f55d3f9817ce4714c91d1adfd36101141829dc0b5ea0c4944668c0005ddb6f9e2718f60014f21932a42a36ffaf58e88e77b217b2af366c15dd59e6b136ca773729832dcfc5875ec0830d04012dd5a4fa77a196646ea2b356289116fd02558c034b62d63f8a65bdd20d7ffc3fec6c266cd974be776a9e92759b90f288dcc2525b6b6bd5622c5f02e0922440e9ad1095c19b4467fd94566caa9755669d8e0000000180800000000400f64081ae6209dce9245753a4f764d6f168aae1af00000000000000000000000000000064000041dbcc7391991c1a18371eb49b879240247a3ec7f281328f53976c1218ffd65421dbb101e59370e2c972b29f48dc674b2de5e1b65acbd41d5d2689124d42c16c01010000000000051a346048df62be3a52bb6236e11394e8600229e27b000000000000271000000000000000000000000000000000000000000000000000000000000000000000",
  "chain_id": 2147483648
}

response = requests.post('https://stacks.nownodes.io/v3/block_proposal', json=payload)
data = response.json()

Request Body

{
  "block": "00000000000000001f00000000000927c08fb5ae5bf80e39e4168f6a3fddb0407a069d21ee68465e6856393254d2a66194f44bb01070666d5effcfb2436e209a75878fe80a04b4258a8cd34ab97c38a8dde331a2a509dd7e4b90590726866172cc138c18e80567737667f55d3f9817ce4714c91d1adfd36101141829dc0b5ea0c4944668c0005ddb6f9e2718f60014f21932a42a36ffaf58e88e77b217b2af366c15dd59e6b136ca773729832dcfc5875ec0830d04012dd5a4fa77a196646ea2b356289116fd02558c034b62d63f8a65bdd20d7ffc3fec6c266cd974be776a9e92759b90f288dcc2525b6b6bd5622c5f02e0922440e9ad1095c19b4467fd94566caa9755669d8e0000000180800000000400f64081ae6209dce9245753a4f764d6f168aae1af00000000000000000000000000000064000041dbcc7391991c1a18371eb49b879240247a3ec7f281328f53976c1218ffd65421dbb101e59370e2c972b29f48dc674b2de5e1b65acbd41d5d2689124d42c16c01010000000000051a346048df62be3a52bb6236e11394e8600229e27b000000000000271000000000000000000000000000000000000000000000000000000000000000000000",
  "chain_id": 2147483648
}

{
  "message": "Block proposal is processing, result will be returned via the event observer",
  "result": "Accepted"
}

{
  "message": "Could not process block proposal request: Proposal currently being evaluated",
  "result": "Error"
}

Fetch the stacker and signer set information for a given cycle.

GET

https://stacks.nownodes.io/v3/stacker_set/{cycle_number}

Used to get stacker and signer set information for a given cycle.

This will only return information for cycles started in Epoch-2.5 where PoX-4 was active and subsequent cycles.

Parameters

cycle_numberintegerrequiredpath

reward cycle number

Response

200OK

Information for the given reward cycle

400Bad Request

Could not fetch the given reward set

Authorization

api-keyAuthapiKey in header

Fetch the stacker and signer set information for a given cycle.

curl -X GET 'https://stacks.nownodes.io/v3/stacker_set/{cycle_number}'

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

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v3/stacker_set/{cycle_number}')
data = response.json()

{
  "stacker_set": {
    "rewarded_addresses": [
      {
        "Standard": [
          {
            "bytes": "dc5f18421006ee2b98ab972edfa7268a981e3f00",
            "version": 26
          },
          "SerializeP2PKH"
        ]
      }
    ],
    "signers": [
      {
        "signing_key": "02d0a27e4f1bf186b4391eecfcc4d4a0d403684ad089b477b8548a69dd6378bf26",
        "slots": 1,
        "stacked_amt": 2143020000000000
      }
    ],
    "start_cycle_state": {
      "missed_reward_slots": []
    }
  }
}

{
  "response": "error",
  "err_msg": "Could not read reward set. Prepare phase may not have started for this cycle yet. Cycle = 22, Err = PoXAnchorBlockRequired"
}

Signers

Get number of blocks signed by signer during a given reward cycle

GET

https://stacks.nownodes.io/v3/signer/{signer}/{cycle_number}

Get number of blocks signed by signer during a given reward cycle

Parameters

signerstringrequiredpath

Hex-encoded compressed Secp256k1 public key of signer

cycle_numberintegerrequiredpath

Reward cycle number

Response

200OK

Number of blocks signed

Authorization

api-keyAuthapiKey in header

Get number of blocks signed by signer during a given reward cycle

curl -X GET 'https://stacks.nownodes.io/v3/signer/{signer}/{cycle_number}'

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

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v3/signer/{signer}/{cycle_number}')
data = response.json()

200

STX

Accounts

Read-only endpoints to obtain Stacks account details

Get account info

GET

https://stacks.nownodes.io/v2/accounts/{principal}

Get the account data for the provided principal

Where balance is the hex encoding of a unsigned 128-bit integer (big-endian), nonce is a unsigned 64-bit integer, and the proofs are provided as hex strings.

For non-existent accounts, this does not 404, rather it returns an object with balance and nonce of 0.

Parameters

principalstringrequiredpath

Stacks address or a Contract identifier (e.g. SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info)

proofintegerquery

Returns object without the proof field if set to 0

tipstringquery

The Stacks chain tip to query from. If tip == latest, the query will be run from the latest known tip (includes unconfirmed state).

Response

200OK

Success

Authorization

api-keyAuthapiKey in header

Get account info

curl -X GET 'https://stacks.nownodes.io/v2/accounts/{principal}'

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

const data = await response.json();

import requests

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

200

{
  "balance": "0x0000000000000000000000000007a120",
  "locked": "0x0000000000000000000000000007a120",
  "unlock_height": 126,
  "nonce": 2867,
  "balance_proof": "0xabce",
  "nonce_proof": "0xabcd"
}

Blocks

Read-only endpoints to obtain Stacks block details

Fetch a Nakamoto block

GET

https://stacks.nownodes.io/v3/blocks/{block_id}

Fetch a Nakamoto block by its index block hash.

Parameters

block_idstringrequiredpath

The block's ID hash

Response

200OK

The raw SIP-003-encoded block will be returned.

404Not Found

The block could not be found

Authorization

api-keyAuthapiKey in header

Fetch a Nakamoto block

curl -X GET 'https://stacks.nownodes.io/v3/blocks/{block_id}'

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

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v3/blocks/{block_id}')
data = response.json()

200

"binary"

Fetch a Nakamoto block by its height and optional tip

GET

https://stacks.nownodes.io/v3/blocks/height/{block_height}

Fetch a Nakamoto block by its height and optional tip.

Parameters

block_heightintegerrequiredpath

The block's height

tipstringquery

The Stacks chain tip to query from. If tip == latest or empty, the query will be run from the latest known tip.

Response

200OK

The raw SIP-003-encoded block will be returned.

404Not Found

The block could not be found

Authorization

api-keyAuthapiKey in header

Fetch a Nakamoto block by its height and optional tip

curl -X GET 'https://stacks.nownodes.io/v3/blocks/height/{block_height}'

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

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v3/blocks/height/{block_height}')
data = response.json()

200

"binary"

Fetch metadata about the ongoing Nakamoto tenure

GET

https://stacks.nownodes.io/v3/tenures/info

Fetch metadata about the ongoing Nakamoto tenure. This information is sufficient to obtain and authenticate the highest complete tenure, as well as obtain new tenure blocks.

Response

200OK

Metadata about the ongoing tenure

Authorization

api-keyAuthapiKey in header

Fetch metadata about the ongoing Nakamoto tenure

curl -X GET 'https://stacks.nownodes.io/v3/tenures/info'

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

const data = await response.json();

import requests

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

200

{
  "consensus_hash": "4c5a49be0e34dc603b66f090fd07d28a2f76a2ad",
  "parent_consensus_hash": "fa8a04af41957499afdd4082b9b702ffca9a4370",
  "parent_tenure_start_block_id": "0cfec8433849d353ad6b2fe1173da143e3d4a3ab452588a14eb074d0181ac202",
  "reward_cycle": 8,
  "tenure_start_block_id": "0425099d51547c714df6a7864c040c1a605b198ff07f71d19a823139c88a35f8",
  "tip_block_id": "52d64f5e47abc7666c4fed3fe850f381f93f2d588ee2a92a4e07b44f14588d5e",
  "tip_height": 416
}

Fetch a sequence of Nakamoto blocks in a tenure

GET

https://stacks.nownodes.io/v3/tenures/{block_id}

Fetch a sequence of Nakamoto blocks in a tenure. The blocks will be served in order from highest to lowest. The blocks will be encoded in their SIP-003 wire format, and concatenated together.

Parameters

block_idstringrequiredpath

The tenure-start block ID of the tenure to query

stopstringquery

Response

200OK

SIP-003-encoded Nakamoto blocks, concatenated together

Authorization

api-keyAuthapiKey in header

Fetch a sequence of Nakamoto blocks in a tenure

curl -X GET 'https://stacks.nownodes.io/v3/tenures/{block_id}'

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

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v3/tenures/{block_id}')
data = response.json()

200

"binary"

Fetch information about evaluated burnchain blocks (i.e., sortitions).

GET

https://stacks.nownodes.io/v3/sortitions/{lookup_kind}/{lookup}

Fetch sortition information about a burnchain block. If the lookup_kind and lookup parameters are empty, it will return information about the latest burn block.

Parameters

lookup_kindstringpath

The style of lookup that should be performed. If not given, the most recent burn block processed will be returned. Otherwise, the lookup_kind should be one of the following strings:

consensus - find the burn block using the consensus hash supplied in the lookup field.
burn_height - find the burn block using the burn block height supplied in the lookup field.
burn - find the burn block using the burn block hash supplied in the lookup field.
latest_and_last - return information about the latest burn block with a winning miner and the previous such burn block

lookupstringpath

The value to use for the lookup if lookup_kind is consensus, burn_height, or burn

Response

200OK

Information for the burn block or in the case of latest_and_last, multiple burn blocks

Authorization

api-keyAuthapiKey in header

Fetch information about evaluated burnchain blocks (i.e., sortitions).

curl -X GET 'https://stacks.nownodes.io/v3/sortitions/{lookup_kind}/{lookup}'

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

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v3/sortitions/{lookup_kind}/{lookup}')
data = response.json()

200

A single element list is returned when just one sortition is requested

[
  {
    "burn_block_hash": "0x046f54cd1924a5d80fc3b8186d0334b7521acae90f9e136e2bee680c720d0e83",
    "burn_block_height": 231,
    "burn_header_timestamp": 1726797570,
    "sortition_id": "0x8a5116b7b4306dc4f6db290d1adfff9e1347f3e921bb793fc4c33e2ff05056e2",
    "parent_sortition_id": "0xdaf479110cf859e58c56b6ae941f8a14e7c7992c57027183dfbda4a4b820897c",
    "consensus_hash": "0x8d2c51db737597a93191f49bcdc9c7bb44b90892",
    "was_sortition": true,
    "miner_pk_hash160": "0x6bc51b33e9f3626944eb879147e18111581f8f9b",
    "stacks_parent_ch": "0x697357c72da55b759b1d6b721676c92c69f0b490",
    "last_sortition_ch": "0x697357c72da55b759b1d6b721676c92c69f0b490",
    "committed_block_hash": "0xeea47d6d639c565027110e192e308fb11656183d5c077bcd718d830652800183",
    "vrf_seed": "0x48b754acc291a5bfad1354ee19bbc471f14af2b21dc7eccc0f929bd16798defe"
  }
]

Sortition information about the latest burn block with a winning miner, and the previous such burn block.

[
  {
    "burn_block_hash": "0x046f54cd1924a5d80fc3b8186d0334b7521acae90f9e136e2bee680c720d0e83",
    "burn_block_height": 231,
    "burn_header_timestamp": 1726797570,
    "sortition_id": "0x8a5116b7b4306dc4f6db290d1adfff9e1347f3e921bb793fc4c33e2ff05056e2",
    "parent_sortition_id": "0xdaf479110cf859e58c56b6ae941f8a14e7c7992c57027183dfbda4a4b820897c",
    "consensus_hash": "0x8d2c51db737597a93191f49bcdc9c7bb44b90892",
    "was_sortition": true,
    "miner_pk_hash160": "0x6bc51b33e9f3626944eb879147e18111581f8f9b",
    "stacks_parent_ch": "0x697357c72da55b759b1d6b721676c92c69f0b490",
    "last_sortition_ch": "0x697357c72da55b759b1d6b721676c92c69f0b490",
    "committed_block_hash": "0xeea47d6d639c565027110e192e308fb11656183d5c077bcd718d830652800183"
  },
  {
    "burn_block_hash": "0x496ff02cb63a4850d0bdee5fab69284b6eb0392b4538e1c462f82362c5becfa4",
    "burn_block_height": 230,
    "burn_header_timestamp": 1726797570,
    "sortition_id": "0xdaf479110cf859e58c56b6ae941f8a14e7c7992c57027183dfbda4a4b820897c",
    "parent_sortition_id": "0xf9058692055cbd879d7f71e566e44b905a887b2b182407ed596b5d6499ceae2a",
    "consensus_hash": "0x697357c72da55b759b1d6b721676c92c69f0b490",
    "was_sortition": true,
    "miner_pk_hash160": "0x6bc51b33e9f3626944eb879147e18111581f8f9b",
    "stacks_parent_ch": "0xf7d1bd7d9d5c5a5c368402b6ef9510bd014d70f7",
    "last_sortition_ch": "0xf7d1bd7d9d5c5a5c368402b6ef9510bd014d70f7",
    "committed_block_hash": "0x36ee5f7f7271de1c1d4cd830e36320b51e01605547621267ae6e9b4e9b10f95e"
  }
]

Get number of blocks signed by signer during a given reward cycle

GET

https://stacks.nownodes.io/v3/signer/{signer}/{cycle_number}

Get number of blocks signed by signer during a given reward cycle

Parameters

signerstringrequiredpath

Hex-encoded compressed Secp256k1 public key of signer

cycle_numberintegerrequiredpath

Reward cycle number

Response

200OK

Number of blocks signed

Authorization

api-keyAuthapiKey in header

Get number of blocks signed by signer during a given reward cycle

curl -X GET 'https://stacks.nownodes.io/v3/signer/{signer}/{cycle_number}'

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

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v3/signer/{signer}/{cycle_number}')
data = response.json()

200

Info

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

Get Core API info

GET

https://stacks.nownodes.io/v2/info

Get Core API information

Response

200OK

Success

Authorization

api-keyAuthapiKey in header

Get Core API info

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

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

const data = await response.json();

import requests

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

200

{
  "peer_version": 385875968,
  "pox_consensus": "17f76e597bab45646956f38dd39573085d72cbc0",
  "burn_block_height": 16,
  "stable_pox_consensus": "8e0561978fc5506b68a589c402dad97e862edb59",
  "stable_burn_block_height": 15,
  "server_version": "blockstack-core 0.0.1 => 23.0.0.0 (, release build, linux [x86_64])",
  "network_id": 2147483648,
  "parent_network_id": 3669344250,
  "stacks_tip_height": 15,
  "stacks_tip": "b1807a2d3f7f8c7922f7c1d60d7c34145ade05d789640dc7dc9ec1021e07bb54",
  "stacks_tip_consensus_hash": "17f76e597bab45646956f38dd39573085d72cbc0",
  "unanchored_tip": "0000000000000000000000000000000000000000000000000000000000000000",
  "tenure_height": 523,
  "exit_at_block_height": null,
  "is_fully_synced": false
}

Get PoX details

GET

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

Get Proof of Transfer (PoX) information. Can be used for Stacking.

Parameters

tipstringquery

The Stacks chain tip to query from. If tip == latest, the query will be run from the latest known tip (includes unconfirmed state).

Response

200OK

Success

Authorization

api-keyAuthapiKey in header

Get PoX details

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

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

const data = await response.json();

import requests

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

200

{
  "contract_id": "SP000000000000000000002Q6VF78.pox",
  "pox_activation_threshold_ustx": 52329761604388,
  "first_burnchain_block_height": 666050,
  "current_burnchain_block_height": 812345,
  "prepare_phase_block_length": 100,
  "reward_phase_block_length": 2000,
  "reward_slots": 4000,
  "rejection_fraction": 25,
  "total_liquid_supply_ustx": 1046595232087772,
  "current_cycle": {
    "id": 2,
    "min_threshold_ustx": 70000000000,
    "stacked_ustx": 202157971547640,
    "is_pox_active": true
  },
  "next_cycle": {
    "id": 3,
    "min_threshold_ustx": 70000000000,
    "min_increment_ustx": 52329761604,
    "stacked_ustx": 162057034977640,
    "prepare_phase_start_block_height": 672250,
    "blocks_until_prepare_phase": 407,
    "reward_phase_start_block_height": 672350,
    "blocks_until_reward_phase": 507,
    "ustx_until_pox_rejection": 261648808021925
  },
  "min_amount_ustx": 70000000000,
  "prepare_cycle_length": 100,
  "reward_cycle_id": 2,
  "reward_cycle_length": 2100,
  "rejection_votes_left_required": 261648808021925,
  "next_reward_cycle_in": 507,
  "contract_versions": [
    {
      "contract_id": "SP000000000000000000002Q6VF78.pox",
      "activation_burnchain_block_height": 666050,
      "first_reward_cycle_id": 0
    },
    {
      "contract_id": "SP000000000000000000002Q6VF78.pox-2",
      "activation_burnchain_block_height": 712345,
      "first_reward_cycle_id": 123
    }
  ]
}

Smart Contracts

Read-only endpoints to obtain Clarity smart contract details

Get contract interface

GET

https://stacks.nownodes.io/v2/contracts/interface/{contract_address}/{contract_name}

Get contract interface using a contract_address and contract name

Parameters

contract_addressstringrequiredpath

Stacks address

contract_namestringrequiredpath

Contract name

tipstringquery

The Stacks chain tip to query from. If tip == latest, the query will be run from the latest known tip (includes unconfirmed state).

Response

200OK

Contract interface

Authorization

api-keyAuthapiKey in header

Get contract interface

curl -X GET 'https://stacks.nownodes.io/v2/contracts/interface/{contract_address}/{contract_name}'

const response = await fetch('https://stacks.nownodes.io/v2/contracts/interface/{contract_address}/{contract_name}', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v2/contracts/interface/{contract_address}/{contract_name}')
data = response.json()

200

{
  "functions": [
    {
      "name": "get-value",
      "access": "public",
      "args": [
        {
          "name": "key",
          "type": {
            "buffer": {
              "length": 32
            }
          }
        }
      ],
      "outputs": {
        "type": {
          "response": {
            "ok": {
              "buffer": {
                "length": 32
              }
            },
            "error": "int128"
          }
        }
      }
    },
    {
      "name": "set-value",
      "access": "public",
      "args": [
        {
          "name": "key",
          "type": {
            "buffer": {
              "length": 32
            }
          }
        },
        {
          "name": "value",
          "type": {
            "buffer": {
              "length": 32
            }
          }
        }
      ],
      "outputs": {
        "type": {
          "response": {
            "ok": "uint128",
            "error": "none"
          }
        }
      }
    },
    {
      "name": "test-emit-event",
      "access": "public",
      "args": [],
      "outputs": {
        "type": {
          "response": {
            "ok": "uint128",
            "error": "none"
          }
        }
      }
    },
    {
      "name": "test-event-types",
      "access": "public",
      "args": [],
      "outputs": {
        "type": {
          "response": {
            "ok": "uint128",
            "error": "none"
          }
        }
      }
    }
  ],
  "variables": [
    {
      "name": "recipient",
      "type": "principal",
      "access": "constant"
    },
    {
      "name": "sender",
      "type": "principal",
      "access": "constant"
    }
  ],
  "maps": [
    {
      "name": "store",
      "key": [
        {
          "name": "key",
          "type": {
            "buffer": {
              "length": 32
            }
          }
        }
      ],
      "value": [
        {
          "name": "value",
          "type": {
            "buffer": {
              "length": 32
            }
          }
        }
      ]
    }
  ],
  "fungible_tokens": [
    {
      "name": "novel-token-19"
    }
  ],
  "non_fungible_tokens": [
    {
      "name": "hello-nft",
      "type": "uint128"
    }
  ]
}

Get specific data-map inside a contract

POST

https://stacks.nownodes.io/v2/map_entry/{contract_address}/{contract_name}/{map_name}

Attempt to fetch data from a contract data map. The contract is identified with [Stacks Address] and [Contract Name] in the URL path. The map is identified with [Map Name].

The key to lookup in the map is supplied via the POST body. This should be supplied as the hex string serialization of the key (which should be a Clarity value). Note, this is a JSON string atom.

Body

application/json

Hex string serialization of the lookup key (which should be a Clarity value)

string

Parameters

contract_addressstringrequiredpath

Stacks address

contract_namestringrequiredpath

Contract name

map_namestringrequiredpath

Map name

proofintegerquery

Returns object without the proof field when set to 0

tipstringquery

The Stacks chain tip to query from. If tip == latest, the query will be run from the latest known tip (includes unconfirmed state).

Response

200OK

Success

400Bad Request

Failed loading data map

Authorization

api-keyAuthapiKey in header

Get specific data-map inside a contract

curl -X POST 'https://stacks.nownodes.io/v2/map_entry/{contract_address}/{contract_name}/{map_name}' \
  -H 'Content-Type: application/json' \
  -d '"string"'

const response = await fetch('https://stacks.nownodes.io/v2/map_entry/{contract_address}/{contract_name}/{map_name}', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify("string"),
});

const data = await response.json();

import requests

payload = "string"

response = requests.post('https://stacks.nownodes.io/v2/map_entry/{contract_address}/{contract_name}/{map_name}', json=payload)
data = response.json()

Request Body

"string"

200

{
  "data": "0x0a0c000000010a6d6f6e737465722d69640100000000000000000000000000000001",
  "proof": "0x123..."
}

Get contract source

GET

https://stacks.nownodes.io/v2/contracts/source/{contract_address}/{contract_name}

Returns the Clarity source code of a given contract, along with the block height it was published in, and the MARF proof for the data

Parameters

contract_addressstringrequiredpath

Stacks address

contract_namestringrequiredpath

Contract name

proofintegerquery

Returns object without the proof field if set to 0

tipstringquery

The Stacks chain tip to query from. If tip == latest, the query will be run from the latest known tip (includes unconfirmed state).

Response

200OK

Success

Authorization

api-keyAuthapiKey in header

Get contract source

curl -X GET 'https://stacks.nownodes.io/v2/contracts/source/{contract_address}/{contract_name}'

const response = await fetch('https://stacks.nownodes.io/v2/contracts/source/{contract_address}/{contract_name}', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v2/contracts/source/{contract_address}/{contract_name}')
data = response.json()

200

{
  "source": "(define-constant sender 'SZ2J6ZY48GV1EZ5V2V5RB9MP66SW86PYKKQ9H6DPR)\n(define-constant recipient 'SM2J6ZY48GV1EZ5V2V5RB9MP66SW86PYKKQVX8X0G)\n\n(define-fungible-token novel-token-19)\n(begin (ft-mint? novel-token-19 u12 sender))\n(begin (ft-transfer? novel-token-19 u2 sender recipient))\n\n(define-non-fungible-token hello-nft uint)\n(begin (nft-mint? hello-nft u1 sender))\n(begin (nft-mint? hello-nft u2 sender))\n(begin (nft-transfer? hello-nft u1 sender recipient))\n\n(define-public (test-emit-event)\n    (begin\n        (print \"Event! Hello world\")\n        (ok u1)))\n(begin (test-emit-event))\n\n(define-public (test-event-types)\n    (begin\n        (unwrap-panic (ft-mint? novel-token-19 u3 recipient))\n        (unwrap-panic (nft-mint? hello-nft u2 recipient))\n        (unwrap-panic (stx-transfer? u60 tx-sender 'SZ2J6ZY48GV1EZ5V2V5RB9MP66SW86PYKKQ9H6DPR))\n        (unwrap-panic (stx-burn? u20 tx-sender))\n        (ok u1)))\n\n(define-map store ((key (buff 32))) ((value (buff 32))))\n(define-public (get-value (key (buff 32)))\n    (begin\n        (match (map-get? store ((key key)))\n            entry (ok (get value entry))\n            (err 0))))\n(define-public (set-value (key (buff 32)) (value (buff 32)))\n    (begin\n        (map-set store ((key key)) ((value value)))\n        (ok u1)))",
  "publish_height": 3196,
  "proof": "0000001104060000001ec4e..."
}

Call read-only function

POST

https://stacks.nownodes.io/v2/contracts/call-read/{contract_address}/{contract_name}/{function_name}

Call a read-only public function on a given smart contract.

The smart contract and function are specified using the URL path. The arguments and the simulated tx-sender are supplied via the POST body in the following JSON format:

Body

application/json

map of arguments and the simulated tx-sender where sender is either a Contract identifier or a normal Stacks address, and arguments is an array of hex serialized Clarity values.

Describes representation of a Type-0 Stacks 2.0 transaction. https://github.com/stacksgov/sips/blob/main/sips/sip-005/sip-005-blocks-and-transactions.md#type-0-transferring-an-asset

senderstringrequired

The simulated tx-sender

argumentsArray<string>required

An array of hex serialized Clarity values

Parameters

contract_addressstringrequiredpath

Stacks address

contract_namestringrequiredpath

Contract name

function_namestringrequiredpath

Function name

tipstringquery

The Stacks chain tip to query from. If tip == latest, the query will be run from the latest known tip (includes unconfirmed state).

Response

200OK

Success

Authorization

api-keyAuthapiKey in header

Call read-only function

curl -X POST 'https://stacks.nownodes.io/v2/contracts/call-read/{contract_address}/{contract_name}/{function_name}' \
  -H 'Content-Type: application/json' \
  -d '{
    "sender": "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info",
    "arguments": [
      "0x0011...",
      "0x00231..."
    ]
  }'

const response = await fetch('https://stacks.nownodes.io/v2/contracts/call-read/{contract_address}/{contract_name}/{function_name}', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "sender": "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info",
      "arguments": [
        "0x0011...",
        "0x00231..."
      ]
    }),
});

const data = await response.json();

import requests

payload = {
  "sender": "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info",
  "arguments": [
    "0x0011...",
    "0x00231..."
  ]
}

response = requests.post('https://stacks.nownodes.io/v2/contracts/call-read/{contract_address}/{contract_name}/{function_name}', json=payload)
data = response.json()

Request Body

{
  "sender": "SP31DA6FTSJX2WGTZ69SFY11BH51NZMB0ZW97B5P0.get-info",
  "arguments": [
    "0x0011...",
    "0x00231..."
  ]
}

200

{
  "okay": true,
  "result": "0x111..."
}

{
  "okay": false,
  "cause": "Unchecked(PublicFunctionNotReadOnly(..."
}

Get trait implementation details

GET

https://stacks.nownodes.io/v2/traits/{contract_address}/{contract_name}/{trait_contract_address}/{trait_contract_name}/{trait_name}

Determine whether or not a specified trait is implemented (either explicitly or implicitly) within a given contract.

Parameters

contract_addressstringrequiredpath

Stacks address

contract_namestringrequiredpath

Contract name

trait_contract_addressstringrequiredpath

Trait Stacks address

trait_contract_namestringrequiredpath

Trait contract name

trait_namestringrequiredpath

Trait name

tipstringquery

Response

200OK

Success

Authorization

api-keyAuthapiKey in header

Get trait implementation details

curl -X GET 'https://stacks.nownodes.io/v2/traits/{contract_address}/{contract_name}/{trait_contract_address}/{trait_contract_name}/{trait_name}'

const response = await fetch('https://stacks.nownodes.io/v2/traits/{contract_address}/{contract_name}/{trait_contract_address}/{trait_contract_name}/{trait_name}', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v2/traits/{contract_address}/{contract_name}/{trait_contract_address}/{trait_contract_name}/{trait_name}')
data = response.json()

200

{
  "is_implemented": true
}

Get the MARF value for a given key

POST

https://stacks.nownodes.io/v2/clarity/marf/{clarity_marf_key}

Attempt to fetch the value of a MARF key.

In the response, data is the hex serialization of the value.

Parameters

clarity_marf_keystringrequiredpath

MARF key

proofintegerquery

Returns object without the proof field when set to 0

tipstringquery

The Stacks chain tip to query from. If tip == latest, the query will be run from the latest known tip (includes unconfirmed state).

Response

200OK

Success

400Bad Request

Failed to retrieve MARF key

Authorization

api-keyAuthapiKey in header

Get the MARF value for a given key

curl -X POST 'https://stacks.nownodes.io/v2/clarity/marf/{clarity_marf_key}'

const response = await fetch('https://stacks.nownodes.io/v2/clarity/marf/{clarity_marf_key}', {
  method: 'POST',
});

const data = await response.json();

import requests

response = requests.post('https://stacks.nownodes.io/v2/clarity/marf/{clarity_marf_key}')
data = response.json()

200

{
  "data": "0x0a0c000000010a6d6f6e737465722d69640100000000000000000000000000000001",
  "proof": "0x123..."
}

Get the contract metadata for the metadata key

POST

https://stacks.nownodes.io/v2/clarity/metadata/{contract_address}/{contract_name}/{clarity_metadata_key}

Attempt to fetch the metadata of a contract. The contract is identified with [Contract Address] and [Contract Name] in the URL path. The metadata key is identified with [Clarity Metadata Key].

In the response, data is formatted as JSON.

Parameters

contract_addressstringrequiredpath

Stacks address

contract_namestringrequiredpath

Contract name

clarity_metadata_keystringrequiredpath

Metadata key

tipstringquery

The Stacks chain tip to query from. If tip == latest, the query will be run from the latest known tip (includes unconfirmed state).

Response

200OK

Success

400Bad Request

Failed to retrieve constant value from contract

Authorization

api-keyAuthapiKey in header

Get the contract metadata for the metadata key

curl -X POST 'https://stacks.nownodes.io/v2/clarity/metadata/{contract_address}/{contract_name}/{clarity_metadata_key}'

const response = await fetch('https://stacks.nownodes.io/v2/clarity/metadata/{contract_address}/{contract_name}/{clarity_metadata_key}', {
  method: 'POST',
});

const data = await response.json();

import requests

response = requests.post('https://stacks.nownodes.io/v2/clarity/metadata/{contract_address}/{contract_name}/{clarity_metadata_key}')
data = response.json()

200

{
  "data": "'{\"contract_identifier\":{...}, \"private_function_types\":{...}'"
}

Get the value of a constant inside a contract

POST

https://stacks.nownodes.io/v2/constant_val/{contract_address}/{contract_name}/{constant_name}

Attempt to fetch the value of a constant inside a contract. The contract is identified with [Stacks Address] and [Contract Name] in the URL path. The constant is identified with [Constant Name].

In the response, data is the hex serialization of the constant value.

Parameters

contract_addressstringrequiredpath

Stacks address

contract_namestringrequiredpath

Contract name

constant_namestringrequiredpath

Constant name

tipstringquery

The Stacks chain tip to query from. If tip == latest, the query will be run from the latest known tip (includes unconfirmed state).

Response

200OK

Success

400Bad Request

Failed to retrieve constant value from contract

Authorization

api-keyAuthapiKey in header

Get the value of a constant inside a contract

curl -X POST 'https://stacks.nownodes.io/v2/constant_val/{contract_address}/{contract_name}/{constant_name}'

const response = await fetch('https://stacks.nownodes.io/v2/constant_val/{contract_address}/{contract_name}/{constant_name}', {
  method: 'POST',
});

const data = await response.json();

import requests

response = requests.post('https://stacks.nownodes.io/v2/constant_val/{contract_address}/{contract_name}/{constant_name}')
data = response.json()

200

{
  "data": "0x01ce..."
}

Transactions

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

Broadcast raw transaction

POST

https://stacks.nownodes.io/v2/transactions

Broadcast raw transactions on the network. You can use the @stacks/transactions project to generate a raw transaction payload.

Body

application/octet-stream

string<binary>

Response

200OK

Transaction ID of successful post of a raw tx to the node's mempool

400Bad Request

Rejections result in a 400 error

Authorization

api-keyAuthapiKey in header

Broadcast raw transaction

curl -X POST 'https://stacks.nownodes.io/v2/transactions' \
  -H 'Content-Type: application/octet-stream' \
  -d '"binary format of 00000000010400bed38c2aadffa348931bcb542880ff79d607afec000000000000000000000000000000c800012b0b1fff6cccd0974966dcd665835838f0985be508e1322e09fb3d751eca132c492bda720f9ef1768d14fdabed6127560ba52d5e3ac470dcb60b784e97dc88c9030200000000000516df0ba3e79792be7be5e50a370289accfc8c9e032000000000000303974657374206d656d6f00000000000000000000000000000000000000000000000000"'

const response = await fetch('https://stacks.nownodes.io/v2/transactions', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/octet-stream',
  },
  body: JSON.stringify("binary format of 00000000010400bed38c2aadffa348931bcb542880ff79d607afec000000000000000000000000000000c800012b0b1fff6cccd0974966dcd665835838f0985be508e1322e09fb3d751eca132c492bda720f9ef1768d14fdabed6127560ba52d5e3ac470dcb60b784e97dc88c9030200000000000516df0ba3e79792be7be5e50a370289accfc8c9e032000000000000303974657374206d656d6f00000000000000000000000000000000000000000000000000"),
});

const data = await response.json();

import requests

payload = "binary format of 00000000010400bed38c2aadffa348931bcb542880ff79d607afec000000000000000000000000000000c800012b0b1fff6cccd0974966dcd665835838f0985be508e1322e09fb3d751eca132c492bda720f9ef1768d14fdabed6127560ba52d5e3ac470dcb60b784e97dc88c9030200000000000516df0ba3e79792be7be5e50a370289accfc8c9e032000000000000303974657374206d656d6f00000000000000000000000000000000000000000000000000"

response = requests.post('https://stacks.nownodes.io/v2/transactions', json=payload)
data = response.json()

Request Body

"binary format of 00000000010400bed38c2aadffa348931bcb542880ff79d607afec000000000000000000000000000000c800012b0b1fff6cccd0974966dcd665835838f0985be508e1322e09fb3d751eca132c492bda720f9ef1768d14fdabed6127560ba52d5e3ac470dcb60b784e97dc88c9030200000000000516df0ba3e79792be7be5e50a370289accfc8c9e032000000000000303974657374206d656d6f00000000000000000000000000000000000000000000000000"

"e161978626f216b2141b156ade10501207ae535fa365a13ef5d7a7c9310a09f2"

{
  "error": "transaction rejected",
  "reason": "BadNonce",
  "reason_data": {
    "actual": 4,
    "expected": 0,
    "is_origin": true,
    "principal": "ST2ZRX0K27GW0SP3GJCEMHD95TQGJMKB7G9Y0X1MH"
  },
  "txid": "caf6fd60ae05b0c2d19ef14ab6a7670b1095d117fa7c80224c74e76214d0a791"
}

Retrieve transaction details by TXID

GET

https://stacks.nownodes.io/v3/transaction/{txid}

Get a JSON with the transaction details including the index_block_hash, the hex-encoded transaction body, and the result.

Parameters

txidstringrequiredpath

Transaction ID

Response

200OK

Transaction JSON with index_block_hash, transaction body and result

404Not Found

Transaction not found

501Not Implemented

Transaction indexing not enabled

Authorization

api-keyAuthapiKey in header

Retrieve transaction details by TXID

curl -X GET 'https://stacks.nownodes.io/v3/transaction/{txid}'

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

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v3/transaction/{txid}')
data = response.json()

200

{
  "index_block_hash": "e0b6c25b1dac0c0e1c75e41ab46bd6d70d9a2d02ffed8f2c0733b6e686289c38",
  "result": "(ok true)",
  "tx": "808000000004008bc5147525b8f477f0bc4522a88c8339b2494db5000000000000001a0000000000000000010123eab800bc9f639c5aa05d154148a981c89fd21064a6f8cafd8649800a56c9ea77e2e46bed8bd9ef0f173b19b20d6c43e2a9f37b078df5c74b9e6f9be75b650e01020000000007588687edeb02248d402c316ed33e22ea0e73af8703ce5011f3e25f5ce12f00f903ca504742117ee0588687edeb02248d402c316ed33e22ea0e73af87c54e0d94e4dd298cf19778352906a2fcf0af74582b07dfb57c710288874f71ca00000001006bc51b33e9f3626944eb879147e18111581f8f9b"
}

Fees

Read-only endpoints to obtain fee details

Get approximate fees for the given transaction

POST

https://stacks.nownodes.io/v2/fees/transaction

Get an estimated fee for the supplied transaction. This estimates the execution cost of the transaction, the current fee rate of the network, and returns estimates for fee amounts.

transaction_payload is a hex-encoded serialization of the TransactionPayload for the transaction.
estimated_len is an optional argument that provides the endpoint with an estimation of the final length (in bytes) of the transaction, including any post-conditions and signatures

DatabaseError - this Stacks node has had an internal database error while trying to estimate the costs of the supplied transaction.
NoEstimateAvailable - this Stacks node has not seen this kind of contract-call before, and it cannot provide an estimate yet.
CostEstimationDisabled - this Stacks node does not perform fee or cost estimation, and it cannot respond on this endpoint.

The 200 response contains the following data:

estimated_cost - the estimated multi-dimensional cost of executing the Clarity VM on the provided transaction.
estimated_cost_scalar - a unitless integer that the Stacks node uses to compare how much of the block limit is consumed by different transactions. This value incorporates the estimated length of the transaction and the estimated execution cost of the transaction. The range of this integer may vary between different Stacks nodes. In order to compute an estimate of total fee amount for the transaction, this value is multiplied by the same Stacks node's estimated fee rate.
cost_scalar_change_by_byte - a float value that indicates how much the estimated_cost_scalar value would increase for every additional byte in the final transaction.
estimations - an array of estimated fee rates and total fees to pay in microSTX for the transaction. This array provides a range of estimates (default: 3) that may be used. Each element of the array contains the following fields:
- fee_rate - the estimated value for the current fee rates in the network
- fee - the estimated value for the total fee in microSTX that the given transaction should pay. These values are the result of computing: fee_rate x estimated_cost_scalar. If the estimated fees are less than the minimum relay fee (1 ustx x estimated_len), then that minimum relay fee will be returned here instead.

Note: If the final transaction's byte size is larger than supplied to estimated_len, then applications should increase this fee amount by:

fee_rate x cost_scalar_change_by_byte x (final_size - estimated_size)

Body

application/json

POST request for estimated fee

transaction_payloadstringrequired

estimated_leninteger

Response

200OK

Estimated fees for the transaction

Authorization

api-keyAuthapiKey in header

Get approximate fees for the given transaction

curl -X POST 'https://stacks.nownodes.io/v2/fees/transaction' \
  -H 'Content-Type: application/json' \
  -d '{
    "estimated_len": 350,
    "transaction_payload": "021af942874ce525e87f21bbe8c121b12fac831d02f4086765742d696e666f0b7570646174652d696e666f00000000"
  }'

const response = await fetch('https://stacks.nownodes.io/v2/fees/transaction', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "estimated_len": 350,
      "transaction_payload": "021af942874ce525e87f21bbe8c121b12fac831d02f4086765742d696e666f0b7570646174652d696e666f00000000"
    }),
});

const data = await response.json();

import requests

payload = {
  "estimated_len": 350,
  "transaction_payload": "021af942874ce525e87f21bbe8c121b12fac831d02f4086765742d696e666f0b7570646174652d696e666f00000000"
}

response = requests.post('https://stacks.nownodes.io/v2/fees/transaction', json=payload)
data = response.json()

Request Body

{
  "estimated_len": 350,
  "transaction_payload": "021af942874ce525e87f21bbe8c121b12fac831d02f4086765742d696e666f0b7570646174652d696e666f00000000"
}

200

{
  "cost_scalar_change_by_byte": 0.00476837158203125,
  "estimated_cost": {
    "read_count": 19,
    "read_length": 4814,
    "runtime": 7175000,
    "write_count": 2,
    "write_length": 1020
  },
  "estimated_cost_scalar": 14,
  "estimations": [
    {
      "fee": 17,
      "fee_rate": 1.2410714285714286
    },
    {
      "fee": 125,
      "fee_rate": 8.958333333333332
    },
    {
      "fee": 140,
      "fee_rate": 10
    }
  ]
}

Get estimated fee

GET

https://stacks.nownodes.io/v2/fees/transfer

Get an estimated fee rate for STX transfer transactions. This a a fee rate / byte, and is returned as a JSON integer

Response

200OK

Success

Authorization

api-keyAuthapiKey in header

Get estimated fee

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

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

const data = await response.json();

import requests

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

200

Mining

Validate a proposed Stacks block

POST

https://stacks.nownodes.io/v3/block_proposal

Used by stackers to validate a proposed Stacks block from a miner.

This API endpoint requires a basic Authorization header.

Body

application/json

Response

202Accepted

Block proposal has been accepted for processing. The result will be returned via the event observer.

400Bad Request

Endpoint not enabled.

401Unauthorized

Unauthorized.

429Too Many Requests

There is an ongoing proposal validation being processed, the new request cannot be accepted until the prior request has been processed.

Authorization

api-keyAuthapiKey in header

Validate a proposed Stacks block

curl -X POST 'https://stacks.nownodes.io/v3/block_proposal' \
  -H 'Content-Type: application/json' \
  -d '{
    "block": "00000000000000001f00000000000927c08fb5ae5bf80e39e4168f6a3fddb0407a069d21ee68465e6856393254d2a66194f44bb01070666d5effcfb2436e209a75878fe80a04b4258a8cd34ab97c38a8dde331a2a509dd7e4b90590726866172cc138c18e80567737667f55d3f9817ce4714c91d1adfd36101141829dc0b5ea0c4944668c0005ddb6f9e2718f60014f21932a42a36ffaf58e88e77b217b2af366c15dd59e6b136ca773729832dcfc5875ec0830d04012dd5a4fa77a196646ea2b356289116fd02558c034b62d63f8a65bdd20d7ffc3fec6c266cd974be776a9e92759b90f288dcc2525b6b6bd5622c5f02e0922440e9ad1095c19b4467fd94566caa9755669d8e0000000180800000000400f64081ae6209dce9245753a4f764d6f168aae1af00000000000000000000000000000064000041dbcc7391991c1a18371eb49b879240247a3ec7f281328f53976c1218ffd65421dbb101e59370e2c972b29f48dc674b2de5e1b65acbd41d5d2689124d42c16c01010000000000051a346048df62be3a52bb6236e11394e8600229e27b000000000000271000000000000000000000000000000000000000000000000000000000000000000000",
    "chain_id": 2147483648
  }'

const response = await fetch('https://stacks.nownodes.io/v3/block_proposal', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "block": "00000000000000001f00000000000927c08fb5ae5bf80e39e4168f6a3fddb0407a069d21ee68465e6856393254d2a66194f44bb01070666d5effcfb2436e209a75878fe80a04b4258a8cd34ab97c38a8dde331a2a509dd7e4b90590726866172cc138c18e80567737667f55d3f9817ce4714c91d1adfd36101141829dc0b5ea0c4944668c0005ddb6f9e2718f60014f21932a42a36ffaf58e88e77b217b2af366c15dd59e6b136ca773729832dcfc5875ec0830d04012dd5a4fa77a196646ea2b356289116fd02558c034b62d63f8a65bdd20d7ffc3fec6c266cd974be776a9e92759b90f288dcc2525b6b6bd5622c5f02e0922440e9ad1095c19b4467fd94566caa9755669d8e0000000180800000000400f64081ae6209dce9245753a4f764d6f168aae1af00000000000000000000000000000064000041dbcc7391991c1a18371eb49b879240247a3ec7f281328f53976c1218ffd65421dbb101e59370e2c972b29f48dc674b2de5e1b65acbd41d5d2689124d42c16c01010000000000051a346048df62be3a52bb6236e11394e8600229e27b000000000000271000000000000000000000000000000000000000000000000000000000000000000000",
      "chain_id": 2147483648
    }),
});

const data = await response.json();

import requests

payload = {
  "block": "00000000000000001f00000000000927c08fb5ae5bf80e39e4168f6a3fddb0407a069d21ee68465e6856393254d2a66194f44bb01070666d5effcfb2436e209a75878fe80a04b4258a8cd34ab97c38a8dde331a2a509dd7e4b90590726866172cc138c18e80567737667f55d3f9817ce4714c91d1adfd36101141829dc0b5ea0c4944668c0005ddb6f9e2718f60014f21932a42a36ffaf58e88e77b217b2af366c15dd59e6b136ca773729832dcfc5875ec0830d04012dd5a4fa77a196646ea2b356289116fd02558c034b62d63f8a65bdd20d7ffc3fec6c266cd974be776a9e92759b90f288dcc2525b6b6bd5622c5f02e0922440e9ad1095c19b4467fd94566caa9755669d8e0000000180800000000400f64081ae6209dce9245753a4f764d6f168aae1af00000000000000000000000000000064000041dbcc7391991c1a18371eb49b879240247a3ec7f281328f53976c1218ffd65421dbb101e59370e2c972b29f48dc674b2de5e1b65acbd41d5d2689124d42c16c01010000000000051a346048df62be3a52bb6236e11394e8600229e27b000000000000271000000000000000000000000000000000000000000000000000000000000000000000",
  "chain_id": 2147483648
}

response = requests.post('https://stacks.nownodes.io/v3/block_proposal', json=payload)
data = response.json()

Request Body

{
  "block": "00000000000000001f00000000000927c08fb5ae5bf80e39e4168f6a3fddb0407a069d21ee68465e6856393254d2a66194f44bb01070666d5effcfb2436e209a75878fe80a04b4258a8cd34ab97c38a8dde331a2a509dd7e4b90590726866172cc138c18e80567737667f55d3f9817ce4714c91d1adfd36101141829dc0b5ea0c4944668c0005ddb6f9e2718f60014f21932a42a36ffaf58e88e77b217b2af366c15dd59e6b136ca773729832dcfc5875ec0830d04012dd5a4fa77a196646ea2b356289116fd02558c034b62d63f8a65bdd20d7ffc3fec6c266cd974be776a9e92759b90f288dcc2525b6b6bd5622c5f02e0922440e9ad1095c19b4467fd94566caa9755669d8e0000000180800000000400f64081ae6209dce9245753a4f764d6f168aae1af00000000000000000000000000000064000041dbcc7391991c1a18371eb49b879240247a3ec7f281328f53976c1218ffd65421dbb101e59370e2c972b29f48dc674b2de5e1b65acbd41d5d2689124d42c16c01010000000000051a346048df62be3a52bb6236e11394e8600229e27b000000000000271000000000000000000000000000000000000000000000000000000000000000000000",
  "chain_id": 2147483648
}

{
  "message": "Block proposal is processing, result will be returned via the event observer",
  "result": "Accepted"
}

{
  "message": "Could not process block proposal request: Proposal currently being evaluated",
  "result": "Error"
}

Fetch the stacker and signer set information for a given cycle.

GET

https://stacks.nownodes.io/v3/stacker_set/{cycle_number}

Used to get stacker and signer set information for a given cycle.

This will only return information for cycles started in Epoch-2.5 where PoX-4 was active and subsequent cycles.

Parameters

cycle_numberintegerrequiredpath

reward cycle number

Response

200OK

Information for the given reward cycle

400Bad Request

Could not fetch the given reward set

Authorization

api-keyAuthapiKey in header

Fetch the stacker and signer set information for a given cycle.

curl -X GET 'https://stacks.nownodes.io/v3/stacker_set/{cycle_number}'

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

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v3/stacker_set/{cycle_number}')
data = response.json()

{
  "stacker_set": {
    "rewarded_addresses": [
      {
        "Standard": [
          {
            "bytes": "dc5f18421006ee2b98ab972edfa7268a981e3f00",
            "version": 26
          },
          "SerializeP2PKH"
        ]
      }
    ],
    "signers": [
      {
        "signing_key": "02d0a27e4f1bf186b4391eecfcc4d4a0d403684ad089b477b8548a69dd6378bf26",
        "slots": 1,
        "stacked_amt": 2143020000000000
      }
    ],
    "start_cycle_state": {
      "missed_reward_slots": []
    }
  }
}

{
  "response": "error",
  "err_msg": "Could not read reward set. Prepare phase may not have started for this cycle yet. Cycle = 22, Err = PoXAnchorBlockRequired"
}

Signers

Get number of blocks signed by signer during a given reward cycle

GET

https://stacks.nownodes.io/v3/signer/{signer}/{cycle_number}

Get number of blocks signed by signer during a given reward cycle

Parameters

signerstringrequiredpath

Hex-encoded compressed Secp256k1 public key of signer

cycle_numberintegerrequiredpath

Reward cycle number

Response

200OK

Number of blocks signed

Authorization

api-keyAuthapiKey in header

Get number of blocks signed by signer during a given reward cycle

curl -X GET 'https://stacks.nownodes.io/v3/signer/{signer}/{cycle_number}'

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

const data = await response.json();

import requests

response = requests.get('https://stacks.nownodes.io/v3/signer/{signer}/{cycle_number}')
data = response.json()

200

Documentation

Authentication

Node

Accounts

Parameters

Response

Authorization

Parameters

Response

Authorization

Parameters

Response

Authorization

Parameters

Response

Authorization

Parameters

Response

Authorization

Parameters

Response

Authorization

Blocks

Parameters

Response

Authorization

Response

Authorization

Parameters

Response

Authorization

Parameters

Response

Authorization

Parameters

Response

Authorization

Burn Blocks

Parameters

Response

Authorization

Parameters

Response

Authorization

Parameters

Response

Authorization

Faucets

Body

Parameters

Response

Authorization

Parameters

Response

Authorization

Body

Parameters

Response

Authorization

Info

Response

Authorization

Parameters

Response

Authorization

Response

Authorization

Parameters

Response

Authorization

Microblocks

Parameters

Response

Authorization

Parameters

Response

Authorization

Response

Authorization

Names