Find the metadata of a given block.
GET/api/core/v2/blocks/:blockId/metadata
Find the metadata of a given block.
Request
Path Parameters
Identifier of the block.
Responses
- 200
- 400
- 403
- 404
- 500
- 503
Successful operation.
- application/json
- Schema
- Example (from schema)
- New Block
- Solid
- Included
- Conflicting
Schema
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.
The identifier of the block. Hex-encoded with 0x prefix.
The identifiers of the blocks this block references. Hex-encoded with 0x prefix.
Tells if the block could get solidified by the node or not.
Tells which milestone references this block.
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.
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
.
Possible values: [1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 10
, 11
, 12
, 255
]
Values:
If set, defines the order of the block in the white flag traversal during milestone solidification. Only referenced blocks have this information.
Tells if the block should be promoted to get more likely picked up by the Coordinator.
Tells if the block should be reattached.
{
"blockId": "string",
"parents": [
"string"
],
"isSolid": true,
"referencedByMilestoneIndex": 0,
"milestoneIndex": 0,
"ledgerInclusionState": "included",
"conflictReason": 1,
"whiteFlagIndex": 0,
"shouldPromote": true,
"shouldReattach": true
}
{
"blockId": "0xf532a53545103276b46876c473846d98648ee418468bce76df4868648dd73e5d",
"parents": [
"0x7ed3d67fc7b619e72e588f51fef2379e43e6e9a856635843b3f29aa3a3f1f006",
"0xd97e89e49ed263b763afeda192515fe154ec826ceb92ef08926cd68ec02c9510"
],
"isSolid": false,
"shouldPromote": true,
"shouldReattach": false
}
{
"blockId": "0xf532a53545103276b46876c473846d98648ee418468bce76df4868648dd73e5d",
"parents": [
"0x7ed3d67fc7b619e72e588f51fef2379e43e6e9a856635843b3f29aa3a3f1f006",
"0xd97e89e49ed263b763afeda192515fe154ec826ceb92ef08926cd68ec02c9510"
],
"isSolid": true,
"shouldPromote": false,
"shouldReattach": false
}
{
"blockId": "0xf532a53545103276b46876c473846d98648ee418468bce76df4868648dd73e5d",
"parents": [
"0x7ed3d67fc7b619e72e588f51fef2379e43e6e9a856635843b3f29aa3a3f1f006",
"0xd97e89e49ed263b763afeda192515fe154ec826ceb92ef08926cd68ec02c9510"
],
"isSolid": true,
"referencedByMilestoneIndex": 15465,
"whiteFlagIndex": 25,
"ledgerInclusionState": "included"
}
{
"blockId": "0xf532a53545103276b46876c473846d98648ee418468bce76df4868648dd73e5d",
"parents": [
"0x7ed3d67fc7b619e72e588f51fef2379e43e6e9a856635843b3f29aa3a3f1f006",
"0xd97e89e49ed263b763afeda192515fe154ec826ceb92ef08926cd68ec02c9510"
],
"isSolid": true,
"referencedByMilestoneIndex": 15465,
"whiteFlagIndex": 25,
"ledgerInclusionState": "conflicting",
"conflictReason": 1
}
Unsuccessful operation: indicates that the provided data is invalid.
- application/json
- Schema
- Example (from schema)
Schema
error objectrequired
The application error code.
The error reason.
{
"error": {
"code": 400,
"message": "invalid data provided"
}
}
Unsuccessful operation: indicates that the endpoint is not available for public use.
- application/json
- Schema
- Example (from schema)
Schema
error objectrequired
The application error code.
The error reason.
{
"error": {
"code": 403,
"message": "not available for public use"
}
}
Unsuccessful operation: indicates that the requested data was not found.
- application/json
- Schema
- Example (from schema)
Schema
error objectrequired
The application error code.
The error reason.
{
"error": {
"code": 404,
"message": "could not find data"
}
}
Unsuccessful operation: indicates that an unexpected, internal server error happened which prevented the node from fulfilling the request.
- application/json
- Schema
- Example (from schema)
Schema
error objectrequired
The application error code.
The error reason.
{
"error": {
"code": 500,
"message": "internal server error"
}
}
Unsuccessful operation: indicates that the node is not synced.
- application/json
- Schema
- Example (from schema)
Schema
error objectrequired
The application error code.
The error reason.
{
"error": {
"code": 503,
"message": "service unavailable"
}
}