Details

Get Entity Details

post

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

Body

all ofOptionalExample: {"addresses":["<entity-address>"],"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"]}}

Responses

200

Entity Details

application/json

Responseall of

4XX

Client-originated request error

application/json

post

HTTPcURLJavaScriptPython

POST /state/entity/details HTTP/1.1
Host: xrd-gateway.nownodes.io
Content-Type: application/json
Accept: */*
Content-Length: 343

{
  "addresses": [
    "<entity-address>"
  ],
  "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"
    ]
  }
}

{
  "ledger_state": {
    "network": "<network-name>",
    "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"
      }
    }
  ]
}