Component

Get Component Details

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.

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

Body

application/json

network*NetworkIdentifier (string)

The logical name of the network

Example: "{{network}}"

component_address*string

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

Response

200400404500

Current state response

Body

application/json

at_ledger_state*LedgerStateSummary (object)

info*Substate (object)

state*Substate (object)

royalty_accumulatorSubstate (object)

owner_role*Substate (object)

vaults*array of VaultBalance (object)

Any vaults owned directly or indirectly by the component

descendent_nodes*array of StateComponentDescendentNode (object)

Any descendent nodes owned directly or indirectly by the component

Request

JavaScriptCurlPython

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

Response

200400404500

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