Radix Core API - Babylon (Bottlenose)

vv1.2.0

Base URLs

https://xrd.nownodes.io/core

https://xrd-gateway.nownodes.io

Authentication

api-keyAuthapiKey

API Key: api-key in header

Core

LTS

For long term support/backward compatible endpoints aimed at integrators such as exchanges.

Get Construction Metadata

POST

https://xrd.nownodes.io/core/lts/transaction/construction

Returns information necessary to build a transaction

Body

application/json

networkNetworkIdentifierrequired

The logical name of the network

Response

200OK

All info needed to build a transaction

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Get Construction Metadata

curl -X POST 'https://xrd.nownodes.io/core/lts/transaction/construction' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}"
  }'

const response = await fetch('https://xrd.nownodes.io/core/lts/transaction/construction', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}"
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}"
}

response = requests.post('https://xrd.nownodes.io/core/lts/transaction/construction', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}"
}

{
  "current_epoch": 0,
  "ledger_clock": {
    "unix_timestamp_ms": 0,
    "date_time": "string"
  }
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

Submit Transaction

POST

https://xrd.nownodes.io/core/lts/transaction/submit

Submits a notarized transaction to the network. Returns whether the transaction submission was already included in the node's mempool.

Body

application/json

networkNetworkIdentifierrequired

The logical name of the network

notarized_transaction_hexstringrequired

A hex-encoded, compiled notarized transaction.

force_recalculateboolean

If true, the transaction validity is freshly recalculated without using any caches (defaults false)

Response

200OK

Transaction Submit Response

400Bad Request

Client error

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Submit Transaction

curl -X POST 'https://xrd.nownodes.io/core/lts/transaction/submit' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}",
    "notarized_transaction_hex": "string",
    "force_recalculate": true
  }'

const response = await fetch('https://xrd.nownodes.io/core/lts/transaction/submit', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}",
      "notarized_transaction_hex": "string",
      "force_recalculate": true
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}",
  "notarized_transaction_hex": "string",
  "force_recalculate": True
}

response = requests.post('https://xrd.nownodes.io/core/lts/transaction/submit', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}",
  "notarized_transaction_hex": "string",
  "force_recalculate": true
}

{
  "duplicate": true
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string",
  "details": {
    "type": "PriorityThresholdNotMet"
  }
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string",
  "details": {
    "type": "PriorityThresholdNotMet"
  }
}

Get Transaction Status

POST

https://xrd.nownodes.io/core/lts/transaction/status

Shares the node's knowledge of any payloads associated with the given intent hash. Generally there will be a single payload for a given intent, but it's theoretically possible there may be multiple. This knowledge is summarised into a status for the intent. This summarised status in the response is likely sufficient for most clients.

Body

application/json

networkNetworkIdentifierrequired

The logical name of the network

intent_hashIntentHashInputrequired

The intent hash for a user transaction, also known as the transaction id. This hash identifies the core content "intent" of the transaction. Each intent can only be committed once. This hash gets signed by any signatories on the transaction, to create the signed intent. Either hex or Bech32m-encoded strings are supported.

Response

200OK

Transaction status response

400Bad Request

Client error

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Get Transaction Status

curl -X POST 'https://xrd.nownodes.io/core/lts/transaction/status' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}",
    "intent_hash": "string"
  }'

const response = await fetch('https://xrd.nownodes.io/core/lts/transaction/status', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}",
      "intent_hash": "string"
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}",
  "intent_hash": "string"
}

response = requests.post('https://xrd.nownodes.io/core/lts/transaction/status', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}",
  "intent_hash": "string"
}

{
  "intent_status": "CommittedSuccess",
  "status_description": "string",
  "committed_state_version": 1,
  "invalid_from_epoch": 0,
  "known_payloads": [
    {
      "payload_hash": "string",
      "payload_hash_bech32m": "string",
      "state_version": 1,
      "status": "CommittedSuccess",
      "error_message": "string"
    }
  ]
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

Get All Account Balances

POST

https://xrd.nownodes.io/core/lts/state/account-all-fungible-resource-balances

Returns balances for all resources associated with an account

Body

application/json

networkNetworkIdentifierrequired

The logical name of the network

account_addressstringrequired

The Bech32m-encoded human readable version of the account's address

Response

200OK

Account all resource balances response

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Get All Account Balances

curl -X POST 'https://xrd.nownodes.io/core/lts/state/account-all-fungible-resource-balances' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}",
    "account_address": "string"
  }'

const response = await fetch('https://xrd.nownodes.io/core/lts/state/account-all-fungible-resource-balances', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}",
      "account_address": "string"
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}",
  "account_address": "string"
}

response = requests.post('https://xrd.nownodes.io/core/lts/state/account-all-fungible-resource-balances', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}",
  "account_address": "string"
}

{
  "state_version": 1,
  "ledger_header_summary": {
    "epoch_round": {
      "epoch": 0,
      "round": 0
    },
    "ledger_hashes": {
      "state_tree_hash": "string",
      "transaction_tree_hash": "string",
      "receipt_tree_hash": "string"
    },
    "proposer_timestamp": {
      "unix_timestamp_ms": 0,
      "date_time": "string"
    }
  },
  "account_address": "string",
  "fungible_resource_balances": [
    {
      "fungible_resource_address": "string",
      "amount": "string"
    }
  ]
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

Get Single Account Balance

POST

https://xrd.nownodes.io/core/lts/state/account-fungible-resource-balance

Returns balance of a single fungible resource in an account

Body

application/json

networkNetworkIdentifierrequired

The logical name of the network

account_addressstringrequired

The Bech32m-encoded human readable version of the account's address

resource_addressResourceAddressrequired

The Bech32m-encoded human readable version of the resource address

Response

200OK

Account resource balance response

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Get Single Account Balance

curl -X POST 'https://xrd.nownodes.io/core/lts/state/account-fungible-resource-balance' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}",
    "account_address": "string",
    "resource_address": "string"
  }'

const response = await fetch('https://xrd.nownodes.io/core/lts/state/account-fungible-resource-balance', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}",
      "account_address": "string",
      "resource_address": "string"
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}",
  "account_address": "string",
  "resource_address": "string"
}

response = requests.post('https://xrd.nownodes.io/core/lts/state/account-fungible-resource-balance', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}",
  "account_address": "string",
  "resource_address": "string"
}

{
  "state_version": 1,
  "ledger_header_summary": {
    "epoch_round": {
      "epoch": 0,
      "round": 0
    },
    "ledger_hashes": {
      "state_tree_hash": "string",
      "transaction_tree_hash": "string",
      "receipt_tree_hash": "string"
    },
    "proposer_timestamp": {
      "unix_timestamp_ms": 0,
      "date_time": "string"
    }
  },
  "account_address": "string",
  "fungible_resource_balance": {
    "fungible_resource_address": "string",
    "amount": "string"
  }
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

Get Account Deposit Behaviour

POST

https://xrd.nownodes.io/core/lts/state/account-deposit-behaviour

Returns deposit behaviour of a single account for multiple resource addresses

Body

application/json

networkNetworkIdentifierrequired

The logical name of the network

account_addressstringrequired

The Bech32m-encoded human readable version of the account's address.

resource_addressesArray<ResourceAddress>

The resource addresses to check the deposit behaviours of.

badgePresentedBadge

The depositor badge to check against the account's set of authorized depositors.

Show child attributes

typePresentedBadgeTypeResourceNonFungiblerequired

resource_addressResourceAddressrequired

The Bech32m-encoded human readable version of the resource address

Response

200OK

Account deposit behaviour response

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Get Account Deposit Behaviour

curl -X POST 'https://xrd.nownodes.io/core/lts/state/account-deposit-behaviour' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}",
    "account_address": "string",
    "resource_addresses": [
      "string"
    ],
    "badge": {
      "type": "Resource",
      "resource_address": "string"
    }
  }'

const response = await fetch('https://xrd.nownodes.io/core/lts/state/account-deposit-behaviour', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}",
      "account_address": "string",
      "resource_addresses": [
        "string"
      ],
      "badge": {
        "type": "Resource",
        "resource_address": "string"
      }
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}",
  "account_address": "string",
  "resource_addresses": [
    "string"
  ],
  "badge": {
    "type": "Resource",
    "resource_address": "string"
  }
}

response = requests.post('https://xrd.nownodes.io/core/lts/state/account-deposit-behaviour', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}",
  "account_address": "string",
  "resource_addresses": [
    "string"
  ],
  "badge": {
    "type": "Resource",
    "resource_address": "string"
  }
}

{
  "state_version": 1,
  "ledger_header_summary": {
    "epoch_round": {
      "epoch": 0,
      "round": 0
    },
    "ledger_hashes": {
      "state_tree_hash": "string",
      "transaction_tree_hash": "string",
      "receipt_tree_hash": "string"
    },
    "proposer_timestamp": {
      "unix_timestamp_ms": 0,
      "date_time": "string"
    }
  },
  "default_deposit_rule": "Accept",
  "is_badge_authorized_depositor": true,
  "resource_specific_behaviours": {}
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

Get Transaction Outcomes

POST

https://xrd.nownodes.io/core/lts/stream/transaction-outcomes

Returns a list of committed transaction outcomes (containing balance changes) from a given state version.

Body

application/json

A request to retrieve a sublist of committed transactions from the ledger.

networkNetworkIdentifierrequired

The logical name of the network

from_state_versionStateVersion<int64>[1, 100000000000000]required

The first (resultant) state version to be returned

limitintegerrequired

The maximum number of transactions that will be returned.

Response

200OK

Paged response

400Bad Request

Client error

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Get Transaction Outcomes

curl -X POST 'https://xrd.nownodes.io/core/lts/stream/transaction-outcomes' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}",
    "from_state_version": 1,
    "limit": 0
  }'

const response = await fetch('https://xrd.nownodes.io/core/lts/stream/transaction-outcomes', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}",
      "from_state_version": 1,
      "limit": 0
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}",
  "from_state_version": 1,
  "limit": 0
}

response = requests.post('https://xrd.nownodes.io/core/lts/stream/transaction-outcomes', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}",
  "from_state_version": 1,
  "limit": 0
}

{
  "from_state_version": 1,
  "count": 0,
  "max_ledger_state_version": 1,
  "committed_transaction_outcomes": [
    {
      "state_version": 1,
      "proposer_timestamp_ms": 0,
      "accumulator_hash": "string",
      "user_transaction_identifiers": {
        "intent_hash": "string",
        "intent_hash_bech32m": "string",
        "signed_intent_hash": "string",
        "signed_intent_hash_bech32m": "string",
        "payload_hash": "string",
        "payload_hash_bech32m": "string"
      },
      "status": "Success",
      "fungible_entity_balance_changes": [
        {
          "entity_address": "string",
          "fee_balance_change": {
            "resource_address": "string",
            "balance_change": "string"
          },
          "fee_balance_changes": [
            {
              "type": "FeePayment",
              "resource_address": "string",
              "balance_change": "string"
            }
          ],
          "non_fee_balance_changes": [
            {
              "resource_address": "string",
              "balance_change": "string"
            }
          ]
        }
      ],
      "non_fungible_entity_balance_changes": [
        {
          "entity_address": "string",
          "resource_address": "string",
          "added": [
            "string"
          ],
          "removed": [
            "string"
          ]
        }
      ],
      "resultant_account_fungible_balances": [
        {
          "account_address": "string",
          "resultant_balances": [
            {
              "resource_address": "string",
              "resultant_balance": "string"
            }
          ]
        }
      ],
      "total_fee": "string"
    }
  ]
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

Get Account Transaction Outcomes

POST

https://xrd.nownodes.io/core/lts/stream/account-transaction-outcomes

Returns a list of committed transaction outcomes (containing balance changes) from a given state version, filtered to only transactions which involved the given account.

Body

application/json

A request to retrieve a sublist of committed transactions from the ledger.

networkNetworkIdentifierrequired

The logical name of the network

account_addressstringrequired

The Bech32m-encoded human readable version of the account's address

from_state_versionStateVersion<int64>[1, 100000000000000]required

The first (resultant) state version to be returned

limitintegerrequired

The maximum number of transactions that will be returned.

Response

200OK

Paged response

400Bad Request

Client error

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Get Account Transaction Outcomes

curl -X POST 'https://xrd.nownodes.io/core/lts/stream/account-transaction-outcomes' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}",
    "account_address": "string",
    "from_state_version": 1,
    "limit": 0
  }'

const response = await fetch('https://xrd.nownodes.io/core/lts/stream/account-transaction-outcomes', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}",
      "account_address": "string",
      "from_state_version": 1,
      "limit": 0
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}",
  "account_address": "string",
  "from_state_version": 1,
  "limit": 0
}

response = requests.post('https://xrd.nownodes.io/core/lts/stream/account-transaction-outcomes', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}",
  "account_address": "string",
  "from_state_version": 1,
  "limit": 0
}

{
  "from_state_version": 1,
  "count": 0,
  "max_ledger_state_version": 1,
  "committed_transaction_outcomes": [
    {
      "state_version": 1,
      "proposer_timestamp_ms": 0,
      "accumulator_hash": "string",
      "user_transaction_identifiers": {
        "intent_hash": "string",
        "intent_hash_bech32m": "string",
        "signed_intent_hash": "string",
        "signed_intent_hash_bech32m": "string",
        "payload_hash": "string",
        "payload_hash_bech32m": "string"
      },
      "status": "Success",
      "fungible_entity_balance_changes": [
        {
          "entity_address": "string",
          "fee_balance_change": {
            "resource_address": "string",
            "balance_change": "string"
          },
          "fee_balance_changes": [
            {
              "type": "FeePayment",
              "resource_address": "string",
              "balance_change": "string"
            }
          ],
          "non_fee_balance_changes": [
            {
              "resource_address": "string",
              "balance_change": "string"
            }
          ]
        }
      ],
      "non_fungible_entity_balance_changes": [
        {
          "entity_address": "string",
          "resource_address": "string",
          "added": [
            "string"
          ],
          "removed": [
            "string"
          ]
        }
      ],
      "resultant_account_fungible_balances": [
        {
          "account_address": "string",
          "resultant_balances": [
            {
              "resource_address": "string",
              "resultant_balance": "string"
            }
          ]
        }
      ],
      "total_fee": "string"
    }
  ]
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

Status

For status and configuration details for the node / engine.

Get Network Configuration

POST

https://xrd.nownodes.io/core/status/network-configuration

Returns the network configuration of the network the node is connected to.

Response

200OK

Network Configuration

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Get Network Configuration

curl -X POST 'https://xrd.nownodes.io/core/status/network-configuration'

const response = await fetch('https://xrd.nownodes.io/core/status/network-configuration', {
  method: 'POST',
});

const data = await response.json();

import requests

response = requests.post('https://xrd.nownodes.io/core/status/network-configuration')
data = response.json()

{
  "version": {
    "core_version": "string",
    "api_version": "string"
  },
  "network": "{{network}}",
  "network_id": 0,
  "network_hrp_suffix": "string",
  "usd_price_in_xrd": "string",
  "address_types": [
    {
      "hrp_prefix": "string",
      "entity_type": "GlobalPackage",
      "address_byte_prefix": 0,
      "address_byte_length": 0
    }
  ],
  "well_known_addresses": {
    "xrd": "string",
    "secp256k1_signature_virtual_badge": "string",
    "ed25519_signature_virtual_badge": "string",
    "package_of_direct_caller_virtual_badge": "string",
    "global_caller_virtual_badge": "string",
    "system_transaction_badge": "string",
    "package_owner_badge": "string",
    "validator_owner_badge": "string",
    "account_owner_badge": "string",
    "identity_owner_badge": "string",
    "package_package": "string",
    "resource_package": "string",
    "account_package": "string",
    "identity_package": "string",
    "consensus_manager_package": "string",
    "access_controller_package": "string",
    "transaction_processor_package": "string",
    "metadata_module_package": "string",
    "royalty_module_package": "string",
    "role_assignment_module_package": "string",
    "genesis_helper_package": "string",
    "faucet_package": "string",
    "pool_package": "string",
    "locker_package": "string",
    "consensus_manager": "string",
    "genesis_helper": "string",
    "faucet": "string",
    "transaction_tracker": "string"
  }
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

Get Network Status

POST

https://xrd.nownodes.io/core/status/network-status

Returns the current state and status of the node's copy of the ledger.

Body

application/json

networkNetworkIdentifierrequired

The logical name of the network

Response

200OK

Network Status

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Get Network Status

curl -X POST 'https://xrd.nownodes.io/core/status/network-status' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}"
  }'

const response = await fetch('https://xrd.nownodes.io/core/status/network-status', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}"
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}"
}

response = requests.post('https://xrd.nownodes.io/core/status/network-status', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}"
}

{
  "pre_genesis_state_identifier": {
    "state_version": 1,
    "state_tree_hash": "string",
    "transaction_tree_hash": "string",
    "receipt_tree_hash": "string"
  },
  "genesis_epoch_round": {
    "epoch": 0,
    "round": 0
  },
  "post_genesis_state_identifier": {
    "state_version": 1,
    "state_tree_hash": "string",
    "transaction_tree_hash": "string",
    "receipt_tree_hash": "string"
  },
  "post_genesis_epoch_round": {
    "epoch": 0,
    "round": 0
  },
  "current_state_identifier": {
    "state_version": 1,
    "state_tree_hash": "string",
    "transaction_tree_hash": "string",
    "receipt_tree_hash": "string"
  },
  "current_epoch_round": {
    "epoch": 0,
    "round": 0
  },
  "current_protocol_version": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

Get Scenarios' results.

POST

https://xrd.nownodes.io/core/status/scenarios

Get results of test "Scenarios" executed on this Network. Note: these Scenarios are meant to only be executed on test Networks; on a production Node, the response is expected to be empty.

Body

application/json

networkNetworkIdentifierrequired

The logical name of the network

Response

200OK

Scenarios' results

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Get Scenarios' results.

curl -X POST 'https://xrd.nownodes.io/core/status/scenarios' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}"
  }'

const response = await fetch('https://xrd.nownodes.io/core/status/scenarios', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}"
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}"
}

response = requests.post('https://xrd.nownodes.io/core/status/scenarios', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}"
}

{
  "executed_scenarios": [
    {
      "sequence_number": 0,
      "logical_name": "string",
      "committed_transactions": [
        {
          "logical_name": "string",
          "state_version": 1,
          "intent_hash": "string",
          "intent_hash_bech32m": "string"
        }
      ],
      "addresses": {}
    }
  ]
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

Transaction

For transaction construction, preview, submission, and monitoring the status of an individual transaction.

Parse Transaction Payload

POST

https://xrd.nownodes.io/core/transaction/parse

Extracts the contents and hashes of various types of transaction payloads, or sub-payloads.

Body

application/json

networkNetworkIdentifierrequired

The logical name of the network

payload_hexstringrequired

A hex-encoded payload of a full transaction or a partial transaction - either a notarized transaction, a signed transaction intent an unsigned transaction intent, or a ledger payload.

parse_modestringAnyNotarizedSignedUnsignedLedger

The type of transaction payload that should be assumed. If omitted, "Any" is used - where the payload is attempted to be parsed as each of the following in turn: Notarized, Signed, Unsigned, Ledger.

validation_modestringNoneStaticFull

The type of validation that should be performed, if the payload correctly decompiles as a Notarized Transaction. This is only relevant for Notarized payloads. If omitted, "Static" is used.

response_modestringBasicFull

The amount of information to return in the response. "Basic" includes the type, validity information, and any relevant identifiers. "Full" also includes the fully parsed information. If omitted, "Full" is used.

transaction_format_optionsTransactionFormatOptions

Requested transaction formats to include in the response

Show child attributes

manifestboolean

Whether to return the raw manifest (default true)

blobsboolean

Whether to return the hex-encoded blobs (default false)

messageboolean

Whether to return the transaction message (default true)

balance_changesboolean

Whether to return the transaction balance changes (default false)

raw_system_transactionboolean

Whether to return the raw hex-encoded system transaction bytes (default false)

raw_notarized_transactionboolean

Whether to return the raw hex-encoded notarized transaction bytes (default true)

raw_ledger_transactionboolean

Whether to return the raw hex-encoded ledger transaction bytes (default false)

Response

200OK

Transaction Parse Response

400Bad Request

Client error

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Parse Transaction Payload

curl -X POST 'https://xrd.nownodes.io/core/transaction/parse' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}",
    "payload_hex": "string",
    "parse_mode": "Any",
    "validation_mode": "None",
    "response_mode": "Basic",
    "transaction_format_options": {
      "manifest": true,
      "blobs": true,
      "message": true,
      "balance_changes": true,
      "raw_system_transaction": true,
      "raw_notarized_transaction": true,
      "raw_ledger_transaction": true
    }
  }'

const response = await fetch('https://xrd.nownodes.io/core/transaction/parse', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}",
      "payload_hex": "string",
      "parse_mode": "Any",
      "validation_mode": "None",
      "response_mode": "Basic",
      "transaction_format_options": {
        "manifest": true,
        "blobs": true,
        "message": true,
        "balance_changes": true,
        "raw_system_transaction": true,
        "raw_notarized_transaction": true,
        "raw_ledger_transaction": true
      }
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}",
  "payload_hex": "string",
  "parse_mode": "Any",
  "validation_mode": "None",
  "response_mode": "Basic",
  "transaction_format_options": {
    "manifest": True,
    "blobs": True,
    "message": True,
    "balance_changes": True,
    "raw_system_transaction": True,
    "raw_notarized_transaction": True,
    "raw_ledger_transaction": True
  }
}

response = requests.post('https://xrd.nownodes.io/core/transaction/parse', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}",
  "payload_hex": "string",
  "parse_mode": "Any",
  "validation_mode": "None",
  "response_mode": "Basic",
  "transaction_format_options": {
    "manifest": true,
    "blobs": true,
    "message": true,
    "balance_changes": true,
    "raw_system_transaction": true,
    "raw_notarized_transaction": true,
    "raw_ledger_transaction": true
  }
}

{
  "parsed": {
    "type": "NotarizedTransaction"
  }
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

Transaction Submit

POST

https://xrd.nownodes.io/core/transaction/submit

Submits a notarized transaction to the network. Returns whether the transaction submission was already included in the node's mempool.

Body

application/json

networkNetworkIdentifierrequired

The logical name of the network

notarized_transaction_hexstringrequired

A hex-encoded, compiled notarized transaction.

force_recalculateboolean

If true, the transaction validity is freshly recalculated without using any caches (defaults false)

Response

200OK

Transaction Submit Response

400Bad Request

Client error

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Transaction Submit

curl -X POST 'https://xrd.nownodes.io/core/transaction/submit' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}",
    "notarized_transaction_hex": "string",
    "force_recalculate": true
  }'

const response = await fetch('https://xrd.nownodes.io/core/transaction/submit', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}",
      "notarized_transaction_hex": "string",
      "force_recalculate": true
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}",
  "notarized_transaction_hex": "string",
  "force_recalculate": True
}

response = requests.post('https://xrd.nownodes.io/core/transaction/submit', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}",
  "notarized_transaction_hex": "string",
  "force_recalculate": true
}

{
  "duplicate": true
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string",
  "details": {
    "type": "PriorityThresholdNotMet"
  }
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string",
  "details": {
    "type": "PriorityThresholdNotMet"
  }
}

Get Transaction Status

POST

https://xrd.nownodes.io/core/transaction/status

Body

application/json

networkNetworkIdentifierrequired

The logical name of the network

intent_hashIntentHashInputrequired

Response

200OK

Transaction status response

400Bad Request

Client error

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Get Transaction Status

curl -X POST 'https://xrd.nownodes.io/core/transaction/status' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}",
    "intent_hash": "string"
  }'

const response = await fetch('https://xrd.nownodes.io/core/transaction/status', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}",
      "intent_hash": "string"
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}",
  "intent_hash": "string"
}

response = requests.post('https://xrd.nownodes.io/core/transaction/status', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}",
  "intent_hash": "string"
}

{
  "intent_status": "CommittedSuccess",
  "status_description": "string",
  "invalid_from_epoch": 0,
  "known_payloads": [
    {
      "payload_hash": "string",
      "payload_hash_bech32m": "string",
      "state_version": 1,
      "status": "CommittedSuccess",
      "error_message": "string"
    }
  ]
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

Get Transaction Receipt

POST

https://xrd.nownodes.io/core/transaction/receipt

Gets the transaction receipt for a committed transaction.

Body

application/json

networkNetworkIdentifierrequired

The logical name of the network

intent_hashIntentHashInputrequired

transaction_format_optionsTransactionFormatOptions

Requested transaction formats to include in the response

Show child attributes

manifestboolean

Whether to return the raw manifest (default true)

blobsboolean

Whether to return the hex-encoded blobs (default false)

messageboolean

Whether to return the transaction message (default true)

balance_changesboolean

Whether to return the transaction balance changes (default false)

raw_system_transactionboolean

Whether to return the raw hex-encoded system transaction bytes (default false)

raw_notarized_transactionboolean

Whether to return the raw hex-encoded notarized transaction bytes (default true)

raw_ledger_transactionboolean

Whether to return the raw hex-encoded ledger transaction bytes (default false)

Response

200OK

Committed transaction found response

400Bad Request

Client error

404Not Found

Committed transaction not found response

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Get Transaction Receipt

curl -X POST 'https://xrd.nownodes.io/core/transaction/receipt' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}",
    "intent_hash": "string",
    "transaction_format_options": {
      "manifest": true,
      "blobs": true,
      "message": true,
      "balance_changes": true,
      "raw_system_transaction": true,
      "raw_notarized_transaction": true,
      "raw_ledger_transaction": true
    }
  }'

const response = await fetch('https://xrd.nownodes.io/core/transaction/receipt', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}",
      "intent_hash": "string",
      "transaction_format_options": {
        "manifest": true,
        "blobs": true,
        "message": true,
        "balance_changes": true,
        "raw_system_transaction": true,
        "raw_notarized_transaction": true,
        "raw_ledger_transaction": true
      }
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}",
  "intent_hash": "string",
  "transaction_format_options": {
    "manifest": True,
    "blobs": True,
    "message": True,
    "balance_changes": True,
    "raw_system_transaction": True,
    "raw_notarized_transaction": True,
    "raw_ledger_transaction": True
  }
}

response = requests.post('https://xrd.nownodes.io/core/transaction/receipt', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}",
  "intent_hash": "string",
  "transaction_format_options": {
    "manifest": true,
    "blobs": true,
    "message": true,
    "balance_changes": true,
    "raw_system_transaction": true,
    "raw_notarized_transaction": true,
    "raw_ledger_transaction": true
  }
}

{
  "committed": {
    "resultant_state_identifiers": {
      "state_version": 1,
      "state_tree_hash": "string",
      "transaction_tree_hash": "string",
      "receipt_tree_hash": "string"
    },
    "ledger_transaction": {
      "type": "Genesis",
      "payload_hex": "string"
    },
    "receipt": {
      "status": "Succeeded",
      "fee_summary": {
        "execution_cost_units_consumed": 0,
        "finalization_cost_units_consumed": 0,
        "xrd_total_execution_cost": "string",
        "xrd_total_finalization_cost": "string",
        "xrd_total_royalty_cost": "string",
        "xrd_total_storage_cost": "string",
        "xrd_total_tipping_cost": "string"
      },
      "costing_parameters": {
        "execution_cost_unit_price": "string",
        "execution_cost_unit_limit": 0,
        "execution_cost_unit_loan": 0,
        "finalization_cost_unit_price": "string",
        "finalization_cost_unit_limit": 0,
        "xrd_usd_price": "string",
        "xrd_storage_price": "string",
        "xrd_archive_storage_price": "string",
        "tip_percentage": 0
      },
      "fee_source": {
        "from_vaults": [
          {
            "vault_entity": {
              "entity_type": "GlobalPackage",
              "is_global": true,
              "entity_address": "string"
            },
            "xrd_amount": "string"
          }
        ]
      },
      "fee_destination": {
        "to_proposer": "string",
        "to_validator_set": "string",
        "to_burn": "string",
        "to_royalty_recipients": [
          {
            "royalty_recipient": {
              "entity_type": "GlobalPackage",
              "is_global": true,
              "entity_address": "string"
            },
            "xrd_amount": "string"
          }
        ]
      },
      "state_updates": {
        "deleted_partitions": [
          {
            "entity_type": "GlobalPackage",
            "entity_address": "string",
            "entity_module": "TypeInfo",
            "partition_kind": "Field",
            "partition_number": 0
          }
        ],
        "created_substates": [
          {
            "substate_id": {
              "entity_type": "GlobalPackage",
              "entity_address": "string",
              "entity_module": "TypeInfo",
              "partition_kind": "Field",
              "partition_number": 0,
              "substate_type": "BootLoaderModuleFieldVmBoot",
              "substate_key": {
                "key_type": "Field",
                "db_sort_key_hex": "string"
              }
            },
            "value": {
              "substate_hex": "string",
              "substate_data_hash": "string",
              "substate_data": {
                "substate_type": "BootLoaderModuleFieldVmBoot",
                "is_locked": true
              }
            },
            "system_structure": {
              "type": "SystemField"
            }
          }
        ],
        "updated_substates": [
          {
            "substate_id": {
              "entity_type": "GlobalPackage",
              "entity_address": "string",
              "entity_module": "TypeInfo",
              "partition_kind": "Field",
              "partition_number": 0,
              "substate_type": "BootLoaderModuleFieldVmBoot",
              "substate_key": {
                "key_type": "Field",
                "db_sort_key_hex": "string"
              }
            },
            "new_value": {
              "substate_hex": "string",
              "substate_data_hash": "string",
              "substate_data": {
                "substate_type": "BootLoaderModuleFieldVmBoot",
                "is_locked": true
              }
            },
            "previous_value": {
              "substate_hex": "string",
              "substate_data_hash": "string",
              "substate_data": {
                "substate_type": "BootLoaderModuleFieldVmBoot",
                "is_locked": true
              }
            },
            "system_structure": {
              "type": "SystemField"
            }
          }
        ],
        "deleted_substates": [
          {
            "substate_id": {
              "entity_type": "GlobalPackage",
              "entity_address": "string",
              "entity_module": "TypeInfo",
              "partition_kind": "Field",
              "partition_number": 0,
              "substate_type": "BootLoaderModuleFieldVmBoot",
              "substate_key": {
                "key_type": "Field",
                "db_sort_key_hex": "string"
              }
            },
            "previous_value": {
              "substate_hex": "string",
              "substate_data_hash": "string",
              "substate_data": {
                "substate_type": "BootLoaderModuleFieldVmBoot",
                "is_locked": true
              }
            },
            "system_structure": {
              "type": "SystemField"
            }
          }
        ],
        "new_global_entities": [
          {
            "entity_type": "GlobalPackage",
            "is_global": true,
            "entity_address": "string"
          }
        ]
      },
      "events": [
        {
          "type": {
            "emitter": {
              "type": "Function"
            },
            "type_reference": {
              "full_type_id": {
                "entity_address": "string",
                "schema_hash": "string",
                "local_type_id": {
                  "kind": "WellKnown",
                  "id": 0,
                  "as_sbor": {
                    "hex": "string"
                  }
                }
              }
            },
            "name": "string"
          },
          "data": {
            "hex": "string"
          }
        }
      ],
      "next_epoch": {
        "epoch": 0,
        "validators": [
          {
            "address": "string",
            "key": {
              "key_type": "EcdsaSecp256k1",
              "key_hex": "string"
            },
            "stake": "string"
          }
        ],
        "significant_protocol_update_readiness": [
          {
            "readiness_signal_name": "string",
            "signalled_stake": "string"
          }
        ]
      },
      "output": [
        {
          "hex": "string"
        }
      ],
      "error_message": "string"
    },
    "balance_changes": {
      "fungible_entity_balance_changes": [
        {
          "entity_address": "string",
          "fee_balance_change": {
            "resource_address": "string",
            "balance_change": "string"
          },
          "fee_balance_changes": [
            {
              "type": "FeePayment",
              "resource_address": "string",
              "balance_change": "string"
            }
          ],
          "non_fee_balance_changes": [
            {
              "resource_address": "string",
              "balance_change": "string"
            }
          ]
        }
      ],
      "non_fungible_entity_balance_changes": [
        {
          "entity_address": "string",
          "resource_address": "string",
          "added": [
            "string"
          ],
          "removed": [
            "string"
          ]
        }
      ]
    },
    "proposer_timestamp_ms": 0
  }
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

Scrypto Call Preview

POST

https://xrd.nownodes.io/core/transaction/call-preview

Preview a scrypto function or method call against the latest network state. Returns the result of the scrypto function or method call.

Body

application/json

networkNetworkIdentifierrequired

The logical name of the network

at_ledger_stateLedgerStateSelector

An optional specification of a historical ledger state at which to execute the request. The "historical state" feature (see the db.historical_substate_values.enable flag) must be enabled on the Node, and the requested point in history must be recent enough (in accordance with the Node's configured state_hash_tree.state_version_history_length).

Show child attributes

typeLedgerStateSelectorTypeByStateVersionrequired

targetTargetIdentifierrequired

Show child attributes

typeTargetIdentifierTypeMethodFunctionrequired

argumentsArray<string>required

Argument list

Response

200OK

Result of the scrypto function call

400Bad Request

Client error

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Scrypto Call Preview

curl -X POST 'https://xrd.nownodes.io/core/transaction/call-preview' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}",
    "at_ledger_state": {
      "type": "ByStateVersion"
    },
    "target": {
      "type": "Method"
    },
    "arguments": [
      "string"
    ]
  }'

const response = await fetch('https://xrd.nownodes.io/core/transaction/call-preview', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}",
      "at_ledger_state": {
        "type": "ByStateVersion"
      },
      "target": {
        "type": "Method"
      },
      "arguments": [
        "string"
      ]
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}",
  "at_ledger_state": {
    "type": "ByStateVersion"
  },
  "target": {
    "type": "Method"
  },
  "arguments": [
    "string"
  ]
}

response = requests.post('https://xrd.nownodes.io/core/transaction/call-preview', json=payload)
data = response.json()

Request Body

{
  "target": {
    "type": "method",
    "component_address": "component_loc1qftacppvmr9ezmekxqpq58en0nk954x0a7jv2zz0hc7qfxlgx4",
    "method_name": "lock_fee"
  },
  "arguments": [
    "a120000000000010632d5ec66b050000000000000000000000000000000000000000000000"
  ]
}

{
  "target": {
    "type": "function",
    "package_address": "package_loc1q9ufgsc8yh5fkv8kzny3vnp68gkmuytc004k0j8dkwvs0xq76q",
    "blueprint_name": "GumballMachine",
    "function_name": "instantiate_gumball_machine"
  },
  "arguments": [
    "a120000000000010632d5ec66b050000000000000000000000000000000000000000000000"
  ]
}

{
  "at_ledger_state": {
    "state_version": 1,
    "header_summary": {
      "epoch_round": {
        "epoch": 0,
        "round": 0
      },
      "ledger_hashes": {
        "state_tree_hash": "string",
        "transaction_tree_hash": "string",
        "receipt_tree_hash": "string"
      },
      "proposer_timestamp": {
        "unix_timestamp_ms": 0,
        "date_time": "string"
      }
    }
  },
  "status": "Succeeded",
  "output": {
    "hex": "string"
  },
  "error_message": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

Transaction Preview

POST

https://xrd.nownodes.io/core/transaction/preview

Preview a transaction against the latest network state, and returns the preview receipt.

Body

application/json

networkNetworkIdentifierrequired

The logical name of the network

at_ledger_stateLedgerStateSelector

Show child attributes

typeLedgerStateSelectorTypeByStateVersionrequired

manifeststringrequired

A text-representation of a transaction manifest

blobs_hexArray<string>

An array of hex-encoded blob data (optional)

start_epoch_inclusiveinteger<int64>[0, 10000000000]required

An integer between 0 and 10^10, marking the epoch at which the transaction starts being valid

end_epoch_exclusiveinteger<int64>[0, 10000000000]required

An integer between 0 and 10^10, marking the epoch at which the transaction is no longer valid

notary_public_keyPublicKey

The notary public key to use (optional)

Show child attributes

key_typePublicKeyTypeEcdsaSecp256k1EddsaEd25519required

notary_is_signatoryboolean

Whether the notary should count as a signatory (optional, default false)

tip_percentageinteger<int32>[0, 65535]required

An integer between 0 and 65535, giving the validator tip as a percentage amount. A value of 1 corresponds to 1% of the fee.

nonceinteger<int64>[0, 4294967295]required

An integer between 0 and 2^32 - 1, chosen to allow a unique intent to be created (to enable submitting an otherwise identical/duplicate intent).

signer_public_keysArray<PublicKey>required

A list of public keys to be used as transaction signers

Show child attributes

key_typePublicKeyTypeEcdsaSecp256k1EddsaEd25519required

messageTransactionMessage

An optional transaction message. Only affects the costing.

Show child attributes

typeTransactionMessageTypePlaintextEncryptedrequired

flagsobjectrequired

Show child attributes

use_free_creditbooleanrequired

assume_all_signature_proofsbooleanrequired

skip_epoch_checkbooleanrequired

disable_auth_checksboolean

Can be used to skip performing auth checks during runtime.

This could be used to e.g.:

Preview protocol update style transactions
Mint resources for previewing trades with resources you don't own. If doing this, be warned:
- Only resources which were potentially mintable/burnable at creation time will be mintable/burnable, due to feature flags on the resource.
- Please see the below warning about unexpected results if using this approach.

Please be warned - this mode of operation is quite a departure from normal operation:

Calculated fees will likely be lower than a standard execution
This mode can subtly break invariants some dApp code might rely on, or result in unexpected behaviour, so the resulting execution result might not be valid for your needs. For example, if I used this flag to mint pool units to preview a redemption (or some dApp interaction which behind the scenes redeemed them), they'd redeem for less than they're currently worth, because the blueprint code relies on the total supply of the pool units to calculate their redemption worth, and you've just inflated the total supply through the mint operation.

Response

200OK

Transaction preview response

400Bad Request

Client error

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Transaction Preview

curl -X POST 'https://xrd.nownodes.io/core/transaction/preview' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}",
    "at_ledger_state": {
      "type": "ByStateVersion"
    },
    "manifest": "string",
    "blobs_hex": [
      "string"
    ],
    "start_epoch_inclusive": 0,
    "end_epoch_exclusive": 0,
    "notary_public_key": {
      "key_type": "EcdsaSecp256k1"
    },
    "notary_is_signatory": true,
    "tip_percentage": 0,
    "nonce": 0,
    "signer_public_keys": [
      {
        "key_type": "EcdsaSecp256k1"
      }
    ],
    "message": {
      "type": "Plaintext"
    },
    "flags": {
      "use_free_credit": true,
      "assume_all_signature_proofs": true,
      "skip_epoch_check": true,
      "disable_auth_checks": true
    }
  }'

const response = await fetch('https://xrd.nownodes.io/core/transaction/preview', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}",
      "at_ledger_state": {
        "type": "ByStateVersion"
      },
      "manifest": "string",
      "blobs_hex": [
        "string"
      ],
      "start_epoch_inclusive": 0,
      "end_epoch_exclusive": 0,
      "notary_public_key": {
        "key_type": "EcdsaSecp256k1"
      },
      "notary_is_signatory": true,
      "tip_percentage": 0,
      "nonce": 0,
      "signer_public_keys": [
        {
          "key_type": "EcdsaSecp256k1"
        }
      ],
      "message": {
        "type": "Plaintext"
      },
      "flags": {
        "use_free_credit": true,
        "assume_all_signature_proofs": true,
        "skip_epoch_check": true,
        "disable_auth_checks": true
      }
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}",
  "at_ledger_state": {
    "type": "ByStateVersion"
  },
  "manifest": "string",
  "blobs_hex": [
    "string"
  ],
  "start_epoch_inclusive": 0,
  "end_epoch_exclusive": 0,
  "notary_public_key": {
    "key_type": "EcdsaSecp256k1"
  },
  "notary_is_signatory": True,
  "tip_percentage": 0,
  "nonce": 0,
  "signer_public_keys": [
    {
      "key_type": "EcdsaSecp256k1"
    }
  ],
  "message": {
    "type": "Plaintext"
  },
  "flags": {
    "use_free_credit": True,
    "assume_all_signature_proofs": True,
    "skip_epoch_check": True,
    "disable_auth_checks": True
  }
}

response = requests.post('https://xrd.nownodes.io/core/transaction/preview', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}",
  "at_ledger_state": {
    "type": "ByStateVersion"
  },
  "manifest": "string",
  "blobs_hex": [
    "string"
  ],
  "start_epoch_inclusive": 0,
  "end_epoch_exclusive": 0,
  "notary_public_key": {
    "key_type": "EcdsaSecp256k1"
  },
  "notary_is_signatory": true,
  "tip_percentage": 0,
  "nonce": 0,
  "signer_public_keys": [
    {
      "key_type": "EcdsaSecp256k1"
    }
  ],
  "message": {
    "type": "Plaintext"
  },
  "flags": {
    "use_free_credit": true,
    "assume_all_signature_proofs": true,
    "skip_epoch_check": true,
    "disable_auth_checks": true
  }
}

{
  "at_ledger_state": {
    "state_version": 1,
    "header_summary": {
      "epoch_round": {
        "epoch": 0,
        "round": 0
      },
      "ledger_hashes": {
        "state_tree_hash": "string",
        "transaction_tree_hash": "string",
        "receipt_tree_hash": "string"
      },
      "proposer_timestamp": {
        "unix_timestamp_ms": 0,
        "date_time": "string"
      }
    }
  },
  "encoded_receipt": "string",
  "receipt": {
    "status": "Succeeded",
    "fee_summary": {
      "execution_cost_units_consumed": 0,
      "finalization_cost_units_consumed": 0,
      "xrd_total_execution_cost": "string",
      "xrd_total_finalization_cost": "string",
      "xrd_total_royalty_cost": "string",
      "xrd_total_storage_cost": "string",
      "xrd_total_tipping_cost": "string"
    },
    "costing_parameters": {
      "execution_cost_unit_price": "string",
      "execution_cost_unit_limit": 0,
      "execution_cost_unit_loan": 0,
      "finalization_cost_unit_price": "string",
      "finalization_cost_unit_limit": 0,
      "xrd_usd_price": "string",
      "xrd_storage_price": "string",
      "xrd_archive_storage_price": "string",
      "tip_percentage": 0
    },
    "fee_source": {
      "from_vaults": [
        {
          "vault_entity": {
            "entity_type": "GlobalPackage",
            "is_global": true,
            "entity_address": "string"
          },
          "xrd_amount": "string"
        }
      ]
    },
    "fee_destination": {
      "to_proposer": "string",
      "to_validator_set": "string",
      "to_burn": "string",
      "to_royalty_recipients": [
        {
          "royalty_recipient": {
            "entity_type": "GlobalPackage",
            "is_global": true,
            "entity_address": "string"
          },
          "xrd_amount": "string"
        }
      ]
    },
    "state_updates": {
      "deleted_partitions": [
        {
          "entity_type": "GlobalPackage",
          "entity_address": "string",
          "entity_module": "TypeInfo",
          "partition_kind": "Field",
          "partition_number": 0
        }
      ],
      "created_substates": [
        {
          "substate_id": {
            "entity_type": "GlobalPackage",
            "entity_address": "string",
            "entity_module": "TypeInfo",
            "partition_kind": "Field",
            "partition_number": 0,
            "substate_type": "BootLoaderModuleFieldVmBoot",
            "substate_key": {
              "key_type": "Field",
              "db_sort_key_hex": "string"
            }
          },
          "value": {
            "substate_hex": "string",
            "substate_data_hash": "string",
            "substate_data": {
              "substate_type": "BootLoaderModuleFieldVmBoot",
              "is_locked": true
            }
          },
          "system_structure": {
            "type": "SystemField"
          }
        }
      ],
      "updated_substates": [
        {
          "substate_id": {
            "entity_type": "GlobalPackage",
            "entity_address": "string",
            "entity_module": "TypeInfo",
            "partition_kind": "Field",
            "partition_number": 0,
            "substate_type": "BootLoaderModuleFieldVmBoot",
            "substate_key": {
              "key_type": "Field",
              "db_sort_key_hex": "string"
            }
          },
          "new_value": {
            "substate_hex": "string",
            "substate_data_hash": "string",
            "substate_data": {
              "substate_type": "BootLoaderModuleFieldVmBoot",
              "is_locked": true
            }
          },
          "previous_value": {
            "substate_hex": "string",
            "substate_data_hash": "string",
            "substate_data": {
              "substate_type": "BootLoaderModuleFieldVmBoot",
              "is_locked": true
            }
          },
          "system_structure": {
            "type": "SystemField"
          }
        }
      ],
      "deleted_substates": [
        {
          "substate_id": {
            "entity_type": "GlobalPackage",
            "entity_address": "string",
            "entity_module": "TypeInfo",
            "partition_kind": "Field",
            "partition_number": 0,
            "substate_type": "BootLoaderModuleFieldVmBoot",
            "substate_key": {
              "key_type": "Field",
              "db_sort_key_hex": "string"
            }
          },
          "previous_value": {
            "substate_hex": "string",
            "substate_data_hash": "string",
            "substate_data": {
              "substate_type": "BootLoaderModuleFieldVmBoot",
              "is_locked": true
            }
          },
          "system_structure": {
            "type": "SystemField"
          }
        }
      ],
      "new_global_entities": [
        {
          "entity_type": "GlobalPackage",
          "is_global": true,
          "entity_address": "string"
        }
      ]
    },
    "events": [
      {
        "type": {
          "emitter": {
            "type": "Function"
          },
          "type_reference": {
            "full_type_id": {
              "entity_address": "string",
              "schema_hash": "string",
              "local_type_id": {
                "kind": "WellKnown",
                "id": 0,
                "as_sbor": {
                  "hex": "string"
                }
              }
            }
          },
          "name": "string"
        },
        "data": {
          "hex": "string"
        }
      }
    ],
    "next_epoch": {
      "epoch": 0,
      "validators": [
        {
          "address": "string",
          "key": {
            "key_type": "EcdsaSecp256k1",
            "key_hex": "string"
          },
          "stake": "string"
        }
      ],
      "significant_protocol_update_readiness": [
        {
          "readiness_signal_name": "string",
          "signalled_stake": "string"
        }
      ]
    },
    "output": [
      {
        "hex": "string"
      }
    ],
    "error_message": "string"
  },
  "instruction_resource_changes": [
    {
      "index": 0,
      "resource_changes": [
        {
          "resource_address": "string",
          "component_entity": {
            "entity_type": "GlobalPackage",
            "is_global": true,
            "entity_address": "string"
          },
          "vault_entity": {
            "entity_type": "GlobalPackage",
            "is_global": true,
            "entity_address": "string"
          },
          "amount": "string"
        }
      ]
    }
  ],
  "logs": [
    {
      "level": "string",
      "message": "string"
    }
  ]
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

Mempool

For information on the contents of the node's mempool.

Get Mempool List

POST

https://xrd.nownodes.io/core/mempool/list

Returns the hashes of all the transactions currently in the mempool

Body

application/json

networkNetworkIdentifierrequired

The logical name of the network

Response

200OK

Mempool List Response

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Get Mempool List

curl -X POST 'https://xrd.nownodes.io/core/mempool/list' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}"
  }'

const response = await fetch('https://xrd.nownodes.io/core/mempool/list', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}"
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}"
}

response = requests.post('https://xrd.nownodes.io/core/mempool/list', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}"
}

{
  "contents": [
    {
      "intent_hash": "string",
      "intent_hash_bech32m": "string",
      "payload_hash": "string",
      "payload_hash_bech32m": "string"
    }
  ]
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

Get Mempool Transaction

POST

https://xrd.nownodes.io/core/mempool/transaction

Returns the payload of a transaction currently in the mempool

Body

application/json

networkNetworkIdentifierrequired

The logical name of the network

payload_hashesArray<NotarizedTransactionHashInput>required

A list of payload hashes to attempt to read. Each hash must be either hex, or in Bech32m format.

Response

200OK

Mempool Transaction Response

404Not Found

Not found error

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Get Mempool Transaction

curl -X POST 'https://xrd.nownodes.io/core/mempool/transaction' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}",
    "payload_hashes": [
      "string"
    ]
  }'

const response = await fetch('https://xrd.nownodes.io/core/mempool/transaction', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}",
      "payload_hashes": [
        "string"
      ]
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}",
  "payload_hashes": [
    "string"
  ]
}

response = requests.post('https://xrd.nownodes.io/core/mempool/transaction', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}",
  "payload_hashes": [
    "string"
  ]
}

{
  "count": 0,
  "payloads": [
    {
      "hash": "string",
      "hash_bech32m": "string",
      "hex": "string",
      "error": "string"
    }
  ]
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

State

For reading the state of entities. At present, we only support reading details from the top of the currently committed ledger.

Get Consensus Manager Details

POST

https://xrd.nownodes.io/core/state/consensus-manager

Reads the consensus manager's substate/s from the top of the current ledger.

Body

application/json

networkNetworkIdentifierrequired

The logical name of the network

include_readiness_signalsboolean

Whether to include protocol update readiness signals of active validator set (default false).

Response

200OK

Current state response

400Bad Request

Client error

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Get Consensus Manager Details

curl -X POST 'https://xrd.nownodes.io/core/state/consensus-manager' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}",
    "include_readiness_signals": true
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/consensus-manager', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}",
      "include_readiness_signals": true
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}",
  "include_readiness_signals": True
}

response = requests.post('https://xrd.nownodes.io/core/state/consensus-manager', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}",
  "include_readiness_signals": true
}

{
  "at_ledger_state": {
    "state_version": 1,
    "header_summary": {
      "epoch_round": {
        "epoch": 0,
        "round": 0
      },
      "ledger_hashes": {
        "state_tree_hash": "string",
        "transaction_tree_hash": "string",
        "receipt_tree_hash": "string"
      },
      "proposer_timestamp": {
        "unix_timestamp_ms": 0,
        "date_time": "string"
      }
    }
  },
  "config": {
    "substate_type": "BootLoaderModuleFieldVmBoot",
    "is_locked": true
  },
  "state": {
    "substate_type": "BootLoaderModuleFieldVmBoot",
    "is_locked": true
  },
  "current_proposal_statistic": {
    "substate_type": "BootLoaderModuleFieldVmBoot",
    "is_locked": true
  },
  "current_validator_set": {
    "substate_type": "BootLoaderModuleFieldVmBoot",
    "is_locked": true
  },
  "current_time": {
    "substate_type": "BootLoaderModuleFieldVmBoot",
    "is_locked": true
  },
  "current_time_rounded_to_minutes": {
    "substate_type": "BootLoaderModuleFieldVmBoot",
    "is_locked": true
  },
  "current_validator_readiness_signals": [
    {
      "signalled_protocol_version": "string",
      "total_active_stake_proportion": "string",
      "signalling_validators": [
        {
          "index": {
            "index": 0
          },
          "active_stake_proportion": "string"
        }
      ]
    }
  ]
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

Get Account Details

POST

https://xrd.nownodes.io/core/state/account

Reads the account's substate/s from the top of the current ledger. Also returns all vaults under the account.

Body

application/json

networkNetworkIdentifierrequired

The logical name of the network

account_addressstringrequired

The Bech32m-encoded human readable version of the account's global address

Response

200OK

Current state response

400Bad Request

Client error

404Not Found

Not found error

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Get Account Details

curl -X POST 'https://xrd.nownodes.io/core/state/account' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}",
    "account_address": "string"
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/account', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}",
      "account_address": "string"
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}",
  "account_address": "string"
}

response = requests.post('https://xrd.nownodes.io/core/state/account', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}",
  "account_address": "string"
}

{
  "at_ledger_state": {
    "state_version": 1,
    "header_summary": {
      "epoch_round": {
        "epoch": 0,
        "round": 0
      },
      "ledger_hashes": {
        "state_tree_hash": "string",
        "transaction_tree_hash": "string",
        "receipt_tree_hash": "string"
      },
      "proposer_timestamp": {
        "unix_timestamp_ms": 0,
        "date_time": "string"
      }
    }
  },
  "info": {
    "substate_type": "BootLoaderModuleFieldVmBoot",
    "is_locked": true
  },
  "owner_role": {
    "substate_type": "BootLoaderModuleFieldVmBoot",
    "is_locked": true
  },
  "state": {
    "substate_type": "BootLoaderModuleFieldVmBoot",
    "is_locked": true
  },
  "vaults": [
    {
      "vault_entity": {
        "entity_type": "GlobalPackage",
        "is_global": true,
        "entity_address": "string"
      },
      "resource_amount": {
        "resource_type": "Fungible",
        "resource_address": "string"
      }
    }
  ]
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

Get Component Details

POST

https://xrd.nownodes.io/core/state/component

Reads the component's substate/s from the top of the current ledger. Also recursively extracts vault balance totals from the component's entity subtree.

Body

application/json

networkNetworkIdentifierrequired

The logical name of the network

component_addressstringrequired

The Bech32m-encoded human readable version of the component's global address

Response

200OK

Current state response

400Bad Request

Client error

404Not Found

Not found error

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Get Component Details

curl -X POST 'https://xrd.nownodes.io/core/state/component' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}",
    "component_address": "string"
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/component', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}",
      "component_address": "string"
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}",
  "component_address": "string"
}

response = requests.post('https://xrd.nownodes.io/core/state/component', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}",
  "component_address": "string"
}

{
  "at_ledger_state": {
    "state_version": 1,
    "header_summary": {
      "epoch_round": {
        "epoch": 0,
        "round": 0
      },
      "ledger_hashes": {
        "state_tree_hash": "string",
        "transaction_tree_hash": "string",
        "receipt_tree_hash": "string"
      },
      "proposer_timestamp": {
        "unix_timestamp_ms": 0,
        "date_time": "string"
      }
    }
  },
  "info": {
    "substate_type": "BootLoaderModuleFieldVmBoot",
    "is_locked": true
  },
  "state": {
    "substate_type": "BootLoaderModuleFieldVmBoot",
    "is_locked": true
  },
  "royalty_accumulator": {
    "substate_type": "BootLoaderModuleFieldVmBoot",
    "is_locked": true
  },
  "owner_role": {
    "substate_type": "BootLoaderModuleFieldVmBoot",
    "is_locked": true
  },
  "vaults": [
    {
      "vault_entity": {
        "entity_type": "GlobalPackage",
        "is_global": true,
        "entity_address": "string"
      },
      "resource_amount": {
        "resource_type": "Fungible",
        "resource_address": "string"
      }
    }
  ],
  "descendent_nodes": [
    {
      "parent_entity": {
        "entity_type": "GlobalPackage",
        "is_global": true,
        "entity_address": "string"
      },
      "parent_partition_number": 0,
      "parent_substate_key_hex": "string",
      "parent_substate_db_sort_key_hex": "string",
      "entity": {
        "entity_type": "GlobalPackage",
        "is_global": true,
        "entity_address": "string"
      },
      "depth": 0
    }
  ]
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

Get Validator Details

POST

https://xrd.nownodes.io/core/state/validator

Reads the validator's substate/s from the top of the current ledger.

Body

application/json

networkNetworkIdentifierrequired

The logical name of the network

validator_addressComponentAddressrequired

The Bech32m-encoded human readable version of the component address

Response

200OK

Current state response

400Bad Request

Client error

404Not Found

Not found error

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Get Validator Details

curl -X POST 'https://xrd.nownodes.io/core/state/validator' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}",
    "validator_address": "string"
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/validator', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}",
      "validator_address": "string"
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}",
  "validator_address": "string"
}

response = requests.post('https://xrd.nownodes.io/core/state/validator', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}",
  "validator_address": "string"
}

{
  "at_ledger_state": {
    "state_version": 1,
    "header_summary": {
      "epoch_round": {
        "epoch": 0,
        "round": 0
      },
      "ledger_hashes": {
        "state_tree_hash": "string",
        "transaction_tree_hash": "string",
        "receipt_tree_hash": "string"
      },
      "proposer_timestamp": {
        "unix_timestamp_ms": 0,
        "date_time": "string"
      }
    }
  },
  "address": "string",
  "state": {
    "substate_type": "BootLoaderModuleFieldVmBoot",
    "is_locked": true
  },
  "protocol_update_readiness_signal": {
    "substate_type": "BootLoaderModuleFieldVmBoot",
    "is_locked": true
  },
  "owner_role": {
    "substate_type": "BootLoaderModuleFieldVmBoot",
    "is_locked": true
  },
  "vaults": [
    {
      "vault_entity": {
        "entity_type": "GlobalPackage",
        "is_global": true,
        "entity_address": "string"
      },
      "resource_amount": {
        "resource_type": "Fungible",
        "resource_address": "string"
      }
    }
  ],
  "descendent_nodes": [
    {
      "parent_entity": {
        "entity_type": "GlobalPackage",
        "is_global": true,
        "entity_address": "string"
      },
      "parent_partition_number": 0,
      "parent_substate_key_hex": "string",
      "parent_substate_db_sort_key_hex": "string",
      "entity": {
        "entity_type": "GlobalPackage",
        "is_global": true,
        "entity_address": "string"
      },
      "depth": 0
    }
  ]
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

Get Access Controller Details

POST

https://xrd.nownodes.io/core/state/access-controller

Reads the access controller's substate/s from the top of the current ledger.

Body

application/json

networkNetworkIdentifierrequired

The logical name of the network

controller_addressComponentAddressrequired

The Bech32m-encoded human readable version of the component address

Response

200OK

Current state response

400Bad Request

Client error

404Not Found

Not found error

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Get Access Controller Details

curl -X POST 'https://xrd.nownodes.io/core/state/access-controller' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}",
    "controller_address": "string"
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/access-controller', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}",
      "controller_address": "string"
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}",
  "controller_address": "string"
}

response = requests.post('https://xrd.nownodes.io/core/state/access-controller', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}",
  "controller_address": "string"
}

{
  "at_ledger_state": {
    "state_version": 1,
    "header_summary": {
      "epoch_round": {
        "epoch": 0,
        "round": 0
      },
      "ledger_hashes": {
        "state_tree_hash": "string",
        "transaction_tree_hash": "string",
        "receipt_tree_hash": "string"
      },
      "proposer_timestamp": {
        "unix_timestamp_ms": 0,
        "date_time": "string"
      }
    }
  },
  "state": {
    "substate_type": "BootLoaderModuleFieldVmBoot",
    "is_locked": true
  },
  "owner_role": {
    "substate_type": "BootLoaderModuleFieldVmBoot",
    "is_locked": true
  },
  "vaults": [
    {
      "vault_entity": {
        "entity_type": "GlobalPackage",
        "is_global": true,
        "entity_address": "string"
      },
      "resource_amount": {
        "resource_type": "Fungible",
        "resource_address": "string"
      }
    }
  ],
  "descendent_nodes": [
    {
      "parent_entity": {
        "entity_type": "GlobalPackage",
        "is_global": true,
        "entity_address": "string"
      },
      "parent_partition_number": 0,
      "parent_substate_key_hex": "string",
      "parent_substate_db_sort_key_hex": "string",
      "entity": {
        "entity_type": "GlobalPackage",
        "is_global": true,
        "entity_address": "string"
      },
      "depth": 0
    }
  ]
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

Get Resource Details

POST

https://xrd.nownodes.io/core/state/resource

Reads the resource manager's substate/s from the top of the current ledger.

Body

application/json

networkNetworkIdentifierrequired

The logical name of the network

resource_addressstringrequired

The Bech32m-encoded human readable version of the resource's global address

Response

200OK

Current state response

400Bad Request

Client error

404Not Found

Not found error

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Get Resource Details

curl -X POST 'https://xrd.nownodes.io/core/state/resource' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}",
    "resource_address": "string"
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/resource', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}",
      "resource_address": "string"
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}",
  "resource_address": "string"
}

response = requests.post('https://xrd.nownodes.io/core/state/resource', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}",
  "resource_address": "string"
}

{
  "at_ledger_state": {
    "state_version": 1,
    "header_summary": {
      "epoch_round": {
        "epoch": 0,
        "round": 0
      },
      "ledger_hashes": {
        "state_tree_hash": "string",
        "transaction_tree_hash": "string",
        "receipt_tree_hash": "string"
      },
      "proposer_timestamp": {
        "unix_timestamp_ms": 0,
        "date_time": "string"
      }
    }
  },
  "manager": {
    "resource_type": "Fungible"
  },
  "owner_role": {
    "substate_type": "BootLoaderModuleFieldVmBoot",
    "is_locked": true
  }
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

Get Non-Fungible Details

POST

https://xrd.nownodes.io/core/state/non-fungible

Reads the data associated with a single Non-Fungible Unit under a Non-Fungible Resource.

Body

application/json

networkNetworkIdentifierrequired

The logical name of the network

resource_addressstringrequired

The Bech32m-encoded human readable version of the resource's global address

non_fungible_idNonFungibleLocalIdSimpleRepresentationrequired

The simple string representation of the non-fungible id.

For string ids, this is <the-string-id>
For integer ids, this is #the-integer-id#
For bytes ids, this is [the-lower-case-hex-representation]
For RUID ids, this is {...-...-...-...} where ... are each 16 hex characters. A given non-fungible resource has a fixed NonFungibleIdType, so this representation uniquely identifies this non-fungible under the given resource address.

Response

200OK

Current state response

400Bad Request

Client error

404Not Found

Not found error

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Get Non-Fungible Details

curl -X POST 'https://xrd.nownodes.io/core/state/non-fungible' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}",
    "resource_address": "string",
    "non_fungible_id": "string"
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/non-fungible', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}",
      "resource_address": "string",
      "non_fungible_id": "string"
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}",
  "resource_address": "string",
  "non_fungible_id": "string"
}

response = requests.post('https://xrd.nownodes.io/core/state/non-fungible', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}",
  "resource_address": "string",
  "non_fungible_id": "string"
}

{
  "at_ledger_state": {
    "state_version": 1,
    "header_summary": {
      "epoch_round": {
        "epoch": 0,
        "round": 0
      },
      "ledger_hashes": {
        "state_tree_hash": "string",
        "transaction_tree_hash": "string",
        "receipt_tree_hash": "string"
      },
      "proposer_timestamp": {
        "unix_timestamp_ms": 0,
        "date_time": "string"
      }
    }
  },
  "non_fungible": {
    "substate_type": "BootLoaderModuleFieldVmBoot",
    "is_locked": true
  }
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

Get Package Details

POST

https://xrd.nownodes.io/core/state/package

Reads the package's substate/s from the top of the current ledger.

Body

application/json

networkNetworkIdentifierrequired

The logical name of the network

package_addressstringrequired

The Bech32m-encoded human readable version of the package's global address

Response

200OK

Current state response

400Bad Request

Client error

404Not Found

Not found error

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Get Package Details

curl -X POST 'https://xrd.nownodes.io/core/state/package' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}",
    "package_address": "string"
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/package', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}",
      "package_address": "string"
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}",
  "package_address": "string"
}

response = requests.post('https://xrd.nownodes.io/core/state/package', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}",
  "package_address": "string"
}

{
  "at_ledger_state": {
    "state_version": 1,
    "header_summary": {
      "epoch_round": {
        "epoch": 0,
        "round": 0
      },
      "ledger_hashes": {
        "state_tree_hash": "string",
        "transaction_tree_hash": "string",
        "receipt_tree_hash": "string"
      },
      "proposer_timestamp": {
        "unix_timestamp_ms": 0,
        "date_time": "string"
      }
    }
  },
  "owner_role": {
    "substate_type": "BootLoaderModuleFieldVmBoot",
    "is_locked": true
  },
  "royalty": {
    "substate_type": "BootLoaderModuleFieldVmBoot",
    "is_locked": true
  }
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string"
}

Stream

To query the transaction or proof stream of the ledger.

Stream Proofs

POST

https://xrd.nownodes.io/core/stream/proofs

Returns a stream of proofs committed to the node's ledger.

NOTE: This endpoint may return different results on different nodes:

Each node may persist different subset of signatures on a given proofs, as long as enough of the validator set has signed.
Inside an epoch, different nodes may receive and persist / keep different proofs, subject to constraints on gaps between proofs.

Proofs during an epoch can also be garbage collected by the node after the fact. Therefore proofs may disappear from this stream.

Some proofs (such as during genesis and protocol update enactment) are created on a node and don't include signatures.

This stream accepts four different options in the request:

All proofs forward (from state version)
All end-of-epoch proofs (from epoch number)
All end-of-epoch proofs triggering a protocol update
All node-injected proofs enacting genesis or a protocol update (for protocol update name, from state version)

The end-of-epoch proofs can be used to "trustlessly" verify the validator set for a given epoch. By tracking the fact that validators for epoch N sign the next validator set for epoch N + 1, this chain of proofs can be used to provide proof of the current validator set from a hardcoded start.

When a validator set is known for a given epoch, this can be used to verify the various transaction hash trees in the epoch, and to prove other data.

NOTE: This endpoint was built after agreeing the new Radix convention for paged APIs. Its models therefore follow the new convention, rather than attempting to align with existing loose Core API conventions.

Body

application/json

A request to retrieve a sublist of proofs.

networkNetworkIdentifierrequired

The logical name of the network

filterStreamProofsFilter

If not provided, defaults to "Any".

Show child attributes

typeStreamProofsFilterTypeAnyNewEpochsProtocolUpdateInitializationsProtocolUpdateExecutionrequired

max_page_sizeinteger

If specified, the maximum number of proofs that will be returned.

continuation_tokenContinuationToken

A continuation token is returned if and only if there are further non-empty pages of items currently available. The token can be provided in a following request to fetch the next page of results. The filter and sort should not be changed when re-using the continuation token.

Response

200OK

Stream proofs response

400Bad Request

Client error

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Stream Proofs

curl -X POST 'https://xrd.nownodes.io/core/stream/proofs' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}",
    "filter": {
      "type": "Any"
    },
    "max_page_size": 0,
    "continuation_token": "string"
  }'

const response = await fetch('https://xrd.nownodes.io/core/stream/proofs', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}",
      "filter": {
        "type": "Any"
      },
      "max_page_size": 0,
      "continuation_token": "string"
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}",
  "filter": {
    "type": "Any"
  },
  "max_page_size": 0,
  "continuation_token": "string"
}

response = requests.post('https://xrd.nownodes.io/core/stream/proofs', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}",
  "filter": {
    "type": "Any"
  },
  "max_page_size": 0,
  "continuation_token": "string"
}

{
  "page": [
    {
      "ledger_header": {
        "epoch": 0,
        "round": 0,
        "state_version": 1,
        "hashes": {
          "state_tree_hash": "string",
          "transaction_tree_hash": "string",
          "receipt_tree_hash": "string"
        },
        "consensus_parent_round_timestamp_ms": 0,
        "proposer_timestamp_ms": 0,
        "next_epoch": {
          "epoch": 0,
          "validators": [
            {
              "address": "string",
              "key": {
                "key_type": "EcdsaSecp256k1",
                "key_hex": "string"
              },
              "stake": "string"
            }
          ],
          "significant_protocol_update_readiness": [
            {
              "readiness_signal_name": "string",
              "signalled_stake": "string"
            }
          ]
        },
        "next_protocol_version": "string"
      },
      "origin": {
        "type": "Genesis"
      }
    }
  ],
  "continuation_token": "string"
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string",
  "details": {
    "type": "RequestedStateVersionOutOfBounds"
  }
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string",
  "details": {
    "type": "RequestedStateVersionOutOfBounds"
  }
}

Get Committed Transactions

POST

https://xrd.nownodes.io/core/stream/transactions

Returns the list of committed transactions.

Body

application/json

A request to retrieve a sublist of committed transactions from the ledger.

networkNetworkIdentifierrequired

The logical name of the network

from_state_versionStateVersion<int64>[1, 100000000000000]required

The first (resultant) state version to be returned

limitintegerrequired

The maximum number of transactions that will be returned.

sbor_format_optionsSborFormatOptions

Requested SBOR formats to include in the response

Show child attributes

rawboolean

Whether to return the raw hex-encoded bytes (default true)

programmatic_jsonboolean

Whether to return the programmatic json format (normally default true, defaults false for streamed transactions)

transaction_format_optionsTransactionFormatOptions

Requested transaction formats to include in the response

Show child attributes

manifestboolean

Whether to return the raw manifest (default true)

blobsboolean

Whether to return the hex-encoded blobs (default false)

messageboolean

Whether to return the transaction message (default true)

balance_changesboolean

Whether to return the transaction balance changes (default false)

raw_system_transactionboolean

Whether to return the raw hex-encoded system transaction bytes (default false)

raw_notarized_transactionboolean

Whether to return the raw hex-encoded notarized transaction bytes (default true)

raw_ledger_transactionboolean

Whether to return the raw hex-encoded ledger transaction bytes (default false)

substate_format_optionsSubstateFormatOptions

Requested substate formats to include in the response

Show child attributes

rawboolean

Whether to return the raw substate value bytes (default false)

hashboolean

Whether to return the raw substate value bytes hash (default false)

typedboolean

Whether to return the typed substate information (default true)

previousboolean

Whether to return the previous substate value for updates and deletes (default false)

include_proofsboolean

Whether to include LedgerProofs (default false)

Response

200OK

Committed transactions response

400Bad Request

Client error

500Internal Server Error

Server error

Authorization

api-keyAuthapiKey in header

Get Committed Transactions

curl -X POST 'https://xrd.nownodes.io/core/stream/transactions' \
  -H 'Content-Type: application/json' \
  -d '{
    "network": "{{network}}",
    "from_state_version": 1,
    "limit": 0,
    "sbor_format_options": {
      "raw": true,
      "programmatic_json": true
    },
    "transaction_format_options": {
      "manifest": true,
      "blobs": true,
      "message": true,
      "balance_changes": true,
      "raw_system_transaction": true,
      "raw_notarized_transaction": true,
      "raw_ledger_transaction": true
    },
    "substate_format_options": {
      "raw": true,
      "hash": true,
      "typed": true,
      "previous": true
    },
    "include_proofs": true
  }'

const response = await fetch('https://xrd.nownodes.io/core/stream/transactions', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network": "{{network}}",
      "from_state_version": 1,
      "limit": 0,
      "sbor_format_options": {
        "raw": true,
        "programmatic_json": true
      },
      "transaction_format_options": {
        "manifest": true,
        "blobs": true,
        "message": true,
        "balance_changes": true,
        "raw_system_transaction": true,
        "raw_notarized_transaction": true,
        "raw_ledger_transaction": true
      },
      "substate_format_options": {
        "raw": true,
        "hash": true,
        "typed": true,
        "previous": true
      },
      "include_proofs": true
    }),
});

const data = await response.json();

import requests

payload = {
  "network": "{{network}}",
  "from_state_version": 1,
  "limit": 0,
  "sbor_format_options": {
    "raw": True,
    "programmatic_json": True
  },
  "transaction_format_options": {
    "manifest": True,
    "blobs": True,
    "message": True,
    "balance_changes": True,
    "raw_system_transaction": True,
    "raw_notarized_transaction": True,
    "raw_ledger_transaction": True
  },
  "substate_format_options": {
    "raw": True,
    "hash": True,
    "typed": True,
    "previous": True
  },
  "include_proofs": True
}

response = requests.post('https://xrd.nownodes.io/core/stream/transactions', json=payload)
data = response.json()

Request Body

{
  "network": "{{network}}",
  "from_state_version": 1,
  "limit": 0,
  "sbor_format_options": {
    "raw": true,
    "programmatic_json": true
  },
  "transaction_format_options": {
    "manifest": true,
    "blobs": true,
    "message": true,
    "balance_changes": true,
    "raw_system_transaction": true,
    "raw_notarized_transaction": true,
    "raw_ledger_transaction": true
  },
  "substate_format_options": {
    "raw": true,
    "hash": true,
    "typed": true,
    "previous": true
  },
  "include_proofs": true
}

{
  "previous_state_identifiers": {
    "state_version": 1,
    "state_tree_hash": "string",
    "transaction_tree_hash": "string",
    "receipt_tree_hash": "string"
  },
  "from_state_version": 1,
  "count": 0,
  "max_ledger_state_version": 1,
  "transactions": [
    {
      "resultant_state_identifiers": {
        "state_version": 1,
        "state_tree_hash": "string",
        "transaction_tree_hash": "string",
        "receipt_tree_hash": "string"
      },
      "ledger_transaction": {
        "type": "Genesis",
        "payload_hex": "string"
      },
      "receipt": {
        "status": "Succeeded",
        "fee_summary": {
          "execution_cost_units_consumed": 0,
          "finalization_cost_units_consumed": 0,
          "xrd_total_execution_cost": "string",
          "xrd_total_finalization_cost": "string",
          "xrd_total_royalty_cost": "string",
          "xrd_total_storage_cost": "string",
          "xrd_total_tipping_cost": "string"
        },
        "costing_parameters": {
          "execution_cost_unit_price": "string",
          "execution_cost_unit_limit": 0,
          "execution_cost_unit_loan": 0,
          "finalization_cost_unit_price": "string",
          "finalization_cost_unit_limit": 0,
          "xrd_usd_price": "string",
          "xrd_storage_price": "string",
          "xrd_archive_storage_price": "string",
          "tip_percentage": 0
        },
        "fee_source": {
          "from_vaults": [
            {
              "vault_entity": {
                "entity_type": "GlobalPackage",
                "is_global": true,
                "entity_address": "string"
              },
              "xrd_amount": "string"
            }
          ]
        },
        "fee_destination": {
          "to_proposer": "string",
          "to_validator_set": "string",
          "to_burn": "string",
          "to_royalty_recipients": [
            {
              "royalty_recipient": {
                "entity_type": "GlobalPackage",
                "is_global": true,
                "entity_address": "string"
              },
              "xrd_amount": "string"
            }
          ]
        },
        "state_updates": {
          "deleted_partitions": [
            {
              "entity_type": "GlobalPackage",
              "entity_address": "string",
              "entity_module": "TypeInfo",
              "partition_kind": "Field",
              "partition_number": 0
            }
          ],
          "created_substates": [
            {
              "substate_id": {
                "entity_type": "GlobalPackage",
                "entity_address": "string",
                "entity_module": "TypeInfo",
                "partition_kind": "Field",
                "partition_number": 0,
                "substate_type": "BootLoaderModuleFieldVmBoot",
                "substate_key": {
                  "key_type": "Field",
                  "db_sort_key_hex": "string"
                }
              },
              "value": {
                "substate_hex": "string",
                "substate_data_hash": "string",
                "substate_data": {
                  "substate_type": "BootLoaderModuleFieldVmBoot",
                  "is_locked": true
                }
              },
              "system_structure": {
                "type": "SystemField"
              }
            }
          ],
          "updated_substates": [
            {
              "substate_id": {
                "entity_type": "GlobalPackage",
                "entity_address": "string",
                "entity_module": "TypeInfo",
                "partition_kind": "Field",
                "partition_number": 0,
                "substate_type": "BootLoaderModuleFieldVmBoot",
                "substate_key": {
                  "key_type": "Field",
                  "db_sort_key_hex": "string"
                }
              },
              "new_value": {
                "substate_hex": "string",
                "substate_data_hash": "string",
                "substate_data": {
                  "substate_type": "BootLoaderModuleFieldVmBoot",
                  "is_locked": true
                }
              },
              "previous_value": {
                "substate_hex": "string",
                "substate_data_hash": "string",
                "substate_data": {
                  "substate_type": "BootLoaderModuleFieldVmBoot",
                  "is_locked": true
                }
              },
              "system_structure": {
                "type": "SystemField"
              }
            }
          ],
          "deleted_substates": [
            {
              "substate_id": {
                "entity_type": "GlobalPackage",
                "entity_address": "string",
                "entity_module": "TypeInfo",
                "partition_kind": "Field",
                "partition_number": 0,
                "substate_type": "BootLoaderModuleFieldVmBoot",
                "substate_key": {
                  "key_type": "Field",
                  "db_sort_key_hex": "string"
                }
              },
              "previous_value": {
                "substate_hex": "string",
                "substate_data_hash": "string",
                "substate_data": {
                  "substate_type": "BootLoaderModuleFieldVmBoot",
                  "is_locked": true
                }
              },
              "system_structure": {
                "type": "SystemField"
              }
            }
          ],
          "new_global_entities": [
            {
              "entity_type": "GlobalPackage",
              "is_global": true,
              "entity_address": "string"
            }
          ]
        },
        "events": [
          {
            "type": {
              "emitter": {
                "type": "Function"
              },
              "type_reference": {
                "full_type_id": {
                  "entity_address": "string",
                  "schema_hash": "string",
                  "local_type_id": {
                    "kind": "WellKnown",
                    "id": 0,
                    "as_sbor": {
                      "hex": "string"
                    }
                  }
                }
              },
              "name": "string"
            },
            "data": {
              "hex": "string"
            }
          }
        ],
        "next_epoch": {
          "epoch": 0,
          "validators": [
            {
              "address": "string",
              "key": {
                "key_type": "EcdsaSecp256k1",
                "key_hex": "string"
              },
              "stake": "string"
            }
          ],
          "significant_protocol_update_readiness": [
            {
              "readiness_signal_name": "string",
              "signalled_stake": "string"
            }
          ]
        },
        "output": [
          {
            "hex": "string"
          }
        ],
        "error_message": "string"
      },
      "balance_changes": {
        "fungible_entity_balance_changes": [
          {
            "entity_address": "string",
            "fee_balance_change": {
              "resource_address": "string",
              "balance_change": "string"
            },
            "fee_balance_changes": [
              {
                "type": "FeePayment",
                "resource_address": "string",
                "balance_change": "string"
              }
            ],
            "non_fee_balance_changes": [
              {
                "resource_address": "string",
                "balance_change": "string"
              }
            ]
          }
        ],
        "non_fungible_entity_balance_changes": [
          {
            "entity_address": "string",
            "resource_address": "string",
            "added": [
              "string"
            ],
            "removed": [
              "string"
            ]
          }
        ]
      },
      "proposer_timestamp_ms": 0
    }
  ],
  "proofs": [
    {
      "ledger_header": {
        "epoch": 0,
        "round": 0,
        "state_version": 1,
        "hashes": {
          "state_tree_hash": "string",
          "transaction_tree_hash": "string",
          "receipt_tree_hash": "string"
        },
        "consensus_parent_round_timestamp_ms": 0,
        "proposer_timestamp_ms": 0,
        "next_epoch": {
          "epoch": 0,
          "validators": [
            {
              "address": "string",
              "key": {
                "key_type": "EcdsaSecp256k1",
                "key_hex": "string"
              },
              "stake": "string"
            }
          ],
          "significant_protocol_update_readiness": [
            {
              "readiness_signal_name": "string",
              "signalled_stake": "string"
            }
          ]
        },
        "next_protocol_version": "string"
      },
      "origin": {
        "type": "Genesis"
      }
    }
  ]
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string",
  "details": {
    "type": "RequestedStateVersionOutOfBounds"
  }
}

{
  "error_type": "Basic",
  "code": 0,
  "message": "string",
  "trace_id": "string",
  "details": {
    "type": "RequestedStateVersionOutOfBounds"
  }
}

Geteway

Status

For status and configuration details for the node / engine.

Get Gateway Status

POST

https://xrd.nownodes.io/core/status/gateway-status

Returns the Gateway API version and current ledger state.

Response

200OK

Network Gateway Information

Authorization

api-keyAuthapiKey in header

Get Gateway Status

curl -X POST 'https://xrd.nownodes.io/core/status/gateway-status'

const response = await fetch('https://xrd.nownodes.io/core/status/gateway-status', {
  method: 'POST',
});

const data = await response.json();

import requests

response = requests.post('https://xrd.nownodes.io/core/status/gateway-status')
data = response.json()

200

{
  "ledger_state": {
    "network": "<network-name>",
    "state_version": 0,
    "proposer_round_timestamp": "string",
    "epoch": 0,
    "round": 0
  },
  "release_info": {
    "release_version": "string",
    "open_api_schema_version": "string",
    "image_tag": "string"
  }
}

Get Network Configuration

POST

https://xrd.nownodes.io/core/status/network-configuration

Returns network identifier, network name and well-known network addresses.

Response

200OK

Network Configuration

Authorization

api-keyAuthapiKey in header

Get Network Configuration

curl -X POST 'https://xrd.nownodes.io/core/status/network-configuration'

const response = await fetch('https://xrd.nownodes.io/core/status/network-configuration', {
  method: 'POST',
});

const data = await response.json();

import requests

response = requests.post('https://xrd.nownodes.io/core/status/network-configuration')
data = response.json()

200

{
  "network_id": "<network-id>",
  "network_name": "<network-name>",
  "well_known_addresses": {
    "xrd": "string",
    "secp256k1_signature_virtual_badge": "string",
    "ed25519_signature_virtual_badge": "string",
    "package_of_direct_caller_virtual_badge": "string",
    "global_caller_virtual_badge": "string",
    "system_transaction_badge": "string",
    "package_owner_badge": "string",
    "validator_owner_badge": "string",
    "account_owner_badge": "string",
    "identity_owner_badge": "string",
    "package_package": "string",
    "resource_package": "string",
    "account_package": "string",
    "identity_package": "string",
    "consensus_manager_package": "string",
    "access_controller_package": "string",
    "transaction_processor_package": "string",
    "metadata_module_package": "string",
    "royalty_module_package": "string",
    "access_rules_package": "string",
    "role_assignment_module_package": "string",
    "genesis_helper_package": "string",
    "faucet_package": "string",
    "consensus_manager": "string",
    "genesis_helper": "string",
    "faucet": "string",
    "pool_package": "string",
    "transaction_tracker": "string"
  }
}

Transaction

For transaction construction, preview, submission, and monitoring the status of an individual transaction.

Get Construction Metadata

POST

https://xrd.nownodes.io/core/transaction/construction

Returns information needed to construct a new transaction including current epoch number.

Response

200OK

Returns information needed to construct transaction.

Authorization

api-keyAuthapiKey in header

Get Construction Metadata

curl -X POST 'https://xrd.nownodes.io/core/transaction/construction'

const response = await fetch('https://xrd.nownodes.io/core/transaction/construction', {
  method: 'POST',
});

const data = await response.json();

import requests

response = requests.post('https://xrd.nownodes.io/core/transaction/construction')
data = response.json()

200

{
  "ledger_state": {
    "network": "<network-name>",
    "state_version": 0,
    "proposer_round_timestamp": "string",
    "epoch": 0,
    "round": 0
  }
}

Preview Transaction

POST

https://xrd.nownodes.io/core/transaction/preview

Previews transaction against the network. This endpoint is effectively a proxy towards the Core API /v0/transaction/preview endpoint. See the Core API documentation for more details.

Body

application/json

manifeststringrequired

A text-representation of a transaction manifest

blobs_hexArray<string>

An array of hex-encoded blob data (optional)

start_epoch_inclusiveinteger<int64>[0, 10000000000]required

An integer between 0 and 10^10, marking the epoch at which the transaction starts being valid

end_epoch_exclusiveinteger<int64>[0, 10000000000]required

An integer between 0 and 10^10, marking the epoch at which the transaction is no longer valid

notary_public_keyPublicKey

The notary public key to use (optional)

Show child attributes

key_typePublicKeyTypeEcdsaSecp256k1EddsaEd25519required

notary_is_signatoryboolean

Whether the notary should count as a signatory (optional, default false)

tip_percentageinteger<int32>[0, 65535]required

An integer between 0 and 65535, giving the validator tip as a percentage amount. A value of 1 corresponds to 1% of the fee.

nonceinteger<int64>>= 0required

A decimal-string-encoded integer between 0 and 2^32 - 1, used to ensure the transaction intent is unique.

signer_public_keysArray<PublicKey>required

A list of public keys to be used as transaction signers

Show child attributes

key_typePublicKeyTypeEcdsaSecp256k1EddsaEd25519required

flagsobjectrequired

Show child attributes

use_free_creditbooleanrequired

assume_all_signature_proofsbooleanrequired

skip_epoch_checkbooleanrequired

Response

200OK

Successful Preview

4XX

Client-originated request error

Authorization

api-keyAuthapiKey in header

Preview Transaction

curl -X POST 'https://xrd.nownodes.io/core/transaction/preview' \
  -H 'Content-Type: application/json' \
  -d '{
    "manifest": "string",
    "blobs_hex": [
      "string"
    ],
    "start_epoch_inclusive": 0,
    "end_epoch_exclusive": 0,
    "notary_public_key": {
      "key_type": "EcdsaSecp256k1"
    },
    "notary_is_signatory": true,
    "tip_percentage": 0,
    "nonce": 0,
    "signer_public_keys": [
      {
        "key_type": "EcdsaSecp256k1"
      }
    ],
    "flags": {
      "use_free_credit": true,
      "assume_all_signature_proofs": true,
      "skip_epoch_check": true
    }
  }'

const response = await fetch('https://xrd.nownodes.io/core/transaction/preview', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "manifest": "string",
      "blobs_hex": [
        "string"
      ],
      "start_epoch_inclusive": 0,
      "end_epoch_exclusive": 0,
      "notary_public_key": {
        "key_type": "EcdsaSecp256k1"
      },
      "notary_is_signatory": true,
      "tip_percentage": 0,
      "nonce": 0,
      "signer_public_keys": [
        {
          "key_type": "EcdsaSecp256k1"
        }
      ],
      "flags": {
        "use_free_credit": true,
        "assume_all_signature_proofs": true,
        "skip_epoch_check": true
      }
    }),
});

const data = await response.json();

import requests

payload = {
  "manifest": "string",
  "blobs_hex": [
    "string"
  ],
  "start_epoch_inclusive": 0,
  "end_epoch_exclusive": 0,
  "notary_public_key": {
    "key_type": "EcdsaSecp256k1"
  },
  "notary_is_signatory": True,
  "tip_percentage": 0,
  "nonce": 0,
  "signer_public_keys": [
    {
      "key_type": "EcdsaSecp256k1"
    }
  ],
  "flags": {
    "use_free_credit": True,
    "assume_all_signature_proofs": True,
    "skip_epoch_check": True
  }
}

response = requests.post('https://xrd.nownodes.io/core/transaction/preview', json=payload)
data = response.json()

Request Body

{
  "manifest": "string",
  "blobs_hex": [
    "string"
  ],
  "start_epoch_inclusive": 0,
  "end_epoch_exclusive": 0,
  "notary_public_key": {
    "key_type": "EcdsaSecp256k1"
  },
  "notary_is_signatory": true,
  "tip_percentage": 0,
  "nonce": 0,
  "signer_public_keys": [
    {
      "key_type": "EcdsaSecp256k1"
    }
  ],
  "flags": {
    "use_free_credit": true,
    "assume_all_signature_proofs": true,
    "skip_epoch_check": true
  }
}

{
  "encoded_receipt": "string",
  "receipt": {},
  "resource_changes": [
    {}
  ],
  "logs": [
    {
      "level": "string",
      "message": "string"
    }
  ]
}

{
  "message": "string",
  "code": 0,
  "details": {
    "type": "string"
  },
  "trace_id": "string"
}

Submit Transaction

POST

https://xrd.nownodes.io/core/transaction/submit

Submits a signed transaction payload to the network.

Body

application/json

notarized_transaction_hexNotarizedTransactionHexStringrequired

Hex-encoded notarized transaction payload which can be submitted.

Response

200OK

Successful Submission

4XX

Client-originated request error

Authorization

api-keyAuthapiKey in header

Submit Transaction

curl -X POST 'https://xrd.nownodes.io/core/transaction/submit' \
  -H 'Content-Type: application/json' \
  -d '{
    "notarized_transaction_hex": "string"
  }'

const response = await fetch('https://xrd.nownodes.io/core/transaction/submit', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "notarized_transaction_hex": "string"
    }),
});

const data = await response.json();

import requests

payload = {
  "notarized_transaction_hex": "string"
}

response = requests.post('https://xrd.nownodes.io/core/transaction/submit', json=payload)
data = response.json()

Request Body

{
  "notarized_transaction_hex": "string"
}

{
  "duplicate": true
}

{
  "message": "string",
  "code": 0,
  "details": {
    "type": "string"
  },
  "trace_id": "string"
}

Get Committed Transaction Details

POST

https://xrd.nownodes.io/core/transaction/committed-details

Returns the committed details and receipt of the transaction for a given transaction identifier. Transaction identifiers which don't correspond to a committed transaction will return a TransactionNotFoundError.

Body

application/json

defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.

at_ledger_stateLedgerStateSelector | null

Optional. This allows for a request to be made against a historic state. If a constraint is specified, the Gateway will resolve the request against the ledger state at that time. If not specified, requests will be made with respect to the top of the committed ledger.

Show child attributes

state_versioninteger<int64> | null[1, 100000000000000]

If provided, the latest ledger state lower than or equal to the given state version is returned.

timestampstring<date-time> | null

If provided, the latest ledger state lower than or equal to the given round timestamp is returned.

epochinteger<int64> | null[0, 10000000000]

If provided, the ledger state lower than or equal to the given epoch at round 0 is returned.

roundinteger<int64> | null[0, 10000000000]

If provided must be accompanied with epoch, the ledger state lower than or equal to the given epoch and round is returned.

intent_hashHashBech32mStringrequired

Bech32m-encoded hash.

opt_insTransactionDetailsOptIns

Show child attributes

raw_hexbooleanfalse

if set to true, raw transaction hex is returned.

receipt_state_changesbooleanfalse

if set to true, state changes inside receipt object are returned.

receipt_fee_summarybooleanfalse

if set to true, fee summary inside receipt object is returned.

receipt_fee_sourcebooleanfalse

if set to true, fee source inside receipt object is returned.

receipt_fee_destinationbooleanfalse

if set to true, fee destination inside receipt object is returned.

receipt_costing_parametersbooleanfalse

if set to true, costing parameters inside receipt object is returned.

receipt_eventsbooleanfalse

if set to true, events inside receipt object is returned.

receipt_outputbooleantrue

(true by default) if set to true, transaction receipt output is returned.

affected_global_entitiesbooleanfalse

if set to true, all affected global entities by given transaction are returned.

manifest_instructionsbooleanfalse

if set to true, manifest instructions for user transactions are returned.

balance_changesbooleanfalse

if set to true, returns the fungible and non-fungible balance changes.

Warning! This opt-in might be missing for recently committed transactions, in that case a null value will be returned. Retry the request until non-null value is returned.

Response

200OK

Transaction Status

4XX

Client-originated request error

Authorization

api-keyAuthapiKey in header

Get Committed Transaction Details

curl -X POST 'https://xrd.nownodes.io/core/transaction/committed-details' \
  -H 'Content-Type: application/json' \
  -d '{
    "intent_hash": "<transaction-intent-hash>"
  }'

const response = await fetch('https://xrd.nownodes.io/core/transaction/committed-details', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "intent_hash": "<transaction-intent-hash>"
    }),
});

const data = await response.json();

import requests

payload = {
  "intent_hash": "<transaction-intent-hash>"
}

response = requests.post('https://xrd.nownodes.io/core/transaction/committed-details', json=payload)
data = response.json()

Request Body

{
  "intent_hash": "<transaction-intent-hash>"
}

{
  "ledger_state": {
    "network": "<network-name>",
    "state_version": 0,
    "proposer_round_timestamp": "string",
    "epoch": 0,
    "round": 0
  },
  "transaction": {
    "state_version": 0,
    "epoch": 0,
    "round": 0,
    "round_timestamp": "string",
    "transaction_status": "Unknown",
    "payload_hash": "string",
    "intent_hash": "string",
    "fee_paid": "string",
    "affected_global_entities": [
      "string"
    ],
    "confirmed_at": "2024-01-15T09:30:00Z",
    "error_message": "string",
    "raw_hex": "string",
    "receipt": {
      "status": "Unknown",
      "fee_summary": {},
      "costing_parameters": {},
      "fee_destination": {},
      "fee_source": {},
      "state_updates": {},
      "next_epoch": {},
      "output": {},
      "events": [
        {
          "name": "string",
          "emitter": {},
          "data": {
            "kind": "Bool",
            "type_name": "string",
            "field_name": "string"
          }
        }
      ],
      "error_message": "string"
    },
    "manifest_instructions": "string",
    "manifest_classes": [
      "General"
    ],
    "message": {},
    "balance_changes": {
      "fungible_fee_balance_changes": [
        {
          "type": "FeePayment",
          "entity_address": "string",
          "resource_address": "string",
          "balance_change": "string"
        }
      ],
      "fungible_balance_changes": [
        {
          "entity_address": "string",
          "resource_address": "string",
          "balance_change": "string"
        }
      ],
      "non_fungible_balance_changes": [
        {
          "entity_address": "string",
          "resource_address": "string",
          "added": [
            "string"
          ],
          "removed": [
            "string"
          ]
        }
      ]
    }
  }
}

{
  "message": "string",
  "code": 0,
  "details": {
    "type": "string"
  },
  "trace_id": "string"
}

Get Transaction Status

POST

https://xrd.nownodes.io/core/transaction/status

Returns overall transaction status and all of its known payloads based on supplied intent hash.

Body

application/json

intent_hashHashBech32mStringrequired

Bech32m-encoded hash.

Response

200OK

Transaction Status

4XX

Client-originated request error

Authorization

api-keyAuthapiKey in header

Get Transaction Status

curl -X POST 'https://xrd.nownodes.io/core/transaction/status' \
  -H 'Content-Type: application/json' \
  -d '{
    "intent_hash": "<transaction-intent-hash>"
  }'

const response = await fetch('https://xrd.nownodes.io/core/transaction/status', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "intent_hash": "<transaction-intent-hash>"
    }),
});

const data = await response.json();

import requests

payload = {
  "intent_hash": "<transaction-intent-hash>"
}

response = requests.post('https://xrd.nownodes.io/core/transaction/status', json=payload)
data = response.json()

Request Body

{
  "intent_hash": "<transaction-intent-hash>"
}

{
  "ledger_state": {
    "network": "<network-name>",
    "state_version": 0,
    "proposer_round_timestamp": "string",
    "epoch": 0,
    "round": 0
  },
  "status": "Unknown",
  "intent_status": "Unknown",
  "intent_status_description": "string",
  "known_payloads": [
    {
      "payload_hash": "string",
      "status": "Unknown",
      "payload_status": "Unknown",
      "payload_status_description": "string",
      "error_message": "string",
      "latest_error_message": "string",
      "handling_status": "HandlingSubmission",
      "handling_status_reason": "string",
      "submission_error": "string"
    }
  ],
  "committed_state_version": 0,
  "permanently_rejects_at_epoch": 0,
  "error_message": "string"
}

{
  "message": "string",
  "code": 0,
  "details": {
    "type": "string"
  },
  "trace_id": "string"
}

PreValidate deposit of resources to an account

POST

https://xrd.nownodes.io/core/transaction/account-deposit-pre-validation

Helper endpoint that allows pre-validation if a deposit of certain resources to a given account can succeed or not. It is only meant for pre-validation usage, it does not guarantee that execution will succeed.

Body

application/json

account_addressAddressrequired

Bech32m-encoded human readable version of the address.

resource_addressesArray<Address>required

badgeTransactionAccountDepositPreValidationAuthorizedDepositorBadge

Show child attributes

badge_typeAccountAuthorizedDepositorBadgeTypeResourceBadgeNonFungibleBadgerequired

resource_addressAddressrequired

Bech32m-encoded human readable version of the address.

Response

200OK

Pre-validation response, including all deciding factors that were used to generate that response.

4XX

Client-originated request error

Authorization

api-keyAuthapiKey in header

PreValidate deposit of resources to an account

curl -X POST 'https://xrd.nownodes.io/core/transaction/account-deposit-pre-validation' \
  -H 'Content-Type: application/json' \
  -d '{
    "account_address": "<account-address>",
    "resource_addresses": [
      "<resource-address>"
    ]
  }'

const response = await fetch('https://xrd.nownodes.io/core/transaction/account-deposit-pre-validation', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "account_address": "<account-address>",
      "resource_addresses": [
        "<resource-address>"
      ]
    }),
});

const data = await response.json();

import requests

payload = {
  "account_address": "<account-address>",
  "resource_addresses": [
    "<resource-address>"
  ]
}

response = requests.post('https://xrd.nownodes.io/core/transaction/account-deposit-pre-validation', json=payload)
data = response.json()

Request Body

{
  "account_address": "<account-address>",
  "resource_addresses": [
    "<resource-address>"
  ]
}

{
  "ledger_state": {
    "network": "<network-name>",
    "state_version": 0,
    "proposer_round_timestamp": "string",
    "epoch": 0,
    "round": 0
  },
  "allows_try_deposit_batch": true,
  "resource_specific_behaviour": [
    {
      "resource_address": "string",
      "allows_try_deposit": true
    }
  ],
  "deciding_factors": {
    "is_badge_authorized_depositor": true,
    "default_deposit_rule": "Accept",
    "resource_specific_details": [
      {
        "resource_address": "string",
        "vault_exists": true,
        "is_xrd": true,
        "resource_preference_rule": "Allowed"
      }
    ]
  }
}

{
  "message": "string",
  "code": 0,
  "details": {
    "type": "string"
  },
  "trace_id": "string"
}

State

For reading the state of entities. At present, we only support reading details from the top of the currently committed ledger.

Get Entity Details

POST

https://xrd.nownodes.io/core/state/entity/details

Returns detailed information for collection of entities. Aggregate resources globally by default.

Body

application/json

defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.

at_ledger_stateLedgerStateSelector | null

Show child attributes

state_versioninteger<int64> | null[1, 100000000000000]

If provided, the latest ledger state lower than or equal to the given state version is returned.

timestampstring<date-time> | null

If provided, the latest ledger state lower than or equal to the given round timestamp is returned.

epochinteger<int64> | null[0, 10000000000]

If provided, the ledger state lower than or equal to the given epoch at round 0 is returned.

roundinteger<int64> | null[0, 10000000000]

If provided must be accompanied with epoch, the ledger state lower than or equal to the given epoch and round is returned.

opt_insStateEntityDetailsOptIns

Check detailed OptIns documentation for more details

Show child attributes

ancestor_identitiesbooleanfalse

if set to true, ancestor addresses - parent_address, owner_address and global_address for entities are returned.

component_royalty_configbooleanfalse

if set to true, royalty_config for component entities is returned.

component_royalty_vault_balancebooleanfalse

if set to true, royalty_vault_balance for component entities is returned.

package_royalty_vault_balancebooleanfalse

if set to true, royalty_vault_balance for package entities is returned.

non_fungible_include_nfidsbooleanfalse

if set to true, first page of non fungible ids are returned for each non fungible resource, with next_cursor which can be later used at /state/entity/page/non-fungible-vault/ids endpoint.

explicit_metadataArray<string>

allows specifying explicitly metadata properties which should be returned in response.

addressesArray<Address>required

limited to max 100 items.

aggregation_levelResourceAggregationLevelGlobalVault

Response

200OK

Entity Details

4XX

Client-originated request error

Authorization

api-keyAuthapiKey in header

Get Entity Details

curl -X POST 'https://xrd.nownodes.io/core/state/entity/details' \
  -H 'Content-Type: application/json' \
  -d '{
    "addresses": [
      "<entity-address>"
    ],
    "aggregation_level": "Vault",
    "opt_ins": {
      "ancestor_identities": true,
      "component_royalty_config": true,
      "component_royalty_vault_balance": true,
      "package_royalty_vault_balance": true,
      "non_fungible_include_nfids": true,
      "explicit_metadata": [
        "name",
        "description"
      ]
    }
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/entity/details', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "addresses": [
        "<entity-address>"
      ],
      "aggregation_level": "Vault",
      "opt_ins": {
        "ancestor_identities": true,
        "component_royalty_config": true,
        "component_royalty_vault_balance": true,
        "package_royalty_vault_balance": true,
        "non_fungible_include_nfids": true,
        "explicit_metadata": [
          "name",
          "description"
        ]
      }
    }),
});

const data = await response.json();

import requests

payload = {
  "addresses": [
    "<entity-address>"
  ],
  "aggregation_level": "Vault",
  "opt_ins": {
    "ancestor_identities": True,
    "component_royalty_config": True,
    "component_royalty_vault_balance": True,
    "package_royalty_vault_balance": True,
    "non_fungible_include_nfids": True,
    "explicit_metadata": [
      "name",
      "description"
    ]
  }
}

response = requests.post('https://xrd.nownodes.io/core/state/entity/details', json=payload)
data = response.json()

Request Body

{
  "addresses": [
    "<entity-address>"
  ],
  "aggregation_level": "Vault",
  "opt_ins": {
    "ancestor_identities": true,
    "component_royalty_config": true,
    "component_royalty_vault_balance": true,
    "package_royalty_vault_balance": true,
    "non_fungible_include_nfids": true,
    "explicit_metadata": [
      "name",
      "description"
    ]
  }
}

{
  "ledger_state": {
    "network": "<network-name>",
    "state_version": 0,
    "proposer_round_timestamp": "string",
    "epoch": 0,
    "round": 0
  },
  "items": [
    {
      "address": "string",
      "fungible_resources": {
        "total_count": 0,
        "next_cursor": "string",
        "items": [
          {
            "aggregation_level": "Global",
            "resource_address": "string",
            "explicit_metadata": {
              "total_count": 0,
              "next_cursor": "string",
              "items": [
                {
                  "key": "string",
                  "value": {
                    "raw_hex": "string",
                    "programmatic_json": {
                      "kind": "Bool",
                      "type_name": "string",
                      "field_name": "string"
                    },
                    "typed": {
                      "type": "String"
                    }
                  },
                  "is_locked": true,
                  "last_updated_at_state_version": 1
                }
              ]
            }
          }
        ]
      },
      "non_fungible_resources": {
        "total_count": 0,
        "next_cursor": "string",
        "items": [
          {
            "aggregation_level": "Global",
            "resource_address": "string",
            "explicit_metadata": {
              "total_count": 0,
              "next_cursor": "string",
              "items": [
                {
                  "key": "string",
                  "value": {
                    "raw_hex": "string",
                    "programmatic_json": {
                      "kind": "Bool",
                      "type_name": "string",
                      "field_name": "string"
                    },
                    "typed": {
                      "type": "String"
                    }
                  },
                  "is_locked": true,
                  "last_updated_at_state_version": 1
                }
              ]
            }
          }
        ]
      },
      "ancestor_identities": {
        "parent_address": "string",
        "owner_address": "string",
        "global_address": "string"
      },
      "metadata": {
        "total_count": 0,
        "next_cursor": "string",
        "items": [
          {
            "key": "string",
            "value": {
              "raw_hex": "string",
              "programmatic_json": {
                "kind": "Bool",
                "type_name": "string",
                "field_name": "string"
              },
              "typed": {
                "type": "String"
              }
            },
            "is_locked": true,
            "last_updated_at_state_version": 1
          }
        ]
      },
      "explicit_metadata": {
        "total_count": 0,
        "next_cursor": "string",
        "items": [
          {
            "key": "string",
            "value": {
              "raw_hex": "string",
              "programmatic_json": {
                "kind": "Bool",
                "type_name": "string",
                "field_name": "string"
              },
              "typed": {
                "type": "String"
              }
            },
            "is_locked": true,
            "last_updated_at_state_version": 1
          }
        ]
      },
      "details": {
        "type": "FungibleResource"
      }
    }
  ]
}

{
  "message": "string",
  "code": 0,
  "details": {
    "type": "string"
  },
  "trace_id": "string"
}

Get Entity Metadata Page

POST

https://xrd.nownodes.io/core/state/entity/page/metadata

Returns all the metadata properties associated with a given global entity. The returned response is in a paginated format, ordered by first appearance on the ledger.

Body

application/json

defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.

at_ledger_stateLedgerStateSelector | null

Show child attributes

state_versioninteger<int64> | null[1, 100000000000000]

If provided, the latest ledger state lower than or equal to the given state version is returned.

timestampstring<date-time> | null

If provided, the latest ledger state lower than or equal to the given round timestamp is returned.

epochinteger<int64> | null[0, 10000000000]

If provided, the ledger state lower than or equal to the given epoch at round 0 is returned.

roundinteger<int64> | null[0, 10000000000]

If provided must be accompanied with epoch, the ledger state lower than or equal to the given epoch and round is returned.

cursorstring | null

This cursor allows forward pagination, by providing the cursor from the previous request.

limit_per_pageinteger | null

The page size requested.

addressAddressrequired

Bech32m-encoded human readable version of the address.

Response

200OK

Entity Metadata (paginated)

4XX

Client-originated request error

Authorization

api-keyAuthapiKey in header

Get Entity Metadata Page

curl -X POST 'https://xrd.nownodes.io/core/state/entity/page/metadata' \
  -H 'Content-Type: application/json' \
  -d '{
    "address": "<entity-address>"
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/entity/page/metadata', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "address": "<entity-address>"
    }),
});

const data = await response.json();

import requests

payload = {
  "address": "<entity-address>"
}

response = requests.post('https://xrd.nownodes.io/core/state/entity/page/metadata', json=payload)
data = response.json()

Request Body

{
  "address": "<entity-address>"
}

{
  "ledger_state": {
    "network": "<network-name>",
    "state_version": 0,
    "proposer_round_timestamp": "string",
    "epoch": 0,
    "round": 0
  },
  "total_count": 0,
  "next_cursor": "string",
  "items": [
    {
      "key": "string",
      "value": {
        "raw_hex": "string",
        "programmatic_json": {
          "kind": "Bool",
          "type_name": "string",
          "field_name": "string"
        },
        "typed": {
          "type": "String"
        }
      },
      "is_locked": true,
      "last_updated_at_state_version": 1
    }
  ],
  "address": "string"
}

{
  "message": "string",
  "code": 0,
  "details": {
    "type": "string"
  },
  "trace_id": "string"
}

Get Entity Schema Page

POST

https://xrd.nownodes.io/core/state/entity/page/schemas

Returns all the schemas associated with a given global entity. The returned response is in a paginated format, ordered by first appearance on the ledger.

Body

application/json

defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.

at_ledger_stateLedgerStateSelector | null

Show child attributes

state_versioninteger<int64> | null[1, 100000000000000]

If provided, the latest ledger state lower than or equal to the given state version is returned.

timestampstring<date-time> | null

If provided, the latest ledger state lower than or equal to the given round timestamp is returned.

epochinteger<int64> | null[0, 10000000000]

If provided, the ledger state lower than or equal to the given epoch at round 0 is returned.

roundinteger<int64> | null[0, 10000000000]

If provided must be accompanied with epoch, the ledger state lower than or equal to the given epoch and round is returned.

cursorstring | null

This cursor allows forward pagination, by providing the cursor from the previous request.

limit_per_pageinteger | null

The page size requested.

addressAddressrequired

Bech32m-encoded human readable version of the address.

Response

200OK

Entity Schemas (paginated)

4XX

Client-originated request error

Authorization

api-keyAuthapiKey in header

Get Entity Schema Page

curl -X POST 'https://xrd.nownodes.io/core/state/entity/page/schemas' \
  -H 'Content-Type: application/json' \
  -d '{
    "address": "<package-address>"
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/entity/page/schemas', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "address": "<package-address>"
    }),
});

const data = await response.json();

import requests

payload = {
  "address": "<package-address>"
}

response = requests.post('https://xrd.nownodes.io/core/state/entity/page/schemas', json=payload)
data = response.json()

Request Body

{
  "address": "<package-address>"
}

{
  "ledger_state": {
    "network": "<network-name>",
    "state_version": 0,
    "proposer_round_timestamp": "string",
    "epoch": 0,
    "round": 0
  },
  "total_count": 0,
  "next_cursor": "string",
  "items": [
    {
      "schema_hash_hex": "string",
      "schema_hex": "string"
    }
  ],
  "address": "string"
}

{
  "message": "string",
  "code": 0,
  "details": {
    "type": "string"
  },
  "trace_id": "string"
}

Get page of Global Entity Fungible Resource Balances

POST

https://xrd.nownodes.io/core/state/entity/page/fungibles

Returns the total amount of each fungible resource owned by a given global entity. Result can be aggregated globally or per vault. The returned response is in a paginated format, ordered by the resource's first appearance on the ledger.

Body

application/json

defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.

at_ledger_stateLedgerStateSelector | null

Show child attributes

state_versioninteger<int64> | null[1, 100000000000000]

If provided, the latest ledger state lower than or equal to the given state version is returned.

timestampstring<date-time> | null

If provided, the latest ledger state lower than or equal to the given round timestamp is returned.

epochinteger<int64> | null[0, 10000000000]

If provided, the ledger state lower than or equal to the given epoch at round 0 is returned.

roundinteger<int64> | null[0, 10000000000]

If provided must be accompanied with epoch, the ledger state lower than or equal to the given epoch and round is returned.

cursorstring | null

This cursor allows forward pagination, by providing the cursor from the previous request.

limit_per_pageinteger | null

The page size requested.

addressAddressrequired

Bech32m-encoded human readable version of the address.

aggregation_levelResourceAggregationLevelGlobalVault

opt_insStateEntityFungiblesPageRequestOptIns

Check detailed OptIns documentation for more details

Show child attributes

explicit_metadataArray<string>

allows specifying explicitly metadata properties which should be returned in response, limited to max 20 items.

Response

200OK

Entity Fungibles (paginated)

4XX

Client-originated request error

Authorization

api-keyAuthapiKey in header

Get page of Global Entity Fungible Resource Balances

curl -X POST 'https://xrd.nownodes.io/core/state/entity/page/fungibles/' \
  -H 'Content-Type: application/json' \
  -d '{
    "address": "<component-entity-address>"
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/entity/page/fungibles/', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "address": "<component-entity-address>"
    }),
});

const data = await response.json();

import requests

payload = {
  "address": "<component-entity-address>"
}

response = requests.post('https://xrd.nownodes.io/core/state/entity/page/fungibles/', json=payload)
data = response.json()

Request Body

{
  "address": "<component-entity-address>"
}

{
  "ledger_state": {
    "network": "<network-name>",
    "state_version": 0,
    "proposer_round_timestamp": "string",
    "epoch": 0,
    "round": 0
  },
  "total_count": 0,
  "next_cursor": "string",
  "items": [
    {
      "aggregation_level": "Global",
      "resource_address": "string",
      "explicit_metadata": {
        "total_count": 0,
        "next_cursor": "string",
        "items": [
          {
            "key": "string",
            "value": {
              "raw_hex": "string",
              "programmatic_json": {
                "kind": "Bool",
                "type_name": "string",
                "field_name": "string"
              },
              "typed": {
                "type": "String"
              }
            },
            "is_locked": true,
            "last_updated_at_state_version": 1
          }
        ]
      }
    }
  ],
  "address": "string"
}

{
  "message": "string",
  "code": 0,
  "details": {
    "type": "string"
  },
  "trace_id": "string"
}

Get page of Global Entity Fungible Resource Vaults

POST

https://xrd.nownodes.io/core/state/entity/page/fungible-vaults

Returns vaults for fungible resource owned by a given global entity. The returned response is in a paginated format, ordered by the resource's first appearance on the ledger.

Body

application/json

defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.

at_ledger_stateLedgerStateSelector | null

Show child attributes

state_versioninteger<int64> | null[1, 100000000000000]

If provided, the latest ledger state lower than or equal to the given state version is returned.

timestampstring<date-time> | null

If provided, the latest ledger state lower than or equal to the given round timestamp is returned.

epochinteger<int64> | null[0, 10000000000]

If provided, the ledger state lower than or equal to the given epoch at round 0 is returned.

roundinteger<int64> | null[0, 10000000000]

If provided must be accompanied with epoch, the ledger state lower than or equal to the given epoch and round is returned.

cursorstring | null

This cursor allows forward pagination, by providing the cursor from the previous request.

limit_per_pageinteger | null

The page size requested.

addressAddressrequired

Bech32m-encoded human readable version of the address.

resource_addressAddressrequired

Bech32m-encoded human readable version of the address.

Response

200OK

Entity Fungibles (paginated)

4XX

Client-originated request error

Authorization

api-keyAuthapiKey in header

Get page of Global Entity Fungible Resource Vaults

curl -X POST 'https://xrd.nownodes.io/core/state/entity/page/fungible-vaults/' \
  -H 'Content-Type: application/json' \
  -d '{
    "address": "<component-entity-address>",
    "resource_address": "<resource-address>"
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/entity/page/fungible-vaults/', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "address": "<component-entity-address>",
      "resource_address": "<resource-address>"
    }),
});

const data = await response.json();

import requests

payload = {
  "address": "<component-entity-address>",
  "resource_address": "<resource-address>"
}

response = requests.post('https://xrd.nownodes.io/core/state/entity/page/fungible-vaults/', json=payload)
data = response.json()

Request Body

{
  "address": "<component-entity-address>",
  "resource_address": "<resource-address>"
}

{
  "ledger_state": {
    "network": "<network-name>",
    "state_version": 0,
    "proposer_round_timestamp": "string",
    "epoch": 0,
    "round": 0
  },
  "total_count": 0,
  "next_cursor": "string",
  "items": [
    {
      "vault_address": "string",
      "amount": "string",
      "last_updated_at_state_version": 1
    }
  ],
  "address": "string",
  "resource_address": "string"
}

{
  "message": "string",
  "code": 0,
  "details": {
    "type": "string"
  },
  "trace_id": "string"
}

Get page of Global Entity Non-Fungible Resource Balances

POST

https://xrd.nownodes.io/core/state/entity/page/non-fungibles

Returns the total amount of each non-fungible resource owned by a given global entity. Result can be aggregated globally or per vault. The returned response is in a paginated format, ordered by the resource's first appearance on the ledger.

Body

application/json

defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.

at_ledger_stateLedgerStateSelector | null

Show child attributes

state_versioninteger<int64> | null[1, 100000000000000]

If provided, the latest ledger state lower than or equal to the given state version is returned.

timestampstring<date-time> | null

If provided, the latest ledger state lower than or equal to the given round timestamp is returned.

epochinteger<int64> | null[0, 10000000000]

If provided, the ledger state lower than or equal to the given epoch at round 0 is returned.

roundinteger<int64> | null[0, 10000000000]

If provided must be accompanied with epoch, the ledger state lower than or equal to the given epoch and round is returned.

cursorstring | null

This cursor allows forward pagination, by providing the cursor from the previous request.

limit_per_pageinteger | null

The page size requested.

addressAddressrequired

Bech32m-encoded human readable version of the address.

aggregation_levelResourceAggregationLevelGlobalVault

opt_insStateEntityNonFungiblesPageRequestOptIns

Check detailed OptIns documentation for more details

Show child attributes

non_fungible_include_nfidsbooleanfalse

if set to true, first page of non fungible ids are returned for each non fungible resource, with cursor which can be later used at /state/entity/page/non-fungible-vault/ids endpoint.

explicit_metadataArray<string>

allows specifying explicitly metadata properties which should be returned in response, limited to max 20 items.

Response

200OK

Entity Non-Fungibles (paginated)

4XX

Client-originated request error

Authorization

api-keyAuthapiKey in header

Get page of Global Entity Non-Fungible Resource Balances

curl -X POST 'https://xrd.nownodes.io/core/state/entity/page/non-fungibles/' \
  -H 'Content-Type: application/json' \
  -d '{
    "address": "<component-entity-address>"
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/entity/page/non-fungibles/', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "address": "<component-entity-address>"
    }),
});

const data = await response.json();

import requests

payload = {
  "address": "<component-entity-address>"
}

response = requests.post('https://xrd.nownodes.io/core/state/entity/page/non-fungibles/', json=payload)
data = response.json()

Request Body

{
  "address": "<component-entity-address>"
}

{
  "ledger_state": {
    "network": "<network-name>",
    "state_version": 0,
    "proposer_round_timestamp": "string",
    "epoch": 0,
    "round": 0
  },
  "total_count": 0,
  "next_cursor": "string",
  "items": [
    {
      "aggregation_level": "Global",
      "resource_address": "string",
      "explicit_metadata": {
        "total_count": 0,
        "next_cursor": "string",
        "items": [
          {
            "key": "string",
            "value": {
              "raw_hex": "string",
              "programmatic_json": {
                "kind": "Bool",
                "type_name": "string",
                "field_name": "string"
              },
              "typed": {
                "type": "String"
              }
            },
            "is_locked": true,
            "last_updated_at_state_version": 1
          }
        ]
      }
    }
  ],
  "address": "string"
}

{
  "message": "string",
  "code": 0,
  "details": {
    "type": "string"
  },
  "trace_id": "string"
}

Get page of Global Entity Non-Fungible Resource Vaults

POST

https://xrd.nownodes.io/core/state/entity/page/non-fungible-vaults

Returns vaults for non fungible resource owned by a given global entity. The returned response is in a paginated format, ordered by the resource's first appearance on the ledger.

Body

application/json

defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.

at_ledger_stateLedgerStateSelector | null

Show child attributes

state_versioninteger<int64> | null[1, 100000000000000]

If provided, the latest ledger state lower than or equal to the given state version is returned.

timestampstring<date-time> | null

If provided, the latest ledger state lower than or equal to the given round timestamp is returned.

epochinteger<int64> | null[0, 10000000000]

If provided, the ledger state lower than or equal to the given epoch at round 0 is returned.

roundinteger<int64> | null[0, 10000000000]

If provided must be accompanied with epoch, the ledger state lower than or equal to the given epoch and round is returned.

cursorstring | null

This cursor allows forward pagination, by providing the cursor from the previous request.

limit_per_pageinteger | null

The page size requested.

addressAddressrequired

Bech32m-encoded human readable version of the address.

resource_addressAddressrequired

Bech32m-encoded human readable version of the address.

opt_insStateEntityNonFungibleResourceVaultsPageOptIns

Check detailed OptIns documentation for more details

Show child attributes

non_fungible_include_nfidsboolean

if set to true, first page of non fungible ids are returned for each non fungible resource, with cursor which can be later used at /state/entity/page/non-fungible-vault/ids endpoint.

Response

200OK

Entity Fungibles (paginated)

4XX

Client-originated request error

Authorization

api-keyAuthapiKey in header

Get page of Global Entity Non-Fungible Resource Vaults

curl -X POST 'https://xrd.nownodes.io/core/state/entity/page/non-fungible-vaults/' \
  -H 'Content-Type: application/json' \
  -d '{
    "address": "<component-entity-address>",
    "resource_address": "<resource-address>"
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/entity/page/non-fungible-vaults/', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "address": "<component-entity-address>",
      "resource_address": "<resource-address>"
    }),
});

const data = await response.json();

import requests

payload = {
  "address": "<component-entity-address>",
  "resource_address": "<resource-address>"
}

response = requests.post('https://xrd.nownodes.io/core/state/entity/page/non-fungible-vaults/', json=payload)
data = response.json()

Request Body

{
  "address": "<component-entity-address>",
  "resource_address": "<resource-address>"
}

{
  "ledger_state": {
    "network": "<network-name>",
    "state_version": 0,
    "proposer_round_timestamp": "string",
    "epoch": 0,
    "round": 0
  },
  "total_count": 0,
  "next_cursor": "string",
  "items": [
    {
      "total_count": 0,
      "next_cursor": "string",
      "items": [
        "string"
      ],
      "vault_address": "string",
      "last_updated_at_state_version": 1
    }
  ],
  "address": "string",
  "resource_address": "string"
}

{
  "message": "string",
  "code": 0,
  "details": {
    "type": "string"
  },
  "trace_id": "string"
}

Get page of Non-Fungibles in Vault

POST

https://xrd.nownodes.io/core/state/entity/page/non-fungible-vault/ids

Returns all non-fungible IDs of a given non-fungible resource owned by a given entity. The returned response is in a paginated format, ordered by the resource's first appearence on the ledger.

Body

application/json

defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.

at_ledger_stateLedgerStateSelector | null

Show child attributes

state_versioninteger<int64> | null[1, 100000000000000]

If provided, the latest ledger state lower than or equal to the given state version is returned.

timestampstring<date-time> | null

If provided, the latest ledger state lower than or equal to the given round timestamp is returned.

epochinteger<int64> | null[0, 10000000000]

If provided, the ledger state lower than or equal to the given epoch at round 0 is returned.

roundinteger<int64> | null[0, 10000000000]

If provided must be accompanied with epoch, the ledger state lower than or equal to the given epoch and round is returned.

cursorstring | null

This cursor allows forward pagination, by providing the cursor from the previous request.

limit_per_pageinteger | null

The page size requested.

addressAddressrequired

Bech32m-encoded human readable version of the address.

vault_addressAddressrequired

Bech32m-encoded human readable version of the address.

resource_addressAddressrequired

Bech32m-encoded human readable version of the address.

Response

200OK

Entity Non-Fungible IDs (paginated)

4XX

Client-originated request error

Authorization

api-keyAuthapiKey in header

Get page of Non-Fungibles in Vault

curl -X POST 'https://xrd.nownodes.io/core/state/entity/page/non-fungible-vault/ids' \
  -H 'Content-Type: application/json' \
  -d '{
    "address": "<component-entity-address>",
    "resource_address": null,
    "vault_address": null
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/entity/page/non-fungible-vault/ids', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "address": "<component-entity-address>",
      "resource_address": null,
      "vault_address": null
    }),
});

const data = await response.json();

import requests

payload = {
  "address": "<component-entity-address>",
  "resource_address": None,
  "vault_address": None
}

response = requests.post('https://xrd.nownodes.io/core/state/entity/page/non-fungible-vault/ids', json=payload)
data = response.json()

Request Body

{
  "address": "<component-entity-address>",
  "resource_address": null,
  "vault_address": null
}

{
  "ledger_state": {
    "network": "<network-name>",
    "state_version": 0,
    "proposer_round_timestamp": "string",
    "epoch": 0,
    "round": 0
  },
  "total_count": 0,
  "next_cursor": "string",
  "items": [
    "string"
  ],
  "address": "string",
  "resource_address": "string"
}

{
  "message": "string",
  "code": 0,
  "details": {
    "type": "string"
  },
  "trace_id": "string"
}

Get page of Non-Fungible Ids in Resource Collection

POST

https://xrd.nownodes.io/core/state/non-fungible/ids

Returns the non-fungible IDs of a given non-fungible resource. Returned response is in a paginated format, ordered by their first appearance on the ledger.

Body

application/json

defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.

at_ledger_stateLedgerStateSelector | null

Show child attributes

state_versioninteger<int64> | null[1, 100000000000000]

If provided, the latest ledger state lower than or equal to the given state version is returned.

timestampstring<date-time> | null

If provided, the latest ledger state lower than or equal to the given round timestamp is returned.

epochinteger<int64> | null[0, 10000000000]

If provided, the ledger state lower than or equal to the given epoch at round 0 is returned.

roundinteger<int64> | null[0, 10000000000]

If provided must be accompanied with epoch, the ledger state lower than or equal to the given epoch and round is returned.

cursorstring | null

This cursor allows forward pagination, by providing the cursor from the previous request.

limit_per_pageinteger | null

The page size requested.

resource_addressAddressrequired

Bech32m-encoded human readable version of the address.

Response

200OK

Non-Fungible IDs (paginated)

4XX

Client-originated request error

Authorization

api-keyAuthapiKey in header

Get page of Non-Fungible Ids in Resource Collection

curl -X POST 'https://xrd.nownodes.io/core/state/non-fungible/ids' \
  -H 'Content-Type: application/json' \
  -d '{
    "resource_address": "<non-fungible-entity-address>"
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/non-fungible/ids', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "resource_address": "<non-fungible-entity-address>"
    }),
});

const data = await response.json();

import requests

payload = {
  "resource_address": "<non-fungible-entity-address>"
}

response = requests.post('https://xrd.nownodes.io/core/state/non-fungible/ids', json=payload)
data = response.json()

Request Body

{
  "resource_address": "<non-fungible-entity-address>"
}

{
  "ledger_state": {
    "network": "<network-name>",
    "state_version": 0,
    "proposer_round_timestamp": "string",
    "epoch": 0,
    "round": 0
  },
  "resource_address": "string",
  "non_fungible_ids": {
    "total_count": 0,
    "next_cursor": "string",
    "items": [
      "string"
    ]
  }
}

{
  "message": "string",
  "code": 0,
  "details": {
    "type": "string"
  },
  "trace_id": "string"
}

Get Non-Fungible Data

POST

https://xrd.nownodes.io/core/state/non-fungible/data

Returns data associated with a given non-fungible ID of a given non-fungible resource.

Body

application/json

defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.

at_ledger_stateLedgerStateSelector | null

Show child attributes

state_versioninteger<int64> | null[1, 100000000000000]

If provided, the latest ledger state lower than or equal to the given state version is returned.

timestampstring<date-time> | null

If provided, the latest ledger state lower than or equal to the given round timestamp is returned.

epochinteger<int64> | null[0, 10000000000]

If provided, the ledger state lower than or equal to the given epoch at round 0 is returned.

roundinteger<int64> | null[0, 10000000000]

If provided must be accompanied with epoch, the ledger state lower than or equal to the given epoch and round is returned.

resource_addressAddressrequired

Bech32m-encoded human readable version of the address.

non_fungible_idsArray<NonFungibleId>required

limited to max 100 items.

Response

200OK

Non-Fungible ID Data

4XX

Client-originated request error

Authorization

api-keyAuthapiKey in header

Get Non-Fungible Data

curl -X POST 'https://xrd.nownodes.io/core/state/non-fungible/data' \
  -H 'Content-Type: application/json' \
  -d '{
    "resource_address": "<non-fungible-entity-address>",
    "non_fungible_ids": [
      "#1#"
    ]
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/non-fungible/data', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "resource_address": "<non-fungible-entity-address>",
      "non_fungible_ids": [
        "#1#"
      ]
    }),
});

const data = await response.json();

import requests

payload = {
  "resource_address": "<non-fungible-entity-address>",
  "non_fungible_ids": [
    "#1#"
  ]
}

response = requests.post('https://xrd.nownodes.io/core/state/non-fungible/data', json=payload)
data = response.json()

Request Body

{
  "resource_address": "<non-fungible-entity-address>",
  "non_fungible_ids": [
    "#1#"
  ]
}

{
  "ledger_state": {
    "network": "<network-name>",
    "state_version": 0,
    "proposer_round_timestamp": "string",
    "epoch": 0,
    "round": 0
  },
  "resource_address": "string",
  "non_fungible_id_type": "String",
  "non_fungible_ids": [
    {
      "is_burned": true,
      "non_fungible_id": "string",
      "data": {
        "raw_hex": "string",
        "programmatic_json": {
          "kind": "Bool",
          "type_name": "string",
          "field_name": "string"
        }
      },
      "last_updated_at_state_version": 1
    }
  ]
}

{
  "message": "string",
  "code": 0,
  "details": {
    "type": "string"
  },
  "trace_id": "string"
}

Get Non-Fungible Location

POST

https://xrd.nownodes.io/core/state/non-fungible/location

Returns location of a given non-fungible ID.

Body

application/json

defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.

at_ledger_stateLedgerStateSelector | null

Show child attributes

state_versioninteger<int64> | null[1, 100000000000000]

If provided, the latest ledger state lower than or equal to the given state version is returned.

timestampstring<date-time> | null

If provided, the latest ledger state lower than or equal to the given round timestamp is returned.

epochinteger<int64> | null[0, 10000000000]

If provided, the ledger state lower than or equal to the given epoch at round 0 is returned.

roundinteger<int64> | null[0, 10000000000]

If provided must be accompanied with epoch, the ledger state lower than or equal to the given epoch and round is returned.

resource_addressAddressrequired

Bech32m-encoded human readable version of the address.

non_fungible_idsArray<NonFungibleId>required

limited to max 100 items.

Response

200OK

Non-Fungible ID Location

4XX

Client-originated request error

Authorization

api-keyAuthapiKey in header

Get Non-Fungible Location

curl -X POST 'https://xrd.nownodes.io/core/state/non-fungible/location' \
  -H 'Content-Type: application/json' \
  -d '{
    "resource_address": "<non-fungible-entity-address>",
    "non_fungible_ids": [
      "#1#"
    ]
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/non-fungible/location', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "resource_address": "<non-fungible-entity-address>",
      "non_fungible_ids": [
        "#1#"
      ]
    }),
});

const data = await response.json();

import requests

payload = {
  "resource_address": "<non-fungible-entity-address>",
  "non_fungible_ids": [
    "#1#"
  ]
}

response = requests.post('https://xrd.nownodes.io/core/state/non-fungible/location', json=payload)
data = response.json()

Request Body

{
  "resource_address": "<non-fungible-entity-address>",
  "non_fungible_ids": [
    "#1#"
  ]
}

{
  "ledger_state": {
    "network": "<network-name>",
    "state_version": 0,
    "proposer_round_timestamp": "string",
    "epoch": 0,
    "round": 0
  },
  "resource_address": "string",
  "non_fungible_ids": [
    {
      "non_fungible_id": "string",
      "owning_vault_address": "string",
      "owning_vault_parent_ancestor_address": "string",
      "owning_vault_global_ancestor_address": "string",
      "is_burned": true,
      "last_updated_at_state_version": 1
    }
  ]
}

{
  "message": "string",
  "code": 0,
  "details": {
    "type": "string"
  },
  "trace_id": "string"
}

Get KeyValueStore Keys

POST

https://xrd.nownodes.io/core/state/key-value-store/keys

Allows to iterate over key value store keys.

Body

application/json

defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.

at_ledger_stateLedgerStateSelector | null

Show child attributes

state_versioninteger<int64> | null[1, 100000000000000]

If provided, the latest ledger state lower than or equal to the given state version is returned.

timestampstring<date-time> | null

If provided, the latest ledger state lower than or equal to the given round timestamp is returned.

epochinteger<int64> | null[0, 10000000000]

If provided, the ledger state lower than or equal to the given epoch at round 0 is returned.

roundinteger<int64> | null[0, 10000000000]

If provided must be accompanied with epoch, the ledger state lower than or equal to the given epoch and round is returned.

cursorstring | null

This cursor allows forward pagination, by providing the cursor from the previous request.

limit_per_pageinteger | null

The page size requested.

key_value_store_addressAddressrequired

Bech32m-encoded human readable version of the address.

Response

200OK

KeyValueStore keys collection

4XX

Client-originated request error

Authorization

api-keyAuthapiKey in header

Get KeyValueStore Keys

curl -X POST 'https://xrd.nownodes.io/core/state/key-value-store/keys' \
  -H 'Content-Type: application/json' \
  -d '{
    "key_value_store_address": "<key-value-store-address>"
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/key-value-store/keys', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "key_value_store_address": "<key-value-store-address>"
    }),
});

const data = await response.json();

import requests

payload = {
  "key_value_store_address": "<key-value-store-address>"
}

response = requests.post('https://xrd.nownodes.io/core/state/key-value-store/keys', json=payload)
data = response.json()

Request Body

{
  "key_value_store_address": "<key-value-store-address>"
}

{
  "ledger_state": {
    "network": "<network-name>",
    "state_version": 0,
    "proposer_round_timestamp": "string",
    "epoch": 0,
    "round": 0
  },
  "total_count": 0,
  "next_cursor": "string",
  "items": [
    {
      "key": {
        "raw_hex": "string",
        "programmatic_json": {
          "kind": "Bool",
          "type_name": "string",
          "field_name": "string"
        }
      },
      "last_updated_at_state_version": 1
    }
  ],
  "key_value_store_address": "string"
}

{
  "message": "string",
  "code": 0,
  "details": {
    "type": "string"
  },
  "trace_id": "string"
}

Get KeyValueStore Data

POST

https://xrd.nownodes.io/core/state/key-value-store/data

Returns data (value) associated with a given key of a given key-value store. Check detailed documentation for explanation

Body

application/json

defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.

at_ledger_stateLedgerStateSelector | null

Show child attributes

state_versioninteger<int64> | null[1, 100000000000000]

If provided, the latest ledger state lower than or equal to the given state version is returned.

timestampstring<date-time> | null

If provided, the latest ledger state lower than or equal to the given round timestamp is returned.

epochinteger<int64> | null[0, 10000000000]

If provided, the ledger state lower than or equal to the given epoch at round 0 is returned.

roundinteger<int64> | null[0, 10000000000]

If provided must be accompanied with epoch, the ledger state lower than or equal to the given epoch and round is returned.

key_value_store_addressAddressrequired

Bech32m-encoded human readable version of the address.

keysArray<StateKeyValueStoreDataRequestKeyItem>required

limited to max 100 items.

Show child attributes

key_hexHexString

Hex-encoded binary blob.

key_jsonProgrammaticScryptoSborValue

Arbitrary SBOR value represented as programmatic JSON with optional property name annotations.

All scalar types (Bool, I*, U*, String, Reference, Own, Decimal, PreciseDecimal, NonFungibleLocalId) convey their value via value string property with notable exception of Bool type that uses regular JSON boolean type. Numeric values as string-encoded to preserve accuracy and simplify implementation on platforms with no native support for 64-bit long numerical values.

Common properties represented as nullable strings:

type_name is only output when a schema is present and the type has a name,
field_name is only output when the value is a child of a Tuple or Enum, which has a type with named fields,
variant_name is only output when a schema is present and the type is an Enum.

The following is a non-normative example annotated Tuple value with String and U32 fields:

Copied!

{
  "kind": "Tuple",
  "type_name": "CustomStructure",
  "fields": [
    {
      "kind": "String",
      "field_name": "favorite_color",
      "value": "Blue"
    },
    {
      "kind": "U32",
      "field_name": "usage_counter",
      "value": "462231"
    }
  ]
}

Show child attributes

kindProgrammaticScryptoSborValueKindBoolI8I16I32I64I128U8U16U32U64U128StringEnumArrayBytesMapTupleReferenceOwnDecimalPreciseDecimalNonFungibleLocalIdrequired

These are the Scrypto SBOR ValueKinds, but with Bytes added as an alias for Vec, to display such values as hex-encoded strings.

type_namestring | null

The name of the type of this value. This is only output when a schema is present and the type has a name. This property is ignored when the value is used as an input to the API.

field_namestring | null

The name of the field which hosts this value. This property is only included if this value is a child of a Tuple or Enum with named fields. This property is ignored when the value is used as an input to the API.

Response

200OK

Non-Fungible ID Data

4XX

Client-originated request error

Authorization

api-keyAuthapiKey in header

Get KeyValueStore Data

curl -X POST 'https://xrd.nownodes.io/core/state/key-value-store/data' \
  -H 'Content-Type: application/json' \
  -d '{
    "key_value_store_address": "<key-value-store-address>",
    "keys": [
      {
        "key_hex": "5C21010901000000"
      },
      {
        "key_json": {
          "kind": "Tuple",
          "fields": [
            {
              "kind": "U32",
              "value": "1"
            }
          ]
        }
      }
    ]
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/key-value-store/data', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "key_value_store_address": "<key-value-store-address>",
      "keys": [
        {
          "key_hex": "5C21010901000000"
        },
        {
          "key_json": {
            "kind": "Tuple",
            "fields": [
              {
                "kind": "U32",
                "value": "1"
              }
            ]
          }
        }
      ]
    }),
});

const data = await response.json();

import requests

payload = {
  "key_value_store_address": "<key-value-store-address>",
  "keys": [
    {
      "key_hex": "5C21010901000000"
    },
    {
      "key_json": {
        "kind": "Tuple",
        "fields": [
          {
            "kind": "U32",
            "value": "1"
          }
        ]
      }
    }
  ]
}

response = requests.post('https://xrd.nownodes.io/core/state/key-value-store/data', json=payload)
data = response.json()

Request Body

{
  "key_value_store_address": "<key-value-store-address>",
  "keys": [
    {
      "key_hex": "5C21010901000000"
    },
    {
      "key_json": {
        "kind": "Tuple",
        "fields": [
          {
            "kind": "U32",
            "value": "1"
          }
        ]
      }
    }
  ]
}

{
  "ledger_state": {
    "network": "<network-name>",
    "state_version": 0,
    "proposer_round_timestamp": "string",
    "epoch": 0,
    "round": 0
  },
  "key_value_store_address": "string",
  "entries": [
    {
      "key": {
        "raw_hex": "string",
        "programmatic_json": {
          "kind": "Bool",
          "type_name": "string",
          "field_name": "string"
        }
      },
      "value": {
        "raw_hex": "string",
        "programmatic_json": {
          "kind": "Bool",
          "type_name": "string",
          "field_name": "string"
        }
      },
      "last_updated_at_state_version": 1,
      "is_locked": true
    }
  ]
}

{
  "message": "string",
  "code": 0,
  "details": {
    "type": "string"
  },
  "trace_id": "string"
}

Get Validators List

POST

https://xrd.nownodes.io/core/state/validators/list

Body

application/json

defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.

at_ledger_stateLedgerStateSelector | null

Show child attributes

state_versioninteger<int64> | null[1, 100000000000000]

If provided, the latest ledger state lower than or equal to the given state version is returned.

timestampstring<date-time> | null

If provided, the latest ledger state lower than or equal to the given round timestamp is returned.

epochinteger<int64> | null[0, 10000000000]

If provided, the ledger state lower than or equal to the given epoch at round 0 is returned.

roundinteger<int64> | null[0, 10000000000]

If provided must be accompanied with epoch, the ledger state lower than or equal to the given epoch and round is returned.

cursorstring | null

This cursor allows forward pagination, by providing the cursor from the previous request.

Response

200OK

Validators List

4XX

Client-originated request error

Authorization

api-keyAuthapiKey in header

Get Validators List

curl -X POST 'https://xrd.nownodes.io/core/state/validators/list' \
  -H 'Content-Type: application/json' \
  -d '{
    "at_ledger_state": null
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/validators/list', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "at_ledger_state": null
    }),
});

const data = await response.json();

import requests

payload = {
  "at_ledger_state": None
}

response = requests.post('https://xrd.nownodes.io/core/state/validators/list', json=payload)
data = response.json()

Request Body

{
  "at_ledger_state": null
}

{
  "ledger_state": {
    "network": "<network-name>",
    "state_version": 0,
    "proposer_round_timestamp": "string",
    "epoch": 0,
    "round": 0
  },
  "validators": {
    "total_count": 0,
    "next_cursor": "string",
    "items": [
      {
        "address": "string",
        "stake_vault": {
          "balance": "string",
          "last_changed_at_state_version": 0,
          "address": "string"
        },
        "pending_xrd_withdraw_vault": {
          "balance": "string",
          "last_changed_at_state_version": 0,
          "address": "string"
        },
        "locked_owner_stake_unit_vault": {
          "balance": "string",
          "last_changed_at_state_version": 0,
          "address": "string"
        },
        "pending_owner_stake_unit_unlock_vault": {
          "balance": "string",
          "last_changed_at_state_version": 0,
          "address": "string"
        },
        "state": {},
        "active_in_epoch": {
          "stake": "string",
          "stake_percentage": 0,
          "key": {
            "key_type": "EcdsaSecp256k1"
          }
        },
        "metadata": {
          "total_count": 0,
          "next_cursor": "string",
          "items": [
            {
              "key": "string",
              "value": {
                "raw_hex": "string",
                "programmatic_json": {
                  "kind": "Bool",
                  "type_name": "string",
                  "field_name": "string"
                },
                "typed": {
                  "type": "String"
                }
              },
              "is_locked": true,
              "last_updated_at_state_version": 1
            }
          ]
        },
        "effective_fee_factor": {
          "current": {
            "fee_factor": "string"
          },
          "pending": {
            "fee_factor": "string",
            "effective_at_epoch": 0
          }
        }
      }
    ]
  }
}

{
  "message": "string",
  "code": 0,
  "details": {
    "type": "string"
  },
  "trace_id": "string"
}

Get Account resource preferences

POST

https://xrd.nownodes.io/core/state/account/page/resource-preferences

Returns paginable collection of resource preference rules for given account.

Body

application/json

defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.

at_ledger_stateLedgerStateSelector | null

Show child attributes

state_versioninteger<int64> | null[1, 100000000000000]

If provided, the latest ledger state lower than or equal to the given state version is returned.

timestampstring<date-time> | null

If provided, the latest ledger state lower than or equal to the given round timestamp is returned.

epochinteger<int64> | null[0, 10000000000]

If provided, the ledger state lower than or equal to the given epoch at round 0 is returned.

roundinteger<int64> | null[0, 10000000000]

If provided must be accompanied with epoch, the ledger state lower than or equal to the given epoch and round is returned.

cursorstring | null

This cursor allows forward pagination, by providing the cursor from the previous request.

limit_per_pageinteger | null

The page size requested.

account_addressAddressrequired

Bech32m-encoded human readable version of the address.

Response

200OK

Account resource preferences page

4XX

Client-originated request error

Authorization

api-keyAuthapiKey in header

Get Account resource preferences

curl -X POST 'https://xrd.nownodes.io/core/state/account/page/resource-preferences' \
  -H 'Content-Type: application/json' \
  -d '{
    "account_address": null
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/account/page/resource-preferences', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "account_address": null
    }),
});

const data = await response.json();

import requests

payload = {
  "account_address": None
}

response = requests.post('https://xrd.nownodes.io/core/state/account/page/resource-preferences', json=payload)
data = response.json()

Request Body

{
  "account_address": null
}

{
  "ledger_state": {
    "network": "<network-name>",
    "state_version": 0,
    "proposer_round_timestamp": "string",
    "epoch": 0,
    "round": 0
  },
  "total_count": 0,
  "next_cursor": "string",
  "items": [
    {
      "resource_address": "string",
      "resource_preference_rule": "Allowed",
      "last_updated_at_state_version": 1
    }
  ],
  "account_address": "string"
}

{
  "message": "string",
  "code": 0,
  "details": {
    "type": "string"
  },
  "trace_id": "string"
}

Get Account authorized depositors

POST

https://xrd.nownodes.io/core/state/account/page/authorized-depositors

Returns paginable collection of authorized depositors for given account.

Body

application/json

defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.

at_ledger_stateLedgerStateSelector | null

Show child attributes

state_versioninteger<int64> | null[1, 100000000000000]

If provided, the latest ledger state lower than or equal to the given state version is returned.

timestampstring<date-time> | null

If provided, the latest ledger state lower than or equal to the given round timestamp is returned.

epochinteger<int64> | null[0, 10000000000]

If provided, the ledger state lower than or equal to the given epoch at round 0 is returned.

roundinteger<int64> | null[0, 10000000000]

If provided must be accompanied with epoch, the ledger state lower than or equal to the given epoch and round is returned.

cursorstring | null

This cursor allows forward pagination, by providing the cursor from the previous request.

limit_per_pageinteger | null

The page size requested.

account_addressAddressrequired

Bech32m-encoded human readable version of the address.

Response

200OK

Account resource preferences page

4XX

Client-originated request error

Authorization

api-keyAuthapiKey in header

Get Account authorized depositors

curl -X POST 'https://xrd.nownodes.io/core/state/account/page/authorized-depositors' \
  -H 'Content-Type: application/json' \
  -d '{
    "account_address": null
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/account/page/authorized-depositors', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "account_address": null
    }),
});

const data = await response.json();

import requests

payload = {
  "account_address": None
}

response = requests.post('https://xrd.nownodes.io/core/state/account/page/authorized-depositors', json=payload)
data = response.json()

Request Body

{
  "account_address": null
}

{
  "ledger_state": {
    "network": "<network-name>",
    "state_version": 0,
    "proposer_round_timestamp": "string",
    "epoch": 0,
    "round": 0
  },
  "total_count": 0,
  "next_cursor": "string",
  "items": [
    {
      "badge_type": "ResourceBadge"
    }
  ],
  "account_address": "string"
}

{
  "message": "string",
  "code": 0,
  "details": {
    "type": "string"
  },
  "trace_id": "string"
}

Get Package Blueprints Page

POST

https://xrd.nownodes.io/core/state/package/page/blueprints

Returns all the blueprints associated with a given package entity. The returned response is in a paginated format, ordered by first appearance on the ledger.

Body

application/json

defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.

at_ledger_stateLedgerStateSelector | null

Show child attributes

state_versioninteger<int64> | null[1, 100000000000000]

If provided, the latest ledger state lower than or equal to the given state version is returned.

timestampstring<date-time> | null

If provided, the latest ledger state lower than or equal to the given round timestamp is returned.

epochinteger<int64> | null[0, 10000000000]

If provided, the ledger state lower than or equal to the given epoch at round 0 is returned.

roundinteger<int64> | null[0, 10000000000]

If provided must be accompanied with epoch, the ledger state lower than or equal to the given epoch and round is returned.

cursorstring | null

This cursor allows forward pagination, by providing the cursor from the previous request.

limit_per_pageinteger | null

The page size requested.

package_addressAddressrequired

Bech32m-encoded human readable version of the address.

Response

200OK

Package Blueprints (paginated)

4XX

Client-originated request error

Authorization

api-keyAuthapiKey in header

Get Package Blueprints Page

curl -X POST 'https://xrd.nownodes.io/core/state/package/page/blueprints' \
  -H 'Content-Type: application/json' \
  -d '{
    "package_address": "<package-address>"
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/package/page/blueprints', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "package_address": "<package-address>"
    }),
});

const data = await response.json();

import requests

payload = {
  "package_address": "<package-address>"
}

response = requests.post('https://xrd.nownodes.io/core/state/package/page/blueprints', json=payload)
data = response.json()

Request Body

{
  "package_address": "<package-address>"
}

{
  "ledger_state": {
    "network": "<network-name>",
    "state_version": 0,
    "proposer_round_timestamp": "string",
    "epoch": 0,
    "round": 0
  },
  "total_count": 0,
  "next_cursor": "string",
  "items": [
    {
      "name": "string",
      "version": "string",
      "definition": {},
      "dependant_entities": [
        "string"
      ],
      "auth_template": {},
      "auth_template_is_locked": true,
      "royalty_config": {
        "is_enabled": true,
        "method_rules": [
          {
            "method_name": "string",
            "royalty_amount": {
              "amount": "string",
              "unit": "XRD"
            }
          }
        ]
      },
      "royalty_config_is_locked": true
    }
  ],
  "package_address": "string"
}

{
  "message": "string",
  "code": 0,
  "details": {
    "type": "string"
  },
  "trace_id": "string"
}

Get Package Codes Page

POST

https://xrd.nownodes.io/core/state/package/page/codes

Returns all the codes associated with a given package entity. The returned response is in a paginated format, ordered by first appearance on the ledger.

Body

application/json

defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.

at_ledger_stateLedgerStateSelector | null

Show child attributes

state_versioninteger<int64> | null[1, 100000000000000]

If provided, the latest ledger state lower than or equal to the given state version is returned.

timestampstring<date-time> | null

If provided, the latest ledger state lower than or equal to the given round timestamp is returned.

epochinteger<int64> | null[0, 10000000000]

If provided, the ledger state lower than or equal to the given epoch at round 0 is returned.

roundinteger<int64> | null[0, 10000000000]

If provided must be accompanied with epoch, the ledger state lower than or equal to the given epoch and round is returned.

cursorstring | null

This cursor allows forward pagination, by providing the cursor from the previous request.

limit_per_pageinteger | null

The page size requested.

package_addressAddressrequired

Bech32m-encoded human readable version of the address.

Response

200OK

Package Blueprints (paginated)

4XX

Client-originated request error

Authorization

api-keyAuthapiKey in header

Get Package Codes Page

curl -X POST 'https://xrd.nownodes.io/core/state/package/page/codes' \
  -H 'Content-Type: application/json' \
  -d '{
    "package_address": "<package-address>"
  }'

const response = await fetch('https://xrd.nownodes.io/core/state/package/page/codes', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "package_address": "<package-address>"
    }),
});

const data = await response.json();

import requests

payload = {
  "package_address": "<package-address>"
}

response = requests.post('https://xrd.nownodes.io/core/state/package/page/codes', json=payload)
data = response.json()

Request Body

{
  "package_address": "<package-address>"
}

{
  "ledger_state": {
    "network": "<network-name>",
    "state_version": 0,
    "proposer_round_timestamp": "string",
    "epoch": 0,
    "round": 0
  },
  "total_count": 0,
  "next_cursor": "string",
  "items": [
    {
      "vm_type": "Native",
      "code_hash_hex": "string",
      "code_hex": "string"
    }
  ],
  "package_address": "string"
}

{
  "message": "string",
  "code": 0,
  "details": {
    "type": "string"
  },
  "trace_id": "string"
}

Stream

To query the transaction or proof stream of the ledger.

Get Transactions Stream

POST

https://xrd.nownodes.io/core/stream/transactions

Returns transactions which have been committed to the ledger. Check detailed documentation for brief explanation

Body

application/json

defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.

at_ledger_stateLedgerStateSelector | null

Show child attributes

state_versioninteger<int64> | null[1, 100000000000000]

If provided, the latest ledger state lower than or equal to the given state version is returned.

timestampstring<date-time> | null

If provided, the latest ledger state lower than or equal to the given round timestamp is returned.

epochinteger<int64> | null[0, 10000000000]

If provided, the ledger state lower than or equal to the given epoch at round 0 is returned.

roundinteger<int64> | null[0, 10000000000]

If provided must be accompanied with epoch, the ledger state lower than or equal to the given epoch and round is returned.

defines lower boundary (inclusive) for queried data. i.e { "from_state_version" = {"epoch" = 10} }, will return data from epoch 10 till current max ledger tip.

from_ledger_stateLedgerStateSelector | null

Show child attributes

state_versioninteger<int64> | null[1, 100000000000000]

If provided, the latest ledger state lower than or equal to the given state version is returned.

timestampstring<date-time> | null

If provided, the latest ledger state lower than or equal to the given round timestamp is returned.

epochinteger<int64> | null[0, 10000000000]

If provided, the ledger state lower than or equal to the given epoch at round 0 is returned.

roundinteger<int64> | null[0, 10000000000]

If provided must be accompanied with epoch, the ledger state lower than or equal to the given epoch and round is returned.

cursorstring | null

This cursor allows forward pagination, by providing the cursor from the previous request.

limit_per_pageinteger | null

The page size requested.

kind_filterstringUserEpochChangeAll

Limit returned transactions by their kind. Defaults to user.

manifest_accounts_withdrawn_from_filterArray<Address>

manifest_accounts_deposited_into_filterArray<Address>

manifest_badges_presented_filterArray<Address>

manifest_resources_filterArray<Address>

affected_global_entities_filterArray<Address>

events_filterArray<StreamTransactionsRequestEventFilterItem>

Show child attributes

eventstringDepositWithdrawalrequired

emitter_addressAddress

Bech32m-encoded human readable version of the address.

resource_addressAddress

Bech32m-encoded human readable version of the address.

accounts_with_manifest_owner_method_callsArray<Address>

accounts_without_manifest_owner_method_callsArray<Address>

manifest_class_filterobject

Show child attributes

classManifestClassGeneralTransferPoolContributionPoolRedemptionValidatorStakeValidatorUnstakeValidatorClaimAccountDepositSettingsUpdaterequired

High-level manifest class type:

General: A general manifest that involves any amount of arbitrary components and packages where nothing more concrete can be said about the manifest and its nature.
Transfer: A manifest of a 1-to-1 transfer to a one-to-many transfer of resources.
PoolContribution: A manifest that contributed some amount of resources to a liquidity pool that can be a one-resource pool, two-resource pool, or a multi-resource pool.
PoolRedemption: A manifest that redeemed resources from a liquidity pool. Similar to contributions, this can be any of the three pool blueprints available in the pool package.
ValidatorStake: A manifest where XRD is staked to one or more validators.
ValidatorUnstake: A manifest where XRD is unstaked from one or more validators.
ValidatorClaim: A manifest where XRD is claimed from one or more validators.
AccountDepositSettingsUpdate: A manifest that updated the deposit settings of the account.

match_only_most_specificbooleanfalse

orderstringAscDesc

Configures the order of returned result set. Defaults to desc.

opt_insTransactionDetailsOptIns

Show child attributes

raw_hexbooleanfalse

if set to true, raw transaction hex is returned.

receipt_state_changesbooleanfalse

if set to true, state changes inside receipt object are returned.

receipt_fee_summarybooleanfalse

if set to true, fee summary inside receipt object is returned.

receipt_fee_sourcebooleanfalse

if set to true, fee source inside receipt object is returned.

receipt_fee_destinationbooleanfalse

if set to true, fee destination inside receipt object is returned.

receipt_costing_parametersbooleanfalse

if set to true, costing parameters inside receipt object is returned.

receipt_eventsbooleanfalse

if set to true, events inside receipt object is returned.

receipt_outputbooleantrue

(true by default) if set to true, transaction receipt output is returned.

affected_global_entitiesbooleanfalse

if set to true, all affected global entities by given transaction are returned.

manifest_instructionsbooleanfalse

if set to true, manifest instructions for user transactions are returned.

balance_changesbooleanfalse

if set to true, returns the fungible and non-fungible balance changes.

Warning! This opt-in might be missing for recently committed transactions, in that case a null value will be returned. Retry the request until non-null value is returned.

Response

200OK

Transactions (paginated)

4XX

Client-originated request error

Authorization

api-keyAuthapiKey in header

Get Transactions Stream

curl -X POST 'https://xrd.nownodes.io/core/stream/transactions' \
  -H 'Content-Type: application/json' \
  -d '{
    "limit_per_page": 5
  }'

const response = await fetch('https://xrd.nownodes.io/core/stream/transactions', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "limit_per_page": 5
    }),
});

const data = await response.json();

import requests

payload = {
  "limit_per_page": 5
}

response = requests.post('https://xrd.nownodes.io/core/stream/transactions', json=payload)
data = response.json()

Request Body

{
  "limit_per_page": 5
}

{
  "ledger_state": {
    "network": "<network-name>",
    "state_version": 0,
    "proposer_round_timestamp": "string",
    "epoch": 0,
    "round": 0
  },
  "total_count": 0,
  "next_cursor": "string",
  "items": [
    {
      "state_version": 0,
      "epoch": 0,
      "round": 0,
      "round_timestamp": "string",
      "transaction_status": "Unknown",
      "payload_hash": "string",
      "intent_hash": "string",
      "fee_paid": "string",
      "affected_global_entities": [
        "string"
      ],
      "confirmed_at": "2024-01-15T09:30:00Z",
      "error_message": "string",
      "raw_hex": "string",
      "receipt": {
        "status": "Unknown",
        "fee_summary": {},
        "costing_parameters": {},
        "fee_destination": {},
        "fee_source": {},
        "state_updates": {},
        "next_epoch": {},
        "output": {},
        "events": [
          {
            "name": "string",
            "emitter": {},
            "data": {
              "kind": "Bool",
              "type_name": "string",
              "field_name": "string"
            }
          }
        ],
        "error_message": "string"
      },
      "manifest_instructions": "string",
      "manifest_classes": [
        "General"
      ],
      "message": {},
      "balance_changes": {
        "fungible_fee_balance_changes": [
          {
            "type": "FeePayment",
            "entity_address": "string",
            "resource_address": "string",
            "balance_change": "string"
          }
        ],
        "fungible_balance_changes": [
          {
            "entity_address": "string",
            "resource_address": "string",
            "balance_change": "string"
          }
        ],
        "non_fungible_balance_changes": [
          {
            "entity_address": "string",
            "resource_address": "string",
            "added": [
              "string"
            ],
            "removed": [
              "string"
            ]
          }
        ]
      }
    }
  ]
}

{
  "message": "string",
  "code": 0,
  "details": {
    "type": "string"
  },
  "trace_id": "string"
}

Statistics

Calculate particular statistics based on current or historic ledger state.

Get Validators Uptime

POST

https://xrd.nownodes.io/core/statistics/validators/uptime

Returns validators uptime data for time range limited by from_state_version and at_state_version.

Body

application/json

For at_ledger_state and from_ledger_state you can use one of state_version, epoch, epoch and round, or timestamp, but then ongoing epoch will be selected and used for querying data. i.e for request with { "from_state_version" = { "state_version" = 100 }, "at_state_version" = { "state_version" = 300} } gateway api will check in which epoch transactions with state version 100 and 300 were and then use that as inclusive boundary for request.

defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.

at_ledger_stateLedgerStateSelector | null

Show child attributes

state_versioninteger<int64> | null[1, 100000000000000]

If provided, the latest ledger state lower than or equal to the given state version is returned.

timestampstring<date-time> | null

If provided, the latest ledger state lower than or equal to the given round timestamp is returned.

epochinteger<int64> | null[0, 10000000000]

If provided, the ledger state lower than or equal to the given epoch at round 0 is returned.

roundinteger<int64> | null[0, 10000000000]

If provided must be accompanied with epoch, the ledger state lower than or equal to the given epoch and round is returned.

defines lower boundary (inclusive) for queried data. i.e { "from_state_version" = {"epoch" = 10} }, will return data from epoch 10 till current max ledger tip.

from_ledger_stateLedgerStateSelector | null

Show child attributes

state_versioninteger<int64> | null[1, 100000000000000]

If provided, the latest ledger state lower than or equal to the given state version is returned.

timestampstring<date-time> | null

If provided, the latest ledger state lower than or equal to the given round timestamp is returned.

epochinteger<int64> | null[0, 10000000000]

If provided, the ledger state lower than or equal to the given epoch at round 0 is returned.

roundinteger<int64> | null[0, 10000000000]

If provided must be accompanied with epoch, the ledger state lower than or equal to the given epoch and round is returned.

validator_addressesArray<Address>

Response

200OK

Validators Uptime

4XX

Client-originated request error

Authorization

api-keyAuthapiKey in header

Get Validators Uptime

curl -X POST 'https://xrd.nownodes.io/core/statistics/validators/uptime' \
  -H 'Content-Type: application/json' \
  -d '{
    "at_ledger_state": {
      "state_version": 1,
      "timestamp": "2024-01-15T09:30:00Z",
      "epoch": 0,
      "round": 0
    },
    "from_ledger_state": {
      "state_version": 1,
      "timestamp": "2024-01-15T09:30:00Z",
      "epoch": 0,
      "round": 0
    },
    "validator_addresses": [
      "string"
    ]
  }'

const response = await fetch('https://xrd.nownodes.io/core/statistics/validators/uptime', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "at_ledger_state": {
        "state_version": 1,
        "timestamp": "2024-01-15T09:30:00Z",
        "epoch": 0,
        "round": 0
      },
      "from_ledger_state": {
        "state_version": 1,
        "timestamp": "2024-01-15T09:30:00Z",
        "epoch": 0,
        "round": 0
      },
      "validator_addresses": [
        "string"
      ]
    }),
});

const data = await response.json();

import requests

payload = {
  "at_ledger_state": {
    "state_version": 1,
    "timestamp": "2024-01-15T09:30:00Z",
    "epoch": 0,
    "round": 0
  },
  "from_ledger_state": {
    "state_version": 1,
    "timestamp": "2024-01-15T09:30:00Z",
    "epoch": 0,
    "round": 0
  },
  "validator_addresses": [
    "string"
  ]
}

response = requests.post('https://xrd.nownodes.io/core/statistics/validators/uptime', json=payload)
data = response.json()

Request Body

{
  "at_ledger_state": {
    "state_version": 1,
    "timestamp": "2024-01-15T09:30:00Z",
    "epoch": 0,
    "round": 0
  },
  "from_ledger_state": {
    "state_version": 1,
    "timestamp": "2024-01-15T09:30:00Z",
    "epoch": 0,
    "round": 0
  },
  "validator_addresses": [
    "string"
  ]
}

{
  "ledger_state": {
    "network": "<network-name>",
    "state_version": 0,
    "proposer_round_timestamp": "string",
    "epoch": 0,
    "round": 0
  },
  "validators": {
    "items": [
      {
        "address": "string",
        "proposals_made": 0,
        "proposals_missed": 0,
        "epochs_active_in": 0
      }
    ]
  }
}

{
  "message": "string",
  "code": 0,
  "details": {
    "type": "string"
  },
  "trace_id": "string"
}

Documentation

Authentication

Core

LTS

Body

Response

Authorization

Body

Response

Authorization

Body

Response

Authorization

Body

Response

Authorization

Body

Response

Authorization

Body

Response

Authorization

Body

Response

Authorization

Body

Response

Authorization

Status

Response

Authorization

Body

Response

Authorization

Body

Response

Authorization

Transaction

Body

Response

Authorization

Body

Response

Authorization

Body

Response

Authorization

Body

Response

Authorization

Body

Response

Authorization

Body

Response

Authorization

Mempool

Body

Response

Authorization

Body

Response

Authorization

State

Body

Response

Authorization

Body

Response

Authorization

Body

Response

Authorization

Body

Response

Authorization

Body

Response

Authorization

Body