Submit a block.

POST 
http://127.0.0.1:14265/api/core/v3/blocks

Submit a block or a payload. This endpoint will return the identifier of the built block. Only full block is accepted.

Request

application/json

Body

required

allOf Block

A block is the object nodes gossip around in the network. It always references 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.

header required

protocolVersion numberrequired

Protocol version identifier. It also tells which protocol rules apply to the block.

networkId stringrequired

Network version identifier. It also tells which network the node is running.

issuingTime stringrequired

The timestamp of issuing this block, a uint64 string in nanosecond-precision.

slotCommitmentId stringrequired

The slot commitment ID contains in this block.

latestFinalizedSlot integerrequired

The latest finalized slot of issuing node.

issuerId stringrequired

The identifier of the issuer.

body object required

The block content.

oneOf

BasicBlock

type integerrequired

Set to value 0 to denote a Basic Block.

strongParents string[]required

The identifiers of the blocks this block references. Hex-encoded data with 0x prefix.

weakParents string[]

The identifiers of the blocks this block references. Hex-encoded data with 0x prefix.

shallowLikeParents string[]

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.

oneOf

SignedTransactionPayload

type integerrequired

Set to value 1 to denote a Signed Transaction Payload.

transaction object required

oneOf

Transaction

networkId stringrequired

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.

creationSlot integerrequired

The slot index in which the transaction was created.

contextInputs object[]required

Array [

anyOf

CommitmentInput

type integerrequired

Set to value 1 to denote a Commitment Input.

commitmentId stringrequired

The commitment identifier to reference.

BlockIssuanceCreditInput

type integerrequired

Set to value 2 to denote an BIC Input.

accountId stringrequired

The account identifier.

RewardInput

type integerrequired

Set to value 3 to denote a Reward Input.

index integerrequired

The index of the transaction input for which to claim rewards.

]

inputs object[]required

The inputs of this transaction.

Array [

oneOf

UTXOInput

type integerrequired

Set to value 0 to denote a UTXO Input.

transactionId stringrequired

The BLAKE2b-256 hash of the transaction from which the UTXO comes from. Hex-encoded data with 0x prefix.

transactionOutputIndex integerrequired

The index of the output on the referenced transaction to consume.

]

allotments object[]required

The accounts map with corresponding allotment values.

Array [

oneOf

Allotment

accountId string

The account ID to allot the mana to.

mana string

The amount of mana to allot.

]

capabilities stringrequired

The capabilities of this transaction.

payload object

The optional embedded payload.

oneOf

TaggedDataPayload

type integerrequired

Set to value 0 to denote a Tagged Data Payload.

tag string

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.

data stringrequired

The optional data to attach. This may have a length of 0. Hex-encoded with 0x prefix.

outputs object[]required

The outputs of this transaction.

Array [

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.

]

]

unlocks object[]required

Array [

oneOf

SignatureUnlock

type integerrequired

Denotes a Signature Unlock.

signature object required

oneOf

Ed25519Signature

type integerrequired

Set to value 0 to denote an Ed25519 Signature.

publicKey stringrequired

The public key of the Ed25519 keypair which is used to verify the signature. Hex-encoded with 0x prefix.

signature stringrequired

The signature signing the serialized Transaction Essence. Hex-encoded with 0x prefix.

ReferenceUnlock

type integerrequired

Set to value 1 to denote a Reference Unlock.

reference integerrequired

Represents the index of a previous unlock.

AccountUnlock

type integerrequired

Set to value 2 to denote an Account Unlock.

reference integerrequired

Represents the index of a previous unlock.

NFTUnlock

type integerrequired

Set to value 3 to denote an NFT Unlock.

reference integerrequired

Represents the index of a previous unlock.

]

TaggedDataPayload

type integerrequired

Set to value 0 to denote a Tagged Data Payload.

tag string

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.

data stringrequired

The optional data to attach. This may have a length of 0. Hex-encoded with 0x prefix.

maxBurnedMana stringrequired

The mana burned in this block.

ValidationBlock

type integerrequired

Set to value 1 to denote a Validation Block.

strongParents string[]required

The identifiers of the blocks this block references. Hex-encoded data with 0x prefix.

weakParents string[]

The identifiers of the blocks this block references. Hex-encoded data with 0x prefix.

shallowLikeParents string[]

The identifiers of the blocks this block references. Hex-encoded data with 0x prefix.

highestSupportedVersion integerrequired

The highest supported version of the protocol.

protocolParametersHash stringrequired

The hash of the protocol parameters for the highestSupportedVersion.

signature object required

The signature of entire block, signed by the issuer.

oneOf

Ed25519Signature

type integerrequired

Set to value 0 to denote an Ed25519 Signature.

publicKey stringrequired

The public key of the Ed25519 keypair which is used to verify the signature. Hex-encoded with 0x prefix.

signature stringrequired

The signature signing the serialized Transaction Essence. Hex-encoded with 0x prefix.

application/vnd.iota.serializer-v2

Body

required

string

Responses

201

Successful operation.

Response Headers

• Location string

  The blockId of the newly created block.

application/json

Schema

Schema

blockId stringrequired

The block identifier of the submitted block. Hex-encoded with 0x prefix.

Example (from schema)

{
  "blockId": "string"
}

default

{
  "blockId": "0x0482f0eba39a23c9a13072c93d828b55543132c47f5f57514d9e55535e9d4f4f35000000"
}

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"
  }
}

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"
  }
}

503

Unsuccessful operation: indicates that the node can´t auto-fill the parents or perform Proof-of-Work.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 503,
    "message": "service unavailable"
  }
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X POST 'http://127.0.0.1:14265/api/core/v3/blocks' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "allOf": {
    "header": {
      "protocolVersion": 0,
      "networkId": "string",
      "issuingTime": "string",
      "slotCommitmentId": "string",
      "latestFinalizedSlot": 0,
      "issuerId": "string"
    },
    "body": {
      "type": 0,
      "strongParents": [
        "string"
      ],
      "weakParents": [
        "string"
      ],
      "shallowLikeParents": [
        "string"
      ],
      "payload": {
        "type": 0,
        "transaction": {
          "networkId": "string",
          "creationSlot": 0,
          "contextInputs": [
            {
              "type": 0,
              "commitmentId": "string"
            },
            {
              "type": 0,
              "accountId": "string"
            },
            {
              "type": 0,
              "index": 0
            }
          ],
          "inputs": [
            {
              "type": 0,
              "transactionId": "string",
              "transactionOutputIndex": 0
            }
          ],
          "allotments": [
            {
              "accountId": "string",
              "mana": "string"
            }
          ],
          "capabilities": "string",
          "payload": {
            "type": 0,
            "tag": "string",
            "data": "string"
          },
          "outputs": [
            {
              "type": 0,
              "amount": "string",
              "mana": "string",
              "unlockConditions": [
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "pubKeyHash": "string"
                  }
                },
                {
                  "type": 0,
                  "returnAddress": {
                    "type": 0,
                    "pubKeyHash": "string"
                  },
                  "amount": "string"
                },
                {
                  "type": 0,
                  "slot": 0
                },
                {
                  "type": 0,
                  "returnAddress": {
                    "type": 0,
                    "pubKeyHash": "string"
                  },
                  "slot": 0
                }
              ],
              "features": [
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "pubKeyHash": "string"
                  }
                },
                {
                  "type": 0,
                  "entries": [
                    {
                      "did:iota": "0x68656c6c6f206469676974616c206175746f6e6f6d79"
                    },
                    {
                      "hello": "0x776f726c64"
                    }
                  ]
                },
                {
                  "type": 0,
                  "tag": "string"
                },
                {
                  "type": 0,
                  "id": "string",
                  "amount": "string"
                }
              ]
            },
            {
              "type": 0,
              "amount": "string",
              "mana": "string",
              "accountId": "string",
              "foundryCounter": 0,
              "unlockConditions": [
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "pubKeyHash": "string"
                  }
                }
              ],
              "features": [
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "pubKeyHash": "string"
                  }
                },
                {
                  "type": 0,
                  "entries": [
                    {
                      "did:iota": "0x68656c6c6f206469676974616c206175746f6e6f6d79"
                    },
                    {
                      "hello": "0x776f726c64"
                    }
                  ]
                },
                {
                  "type": 6,
                  "blockIssuerKeys": [
                    {
                      "type": 0,
                      "publicKey": "string"
                    }
                  ],
                  "expirySlot": "string"
                },
                {
                  "type": 7,
                  "stakedAmount": "string",
                  "fixedCost": "string",
                  "startEpoch": 0,
                  "endEpoch": 0
                }
              ],
              "immutableFeatures": [
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "pubKeyHash": "string"
                  }
                },
                {
                  "type": 0,
                  "entries": [
                    {
                      "did:iota": "0x68656c6c6f206469676974616c206175746f6e6f6d79"
                    },
                    {
                      "hello": "0x776f726c64"
                    }
                  ]
                }
              ]
            },
            {
              "type": 0,
              "amount": "string",
              "mana": "string",
              "anchorId": "string",
              "stateIndex": 0,
              "unlockConditions": [
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "pubKeyHash": "string"
                  }
                },
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "pubKeyHash": "string"
                  }
                }
              ],
              "features": [
                {
                  "type": 0,
                  "entries": [
                    {
                      "did:iota": "0x68656c6c6f206469676974616c206175746f6e6f6d79"
                    },
                    {
                      "hello": "0x776f726c64"
                    }
                  ]
                },
                {
                  "type": 3,
                  "entries": [
                    {
                      "did:iota": "0x68656c6c6f206469676974616c206175746f6e6f6d79"
                    },
                    {
                      "hello": "0x776f726c64"
                    }
                  ]
                }
              ],
              "immutableFeatures": [
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "pubKeyHash": "string"
                  }
                },
                {
                  "type": 0,
                  "entries": [
                    {
                      "did:iota": "0x68656c6c6f206469676974616c206175746f6e6f6d79"
                    },
                    {
                      "hello": "0x776f726c64"
                    }
                  ]
                }
              ]
            },
            {
              "type": 0,
              "amount": "string",
              "serialNumber": 0,
              "tokenScheme": [
                {
                  "type": 0,
                  "mintedTokens": "string",
                  "meltedTokens": "string",
                  "maxSupply": "string"
                }
              ],
              "unlockConditions": [
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "accountId": "string"
                  }
                }
              ],
              "features": [
                {
                  "type": 0,
                  "entries": [
                    {
                      "did:iota": "0x68656c6c6f206469676974616c206175746f6e6f6d79"
                    },
                    {
                      "hello": "0x776f726c64"
                    }
                  ]
                },
                {
                  "type": 0,
                  "id": "string",
                  "amount": "string"
                }
              ],
              "immutableFeatures": [
                {
                  "type": 0,
                  "entries": [
                    {
                      "did:iota": "0x68656c6c6f206469676974616c206175746f6e6f6d79"
                    },
                    {
                      "hello": "0x776f726c64"
                    }
                  ]
                }
              ]
            },
            {
              "type": 0,
              "amount": "string",
              "mana": "string",
              "nftId": "string",
              "unlockConditions": [
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "pubKeyHash": "string"
                  }
                },
                {
                  "type": 0,
                  "returnAddress": {
                    "type": 0,
                    "pubKeyHash": "string"
                  },
                  "amount": "string"
                },
                {
                  "type": 0,
                  "slot": 0
                },
                {
                  "type": 0,
                  "returnAddress": {
                    "type": 0,
                    "pubKeyHash": "string"
                  },
                  "slot": 0
                }
              ],
              "features": [
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "pubKeyHash": "string"
                  }
                },
                {
                  "type": 0,
                  "entries": [
                    {
                      "did:iota": "0x68656c6c6f206469676974616c206175746f6e6f6d79"
                    },
                    {
                      "hello": "0x776f726c64"
                    }
                  ]
                },
                {
                  "type": 0,
                  "tag": "string"
                }
              ],
              "immutableFeatures": [
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "pubKeyHash": "string"
                  }
                },
                {
                  "type": 0,
                  "entries": [
                    {
                      "did:iota": "0x68656c6c6f206469676974616c206175746f6e6f6d79"
                    },
                    {
                      "hello": "0x776f726c64"
                    }
                  ]
                }
              ]
            },
            {
              "type": 5,
              "amount": "100",
              "delegatedAmount": "string",
              "delegationId": "0x1505ec099896ab05d9e08fbc7101ae4dff0093b3943b28f789ed2ca728bcc8d6",
              "validatorAddress": "0x1505ec099896ab05d9e08fbc7101ae4dff0093b3943b28f789ed2ca728bcc8d6",
              "startEpoch": "10",
              "endEpoch": "12",
              "unlockConditions": [
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "pubKeyHash": "string"
                  }
                }
              ]
            }
          ]
        },
        "unlocks": [
          {
            "type": 0,
            "signature": {
              "type": 0,
              "publicKey": "string",
              "signature": "string"
            }
          },
          {
            "type": 0,
            "reference": 0
          },
          {
            "type": 0,
            "reference": 0
          },
          {
            "type": 0,
            "reference": 0
          }
        ]
      },
      "maxBurnedMana": "string"
    },
    "signature": {
      "type": 0,
      "publicKey": "string",
      "signature": "string"
    }
  }
}'

Request Collapse all

Base URL

http://127.0.0.1:14265

Body required

Content-Type

application/jsonapplication/vnd.iota.serializer-v2

• Example (from schema)
• Full block with Tagged Data Payload
• Full block with Transaction Payload

{
  "allOf": {
    "header": {
      "protocolVersion": 0,
      "networkId": "string",
      "issuingTime": "string",
      "slotCommitmentId": "string",
      "latestFinalizedSlot": 0,
      "issuerId": "string"
    },
    "body": {
      "type": 0,
      "strongParents": [
        "string"
      ],
      "weakParents": [
        "string"
      ],
      "shallowLikeParents": [
        "string"
      ],
      "payload": {
        "type": 0,
        "transaction": {
          "networkId": "string",
          "creationSlot": 0,
          "contextInputs": [
            {
              "type": 0,
              "commitmentId": "string"
            },
            {
              "type": 0,
              "accountId": "string"
            },
            {
              "type": 0,
              "index": 0
            }
          ],
          "inputs": [
            {
              "type": 0,
              "transactionId": "string",
              "transactionOutputIndex": 0
            }
          ],
          "allotments": [
            {
              "accountId": "string",
              "mana": "string"
            }
          ],
          "capabilities": "string",
          "payload": {
            "type": 0,
            "tag": "string",
            "data": "string"
          },
          "outputs": [
            {
              "type": 0,
              "amount": "string",
              "mana": "string",
              "unlockConditions": [
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "pubKeyHash": "string"
                  }
                },
                {
                  "type": 0,
                  "returnAddress": {
                    "type": 0,
                    "pubKeyHash": "string"
                  },
                  "amount": "string"
                },
                {
                  "type": 0,
                  "slot": 0
                },
                {
                  "type": 0,
                  "returnAddress": {
                    "type": 0,
                    "pubKeyHash": "string"
                  },
                  "slot": 0
                }
              ],
              "features": [
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "pubKeyHash": "string"
                  }
                },
                {
                  "type": 0,
                  "entries": [
                    {
                      "did:iota": "0x68656c6c6f206469676974616c206175746f6e6f6d79"
                    },
                    {
                      "hello": "0x776f726c64"
                    }
                  ]
                },
                {
                  "type": 0,
                  "tag": "string"
                },
                {
                  "type": 0,
                  "id": "string",
                  "amount": "string"
                }
              ]
            },
            {
              "type": 0,
              "amount": "string",
              "mana": "string",
              "accountId": "string",
              "foundryCounter": 0,
              "unlockConditions": [
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "pubKeyHash": "string"
                  }
                }
              ],
              "features": [
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "pubKeyHash": "string"
                  }
                },
                {
                  "type": 0,
                  "entries": [
                    {
                      "did:iota": "0x68656c6c6f206469676974616c206175746f6e6f6d79"
                    },
                    {
                      "hello": "0x776f726c64"
                    }
                  ]
                },
                {
                  "type": 6,
                  "blockIssuerKeys": [
                    {
                      "type": 0,
                      "publicKey": "string"
                    }
                  ],
                  "expirySlot": "string"
                },
                {
                  "type": 7,
                  "stakedAmount": "string",
                  "fixedCost": "string",
                  "startEpoch": 0,
                  "endEpoch": 0
                }
              ],
              "immutableFeatures": [
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "pubKeyHash": "string"
                  }
                },
                {
                  "type": 0,
                  "entries": [
                    {
                      "did:iota": "0x68656c6c6f206469676974616c206175746f6e6f6d79"
                    },
                    {
                      "hello": "0x776f726c64"
                    }
                  ]
                }
              ]
            },
            {
              "type": 0,
              "amount": "string",
              "mana": "string",
              "anchorId": "string",
              "stateIndex": 0,
              "unlockConditions": [
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "pubKeyHash": "string"
                  }
                },
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "pubKeyHash": "string"
                  }
                }
              ],
              "features": [
                {
                  "type": 0,
                  "entries": [
                    {
                      "did:iota": "0x68656c6c6f206469676974616c206175746f6e6f6d79"
                    },
                    {
                      "hello": "0x776f726c64"
                    }
                  ]
                },
                {
                  "type": 3,
                  "entries": [
                    {
                      "did:iota": "0x68656c6c6f206469676974616c206175746f6e6f6d79"
                    },
                    {
                      "hello": "0x776f726c64"
                    }
                  ]
                }
              ],
              "immutableFeatures": [
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "pubKeyHash": "string"
                  }
                },
                {
                  "type": 0,
                  "entries": [
                    {
                      "did:iota": "0x68656c6c6f206469676974616c206175746f6e6f6d79"
                    },
                    {
                      "hello": "0x776f726c64"
                    }
                  ]
                }
              ]
            },
            {
              "type": 0,
              "amount": "string",
              "serialNumber": 0,
              "tokenScheme": [
                {
                  "type": 0,
                  "mintedTokens": "string",
                  "meltedTokens": "string",
                  "maxSupply": "string"
                }
              ],
              "unlockConditions": [
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "accountId": "string"
                  }
                }
              ],
              "features": [
                {
                  "type": 0,
                  "entries": [
                    {
                      "did:iota": "0x68656c6c6f206469676974616c206175746f6e6f6d79"
                    },
                    {
                      "hello": "0x776f726c64"
                    }
                  ]
                },
                {
                  "type": 0,
                  "id": "string",
                  "amount": "string"
                }
              ],
              "immutableFeatures": [
                {
                  "type": 0,
                  "entries": [
                    {
                      "did:iota": "0x68656c6c6f206469676974616c206175746f6e6f6d79"
                    },
                    {
                      "hello": "0x776f726c64"
                    }
                  ]
                }
              ]
            },
            {
              "type": 0,
              "amount": "string",
              "mana": "string",
              "nftId": "string",
              "unlockConditions": [
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "pubKeyHash": "string"
                  }
                },
                {
                  "type": 0,
                  "returnAddress": {
                    "type": 0,
                    "pubKeyHash": "string"
                  },
                  "amount": "string"
                },
                {
                  "type": 0,
                  "slot": 0
                },
                {
                  "type": 0,
                  "returnAddress": {
                    "type": 0,
                    "pubKeyHash": "string"
                  },
                  "slot": 0
                }
              ],
              "features": [
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "pubKeyHash": "string"
                  }
                },
                {
                  "type": 0,
                  "entries": [
                    {
                      "did:iota": "0x68656c6c6f206469676974616c206175746f6e6f6d79"
                    },
                    {
                      "hello": "0x776f726c64"
                    }
                  ]
                },
                {
                  "type": 0,
                  "tag": "string"
                }
              ],
              "immutableFeatures": [
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "pubKeyHash": "string"
                  }
                },
                {
                  "type": 0,
                  "entries": [
                    {
                      "did:iota": "0x68656c6c6f206469676974616c206175746f6e6f6d79"
                    },
                    {
                      "hello": "0x776f726c64"
                    }
                  ]
                }
              ]
            },
            {
              "type": 5,
              "amount": "100",
              "delegatedAmount": "string",
              "delegationId": "0x1505ec099896ab05d9e08fbc7101ae4dff0093b3943b28f789ed2ca728bcc8d6",
              "validatorAddress": "0x1505ec099896ab05d9e08fbc7101ae4dff0093b3943b28f789ed2ca728bcc8d6",
              "startEpoch": "10",
              "endEpoch": "12",
              "unlockConditions": [
                {
                  "type": 0,
                  "address": {
                    "type": 0,
                    "pubKeyHash": "string"
                  }
                }
              ]
            }
          ]
        },
        "unlocks": [
          {
            "type": 0,
            "signature": {
              "type": 0,
              "publicKey": "string",
              "signature": "string"
            }
          },
          {
            "type": 0,
            "reference": 0
          },
          {
            "type": 0,
            "reference": 0
          },
          {
            "type": 0,
            "reference": 0
          }
        ]
      },
      "maxBurnedMana": "string"
    },
    "signature": {
      "type": 0,
      "publicKey": "string",
      "signature": "string"
    }
  }
}

ResponseClear

Click the Send API Request button above and see the response here!