Returns the included block of a transaction.
GET/api/core/v2/transactions/:transactionId/included-block
Returns the included block of a transaction.
Request
Path Parameters
Identifier of the transaction to look up.
Responses
- 200
- 400
- 403
- 404
- 500
Successful operation.
- application/json
- application/vnd.iota.serializer-v1
- Schema
- Example (from schema)
- default
Schema
- TransactionPayload
- MilestonePayload
- TaggedDataPayload
- ReceiptPayload
- TransactionEssence
- Array [
- UTXOInput
- ]
- Array [
- 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
- ]
- ]
- TaggedDataPayload
- Array [
- SignatureUnlock
- ReferenceUnlock
- AliasUnlock
- NFTUnlock
- Ed25519Signature
- ]
- Array [
- ReceiptPayload
- ProtocolParamsMilestoneOpt
- Array [
- Ed25519Address
- ]
- ]
- Array [
- Ed25519Signature
- ]
- Array [
- Ed25519Address
- ]
allOf Block
A block is the object nodes gossip around in the network. It always references two other blocks that are known as parents. It is stored as a vertex on the tangle data structure that the nodes maintain. A block can have a maximum size of 32Kb.
Protocol version identifier. It also tells which protocol rules apply to the block.
The identifiers of the blocks this block references. Hex-encoded data with 0x prefix.
payload object
The inner payload of the block. Can be nil.
Set to value 6 to denote a Transaction Payload.
essence object required
Set to value 1 to denote a Transaction Essence.
Network identifier. Plain string encoded number. This field signals for which network the block is meant for. It is computed out of the first 8 bytes of the BLAKE2b-256
hash of the concatenation of the network name and protocol version string.
BLAKE2b-256 hash of the BLAKE2b-256 hashes of the serialized outputs referenced in Inputs by their outputIds (transactionId || outputIndex). Hex-encoded data with 0x prefix.
inputs object[]required
The inputs of this transaction.
Set to value 0 to denote an UTXO Input.
The BLAKE2b-256 hash of the transaction from which the UTXO comes from. Hex-encoded data with 0x prefix.
The index of the output on the referenced transaction to consume.
outputs object[]required
The outputs of this transaction.
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 object required
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 object required
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 object required
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 object required
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 object required
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 object required
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 object required
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 object required
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 object required
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 object required
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 object required
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 object required
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 object required
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 object required
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 object required
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.
payload object
The optional embedded payload.
Set to value 5 to denote a Tagged Data Payload.
The tag to allow external tools to find/look up this block. It has a size between 0 and 64 bytes and must be encoded as a hex-string with 0x prefix. Network nodes do not index blocks with Tagged Data Payload by the tag field by default.
The optional data to attach. This may have a length of 0. Hex-encoded with 0x prefix.
unlocks object[]required
Denotes a Signature Unlock.
signature object required
Set to value 0 to denote an Ed25519 Signature.
The public key of the Ed25519 keypair which is used to verify the signature. Hex-encoded with 0x prefix.
The signature signing the serialized Transaction Essence. Hex-encoded with 0x prefix.
Set to value 1 to denote a Reference Unlock.
Represents the index of a previous unlock.
Set to value 2 to denote an Alias Unlock.
Represents the index of a previous unlock.
Set to value 3 to denote an NFT Unlock.
Represents the index of a previous unlock.
Set to value 7 to denote a Milestone Payload.
The index of the milestone.
The Unix timestamp at which the milestone was issued. The unix timestamp is specified in seconds.
Protocol version of the Milestone Payload and its encapsulating block.
The Milestone ID of the milestone with Index Number - 1.
The identifiers of the blocks this milestone references. Hex-encoded values with 0x prefix.
The merkle root of all directly/indirectly referenced blocks (their IDs) which are newly confirmed by this milestone. Hex-encoded with 0x prefix.
The merkle root of all blocks (their IDs) carrying ledger state mutating transactions. Hex-encoded with 0x prefix.
options object[]
Type identifier of a receipt payload (3).
funds MigratedFundsEntry[]required
address object required
Set to value 0 to denote an Ed25519 Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Ed25519 public key
transaction TreasuryTransactionPayloadrequired
Set to value 4 to denote a Treasury Payload.
input TreasuryInputrequired
Set to value 1 to denote a TreasuryInput.
Hex-encoded with 0x prefix.
output TreasuryOutputrequired
Set to value 2 to denote a TreasuryOutput.
Amount of IOTA tokens in the treasury. Plain string encoded number.
Defines the type of MilestoneOpt.
The milestone index at which these protocol parameters become active.
The to be applied protocol version.
The protocol parameters in binary form. Hex-encoded with 0x prefix.
Hex-encoded binary data with 0x prefix.
signatures object[]required
An array of signatures signing the serialized Milestone Essence. Hex-encoded with 0x prefix.
Set to value 0 to denote an Ed25519 Signature.
The public key of the Ed25519 keypair which is used to verify the signature. Hex-encoded with 0x prefix.
The signature signing the serialized Transaction Essence. Hex-encoded with 0x prefix.
Set to value 5 to denote a Tagged Data Payload.
The tag to allow external tools to find/look up this block. It has a size between 0 and 64 bytes and must be encoded as a hex-string with 0x prefix. Network nodes do not index blocks with Tagged Data Payload by the tag field by default.
The optional data to attach. This may have a length of 0. Hex-encoded with 0x prefix.
Type identifier of a receipt payload (3).
funds MigratedFundsEntry[]required
address object required
Set to value 0 to denote an Ed25519 Address.
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Ed25519 public key
transaction TreasuryTransactionPayloadrequired
Set to value 4 to denote a Treasury Payload.
input TreasuryInputrequired
Set to value 1 to denote a TreasuryInput.
Hex-encoded with 0x prefix.
output TreasuryOutputrequired
Set to value 2 to denote a TreasuryOutput.
Amount of IOTA tokens in the treasury. Plain string encoded number.
The nonce which lets this block fulfill the Proof-of-Work requirement. Plain string encoded number.
{
"allOf": {
"protocolVersion": 0,
"parents": [
"string"
],
"nonce": "string"
}
}
{
"protocolVersion": 2,
"parents": [
"0x174e3151f6ce2cfb7f00829ac4a96a35caa2078cc20eba99359867cd21aad0d6",
"0x5807bb4ad068e6cdadd103218e4e24ed55b62c985d4f64e97808d9f09180f89c",
"0x7a09324557e9200f39bf493fc8fd6ac43e9ca750c6f6d884cc72386ddcb7d695",
"0xde9e9d780ba7ebeebc38da16cb53b2a8991d38eee94bcdc3f3ef99aa8c345652"
],
"payload": {
"type": 6,
"essence": {
"type": 1,
"networkId": "1337133713371337",
"inputsCommitment": "0x0e6c2998f5177834ecb3bae1596d5056af76e487386eecb19727465b4be86a79",
"inputs": [
{
"type": 0,
"transactionId": "0xaf7579fb57746219561072c2cc0e4d0fbb8d493d075bd21bf25ae81a450c11ef",
"transactionOutputIndex": 0
}
],
"outputs": [
{
"type": 3,
"unlockConditions": {
"type": 0,
"address": {
"type": 0,
"pubKeyHash": "0xa18996d96163405e3c0eb13fa3459a07f68a89e8cf7cc239c89e7192344daa5b"
}
},
"amount": "1000000"
}
],
"payload": {
"type": 2,
"index": "0x454f59",
"data": ""
}
},
"unlocks": [
{
"type": 0,
"signature": {
"type": 0,
"publicKey": "0xee26ac07834c603c22130fced361ca58552b0dbfc63e4b73ba24b3b59d9f4050",
"signature": "0x0492a353f96883c472e2686a640e77eda30be8fcc417aa9fc1c15eae854661e0253287be6ea68f649f19ca590de0a6c57fb88635ef0e013310e0be2b83609503"
}
}
]
},
"nonce": "17293822569102719312"
}
- Schema
Schema
string
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"
}
}