Home

Radix Gateway API - Babylon

vv1.5.2
Base URL
https://xrd-gateway.nownodes.io

Authentication

api-keyAuthapiKey

API Key: api-key in header

Geteway

Status

Query information about the Gateway API status.

Get Gateway Status

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

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Returns the Gateway API version and current ledger state.

Response

200OK

Network Gateway Information

Get Network Configuration

POST
https://xrd-gateway.nownodes.io/status/network-configuration

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

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

Response

200OK

Network Configuration

Transaction

Query status of, construct, preview and submit transactions.

Get Construction Metadata

POST
https://xrd-gateway.nownodes.io/transaction/construction

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

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

Response

200OK

Returns information needed to construct transaction.

Preview Transaction

POST
https://xrd-gateway.nownodes.io/transaction/preview

Authorizations

ApiKeyAuthApiKeyAuth

api-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

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

Submit Transaction

POST
https://xrd-gateway.nownodes.io/transaction/submit

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

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

Get Committed Transaction Details

POST
https://xrd-gateway.nownodes.io/transaction/committed-details

Authorizations

ApiKeyAuthApiKeyAuth

api-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

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

Get Transaction Status

POST
https://xrd-gateway.nownodes.io/transaction/status

Authorizations

ApiKeyAuthApiKeyAuth

api-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

application/json
intent_hashHashBech32mStringrequired

Bech32m-encoded hash.

Response

200OK

Transaction Status

4XX

Client-originated request error

PreValidate deposit of resources to an account

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

Authorizations

ApiKeyAuthApiKeyAuth

api-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

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

Stream

Browse through the history of transactions.

Get Transactions Stream

POST
https://xrd-gateway.nownodes.io/stream/transactions

Authorizations

ApiKeyAuthApiKeyAuth

api-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

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.

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

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.

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

State

Query information snapshot about state of ledger entities at present or past time.

Get Entity Details

POST
https://xrd-gateway.nownodes.io/state/entity/details

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

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

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.

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

Get Entity Metadata Page

POST
https://xrd-gateway.nownodes.io/state/entity/page/metadata

Authorizations

ApiKeyAuthApiKeyAuth

api-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

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.

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

Get Entity Schema Page

POST
https://xrd-gateway.nownodes.io/state/entity/page/schemas

Authorizations

ApiKeyAuthApiKeyAuth

api-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

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.

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

Get page of Global Entity Fungible Resource Balances

POST
https://xrd-gateway.nownodes.io/state/entity/page/fungibles

Authorizations

ApiKeyAuthApiKeyAuth

api-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

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.

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

Get page of Global Entity Fungible Resource Vaults

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

Authorizations

ApiKeyAuthApiKeyAuth

api-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

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.

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

Get page of Global Entity Non-Fungible Resource Balances

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

Authorizations

ApiKeyAuthApiKeyAuth

api-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

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.

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

Get page of Global Entity Non-Fungible Resource Vaults

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

Authorizations

ApiKeyAuthApiKeyAuth

api-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

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.

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

Get page of Non-Fungibles in Vault

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

Authorizations

ApiKeyAuthApiKeyAuth

api-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

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.

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

Get page of Non-Fungible Ids in Resource Collection

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

Authorizations

ApiKeyAuthApiKeyAuth

api-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

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.

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

Get Non-Fungible Data

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

Authorizations

ApiKeyAuthApiKeyAuth

api-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

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.

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

Get Non-Fungible Location

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

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

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

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.

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

Get KeyValueStore Keys

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

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

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

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.

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

Get KeyValueStore Data

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

Authorizations

ApiKeyAuthApiKeyAuth

api-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

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.

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

Get Validators List

POST
https://xrd-gateway.nownodes.io/state/validators/list

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

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.

cursorstring | null

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

Response

200OK

Validators List

4XX

Client-originated request error

Get Account resource preferences

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

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

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

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.

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

Get Account authorized depositors

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

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

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

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.

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

Get Package Blueprints Page

POST
https://xrd-gateway.nownodes.io/state/package/page/blueprints

Authorizations

ApiKeyAuthApiKeyAuth

api-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

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.

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

Get Package Codes Page

POST
https://xrd-gateway.nownodes.io/state/package/page/codes

Authorizations

ApiKeyAuthApiKeyAuth

api-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

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.

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

Statistics

Calculate particular statistics based on current or historic ledger state.

Get Validators Uptime

POST
https://xrd-gateway.nownodes.io/statistics/validators/uptime

Authorizations

ApiKeyAuthApiKeyAuth

api-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

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

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.

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

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.

validator_addressesArray<Address>

Response

200OK

Validators Uptime

4XX

Client-originated request error