Returns metadata about an output by its identifier.
GET/api/core/v2/outputs/:outputId/metadata
Returns metadata about an output by its identifier.
Request
Path Parameters
Identifier of the output encoded in hex. An output is identified by the concatenation of transactionId+outputIndex
. Hex-encoded with 0x prefix.
Responses
- 200
- 400
- 403
- 404
- 500
Successful operation.
- application/json
- Schema
- Example (from schema)
- unspent
- spent
Schema
The block identifier that references the output. Hex-encoded with 0x prefix.
The identifier of the transaction. Hex-encoded with 0x prefix.
The index of the output.
Tells if the output is spent or not.
The milestone index at which this output was spent.
The milestone timestamp this output was spent.
The transaction this output was spent with. Hex-encoded with 0x prefix.
The milestone index at which the output was booked.
The milestone unix timestamp at which the output was booked.
The current ledger index for which the request was made.
{
"blockId": "string",
"transactionId": "string",
"outputIndex": 0,
"isSpent": true,
"milestoneIndexSpent": 0,
"milestoneTimestampSpent": 0,
"transactionIdSpent": "string",
"milestoneIndexBooked": 0,
"milestoneTimestampBooked": 0,
"ledgerIndex": 0
}
{
"blockId": "0x9cd745ef6800c8e8c80b09174ee4b250b3c43dfa62d7c6a4e61f848febf731a0",
"transactionId": "0x1ee46e19f4219ee65afc10227d0ca22753f76ef32d1e922e5cbe3fbc9b5a5298",
"outputIndex": 1,
"isSpent": false,
"milestoneIndexBooked": 1234567,
"milestoneTimestampBooked": 1643207146,
"ledgerIndex": 946704
}
{
"blockId": "0x9cd745ef6800c8e8c80b09174ee4b250b3c43dfa62d7c6a4e61f848febf731a0",
"transactionId": "0xfa0de75d225cca2799395e5fc340702fc7eac821d2bdd79911126f131ae097a2",
"outputIndex": 1,
"isSpent": true,
"milestoneIndexSpent": 1234570,
"milestoneTimestampSpent": 1643207176,
"transactionIdSpent": "0xaf7579fb57746219561072c2cc0e4d0fbb8d493d075bd21bf25ae81a450c11ef",
"milestoneIndexBooked": 1234567,
"milestoneTimestampBooked": 1643207146,
"ledgerIndex": 946704
}
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"
}
}