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

outputId stringrequired
Identifier of the output encoded in hex. An output is identified by the concatenation of transactionId+outputIndex. Hex-encoded with 0x prefix.
Example: 0xfa0de75d225cca2799395e5fc340702fc7eac821d2bdd79911126f131ae097a20100

Responses

200

Successful operation.

application/json

Schema

Schema

blockId stringrequired

The block identifier that references the output. Hex-encoded with 0x prefix.

transactionId stringrequired

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

outputIndex integerrequired

The index of the output.

isSpent booleanrequired

Tells if the output is spent or not.

milestoneIndexSpent integer

The milestone index at which this output was spent.

milestoneTimestampSpent integer

The milestone timestamp this output was spent.

transactionIdSpent string

The transaction this output was spent with. Hex-encoded with 0x prefix.

milestoneIndexBooked integerrequired

The milestone index at which the output was booked.

milestoneTimestampBooked integerrequired

The milestone unix timestamp at which the output was booked.

ledgerIndex integerrequired

The current ledger index for which the request was made.

Example (from schema)

{
  "blockId": "string",
  "transactionId": "string",
  "outputIndex": 0,
  "isSpent": true,
  "milestoneIndexSpent": 0,
  "milestoneTimestampSpent": 0,
  "transactionIdSpent": "string",
  "milestoneIndexBooked": 0,
  "milestoneTimestampBooked": 0,
  "ledgerIndex": 0
}

unspent

{
  "blockId": "0x9cd745ef6800c8e8c80b09174ee4b250b3c43dfa62d7c6a4e61f848febf731a0",
  "transactionId": "0x1ee46e19f4219ee65afc10227d0ca22753f76ef32d1e922e5cbe3fbc9b5a5298",
  "outputIndex": 1,
  "isSpent": false,
  "milestoneIndexBooked": 1234567,
  "milestoneTimestampBooked": 1643207146,
  "ledgerIndex": 946704
}

spent

{
  "blockId": "0x9cd745ef6800c8e8c80b09174ee4b250b3c43dfa62d7c6a4e61f848febf731a0",
  "transactionId": "0xfa0de75d225cca2799395e5fc340702fc7eac821d2bdd79911126f131ae097a2",
  "outputIndex": 1,
  "isSpent": true,
  "milestoneIndexSpent": 1234570,
  "milestoneTimestampSpent": 1643207176,
  "transactionIdSpent": "0xaf7579fb57746219561072c2cc0e4d0fbb8d493d075bd21bf25ae81a450c11ef",
  "milestoneIndexBooked": 1234567,
  "milestoneTimestampBooked": 1643207146,
  "ledgerIndex": 946704
}

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"
  }
}

Loading...