Find the metadata of a given block.

GET 
http://127.0.0.1:14265/api/core/v3/blocks/:blockId/metadata

Find the metadata of a given block.

Request

Path Parameters

blockId stringrequired
Identifier of the block.
Example: 0x2de585533d9c9684747e49f70e5e620a4e6c3fd1c7d8b73520c198c7def29a050200000000000000

Responses

200

Successful operation.

application/json

Schema

Schema

blockId stringrequired

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

blockState stringrequired

Possible values: [pending, confirmed, finalized, rejected, failed]

If pending, the block is stored but not confirmed. If confirmed, the block is confirmed with the first level of knowledge. If finalized, the block is included and cannot be reverted anymore. If rejected, the block is rejected by the node, and user should reissue payload if it contains one. If failed, the block is not successfully issued due to failure reason.

blockFailureReason integer
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 255]
Values:
• 1 - denotes that the block is too old to issue.
• 2 - denotes that the block's parents are too old.
• 3 - denotes that one of block's parents does not exist.
• 4 - denotes that one of block's parents is invalid.
• 5 - denotes that the issuer account could not be found.
• 6 - denotes that the block version is invalid to retrieve the corresponding protocol information.
• 7 - denotes that the Mana cost could not be calculated.
• 8 - denotes that the issuer account burned insufficient Mana for the block.
• 9 - denotes that the account is invalid, e.g. the account has negative Block Issuance Credits, or the account has expired.
• 10 - denotes that the signature is invalid.
• 11 - denotes that the block is dropped due to congestion.
• 12 - denotes that the payload is invalid.
• 255 - denotes that the block is invalid.
transactionMetadata TransactionMetadataResponse
The metadata of the transactions in the block.
transactionId stringrequired
The identifier of the transaction. Hex-encoded with 0x prefix.
transactionState stringrequired
Possible values: [pending, accepted, confirmed, finalized, failed]
If 'pending', the transaction is not included yet. If 'accepted', the transaction is included. If 'confirmed' means transaction is included and its included block is confirmed. If 'finalized' means transaction is included, its included block is finalized and cannot be reverted anymore. If 'failed' means transaction is issued but failed due to the transaction failure reason.
transactionFailureReason integer
Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 255]
Values:
• 1 - denotes that the referenced UTXO was already spent.
• 2 - denotes that the transaction is conflicting with another transaction. Conflicting specifically means a double spend situation that both transaction pass all validation rules, eventually losing one(s) should have this reason.
• 3 - denotes that the referenced UTXO is invalid.
• 4 - denotes that the transaction is invalid.
• 5 - denotes that the sum of the inputs and output base token amount does not match.
• 6 - denotes that the unlock block signature is invalid.
• 7 - denotes that the configured timelock is not yet expired.
• 8 - denotes that the given native tokens are invalid.
• 9 - denotes that the return amount in a transaction is not fulfilled by the output side.
• 10 - denotes that the input unlock 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.
• 13 - denotes that the referenced input is created after transaction issuing time.
• 14 - denotes that the mana amount is invalid.
• 15 - denotes that the Block Issuance Credits Input is invalid.
• 16 - denotes that Reward Context Input is invalid.
• 17 - denotes that Commitment Context Input is invalid.
• 18 - denotes that Staking Feature is not provided in account output when claiming rewards.
• 19 - denotes that fail to claim staking reward.
• 20 - denotes that fail to claim delegation reward.
• 21 - denotes that the burning of native tokens was not allowed in the transaction capabilities.
• 22 - denotes that the burning of mana was not allowed in the transaction capabilities.
• 23 - denotes that the destruction of accounts was not allowed in the transaction capabilities.
• 24 - denotes that the destruction of anchors was not allowed in the transaction capabilities.
• 25 - denotes that the destruction of foundries was not allowed in the transaction capabilities.
• 26 - denotes that the destruction of nfts was not allowed in the transaction capabilities.
• 255 - denotes that the semantic validation failed.

Example (from schema)

{
  "blockId": "string",
  "blockState": "pending",
  "blockFailureReason": 1,
  "transactionMetadata": {
    "transactionId": "string",
    "transactionState": "pending",
    "transactionFailureReason": 1
  }
}

New Block with Transaction Payload

{
  "blockId": "0x0482f0eba39a23c9a13072c93d828b55543132c47f5f57514d9e55535e9d4f4f35000000",
  "blockState": "pending",
  "transactionMetadata": {
    "transactionId": "0x72f0dfa9ad116ade8bdac8ef291ed2fb8065c6c75d5d3666e8b2053696c94a9e00001000",
    "transactionState": "pending"
  }
}

New Block without Transaction Payload

{
  "blockId": "0x0482f0eba39a23c9a13072c93d828b55543132c47f5f57514d9e55535e9d4f4f35000000",
  "blockState": "pending"
}

Confirmed with Transaction Payload

{
  "blockId": "0xf7ac0552041789a3931ae76eafa47df063632cddd3f8b11bd0bfffba1bc8c46800000000",
  "blockState": "confirmed",
  "transactionMetadata": {
    "transactionId": "0x72f0dfa9ad116ade8bdac8ef291ed2fb8065c6c75d5d3666e8b2053696c94a9e00001000",
    "transactionState": "confirmed"
  }
}

Confirmed without Transaction Payload

{
  "blockId": "0x3848a6d17070830206e5032fbce2ae3939e60eec0816546e074316b1f66977d04d010000",
  "blockState": "confirmed"
}

Conflicting with Transaction Payload

{
  "blockId": "0x3848a6d17070830206e5032fbce2ae3939e60eec0816546e074316b1f66977d04d010000",
  "blockState": "confirmed",
  "transactionMetadata": {
    "transactionId": "0x72f0dfa9ad116ade8bdac8ef291ed2fb8065c6c75d5d3666e8b2053696c94a9e00001000",
    "transactionState": "failed",
    "transactionFailureReason": 2
  }
}

400

Unsuccessful operation: indicates that the provided data is invalid.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 400,
    "message": "invalid data provided"
  }
}

403

Unsuccessful operation: indicates that the endpoint is not available for public use.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 403,
    "message": "not available for public use"
  }
}

404

Unsuccessful operation: indicates that the requested data was not found.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 404,
    "message": "could not find data"
  }
}

500

Unsuccessful operation: indicates that an unexpected, internal server error happened which prevented the node from fulfilling the request.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 500,
    "message": "internal server error"
  }
}

503

Unsuccessful operation: indicates that the node is not synced.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 503,
    "message": "service unavailable"
  }
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'http://127.0.0.1:14265/api/core/v3/blocks/:blockId/metadata' \
-H 'Accept: application/json'

Request Collapse all

Base URL

http://127.0.0.1:14265

Parameters

blockId — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!