GuidesAPI Reference
DocumentationLog In

Identifiers

Network Identifier

Schema

The network_identifier specifies which network a particular object is associated with.

{
    "blockchain": "bitcoin",
    "network": "mainnet",
    "sub_network_identifier": {
        "network": "shard 1",
        "metadata": {
            "producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
        }
    }
}

Sub-Network Identifier

Schema

In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.

{
    "network": "shard 1",
    "metadata": {
        "producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
    }
}

Block Identifier

Schema

The block_identifier uniquely identifies a block in a particular network.

{
    "index": 1123941,
    "hash": "0x1f2cc6c5027d2f201a5453ad1119574d2aed23a392654742ac3c78783c071f85"
}

Transaction Identifier

Schema

The transaction_identifier uniquely identifies a transaction in a particular network and block or in the mempool.

{
    "hash": "0x2f23fd8cca835af21f3ac375bac601f97ead75f2e79143bdf71fe2c4be043e8f"
}

Operation Identifier

Schema

The operation_identifier uniquely identifies an operation within a transaction.

{
    "index": 5,
    "network_index": 0
}

Account Identifier

Schema

The account_identifier uniquely identifies an account within a network. All fields in the account_identifier are utilized to determine this uniqueness (including the metadata field, if populated).

{
    "address": "0x3a065000ab4183c6bf581dc1e55a605455fc6d61",
    "sub_account": {
        "address": "0x6b175474e89094c44da98b954eedeac495271d0f",
        "metadata": {}
    },
    "metadata": {}
}

Sub-Account Identifier

Schema

An account may have state specific to a contract address (ERC-20 token) and/or a stake (delegated balance). The sub_account_identifier should specify which state (if applicable) an account instantiation refers to.

{
    "address": "0x6b175474e89094c44da98b954eedeac495271d0f",
    "metadata": {}
}