Get all UTXO changes of a given slot index.

GET 
/api/core/v3/commitments/by-slot/:slot/utxo-changes/full

Get all UTXO changes of a given slot index.

Request

Path Parameters

slot integerrequired
Index of the commitment to look up.
Example: 154862

Responses

200

Successful operation.

application/json

Schema

Schema

commitmentId string

The commitment ID of the requested slot that contains the changes. Hex-encoded with 0x prefix.

createdOutputs object[]required
The created outputs of the given slot.
Array [
oneOf
OutputWithId
outputId stringrequired
The output identifier of requested output. Hex-encoded with 0x prefix.
output object required
anyOf
BasicOutput
type integerrequired
Set to value 0 to denote a Basic Output.
amount stringrequired
The amount of IOTA tokens to deposit with this BasicOutput output. Plain string encoded number.
mana stringrequired
The stored mana held by the output.
unlockConditions object[]
Unlock conditions that define how the output can be unlocked in a transaction.
Array [
anyOf
AddressUnlockCondition
type integerrequired
Set to value 0 to denote an Address Unlock Condition.
address object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
StorageDepositReturnUnlockCondition
type integerrequired
Set to value 1 to denote a Storage Deposit Return Unlock Condition.
returnAddress object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
amount stringrequired
Amount of IOTA tokens the consuming transaction must deposit to the address defined in Return Address. Plain string encoded number.
TimelockUnlockCondition
type integerrequired
Set to value 2 to denote a Timelock Unlock Condition.
slot integer
The slot index until which the timelock applies (inclusive).
ExpirationUnlockCondition
type integerrequired
Set to value 3 to denote an Expiration Unlock Condition.
returnAddress object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
slot integer
The slot index at which the expiration happens.
]
features object[]
The features on the output
Array [
anyOf
SenderFeature
type integerrequired
Set to value 0 to denote a Sender Feature.
address object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
MetadataFeature
type integerrequired
Set to value 2 to denote a Metadata Feature.
entries objectrequired
property name* string
TagFeature
type integerrequired
Set to value 4 to denote a Tag Feature.
tag stringrequired
Hex-encoded binary indexation tag with 0x prefix.
NativeTokenFeature
type integerrequired
Set to value 5 to denote a Native Token Feature.
id stringrequired
The ID of the native token.
amount stringrequired
The amount of native token. Hex-encoded number with 0x prefix.
]
AccountOutput
type integerrequired
Set to value 1 to denote an Account Output.
amount stringrequired
The amount of IOTA tokens to deposit with this output. Plain string encoded number.
mana stringrequired
The stored mana held by the output.
accountId stringrequired
The identifier of the account.
foundryCounter integerrequired
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.
Array [
anyOf
AddressUnlockCondition
type integerrequired
Set to value 0 to denote an Address Unlock Condition.
address object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
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.
Array [
anyOf
SenderFeature
type integerrequired
Set to value 0 to denote a Sender Feature.
address object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
MetadataFeature
type integerrequired
Set to value 2 to denote a Metadata Feature.
entries objectrequired
property name* string
BlockIssuerFeature
type integerrequired
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.
Array [
oneOf
Ed25519PublicKey
type integerrequired
Set to value 0 to denote an Ed25519 Public key.
publicKey stringrequired
Ed25519 public key in Hex.
]
expirySlot stringrequired
Indicates when the BlockIssuerKeys are expired.
StakingFeature
type stringrequired
Set to value 7 to denote a Staking Feature.
stakedAmount stringrequired
The amount of IOTA coins that are locked and staked in the containing account.
fixedCost stringrequired
The fixed cost that the validator receives from the total pool reward.
startEpoch integerrequired
The epoch index at which the staking starts.
endEpoch integerrequired
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.
Array [
anyOf
IssuerFeature
type integerrequired
Set to value 1 to denote an Issuer Feature.
address object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
MetadataFeature
type integerrequired
Set to value 2 to denote a Metadata Feature.
entries objectrequired
property name* string
]
AnchorOutput
type integerrequired
Set to value 2 to denote an Anchor Output.
amount stringrequired
The amount of IOTA tokens to deposit with this output. Plain string encoded number.
mana stringrequired
The stored mana held by the output.
anchorId stringrequired
The identifier of the anchor.
stateIndex integerrequired
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.
Array [
anyOf
StateControllerAddressUnlockCondition
type integerrequired
Set to value 4 to denote a State Controller Address Unlock Condition.
address object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
GovernorAddressUnlockCondition
type integerrequired
Set to value 5 to denote a Governor Address Unlock Condition.
address object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
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.
Array [
anyOf
MetadataFeature
type integerrequired
Set to value 2 to denote a Metadata Feature.
entries objectrequired
property name* string
StateMetadataFeature
type integerrequired
Set to value 3 to denote a State Metadata Feature.
entries objectrequired
property name* string
]
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 object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
MetadataFeature
type integerrequired
Set to value 2 to denote a Metadata Feature.
entries objectrequired
property name* string
]
FoundryOutput
type integerrequired
Set to value 3 to denote a Foundry Output.
amount stringrequired
The amount of IOTA tokens to deposit with this output. Plain string encoded number.
serialNumber integerrequired
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.
Array [
oneOf
SimpleTokenScheme
type integerrequired
Set to value 0 to denote a 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[]
Unlock conditions that define how the output can be unlocked in a transaction.
Array [
anyOf
ImmutableAccountAddressUnlockCondition
type integerrequired
Set to value 6 to denote an Immutable Account Address Unlock Condition.
address object required
oneOf
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
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.
Array [
anyOf
MetadataFeature
type integerrequired
Set to value 2 to denote a Metadata Feature.
entries objectrequired
property name* string
NativeTokenFeature
type integerrequired
Set to value 5 to denote a Native Token Feature.
id stringrequired
The ID of the native token.
amount stringrequired
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.
Array [
anyOf
MetadataFeature
type integerrequired
Set to value 2 to denote a Metadata Feature.
entries objectrequired
property name* string
]
NFTOutput
type integerrequired
Set to value 4 to denote a NFT Output.
amount stringrequired
The amount of IOTA tokens to deposit with this output. Plain string encoded number.
mana stringrequired
The stored mana held by the output
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[]
Unlock conditions that define how the output can be unlocked in a transaction.
Array [
anyOf
AddressUnlockCondition
type integerrequired
Set to value 0 to denote an Address Unlock Condition.
address object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
StorageDepositReturnUnlockCondition
type integerrequired
Set to value 1 to denote a Storage Deposit Return Unlock Condition.
returnAddress object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
amount stringrequired
Amount of IOTA tokens the consuming transaction must deposit to the address defined in Return Address. Plain string encoded number.
TimelockUnlockCondition
type integerrequired
Set to value 2 to denote a Timelock Unlock Condition.
slot integer
The slot index until which the timelock applies (inclusive).
ExpirationUnlockCondition
type integerrequired
Set to value 3 to denote an Expiration Unlock Condition.
returnAddress object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
slot integer
The slot index at which the expiration happens.
]
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 object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
MetadataFeature
type integerrequired
Set to value 2 to denote a Metadata Feature.
entries objectrequired
property name* string
TagFeature
type integerrequired
Set to value 4 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 object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
MetadataFeature
type integerrequired
Set to value 2 to denote a Metadata Feature.
entries objectrequired
property name* string
]
DelegationOutput
type integerrequired
Set to value 5 to denote a Delegation Output.
amount stringrequired
The amount of IOTA tokens held by the output. Encoded as a plain string.
delegatedAmount stringrequired
The amount of IOTA tokens that were delegated when the output was created.
delegationId stringrequired
The identifier for this delegation output.
validatorAddress stringrequired
The Account Address of the validator to which this output is delegating.
startEpoch integerrequired
The index of the first epoch for which this output delegates.
endEpoch integerrequired
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.
Array [
anyOf
AddressUnlockCondition
type integerrequired
Set to value 0 to denote an Address Unlock Condition.
address object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
]
]
consumedOutputs object[]required
The consumed outputs of the given slot.
Array [
oneOf
OutputWithId
outputId stringrequired
The output identifier of requested output. Hex-encoded with 0x prefix.
output object required
anyOf
BasicOutput
type integerrequired
Set to value 0 to denote a Basic Output.
amount stringrequired
The amount of IOTA tokens to deposit with this BasicOutput output. Plain string encoded number.
mana stringrequired
The stored mana held by the output.
unlockConditions object[]
Unlock conditions that define how the output can be unlocked in a transaction.
Array [
anyOf
AddressUnlockCondition
type integerrequired
Set to value 0 to denote an Address Unlock Condition.
address object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
StorageDepositReturnUnlockCondition
type integerrequired
Set to value 1 to denote a Storage Deposit Return Unlock Condition.
returnAddress object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
amount stringrequired
Amount of IOTA tokens the consuming transaction must deposit to the address defined in Return Address. Plain string encoded number.
TimelockUnlockCondition
type integerrequired
Set to value 2 to denote a Timelock Unlock Condition.
slot integer
The slot index until which the timelock applies (inclusive).
ExpirationUnlockCondition
type integerrequired
Set to value 3 to denote an Expiration Unlock Condition.
returnAddress object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
slot integer
The slot index at which the expiration happens.
]
features object[]
The features on the output
Array [
anyOf
SenderFeature
type integerrequired
Set to value 0 to denote a Sender Feature.
address object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
MetadataFeature
type integerrequired
Set to value 2 to denote a Metadata Feature.
entries objectrequired
property name* string
TagFeature
type integerrequired
Set to value 4 to denote a Tag Feature.
tag stringrequired
Hex-encoded binary indexation tag with 0x prefix.
NativeTokenFeature
type integerrequired
Set to value 5 to denote a Native Token Feature.
id stringrequired
The ID of the native token.
amount stringrequired
The amount of native token. Hex-encoded number with 0x prefix.
]
AccountOutput
type integerrequired
Set to value 1 to denote an Account Output.
amount stringrequired
The amount of IOTA tokens to deposit with this output. Plain string encoded number.
mana stringrequired
The stored mana held by the output.
accountId stringrequired
The identifier of the account.
foundryCounter integerrequired
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.
Array [
anyOf
AddressUnlockCondition
type integerrequired
Set to value 0 to denote an Address Unlock Condition.
address object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
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.
Array [
anyOf
SenderFeature
type integerrequired
Set to value 0 to denote a Sender Feature.
address object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
MetadataFeature
type integerrequired
Set to value 2 to denote a Metadata Feature.
entries objectrequired
property name* string
BlockIssuerFeature
type integerrequired
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.
Array [
oneOf
Ed25519PublicKey
type integerrequired
Set to value 0 to denote an Ed25519 Public key.
publicKey stringrequired
Ed25519 public key in Hex.
]
expirySlot stringrequired
Indicates when the BlockIssuerKeys are expired.
StakingFeature
type stringrequired
Set to value 7 to denote a Staking Feature.
stakedAmount stringrequired
The amount of IOTA coins that are locked and staked in the containing account.
fixedCost stringrequired
The fixed cost that the validator receives from the total pool reward.
startEpoch integerrequired
The epoch index at which the staking starts.
endEpoch integerrequired
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.
Array [
anyOf
IssuerFeature
type integerrequired
Set to value 1 to denote an Issuer Feature.
address object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
MetadataFeature
type integerrequired
Set to value 2 to denote a Metadata Feature.
entries objectrequired
property name* string
]
AnchorOutput
type integerrequired
Set to value 2 to denote an Anchor Output.
amount stringrequired
The amount of IOTA tokens to deposit with this output. Plain string encoded number.
mana stringrequired
The stored mana held by the output.
anchorId stringrequired
The identifier of the anchor.
stateIndex integerrequired
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.
Array [
anyOf
StateControllerAddressUnlockCondition
type integerrequired
Set to value 4 to denote a State Controller Address Unlock Condition.
address object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
GovernorAddressUnlockCondition
type integerrequired
Set to value 5 to denote a Governor Address Unlock Condition.
address object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
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.
Array [
anyOf
MetadataFeature
type integerrequired
Set to value 2 to denote a Metadata Feature.
entries objectrequired
property name* string
StateMetadataFeature
type integerrequired
Set to value 3 to denote a State Metadata Feature.
entries objectrequired
property name* string
]
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 object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
MetadataFeature
type integerrequired
Set to value 2 to denote a Metadata Feature.
entries objectrequired
property name* string
]
FoundryOutput
type integerrequired
Set to value 3 to denote a Foundry Output.
amount stringrequired
The amount of IOTA tokens to deposit with this output. Plain string encoded number.
serialNumber integerrequired
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.
Array [
oneOf
SimpleTokenScheme
type integerrequired
Set to value 0 to denote a 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[]
Unlock conditions that define how the output can be unlocked in a transaction.
Array [
anyOf
ImmutableAccountAddressUnlockCondition
type integerrequired
Set to value 6 to denote an Immutable Account Address Unlock Condition.
address object required
oneOf
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
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.
Array [
anyOf
MetadataFeature
type integerrequired
Set to value 2 to denote a Metadata Feature.
entries objectrequired
property name* string
NativeTokenFeature
type integerrequired
Set to value 5 to denote a Native Token Feature.
id stringrequired
The ID of the native token.
amount stringrequired
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.
Array [
anyOf
MetadataFeature
type integerrequired
Set to value 2 to denote a Metadata Feature.
entries objectrequired
property name* string
]
NFTOutput
type integerrequired
Set to value 4 to denote a NFT Output.
amount stringrequired
The amount of IOTA tokens to deposit with this output. Plain string encoded number.
mana stringrequired
The stored mana held by the output
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[]
Unlock conditions that define how the output can be unlocked in a transaction.
Array [
anyOf
AddressUnlockCondition
type integerrequired
Set to value 0 to denote an Address Unlock Condition.
address object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
StorageDepositReturnUnlockCondition
type integerrequired
Set to value 1 to denote a Storage Deposit Return Unlock Condition.
returnAddress object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
amount stringrequired
Amount of IOTA tokens the consuming transaction must deposit to the address defined in Return Address. Plain string encoded number.
TimelockUnlockCondition
type integerrequired
Set to value 2 to denote a Timelock Unlock Condition.
slot integer
The slot index until which the timelock applies (inclusive).
ExpirationUnlockCondition
type integerrequired
Set to value 3 to denote an Expiration Unlock Condition.
returnAddress object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
slot integer
The slot index at which the expiration happens.
]
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 object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
MetadataFeature
type integerrequired
Set to value 2 to denote a Metadata Feature.
entries objectrequired
property name* string
TagFeature
type integerrequired
Set to value 4 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 object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
MetadataFeature
type integerrequired
Set to value 2 to denote a Metadata Feature.
entries objectrequired
property name* string
]
DelegationOutput
type integerrequired
Set to value 5 to denote a Delegation Output.
amount stringrequired
The amount of IOTA tokens held by the output. Encoded as a plain string.
delegatedAmount stringrequired
The amount of IOTA tokens that were delegated when the output was created.
delegationId stringrequired
The identifier for this delegation output.
validatorAddress stringrequired
The Account Address of the validator to which this output is delegating.
startEpoch integerrequired
The index of the first epoch for which this output delegates.
endEpoch integerrequired
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.
Array [
anyOf
AddressUnlockCondition
type integerrequired
Set to value 0 to denote an Address Unlock Condition.
address object required
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
AccountAddress
type integerrequired
Set to value 8 to denote an Account Address.
accountId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the account.
NFTAddress
type integerrequired
Set to value 16 to denote an NFT Address.
nftId stringrequired
The hex-encoded, 0x prefixed BLAKE2b-256 hash of the Output ID that created the NFT.
]
]

Example (from schema)

{
  "commitmentId": "string",
  "createdOutputs": [
    null
  ],
  "consumedOutputs": [
    null
  ]
}

default

{
  "commitmentId": "0x7387ebe23a3ac1732fcdb6cef77fc003e1fa6e2dad89dd664df249d6aa2dbdc157dec2c6",
  "createdOutputs": [
    {
      "outputId": "0x3130f21c723fa597805763739f3a2a40b674af6b4071ef0494331b644a7e4d52000000001300",
      "output": {
        "type": 0,
        "amount": "1000",
        "unlockConditions": [
          {
            "type": 0,
            "address": {
              "type": 0,
              "pubKeyHash": "0x8eaf87ac1f52eb05f2c7c0c15502df990a228838dc37bd18de9503d69afd257d"
            }
          }
        ],
        "mana": "2000"
      }
    }
  ],
  "consumedOutputs": []
}

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