Radix Core API - Babylon (Bottlenose)
vv1.2.0https://xrd.nownodes.io/coreAuthentication
api-keyAuthapiKeyAPI Key: api-key in header
Core
LTS
For long term support/backward compatible endpoints aimed at integrators such as exchanges.
Get Construction Metadata
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns information necessary to build a transaction
Body
networkNetworkIdentifierrequiredThe logical name of the network
Response
All info needed to build a transaction
Server error
Submit Transaction
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Submits a notarized transaction to the network. Returns whether the transaction submission was already included in the node's mempool.
Body
networkNetworkIdentifierrequiredThe logical name of the network
notarized_transaction_hexstringrequiredA hex-encoded, compiled notarized transaction.
force_recalculatebooleanIf true, the transaction validity is freshly recalculated without using any caches (defaults false)
Response
Transaction Submit Response
Client error
Server error
Get Transaction Status
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
networkNetworkIdentifierrequiredThe logical name of the network
intent_hashIntentHashInputrequiredThe 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
Transaction status response
Client error
Server error
Get All Account Balances
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns balances for all resources associated with an account
Body
networkNetworkIdentifierrequiredThe logical name of the network
account_addressstringrequiredThe Bech32m-encoded human readable version of the account's address
Response
Account all resource balances response
Server error
Get Single Account Balance
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns balance of a single fungible resource in an account
Body
networkNetworkIdentifierrequiredThe logical name of the network
account_addressstringrequiredThe Bech32m-encoded human readable version of the account's address
resource_addressResourceAddressrequiredThe Bech32m-encoded human readable version of the resource address
Response
Account resource balance response
Server error
Get Account Deposit Behaviour
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns deposit behaviour of a single account for multiple resource addresses
Body
networkNetworkIdentifierrequiredThe logical name of the network
account_addressstringrequiredThe Bech32m-encoded human readable version of the account's address.
resource_addressesArray<ResourceAddress>The resource addresses to check the deposit behaviours of.
badgePresentedBadgeThe depositor badge to check against the account's set of authorized depositors.
Response
Account deposit behaviour response
Server error
Get Transaction Outcomes
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns a list of committed transaction outcomes (containing balance changes) from a given state version.
Body
A request to retrieve a sublist of committed transactions from the ledger.
networkNetworkIdentifierrequiredThe logical name of the network
from_state_versionStateVersion<int64>[1, 100000000000000]requiredThe first (resultant) state version to be returned
limitintegerrequiredThe maximum number of transactions that will be returned.
Response
Paged response
Client error
Server error
Get Account Transaction Outcomes
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
A request to retrieve a sublist of committed transactions from the ledger.
networkNetworkIdentifierrequiredThe logical name of the network
account_addressstringrequiredThe Bech32m-encoded human readable version of the account's address
from_state_versionStateVersion<int64>[1, 100000000000000]requiredThe first (resultant) state version to be returned
limitintegerrequiredThe maximum number of transactions that will be returned.
Response
Paged response
Client error
Server error
Status
For status and configuration details for the node / engine.
Get Network Configuration
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns the network configuration of the network the node is connected to.
Response
Network Configuration
Server error
Get Network Status
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns the current state and status of the node's copy of the ledger.
Body
networkNetworkIdentifierrequiredThe logical name of the network
Response
Network Status
Server error
Get Scenarios' results.
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
networkNetworkIdentifierrequiredThe logical name of the network
Response
Scenarios' results
Server error
Transaction
For transaction construction, preview, submission, and monitoring the status of an individual transaction.
Parse Transaction Payload
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Extracts the contents and hashes of various types of transaction payloads, or sub-payloads.
Body
networkNetworkIdentifierrequiredThe logical name of the network
payload_hexstringrequiredA 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_modestringAnyNotarizedSignedUnsignedLedgerThe 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_modestringNoneStaticFullThe 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_modestringBasicFullThe 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_optionsTransactionFormatOptionsRequested transaction formats to include in the response
Response
Transaction Parse Response
Client error
Server error
Transaction Submit
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Submits a notarized transaction to the network. Returns whether the transaction submission was already included in the node's mempool.
Body
networkNetworkIdentifierrequiredThe logical name of the network
notarized_transaction_hexstringrequiredA hex-encoded, compiled notarized transaction.
force_recalculatebooleanIf true, the transaction validity is freshly recalculated without using any caches (defaults false)
Response
Transaction Submit Response
Client error
Server error
Get Transaction Status
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
networkNetworkIdentifierrequiredThe logical name of the network
intent_hashIntentHashInputrequiredThe 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
Transaction status response
Client error
Server error
Get Transaction Receipt
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Gets the transaction receipt for a committed transaction.
Body
networkNetworkIdentifierrequiredThe logical name of the network
intent_hashIntentHashInputrequiredThe 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.
transaction_format_optionsTransactionFormatOptionsRequested transaction formats to include in the response
Response
Committed transaction found response
Client error
Committed transaction not found response
Server error
Scrypto Call Preview
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Preview a scrypto function or method call against the latest network state. Returns the result of the scrypto function or method call.
Body
networkNetworkIdentifierrequiredThe logical name of the network
at_ledger_stateLedgerStateSelectorAn 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).
targetTargetIdentifierrequiredargumentsArray<string>requiredArgument list
Response
Result of the scrypto function call
Client error
Server error
Transaction Preview
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Preview a transaction against the latest network state, and returns the preview receipt.
Body
networkNetworkIdentifierrequiredThe logical name of the network
at_ledger_stateLedgerStateSelectorAn 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).
manifeststringrequiredA text-representation of a transaction manifest
blobs_hexArray<string>An array of hex-encoded blob data (optional)
start_epoch_inclusiveinteger<int64>[0, 10000000000]requiredAn integer between 0 and 10^10, marking the epoch at which the transaction starts being valid
end_epoch_exclusiveinteger<int64>[0, 10000000000]requiredAn integer between 0 and 10^10, marking the epoch at which the transaction is no longer valid
notary_public_keyPublicKeyThe notary public key to use (optional)
notary_is_signatorybooleanWhether the notary should count as a signatory (optional, default false)
tip_percentageinteger<int32>[0, 65535]requiredAn 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]requiredAn 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>requiredA list of public keys to be used as transaction signers
messageTransactionMessageAn optional transaction message. Only affects the costing.
flagsobjectrequiredResponse
Transaction preview response
Client error
Server error
Mempool
For information on the contents of the node's mempool.
Get Mempool List
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns the hashes of all the transactions currently in the mempool
Body
networkNetworkIdentifierrequiredThe logical name of the network
Response
Mempool List Response
Server error
Get Mempool Transaction
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns the payload of a transaction currently in the mempool
Body
networkNetworkIdentifierrequiredThe logical name of the network
payload_hashesArray<NotarizedTransactionHashInput>requiredA list of payload hashes to attempt to read. Each hash must be either hex, or in Bech32m format.
Response
Mempool Transaction Response
Not found error
Server error
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
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Reads the consensus manager's substate/s from the top of the current ledger.
Body
networkNetworkIdentifierrequiredThe logical name of the network
include_readiness_signalsbooleanWhether to include protocol update readiness signals of active validator set (default false).
Response
Current state response
Client error
Server error
Get Account Details
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Reads the account's substate/s from the top of the current ledger. Also returns all vaults under the account.
Body
networkNetworkIdentifierrequiredThe logical name of the network
account_addressstringrequiredThe Bech32m-encoded human readable version of the account's global address
Response
Current state response
Client error
Not found error
Server error
Get Component Details
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
networkNetworkIdentifierrequiredThe logical name of the network
component_addressstringrequiredThe Bech32m-encoded human readable version of the component's global address
Response
Current state response
Client error
Not found error
Server error
Get Validator Details
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Reads the validator's substate/s from the top of the current ledger.
Body
networkNetworkIdentifierrequiredThe logical name of the network
validator_addressComponentAddressrequiredThe Bech32m-encoded human readable version of the component address
Response
Current state response
Client error
Not found error
Server error
Get Access Controller Details
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Reads the access controller's substate/s from the top of the current ledger.
Body
networkNetworkIdentifierrequiredThe logical name of the network
controller_addressComponentAddressrequiredThe Bech32m-encoded human readable version of the component address
Response
Current state response
Client error
Not found error
Server error
Get Resource Details
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Reads the resource manager's substate/s from the top of the current ledger.
Body
networkNetworkIdentifierrequiredThe logical name of the network
resource_addressstringrequiredThe Bech32m-encoded human readable version of the resource's global address
Response
Current state response
Client error
Not found error
Server error
Get Non-Fungible Details
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Reads the data associated with a single Non-Fungible Unit under a Non-Fungible Resource.
Body
networkNetworkIdentifierrequiredThe logical name of the network
resource_addressstringrequiredThe Bech32m-encoded human readable version of the resource's global address
non_fungible_idNonFungibleLocalIdSimpleRepresentationrequiredThe 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 fixedNonFungibleIdType, so this representation uniquely identifies this non-fungible under the given resource address.
Response
Current state response
Client error
Not found error
Server error
Get Package Details
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Reads the package's substate/s from the top of the current ledger.
Body
networkNetworkIdentifierrequiredThe logical name of the network
package_addressstringrequiredThe Bech32m-encoded human readable version of the package's global address
Response
Current state response
Client error
Not found error
Server error
Stream
To query the transaction or proof stream of the ledger.
Stream Proofs
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
A request to retrieve a sublist of proofs.
networkNetworkIdentifierrequiredThe logical name of the network
filterStreamProofsFilterIf not provided, defaults to "Any".
max_page_sizeintegerIf specified, the maximum number of proofs that will be returned.
continuation_tokenContinuationTokenA 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
Stream proofs response
Client error
Server error
Get Committed Transactions
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns the list of committed transactions.
Body
A request to retrieve a sublist of committed transactions from the ledger.
networkNetworkIdentifierrequiredThe logical name of the network
from_state_versionStateVersion<int64>[1, 100000000000000]requiredThe first (resultant) state version to be returned
limitintegerrequiredThe maximum number of transactions that will be returned.
sbor_format_optionsSborFormatOptionsRequested SBOR formats to include in the response
transaction_format_optionsTransactionFormatOptionsRequested transaction formats to include in the response
substate_format_optionsSubstateFormatOptionsRequested substate formats to include in the response
include_proofsbooleanWhether to include LedgerProofs (default false)
Response
Committed transactions response
Client error
Server error