Details

Get Entity Details

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

post

/state/entity/details

Header parameters

api-keystringrequired

Body

at_ledger_statenullable object

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.

opt_insobject

Check detailed OptIns documentation for more details

addressesstring[]required

limited to max 20 items.

aggregation_levelenum

Options: Global, Vault

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://xrd-gateway.nownodes.io/state/entity/details' \
  --header 'api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"addresses":["resource_rdx1tknxxxxxxxxxradxrdxxxxxxxxx009923554798xxxxxxxxxradxrd"],"aggregation_level":"Vault","opt_ins":{"ancestor_identities":true,"component_royalty_config":true,"component_royalty_vault_balance":true,"package_royalty_vault_balance":true,"non_fungible_include_nfids":true,"dapp_two_way_links":true,"native_resource_details":true,"explicit_metadata":["name","description"]}}'

200

4XX

200

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

Entity Details