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
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.
Responses
- 200
- 400
- 403
- 404
- 500
Successful operation.
- application/json
- Schema
- Example (from schema)
- spent
Schema
- BasicOutput
- AccountOutput
- AnchorOutput
- FoundryOutput
- NFTOutput
- DelegationOutput
- Array [
- AddressUnlockCondition
- StorageDepositReturnUnlockCondition
- TimelockUnlockCondition
- ExpirationUnlockCondition
- Ed25519Address
- AccountAddress
- NFTAddress
- Ed25519Address
- AccountAddress
- NFTAddress
- Ed25519Address
- AccountAddress
- NFTAddress
- ]
- Array [
- SenderFeature
- MetadataFeature
- TagFeature
- NativeTokenFeature
- Ed25519Address
- AccountAddress
- NFTAddress
- ]
- Array [
- AddressUnlockCondition
- Ed25519Address
- AccountAddress
- NFTAddress
- ]
- Array [
- SenderFeature
- MetadataFeature
- BlockIssuerFeature
- StakingFeature
- Ed25519Address
- AccountAddress
- NFTAddress
- Array [
- Ed25519PublicKey
- ]
- ]
- Array [
- IssuerFeature
- MetadataFeature
- Ed25519Address
- AccountAddress
- NFTAddress
- ]
- Array [
- StateControllerAddressUnlockCondition
- GovernorAddressUnlockCondition
- Ed25519Address
- AccountAddress
- NFTAddress
- Ed25519Address
- AccountAddress
- NFTAddress
- ]
- Array [
- MetadataFeature
- StateMetadataFeature
- ]
- Array [
- IssuerFeature
- MetadataFeature
- Ed25519Address
- AccountAddress
- NFTAddress
- ]
- Array [
- SimpleTokenScheme
- ]
- Array [
- ImmutableAccountAddressUnlockCondition
- AccountAddress
- ]
- Array [
- MetadataFeature
- NativeTokenFeature
- ]
- Array [
- MetadataFeature
- ]
- Array [
- AddressUnlockCondition
- StorageDepositReturnUnlockCondition
- TimelockUnlockCondition
- ExpirationUnlockCondition
- Ed25519Address
- AccountAddress
- NFTAddress
- Ed25519Address
- AccountAddress
- NFTAddress
- Ed25519Address
- AccountAddress
- NFTAddress
- ]
- Array [
- SenderFeature
- MetadataFeature
- TagFeature
- Ed25519Address
- AccountAddress
- NFTAddress
- ]
- Array [
- IssuerFeature
- MetadataFeature
- Ed25519Address
- AccountAddress
- NFTAddress
- ]
- Array [
- AddressUnlockCondition
- Ed25519Address
- AccountAddress
- NFTAddress
- ]
- HashableNode
- LeafHash
- ValueHash
- LeafHash
- ValueHash
- LeafHash
- ValueHash
output objectrequired
Set to value 0 to denote a Basic Output.
The amount of IOTA tokens to deposit with this BasicOutput output. Plain string encoded number.
The stored mana held by the output.
unlockConditions object[]
Unlock conditions that define how the output can 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 Account Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
Set to value 1 to denote a Storage 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 Account Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
Amount of IOTA tokens the consuming transaction must deposit to the address defined in Return Address. Plain string encoded number.
Set to value 2 to denote a Timelock Unlock Condition.
The slot index until which the timelock applies (inclusive).
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 Account Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
The slot index at which the expiration happens.
features object[]
The features on the output
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 Account Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
Set to value 2 to denote a Metadata Feature.
entries objectrequired
Set to value 4 to denote a Tag Feature.
Hex-encoded binary indexation tag with 0x prefix.
Set to value 5 to denote a Native Token Feature.
The ID of the native token.
The amount of native token. Hex-encoded number with 0x prefix.
Set to value 1 to denote an Account Output.
The amount of IOTA tokens to deposit with this output. Plain string encoded number.
The stored mana held by the output.
The identifier of the account.
A counter that denotes the number of foundries created by this account.
unlockConditions object[]
Unlock conditions that define how the output can 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 Account Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID 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 Account Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
Set to value 2 to denote a Metadata Feature.
entries objectrequired
Set to value 6 to denote a Block Issuer Feature.
blockIssuerKeys object[]required
The keys allowed to issue blocks from an account with a BlockIssuerFeature.
Set to value 0 to denote an Ed25519 Public key.
Ed25519 public key in Hex.
Indicates when the BlockIssuerKeys are expired.
Set to value 7 to denote a Staking Feature.
The amount of IOTA coins that are locked and staked in the containing account.
The fixed cost that the validator receives from the total pool reward.
The epoch index at which the staking starts.
The epoch index at which the staking ends.
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 Account Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
Set to value 2 to denote a Metadata Feature.
entries objectrequired
Set to value 2 to denote an Anchor Output.
The amount of IOTA tokens to deposit with this output. Plain string encoded number.
The stored mana held by the output.
The identifier of the anchor.
A counter that must increase by 1 every time the account is state transitioned.
unlockConditions object[]
Unlock conditions that define how the output can be unlocked in a transaction.
Set to value 4 to denote a State 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 Account Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
Set to value 5 to denote a 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 Account Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
features object[]
Features that add utility to the output but do not impose unlocking conditions.
Set to value 2 to denote a Metadata Feature.
entries objectrequired
Set to value 3 to denote a State Metadata Feature.
entries objectrequired
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 Account Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
Set to value 2 to denote a Metadata Feature.
entries objectrequired
Set to value 3 to denote a Foundry Output.
The amount of IOTA tokens to deposit with this output. Plain string encoded number.
The serial number of the foundry with respect to the controlling account.
tokenScheme object[]required
Defines the supply control scheme of the tokens controlled by the foundry.
Set to value 0 to denote a 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[]
Unlock conditions that define how the output can be unlocked in a transaction.
Set to value 6 to denote an Immutable Account Address Unlock Condition.
address objectrequired
Set to value 8 to denote an Account Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
features object[]
Features that add utility to the output but do not impose unlocking conditions.
Set to value 2 to denote a Metadata Feature.
entries objectrequired
Set to value 5 to denote a Native Token Feature.
The ID of the native token.
The amount of native token. Hex-encoded number 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.
entries objectrequired
Set to value 4 to denote a NFT Output.
The amount of IOTA tokens to deposit with this output. Plain string encoded number.
The stored mana held by the output
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[]
Unlock conditions that define how the output can 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 Account Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
Set to value 1 to denote a Storage 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 Account Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
Amount of IOTA tokens the consuming transaction must deposit to the address defined in Return Address. Plain string encoded number.
Set to value 2 to denote a Timelock Unlock Condition.
The slot index until which the timelock applies (inclusive).
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 Account Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
The slot index at which the expiration happens.
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 Account Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
Set to value 2 to denote a Metadata Feature.
entries objectrequired
Set to value 4 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 Account Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
Set to value 2 to denote a Metadata Feature.
entries objectrequired
Set to value 5 to denote a Delegation Output.
The amount of IOTA tokens held by the output. Encoded as a plain string.
The amount of IOTA tokens that were delegated when the output was created.
The identifier for this delegation output.
The Account Address of the validator to which this output is delegating.
The index of the first epoch for which this output delegates.
The index of the last epoch for which this output delegates.
unlockConditions object[]
Unlock conditions that define how the output can 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 Account Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
Set to value 16 to denote an NFT Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
outputIdProof OutputIdProof
The proof of the output identifier.
The slot index of the output.
The index of the output within the corresponding transaction.
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.
Set to value 0 to denote a Hashable Node.
l object
The left node. Hex-encoded with 0x prefix.
Set to value 1 to denote a Leaf Hash.
The hash of a leaf in the tree. Hex-encoded with 0x prefix.
Set to value 2 to denote a Value Hash.
the hash of the value for which the proof is being computed. Hex-encoded with 0x prefix.
r object
The right node. Hex-encoded with 0x prefix.
Set to value 1 to denote a Leaf Hash.
The hash of a leaf in the tree. Hex-encoded with 0x prefix.
Set to value 2 to denote a Value Hash.
the hash of the value for which the proof is being computed. Hex-encoded with 0x prefix.
Set to value 1 to denote a Leaf Hash.
The hash of a leaf in the tree. Hex-encoded with 0x prefix.
Set to value 2 to denote a Value Hash.
the hash of the value for which the proof is being computed. Hex-encoded with 0x prefix.
metadata OutputMetadataResponse
Returns metadata about an output.
The output identifier of requested output. Hex-encoded with 0x prefix.
The block identifier that references the output. Hex-encoded with 0x prefix.
included required
The slot index in which the output is included.
The identifier of the transaction. Hex-encoded with 0x prefix.
The commitment ID at which the output was included into the ledger.
spent
The slot index in which the output is spent.
The transaction ID that spent the output. Hex-encoded with 0x prefix.
The commitment ID that includes the spending of the output.
The current latest commitment id for which the request was made.
{
"outputIdProof": {
"slot": 0,
"outputIndex": 0,
"transactionCommitment": "string",
"outputCommitmentProof": {
"type": 0
}
},
"metadata": {
"outputId": "string",
"blockId": "string",
"included": {
"slot": 0,
"transactionId": "string",
"commitmentId": "string"
},
"spent": {
"slot": 0,
"transactionId": "string",
"commitmentId": "string"
},
"latestCommitmentId": "string"
}
}
{
"output": {
"type": 0,
"amount": "1000",
"unlockConditions": [
{
"type": 0,
"address": {
"type": 0,
"pubKeyHash": "0x8eaf87ac1f52eb05f2c7c0c15502df990a228838dc37bd18de9503d69afd257d"
}
}
],
"mana": "2000"
},
"outputIdProof": {
"slot": 1893592032,
"outputIndex": 0,
"transactionCommitment": "0xa0687905318860e64db6932d8423bf7a4418627baee62be8089d5f48aaa1af3a",
"outputCommitmentProof": {
"type": 2,
"hash": "0x7f9289b104a55e6fb93d60d70f6e85c9706c761b05ccc034f76b465837ca6070"
}
},
"metadata": {
"outputId": "0x3130f21c723fa597805763739f3a2a40b674af6b4071ef0494331b644a7e4d52000000001300",
"blockId": "0x19e589687082d8f535779df3244908ad6a7b380906fb7ae24efb5fad8a5cfb92a8f8d9a3",
"included": {
"slot": 5,
"transactionId": "0x3e766157614a3a0e13dbb937b5fb1ef5d1555479c19df80445d03a6710f39d75668bd326",
"commitmentId": "0x7387ebe23a3ac1732fcdb6cef77fc003e1fa6e2dad89dd664df249d6aa2dbdc157dec2c6"
},
"spent": {
"slot": 8,
"transactionId": "0x3896f1ede7cbdacbbb4b17f13e953ad45ce0969ea34cc766b5dafe2a15b3e46f998ef4e5",
"commitmentId": "0x26fa9fcbddcf944ced3fd16a73d9c8b2b49dc54dba7629b02da69f7e01249063e7398b2c"
},
"latestCommitmentId": "0x42a88617c2c4ba2b58f82c8b85524720cdbe3642401e7c613f215658d617c569d1219909"
}
}
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"
}
}