Find an output by its identifier.
GET/api/core/v2/outputs/:outputId
Find 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
- application/vnd.iota.serializer-v1
- Schema
- Example (from schema)
- unspent
- spent
Schema
- BasicOutput
- AliasOutput
- FoundryOutput
- NFTOutput
- Array [
- NativeToken
- ]
- Array [
- AddressUnlockCondition
- StorageDepositReturnUnlockCondition
- TimelockUnlockCondition
- ExpirationUnlockCondition
- Ed25519Address
- AliasAddress
- NFTAddress
- Ed25519Address
- AliasAddress
- NFTAddress
- Ed25519Address
- AliasAddress
- NFTAddress
- ]
- Array [
- SenderFeature
- MetadataFeature
- TagFeature
- Ed25519Address
- AliasAddress
- NFTAddress
- ]
- Array [
- NativeToken
- ]
- Array [
- StateControllerAddressUnlockCondition
- GovernorAddressUnlockCondition
- Ed25519Address
- AliasAddress
- NFTAddress
- Ed25519Address
- AliasAddress
- NFTAddress
- ]
- Array [
- SenderFeature
- MetadataFeature
- Ed25519Address
- AliasAddress
- NFTAddress
- ]
- Array [
- IssuerFeature
- MetadataFeature
- Ed25519Address
- AliasAddress
- NFTAddress
- ]
- Array [
- NativeToken
- ]
- Array [
- SimpleTokenScheme
- ]
- Array [
- ImmutableAliasAddressUnlockCondition
- AliasAddress
- ]
- Array [
- MetadataFeature
- ]
- Array [
- MetadataFeature
- ]
- Array [
- NativeToken
- ]
- Array [
- AddressUnlockCondition
- StorageDepositReturnUnlockCondition
- TimelockUnlockCondition
- ExpirationUnlockCondition
- Ed25519Address
- AliasAddress
- NFTAddress
- Ed25519Address
- AliasAddress
- NFTAddress
- Ed25519Address
- AliasAddress
- NFTAddress
- ]
- Array [
- SenderFeature
- IssuerFeature
- MetadataFeature
- TagFeature
- Ed25519Address
- AliasAddress
- NFTAddress
- Ed25519Address
- AliasAddress
- NFTAddress
- ]
- Array [
- IssuerFeature
- MetadataFeature
- Ed25519Address
- AliasAddress
- NFTAddress
- ]
metadata OutputMetadataResponse
Returns metadata about an output.
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.
output objectrequired
The actual output content.
Set to value 3 to denote a Basic Output.
The amount of IOTA tokens to deposit with this BasicOutput output. Plain string encoded number.
nativeTokens object[]
Native tokens held by the otuput.
Hex-encoded identifier with 0x prefix of the native token. Same as foundryId of the controlling foundry.
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.
Set to value 0 to denote an Address Unlock Condition.
address objectrequired
Set to value 0 to denote an Ed25519 Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Ed25519 public key
Set to value 8 to denote an Alias Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
Set to value 1 to denote an Dust Deposit Return Unlock Condition.
returnAddress objectrequired
Set to value 0 to denote an Ed25519 Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Ed25519 public key
Set to value 8 to denote an Alias Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
Amount of IOTA tokens the consuming transaction should deposit to the address defined in Return Address. Plain string encoded number.
Set to value 2 to denote an Timelock Unlock Condition.
Unix time (seconds since Unix epoch) starting from which the output can be consumed.
Set to value 3 to denote an Expiration Unlock Condition.
returnAddress objectrequired
Set to value 0 to denote an Ed25519 Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Ed25519 public key
Set to value 8 to denote an Alias Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
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.
Set to value 0 to denote a Sender Feature.
address objectrequired
Set to value 0 to denote an Ed25519 Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Ed25519 public key
Set to value 8 to denote an Alias Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
Set to value 2 to denote a Metadata Feature.
Hex-encoded binary data with 0x prefix.
Set to value 3 to denote a Tag Feature.
Hex-encoded binary indexation tag with 0x prefix.
Set to value 4 to denote an Alias Output.
The amount of IOTA tokens to deposit with this output. Plain string encoded number.
nativeTokens object[]
Native tokens held by the otuput.
Hex-encoded identifier with 0x prefix of the native token. Same as foundryId of the controlling foundry.
Amount of native tokens (up to uint256). Hex-encoded number with 0x prefix.
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.
A counter that must increase by 1 every time the alias is state transitioned.
Hex-encoded metadata with 0x prefix that can only be changed by the state controller.
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.
Set to value 4 to denote an Sate Controller Address Unlock Condition.
address objectrequired
Set to value 0 to denote an Ed25519 Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Ed25519 public key
Set to value 8 to denote an Alias Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
Set to value 5 to denote an Governor Address Unlock Condition.
address objectrequired
Set to value 0 to denote an Ed25519 Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Ed25519 public key
Set to value 8 to denote an Alias Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
Set to value 16 to denote an NFT Address.
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.
Set to value 0 to denote a Sender Feature.
address objectrequired
Set to value 0 to denote an Ed25519 Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Ed25519 public key
Set to value 8 to denote an Alias Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
Set to value 2 to denote a Metadata Feature.
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.
Set to value 1 to denote an Issuer Feature.
address objectrequired
Set to value 0 to denote an Ed25519 Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Ed25519 public key
Set to value 8 to denote an Alias Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
Set to value 2 to denote a Metadata Feature.
Hex-encoded binary data with 0x prefix.
Set to value5 to denote a Foundry Output.
The amount of IOTA tokens to deposit with this output. Plain string encoded number.
nativeTokens object[]
Native tokens held by the otuput.
Hex-encoded identifier with 0x prefix of the native token. Same as foundryId of the controlling foundry.
Amount of native tokens (up to uint256). Hex-encoded number with 0x prefix.
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.
Set to value 0 to denote an Simple Token Scheme.
Minted tokens controlled by this foundry. Hex-encoded number with 0x prefix.
Melted tokens controlled by this foundry. Hex-encoded number with 0x prefix.
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.
Set to value 6 to denote an Immutable Alias Address Unlock Condition.
address objectrequired
Set to value 8 to denote an Alias Address.
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.
Set to value 2 to denote a Metadata Feature.
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.
Set to value 2 to denote a Metadata Feature.
Hex-encoded binary data with 0x prefix.
Set to value 6 to denote a NFT Output.
The amount of IOTA tokens to deposit with this output. Plain string encoded number.
nativeTokens object[]
Native tokens held by the otuput.
Hex-encoded identifier with 0x prefix of the native token. Same as foundryId of the controlling foundry.
Amount of native tokens (up to uint256). Hex-encoded number with 0x prefix.
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.
Set to value 0 to denote an Address Unlock Condition.
address objectrequired
Set to value 0 to denote an Ed25519 Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Ed25519 public key
Set to value 8 to denote an Alias Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
Set to value 1 to denote an Dust Deposit Return Unlock Condition.
returnAddress objectrequired
Set to value 0 to denote an Ed25519 Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Ed25519 public key
Set to value 8 to denote an Alias Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
Amount of IOTA tokens the consuming transaction should deposit to the address defined in Return Address. Plain string encoded number.
Set to value 2 to denote an Timelock Unlock Condition.
Unix time (seconds since Unix epoch) starting from which the output can be consumed.
Set to value 3 to denote an Expiration Unlock Condition.
returnAddress objectrequired
Set to value 0 to denote an Ed25519 Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Ed25519 public key
Set to value 8 to denote an Alias Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
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.
Set to value 0 to denote a Sender Feature.
address objectrequired
Set to value 0 to denote an Ed25519 Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Ed25519 public key
Set to value 8 to denote an Alias Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
Set to value 1 to denote an Issuer Feature.
address objectrequired
Set to value 0 to denote an Ed25519 Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Ed25519 public key
Set to value 8 to denote an Alias Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
Set to value 2 to denote a Metadata Feature.
Hex-encoded binary data with 0x prefix.
Set to value 3 to denote a Tag Feature.
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.
Set to value 1 to denote an Issuer Feature.
address objectrequired
Set to value 0 to denote an Ed25519 Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Ed25519 public key
Set to value 8 to denote an Alias Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.
Set to value 2 to denote a Metadata Feature.
Hex-encoded binary data with 0x prefix.
{
"metadata": {
"blockId": "string",
"transactionId": "string",
"outputIndex": 0,
"isSpent": true,
"milestoneIndexSpent": 0,
"milestoneTimestampSpent": 0,
"transactionIdSpent": "string",
"milestoneIndexBooked": 0,
"milestoneTimestampBooked": 0,
"ledgerIndex": 0
}
}
{
"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"
}
}
]
}
}
{
"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"
}
}
]
}
}
- Schema
Schema
output in raw binary format
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"
}
}