Skip to main content

Find an output by its identifier.

GET 

/api/core/v2/outputs/:outputId

Find 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

Successful operation.

Schema
    metadata OutputMetadataResponse

    Returns metadata about an output.

    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.

    output objectrequired

    The actual output content.

    anyOf
    type integerrequired

    Set to value 3 to denote a Basic Output.

    amount stringrequired

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

    nativeTokens object[]

    Native tokens held by the otuput.

  • Array [
  • anyOf
    id stringrequired

    Hex-encoded identifier with 0x prefix of the native token. Same as foundryId of the controlling foundry.

    amount stringrequired

    Amount of native tokens (up to uint256). Hex-encoded number with 0x prefix.

  • ]
  • unlockConditions object[]required

    Unlock condtions that define how the output an 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[]

    Features that add utility to the output but do not impose unlocking conditions.

  • 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

  • ]
Loading...