Skip to main content

Find the metadata of a given block.

GET 
/api/core/v2/blocks/:blockId/metadata

Find the metadata of a given block.

Request​

Path Parameters

    blockId stringrequired

    Identifier of the block.

    Example: 0xf532a53545103276b46876c473846d98648ee418468bce76df4868648dd73e5d

Responses​

Successful operation.

Schema
    blockId stringrequired

    The identifier of the block. Hex-encoded with 0x prefix.

    parents string[]required

    The identifiers of the blocks this block references. Hex-encoded with 0x prefix.

    isSolid booleanrequired

    Tells if the block could get solidified by the node or not.

    referencedByMilestoneIndex integer

    Tells which milestone references this block.

    milestoneIndex integer

    If set, this block can be considered as a valid milestone block. This field therefore describes the milestone index of the involved milestone. A block can be considered as a valid milestone block if the milestone payload is valid and if the referenced parents in the milestone payload do match the referenced parents in the block itself. Note it's possible to have different milestone blocks that all represent the same milestone.

    ledgerInclusionState string

    Possible values: [included, conflicting, noTransaction]

    If included, the block contains a transaction that has been included in the ledger. If conflicitng, the block contains a transaction that has not been included in the ledger because it conflicts with another transaction. If the block does not contain a transaction, ledgerInclusionState is set to noTransaction.

    conflictReason integer

    Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 255]

    Values:

    • 1 - denotes that the referenced UTXO was already spent.
    • 2 - denotes that the referenced UTXO was already spent while confirming this milestone.
    • 3 - denotes that the referenced UTXO cannot be found.
    • 4 - denotes that the sum of the inputs and output values does not match.
    • 5 - denotes that the unlock block signature is invalid.
    • 6 - denotes that the configured timelock is not yet expired.
    • 7 - denotes that the given native tokens are invalid.
    • 8 - denotes that the return amount in a transaction is not fulfilled by the output side.
    • 9 - denotes that the input unlock is invalid.
    • 10 - denotes that the inputs commitment is invalid.
    • 11 - denotes that an output contains a Sender with an ident (address) which is not unlocked.
    • 12 - denotes that the chain state transition is invalid.
    • 255 - denotes that the semantic validation failed.
    whiteFlagIndex integer

    If set, defines the order of the block in the white flag traversal during milestone solidification. Only referenced blocks have this information.

    shouldPromote boolean

    Tells if the block should be promoted to get more likely picked up by the Coordinator.

    shouldReattach boolean

    Tells if the block should be reattached.

Loading...