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

200

Successful operation.

application/json

Schema

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
BasicOutput
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
NativeToken
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
AddressUnlockCondition
type integerrequired
Set to value 0 to denote an Address Unlock Condition.
address objectrequired
oneOf
Ed25519Address
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
AliasAddress
type integerrequired
Set to value 8 to denote an Alias Address.
aliasId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
StorageDepositReturnUnlockCondition
type integerrequired
Set to value 1 to denote an Dust Deposit Return Unlock Condition.
returnAddress objectrequired
oneOf
Ed25519Address
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
AliasAddress
type integerrequired
Set to value 8 to denote an Alias Address.
aliasId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
returnAmount stringrequired
Amount of IOTA tokens the consuming transaction should deposit to the address defined in Return Address. Plain string encoded number.
TimelockUnlockCondition
type integerrequired
Set to value 2 to denote an Timelock Unlock Condition.
unixTime integerrequired
Unix time (seconds since Unix epoch) starting from which the output can be consumed.
ExpirationUnlockCondition
type integerrequired
Set to value 3 to denote an Expiration Unlock Condition.
returnAddress objectrequired
oneOf
Ed25519Address
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
AliasAddress
type integerrequired
Set to value 8 to denote an Alias Address.
aliasId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
unixTime integerrequired
Before this unix time, Address Unlock Condition is allowed to unlock the output, after that only the address defined in Return Address.
]
features object[]
Features that add utility to the output but do not impose unlocking conditions.
Array [
anyOf
SenderFeature
type integerrequired
Set to value 0 to denote a Sender Feature.
address objectrequired
oneOf
Ed25519Address
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
AliasAddress
type integerrequired
Set to value 8 to denote an Alias Address.
aliasId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
MetadataFeature
type integerrequired
Set to value 2 to denote a Metadata Feature.
data stringrequired
Hex-encoded binary data with 0x prefix.
TagFeature
type integerrequired
Set to value 3 to denote a Tag Feature.
tag stringrequired
Hex-encoded binary indexation tag with 0x prefix.
]
AliasOutput
type integerrequired
Set to value 4 to denote an Alias Output.
amount stringrequired
The amount of IOTA tokens to deposit with this output. Plain string encoded number.
nativeTokens object[]
Native tokens held by the otuput.
Array [
anyOf
NativeToken
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.
]
aliasId stringrequired
Unique identifier of the alias, which is the BLAKE2b-256 hash of the Output ID that created it. Alias Address = Alias Address Type || Alias ID. Hex-encoded data with 0x prefix.
stateIndex integerrequired
A counter that must increase by 1 every time the alias is state transitioned.
stateMetadata string
Hex-encoded metadata with 0x prefix that can only be changed by the state controller.
foundryCounter integerrequired
A counter that denotes the number of foundries created by this alias account.
unlockConditions object[]required
Unlock condtions that define how the output an be unlocked in a transaction.
Array [
anyOf
StateControllerAddressUnlockCondition
type integerrequired
Set to value 4 to denote an Sate Controller Address Unlock Condition.
address objectrequired
oneOf
Ed25519Address
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
AliasAddress
type integerrequired
Set to value 8 to denote an Alias Address.
aliasId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
GovernorAddressUnlockCondition
type integerrequired
Set to value 5 to denote an Governor Address Unlock Condition.
address objectrequired
oneOf
Ed25519Address
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
AliasAddress
type integerrequired
Set to value 8 to denote an Alias Address.
aliasId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
]
features object[]
Features that add utility to the output but do not impose unlocking conditions.
Array [
anyOf
SenderFeature
type integerrequired
Set to value 0 to denote a Sender Feature.
address objectrequired
oneOf
Ed25519Address
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
AliasAddress
type integerrequired
Set to value 8 to denote an Alias Address.
aliasId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
MetadataFeature
type integerrequired
Set to value 2 to denote a Metadata Feature.
data stringrequired
Hex-encoded binary data with 0x prefix.
]
immutableFeatures object[]
Immutable features that add utility to the output but do not impose unlocking conditions. These features need to be kept in future transitions of the UTXO state machine.
Array [
anyOf
IssuerFeature
type integerrequired
Set to value 1 to denote an Issuer Feature.
address objectrequired
oneOf
Ed25519Address
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
AliasAddress
type integerrequired
Set to value 8 to denote an Alias Address.
aliasId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
MetadataFeature
type integerrequired
Set to value 2 to denote a Metadata Feature.
data stringrequired
Hex-encoded binary data with 0x prefix.
]
FoundryOutput
type integerrequired
Set to value5 to denote a Foundry Output.
amount stringrequired
The amount of IOTA tokens to deposit with this output. Plain string encoded number.
nativeTokens object[]
Native tokens held by the otuput.
Array [
anyOf
NativeToken
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.
]
serialNumber integerrequired
The serial number of the foundry with respect to the controlling alias.
tokenScheme object[]required
Defines the supply control scheme of the tokens controlled by the foundry.
Array [
oneOf
SimpleTokenScheme
type integerrequired
Set to value 0 to denote an Simple Token Scheme.
mintedTokens stringrequired
Minted tokens controlled by this foundry. Hex-encoded number with 0x prefix.
meltedTokens stringrequired
Melted tokens controlled by this foundry. Hex-encoded number with 0x prefix.
maxSupply stringrequired
Maximum supply of tokens controlled by this foundry. Hex-encoded number with 0x prefix.
]
unlockConditions object[]required
Unlock condtions that define how the output an be unlocked in a transaction.
Array [
anyOf
ImmutableAliasAddressUnlockCondition
type integerrequired
Set to value 6 to denote an Immutable Alias Address Unlock Condition.
address objectrequired
oneOf
AliasAddress
type integerrequired
Set to value 8 to denote an Alias Address.
aliasId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
]
features object[]
Features that add utility to the output but do not impose unlocking conditions.
Array [
anyOf
MetadataFeature
type integerrequired
Set to value 2 to denote a Metadata Feature.
data stringrequired
Hex-encoded binary data with 0x prefix.
]
immutableFeatures object[]
Immutable features that add utility to the output but do not impose unlocking conditions. These features need to be kept in future transitions of the UTXO state machine.
Array [
anyOf
MetadataFeature
type integerrequired
Set to value 2 to denote a Metadata Feature.
data stringrequired
Hex-encoded binary data with 0x prefix.
]
NFTOutput
type integerrequired
Set to value 6 to denote a NFT Output.
amount stringrequired
The amount of IOTA tokens to deposit with this output. Plain string encoded number.
nativeTokens object[]
Native tokens held by the otuput.
Array [
anyOf
NativeToken
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.
]
nftId stringrequired
Unique identifier of the NFT, which is the BLAKE2b-256 hash of the Output ID that created it. NFT Address = NFT Address Type || NFT ID. Hex-encoded data with 0x prefix.
unlockConditions object[]required
Unlock condtions that define how the output an be unlocked in a transaction.
Array [
anyOf
AddressUnlockCondition
type integerrequired
Set to value 0 to denote an Address Unlock Condition.
address objectrequired
oneOf
Ed25519Address
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
AliasAddress
type integerrequired
Set to value 8 to denote an Alias Address.
aliasId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
StorageDepositReturnUnlockCondition
type integerrequired
Set to value 1 to denote an Dust Deposit Return Unlock Condition.
returnAddress objectrequired
oneOf
Ed25519Address
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
AliasAddress
type integerrequired
Set to value 8 to denote an Alias Address.
aliasId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
returnAmount stringrequired
Amount of IOTA tokens the consuming transaction should deposit to the address defined in Return Address. Plain string encoded number.
TimelockUnlockCondition
type integerrequired
Set to value 2 to denote an Timelock Unlock Condition.
unixTime integerrequired
Unix time (seconds since Unix epoch) starting from which the output can be consumed.
ExpirationUnlockCondition
type integerrequired
Set to value 3 to denote an Expiration Unlock Condition.
returnAddress objectrequired
oneOf
Ed25519Address
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
AliasAddress
type integerrequired
Set to value 8 to denote an Alias Address.
aliasId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
unixTime integerrequired
Before this unix time, Address Unlock Condition is allowed to unlock the output, after that only the address defined in Return Address.
]
features object[]
Features that add utility to the output but do not impose unlocking conditions.
Array [
anyOf
SenderFeature
type integerrequired
Set to value 0 to denote a Sender Feature.
address objectrequired
oneOf
Ed25519Address
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
AliasAddress
type integerrequired
Set to value 8 to denote an Alias Address.
aliasId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
IssuerFeature
type integerrequired
Set to value 1 to denote an Issuer Feature.
address objectrequired
oneOf
Ed25519Address
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
AliasAddress
type integerrequired
Set to value 8 to denote an Alias Address.
aliasId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
MetadataFeature
type integerrequired
Set to value 2 to denote a Metadata Feature.
data stringrequired
Hex-encoded binary data with 0x prefix.
TagFeature
type integerrequired
Set to value 3 to denote a Tag Feature.
tag stringrequired
Hex-encoded binary indexation tag with 0x prefix.
]
immutableFeatures object[]
Immutable features that add utility to the output but do not impose unlocking conditions. These features need to be kept in future transitions of the UTXO state machine.
Array [
anyOf
IssuerFeature
type integerrequired
Set to value 1 to denote an Issuer Feature.
address objectrequired
oneOf
Ed25519Address
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
AliasAddress
type integerrequired
Set to value 8 to denote an Alias Address.
aliasId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
MetadataFeature
type integerrequired
Set to value 2 to denote a Metadata Feature.
data stringrequired
Hex-encoded binary data with 0x prefix.
]

Example (from schema)

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

unspent

{
  "metadata": {
    "blockId": "0x9cd745ef6800c8e8c80b09174ee4b250b3c43dfa62d7c6a4e61f848febf731a0",
    "transactionId": "0x1ee46e19f4219ee65afc10227d0ca22753f76ef32d1e922e5cbe3fbc9b5a5298",
    "outputIndex": 1,
    "isSpent": false,
    "milestoneIndexBooked": 946699,
    "milestoneTimestampBooked": 1643207130,
    "ledgerIndex": 946704
  },
  "output": {
    "type": 3,
    "amount": "1000",
    "unlockConditions": [
      {
        "type": 0,
        "address": {
          "type": 0,
          "pubKeyHash": "0x8eaf87ac1f52eb05f2c7c0c15502df990a228838dc37bd18de9503d69afd257d"
        }
      }
    ]
  }
}

spent

{
  "metadata": {
    "blockId": "0x9cd745ef6800c8e8c80b09174ee4b250b3c43dfa62d7c6a4e61f848febf731a0",
    "transactionId": "0xfa0de75d225cca2799395e5fc340702fc7eac821d2bdd79911126f131ae097a2",
    "outputIndex": 1,
    "isSpent": true,
    "milestoneIndexSpent": 946700,
    "milestoneTimestampSpent": 1643207176,
    "transactionIdSpent": "0xaf7579fb57746219561072c2cc0e4d0fbb8d493d075bd21bf25ae81a450c11ef",
    "milestoneIndexBooked": 946699,
    "milestoneTimestampBooked": 1643207130,
    "ledgerIndex": 946704
  },
  "output": {
    "type": 3,
    "amount": "1000",
    "unlockConditions": [
      {
        "type": 0,
        "address": {
          "type": 0,
          "pubKeyHash": "0x8eaf87ac1f52eb05f2c7c0c15502df990a228838dc37bd18de9503d69afd257d"
        }
      }
    ]
  }
}

application/vnd.iota.serializer-v1

Schema

Schema

• string binary

  output in raw binary format

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...