Skip to main content

Returns metadata about an output and the output structure by its identifier.

GET 

/api/core/v3/outputs/:outputId/full

Returns the output structure and metadata 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 where outputIndex (u16) needs to be converted to little endian first. Hex-encoded with 0x prefix.

    Example: 0xfa0de75d225cca2799395e5fc340702fc7eac821d2bdd79911126f131ae097a20100

Responses

Successful operation.

Schema
    output objectrequired
    anyOf
    type integerrequired

    Set to value 0 to denote a Basic Output.

    amount stringrequired

    The amount of IOTA tokens to deposit with this BasicOutput output. Plain string encoded number.

    mana stringrequired

    The stored mana held by the output.

    unlockConditions object[]

    Unlock conditions that define how the output can be unlocked in a transaction.

  • Array [
  • anyOf
    type integerrequired

    Set to value 0 to denote an Address Unlock Condition.

    address objectrequired
    oneOf
    type integerrequired

    Set to value 0 to denote an Ed25519 Address.

    pubKeyHash stringrequired

    The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Ed25519 public key

  • ]
  • features object[]

    The features on the output

  • Array [
  • anyOf
    type integerrequired

    Set to value 0 to denote a Sender Feature.

    address objectrequired
    oneOf
    type integerrequired

    Set to value 0 to denote an Ed25519 Address.

    pubKeyHash stringrequired

    The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Ed25519 public key

  • ]
  • outputIdProof OutputIdProof

    The proof of the output identifier.

    slot integerrequired

    The slot index of the output.

    outputIndex integerrequired

    The index of the output within the corresponding transaction.

    transactionCommitment stringrequired

    The commitment of the transaction that created the output. Hex-encoded with 0x prefix.

    outputCommitmentProof objectrequired

    The proof of the output commitment. Hex-encoded with 0x prefix.

    anyOf
    type integerrequired

    Set to value 0 to denote a Hashable Node.

    l object

    The left node. Hex-encoded with 0x prefix.

    anyOf
    type integerrequired

    Set to value 1 to denote a Leaf Hash.

    hash stringrequired

    The hash of a leaf in the tree. Hex-encoded with 0x prefix.

    r object

    The right node. Hex-encoded with 0x prefix.

    anyOf
    type integerrequired

    Set to value 1 to denote a Leaf Hash.

    hash stringrequired

    The hash of a leaf in the tree. Hex-encoded with 0x prefix.

    metadata OutputMetadataResponse

    Returns metadata about an output.

    outputId stringrequired

    The output identifier of requested output. Hex-encoded with 0x prefix.

    blockId stringrequired

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

    included required
    slot integerrequired

    The slot index in which the output is included.

    transactionId stringrequired

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

    commitmentId string

    The commitment ID at which the output was included into the ledger.

    spent
    slot integerrequired

    The slot index in which the output is spent.

    transactionId stringrequired

    The transaction ID that spent the output. Hex-encoded with 0x prefix.

    commitmentId string

    The commitment ID that includes the spending of the output.

    latestCommitmentId stringrequired

    The current latest commitment id for which the request was made.

Loading...