Radix Gateway API - Babylon
vv1.5.2https://xrd-gateway.nownodes.ioAuthentication
api-keyAuthapiKeyAPI Key: api-key in header
Geteway
Status
Query information about the Gateway API status.
Get Gateway Status
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns the Gateway API version and current ledger state.
Response
Network Gateway Information
Get Network Configuration
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns network identifier, network name and well-known network addresses.
Response
Network Configuration
Transaction
Query status of, construct, preview and submit transactions.
Get Construction Metadata
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns information needed to construct a new transaction including current epoch number.
Response
Returns information needed to construct transaction.
Preview Transaction
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
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>>= 0requiredA decimal-string-encoded integer between 0 and 2^32 - 1, used to ensure the transaction intent is unique.
signer_public_keysArray<PublicKey>requiredA list of public keys to be used as transaction signers
flagsobjectrequiredResponse
Successful Preview
Client-originated request error
Submit Transaction
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Submits a signed transaction payload to the network.
Body
notarized_transaction_hexNotarizedTransactionHexStringrequiredHex-encoded notarized transaction payload which can be submitted.
Response
Successful Submission
Client-originated request error
Get Committed Transaction Details
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.
at_ledger_stateLedgerStateSelector | nullOptional. 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.
intent_hashHashBech32mStringrequiredBech32m-encoded hash.
opt_insTransactionDetailsOptInsResponse
Transaction Status
Client-originated request error
Get Transaction Status
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns overall transaction status and all of its known payloads based on supplied intent hash.
Body
intent_hashHashBech32mStringrequiredBech32m-encoded hash.
Response
Transaction Status
Client-originated request error
PreValidate deposit of resources to an account
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
account_addressAddressrequiredBech32m-encoded human readable version of the address.
resource_addressesArray<Address>requiredbadgeTransactionAccountDepositPreValidationAuthorizedDepositorBadgeResponse
Pre-validation response, including all deciding factors that were used to generate that response.
Client-originated request error
Stream
Browse through the history of transactions.
Get Transactions Stream
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns transactions which have been committed to the ledger. Check detailed documentation for brief explanation
Body
defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.
at_ledger_stateLedgerStateSelector | nullOptional. 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.
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 | nullOptional. 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.
cursorstring | nullThis cursor allows forward pagination, by providing the cursor from the previous request.
limit_per_pageinteger | nullThe page size requested.
kind_filterstringUserEpochChangeAllLimit 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>accounts_with_manifest_owner_method_callsArray<Address>accounts_without_manifest_owner_method_callsArray<Address>manifest_class_filterobjectorderstringAscDescConfigures the order of returned result set. Defaults to desc.
opt_insTransactionDetailsOptInsResponse
Transactions (paginated)
Client-originated request error
State
Query information snapshot about state of ledger entities at present or past time.
Get Entity Details
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns detailed information for collection of entities. Aggregate resources globally by default.
Body
defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.
at_ledger_stateLedgerStateSelector | nullOptional. 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.
opt_insStateEntityDetailsOptInsCheck detailed OptIns documentation for more details
addressesArray<Address>requiredlimited to max 100 items.
aggregation_levelResourceAggregationLevelGlobalVaultResponse
Entity Details
Client-originated request error
Get Entity Metadata Page
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.
at_ledger_stateLedgerStateSelector | nullOptional. 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.
cursorstring | nullThis cursor allows forward pagination, by providing the cursor from the previous request.
limit_per_pageinteger | nullThe page size requested.
addressAddressrequiredBech32m-encoded human readable version of the address.
Response
Entity Metadata (paginated)
Client-originated request error
Get Entity Schema Page
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.
at_ledger_stateLedgerStateSelector | nullOptional. 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.
cursorstring | nullThis cursor allows forward pagination, by providing the cursor from the previous request.
limit_per_pageinteger | nullThe page size requested.
addressAddressrequiredBech32m-encoded human readable version of the address.
Response
Entity Schemas (paginated)
Client-originated request error
Get page of Global Entity Fungible Resource Balances
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.
at_ledger_stateLedgerStateSelector | nullOptional. 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.
cursorstring | nullThis cursor allows forward pagination, by providing the cursor from the previous request.
limit_per_pageinteger | nullThe page size requested.
addressAddressrequiredBech32m-encoded human readable version of the address.
aggregation_levelResourceAggregationLevelGlobalVaultopt_insStateEntityFungiblesPageRequestOptInsCheck detailed OptIns documentation for more details
Response
Entity Fungibles (paginated)
Client-originated request error
Get page of Global Entity Fungible Resource Vaults
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.
at_ledger_stateLedgerStateSelector | nullOptional. 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.
cursorstring | nullThis cursor allows forward pagination, by providing the cursor from the previous request.
limit_per_pageinteger | nullThe page size requested.
addressAddressrequiredBech32m-encoded human readable version of the address.
resource_addressAddressrequiredBech32m-encoded human readable version of the address.
Response
Entity Fungibles (paginated)
Client-originated request error
Get page of Global Entity Non-Fungible Resource Balances
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.
at_ledger_stateLedgerStateSelector | nullOptional. 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.
cursorstring | nullThis cursor allows forward pagination, by providing the cursor from the previous request.
limit_per_pageinteger | nullThe page size requested.
addressAddressrequiredBech32m-encoded human readable version of the address.
aggregation_levelResourceAggregationLevelGlobalVaultopt_insStateEntityNonFungiblesPageRequestOptInsCheck detailed OptIns documentation for more details
Response
Entity Non-Fungibles (paginated)
Client-originated request error
Get page of Global Entity Non-Fungible Resource Vaults
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.
at_ledger_stateLedgerStateSelector | nullOptional. 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.
cursorstring | nullThis cursor allows forward pagination, by providing the cursor from the previous request.
limit_per_pageinteger | nullThe page size requested.
addressAddressrequiredBech32m-encoded human readable version of the address.
resource_addressAddressrequiredBech32m-encoded human readable version of the address.
opt_insStateEntityNonFungibleResourceVaultsPageOptInsCheck detailed OptIns documentation for more details
Response
Entity Fungibles (paginated)
Client-originated request error
Get page of Non-Fungibles in Vault
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.
at_ledger_stateLedgerStateSelector | nullOptional. 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.
cursorstring | nullThis cursor allows forward pagination, by providing the cursor from the previous request.
limit_per_pageinteger | nullThe page size requested.
addressAddressrequiredBech32m-encoded human readable version of the address.
vault_addressAddressrequiredBech32m-encoded human readable version of the address.
resource_addressAddressrequiredBech32m-encoded human readable version of the address.
Response
Entity Non-Fungible IDs (paginated)
Client-originated request error
Get page of Non-Fungible Ids in Resource Collection
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.
at_ledger_stateLedgerStateSelector | nullOptional. 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.
cursorstring | nullThis cursor allows forward pagination, by providing the cursor from the previous request.
limit_per_pageinteger | nullThe page size requested.
resource_addressAddressrequiredBech32m-encoded human readable version of the address.
Response
Non-Fungible IDs (paginated)
Client-originated request error
Get Non-Fungible Data
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns data associated with a given non-fungible ID of a given non-fungible resource.
Body
defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.
at_ledger_stateLedgerStateSelector | nullOptional. 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.
resource_addressAddressrequiredBech32m-encoded human readable version of the address.
non_fungible_idsArray<NonFungibleId>requiredlimited to max 100 items.
Response
Non-Fungible ID Data
Client-originated request error
Get Non-Fungible Location
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns location of a given non-fungible ID.
Body
defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.
at_ledger_stateLedgerStateSelector | nullOptional. 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.
resource_addressAddressrequiredBech32m-encoded human readable version of the address.
non_fungible_idsArray<NonFungibleId>requiredlimited to max 100 items.
Response
Non-Fungible ID Location
Client-originated request error
Get KeyValueStore Keys
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Allows to iterate over key value store keys.
Body
defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.
at_ledger_stateLedgerStateSelector | nullOptional. 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.
cursorstring | nullThis cursor allows forward pagination, by providing the cursor from the previous request.
limit_per_pageinteger | nullThe page size requested.
key_value_store_addressAddressrequiredBech32m-encoded human readable version of the address.
Response
KeyValueStore keys collection
Client-originated request error
Get KeyValueStore Data
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns data (value) associated with a given key of a given key-value store. Check detailed documentation for explanation
Body
defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.
at_ledger_stateLedgerStateSelector | nullOptional. 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.
key_value_store_addressAddressrequiredBech32m-encoded human readable version of the address.
keysArray<StateKeyValueStoreDataRequestKeyItem>requiredlimited to max 100 items.
Response
Non-Fungible ID Data
Client-originated request error
Get Validators List
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Body
defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.
at_ledger_stateLedgerStateSelector | nullOptional. 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.
cursorstring | nullThis cursor allows forward pagination, by providing the cursor from the previous request.
Response
Validators List
Client-originated request error
Get Account resource preferences
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns paginable collection of resource preference rules for given account.
Body
defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.
at_ledger_stateLedgerStateSelector | nullOptional. 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.
cursorstring | nullThis cursor allows forward pagination, by providing the cursor from the previous request.
limit_per_pageinteger | nullThe page size requested.
account_addressAddressrequiredBech32m-encoded human readable version of the address.
Response
Account resource preferences page
Client-originated request error
Get Package Blueprints Page
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.
at_ledger_stateLedgerStateSelector | nullOptional. 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.
cursorstring | nullThis cursor allows forward pagination, by providing the cursor from the previous request.
limit_per_pageinteger | nullThe page size requested.
package_addressAddressrequiredBech32m-encoded human readable version of the address.
Response
Package Blueprints (paginated)
Client-originated request error
Get Package Codes Page
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
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
defines upper boundary (inclusive) for queried data. i.e { "at_state_version" = {"epoch" = 10} }, will return data till 10 epoch.
at_ledger_stateLedgerStateSelector | nullOptional. 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.
cursorstring | nullThis cursor allows forward pagination, by providing the cursor from the previous request.
limit_per_pageinteger | nullThe page size requested.
package_addressAddressrequiredBech32m-encoded human readable version of the address.
Response
Package Blueprints (paginated)
Client-originated request error
Statistics
Calculate particular statistics based on current or historic ledger state.
Get Validators Uptime
Authorizations
ApiKeyAuthApiKeyAuthapi-key string
NOWNodes API key passed in the api-key header.
Returns validators uptime data for time range limited by from_state_version and at_state_version.
Body
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 | nullOptional. 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.
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 | nullOptional. 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.
validator_addressesArray<Address>Response
Validators Uptime
Client-originated request error