Submit a block.

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

Submit a block. The node takes care of missing fields and tries to build the block. On success, the block will be stored in the Tangle. This endpoint will return the identifier of the built block. The node will try to auto-fill the following fields in case they are missing: parents, nonce. If payload is missing, the block will be built without a payload. protocolVersion is always required!

Request

application/json

Body

required

protocolVersion integerrequired

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

parents string[]

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

payload object

oneOf

TransactionPayload

type integerrequired

Set to value 6 to denote a Transaction Payload.

essence object required

oneOf

TransactionEssence

type integerrequired

Set to value 1 to denote a Transaction Essence.

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.

inputsCommitment stringrequired

BLAKE2b-256 hash of the BLAKE2b-256 hashes of the serialized outputs referenced in Inputs by their outputIds (transactionId || outputIndex). Hex-encoded data with 0x prefix.

inputs object[]required

The inputs of this transaction.

Array [

oneOf

UTXOInput

type integerrequired

Set to value 0 to denote an 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.

]

outputs object[]required

The outputs of this transaction.

Array [

anyOf

BasicOutput

type integerrequired

Set to value 3 to denote a Basic Output.

amount stringrequired

The amount of IOTA tokens to deposit with this BasicOutput output. Plain string encoded number.

nativeTokens object[]

Native tokens held by the otuput.

Array [

anyOf

NativeToken

id stringrequired

Hex-encoded identifier with 0x prefix of the native token. Same as foundryId of the controlling foundry.

amount stringrequired

Amount of native tokens (up to uint256). Hex-encoded number with 0x prefix.

]

unlockConditions object[]required

Unlock condtions that define how the output an be unlocked in a transaction.

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

AliasAddress

type integerrequired

Set to value 8 to denote an Alias Address.

aliasId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.

NFTAddress

type integerrequired

Set to value 16 to denote an NFT Address.

nftId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.

StorageDepositReturnUnlockCondition

type integerrequired

Set to value 1 to denote an Dust 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

AliasAddress

type integerrequired

Set to value 8 to denote an Alias Address.

aliasId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.

NFTAddress

type integerrequired

Set to value 16 to denote an NFT Address.

nftId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.

returnAmount stringrequired

Amount of IOTA tokens the consuming transaction should deposit to the address defined in Return Address. Plain string encoded number.

TimelockUnlockCondition

type integerrequired

Set to value 2 to denote an Timelock Unlock Condition.

unixTime integerrequired

Unix time (seconds since Unix epoch) starting from which the output can be consumed.

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

AliasAddress

type integerrequired

Set to value 8 to denote an Alias Address.

aliasId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.

NFTAddress

type integerrequired

Set to value 16 to denote an NFT Address.

nftId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.

unixTime integerrequired

Before this unix time, Address Unlock Condition is allowed to unlock the output, after that only the address defined in Return Address.

]

features object[]

Features that add utility to the output but do not impose unlocking conditions.

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

AliasAddress

type integerrequired

Set to value 8 to denote an Alias Address.

aliasId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.

NFTAddress

type integerrequired

Set to value 16 to denote an NFT Address.

nftId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.

MetadataFeature

type integerrequired

Set to value 2 to denote a Metadata Feature.

data stringrequired

Hex-encoded binary data with 0x prefix.

TagFeature

type integerrequired

Set to value 3 to denote a Tag Feature.

tag stringrequired

Hex-encoded binary indexation tag with 0x prefix.

]

AliasOutput

type integerrequired

Set to value 4 to denote an Alias Output.

amount stringrequired

The amount of IOTA tokens to deposit with this output. Plain string encoded number.

nativeTokens object[]

Native tokens held by the otuput.

Array [

anyOf

NativeToken

id stringrequired

Hex-encoded identifier with 0x prefix of the native token. Same as foundryId of the controlling foundry.

amount stringrequired

Amount of native tokens (up to uint256). Hex-encoded number with 0x prefix.

]

aliasId stringrequired

Unique identifier of the alias, which is the BLAKE2b-256 hash of the Output ID that created it. Alias Address = Alias Address Type || Alias ID. Hex-encoded data with 0x prefix.

stateIndex integerrequired

A counter that must increase by 1 every time the alias is state transitioned.

stateMetadata string

Hex-encoded metadata with 0x prefix that can only be changed by the state controller.

foundryCounter integerrequired

A counter that denotes the number of foundries created by this alias account.

unlockConditions object[]required

Unlock condtions that define how the output an be unlocked in a transaction.

Array [

anyOf

StateControllerAddressUnlockCondition

type integerrequired

Set to value 4 to denote an Sate 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

AliasAddress

type integerrequired

Set to value 8 to denote an Alias Address.

aliasId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.

NFTAddress

type integerrequired

Set to value 16 to denote an NFT Address.

nftId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.

GovernorAddressUnlockCondition

type integerrequired

Set to value 5 to denote an 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

AliasAddress

type integerrequired

Set to value 8 to denote an Alias Address.

aliasId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.

NFTAddress

type integerrequired

Set to value 16 to denote an NFT Address.

nftId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.

]

features object[]

Features that add utility to the output but do not impose unlocking conditions.

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

AliasAddress

type integerrequired

Set to value 8 to denote an Alias Address.

aliasId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.

NFTAddress

type integerrequired

Set to value 16 to denote an NFT Address.

nftId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.

MetadataFeature

type integerrequired

Set to value 2 to denote a Metadata Feature.

data stringrequired

Hex-encoded binary data with 0x prefix.

]

immutableFeatures object[]

Immutable features that add utility to the output but do not impose unlocking conditions. These features need to be kept in future transitions of the UTXO state machine.

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

AliasAddress

type integerrequired

Set to value 8 to denote an Alias Address.

aliasId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.

NFTAddress

type integerrequired

Set to value 16 to denote an NFT Address.

nftId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.

MetadataFeature

type integerrequired

Set to value 2 to denote a Metadata Feature.

data stringrequired

Hex-encoded binary data with 0x prefix.

]

FoundryOutput

type integerrequired

Set to value5 to denote a Foundry Output.

amount stringrequired

The amount of IOTA tokens to deposit with this output. Plain string encoded number.

nativeTokens object[]

Native tokens held by the otuput.

Array [

anyOf

NativeToken

id stringrequired

Hex-encoded identifier with 0x prefix of the native token. Same as foundryId of the controlling foundry.

amount stringrequired

Amount of native tokens (up to uint256). Hex-encoded number with 0x prefix.

]

serialNumber integerrequired

The serial number of the foundry with respect to the controlling alias.

tokenScheme object[]required

Defines the supply control scheme of the tokens controlled by the foundry.

Array [

oneOf

SimpleTokenScheme

type integerrequired

Set to value 0 to denote an 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[]required

Unlock condtions that define how the output an be unlocked in a transaction.

Array [

anyOf

ImmutableAliasAddressUnlockCondition

type integerrequired

Set to value 6 to denote an Immutable Alias Address Unlock Condition.

address object required

oneOf

AliasAddress

type integerrequired

Set to value 8 to denote an Alias Address.

aliasId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.

]

features object[]

Features that add utility to the output but do not impose unlocking conditions.

Array [

anyOf

MetadataFeature

type integerrequired

Set to value 2 to denote a Metadata Feature.

data stringrequired

Hex-encoded binary data with 0x prefix.

]

immutableFeatures object[]

Immutable features that add utility to the output but do not impose unlocking conditions. These features need to be kept in future transitions of the UTXO state machine.

Array [

anyOf

MetadataFeature

type integerrequired

Set to value 2 to denote a Metadata Feature.

data stringrequired

Hex-encoded binary data with 0x prefix.

]

NFTOutput

type integerrequired

Set to value 6 to denote a NFT Output.

amount stringrequired

The amount of IOTA tokens to deposit with this output. Plain string encoded number.

nativeTokens object[]

Native tokens held by the otuput.

Array [

anyOf

NativeToken

id stringrequired

Hex-encoded identifier with 0x prefix of the native token. Same as foundryId of the controlling foundry.

amount stringrequired

Amount of native tokens (up to uint256). Hex-encoded number with 0x prefix.

]

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[]required

Unlock condtions that define how the output an 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

AliasAddress

type integerrequired

Set to value 8 to denote an Alias Address.

aliasId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.

NFTAddress

type integerrequired

Set to value 16 to denote an NFT Address.

nftId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.

StorageDepositReturnUnlockCondition

type integerrequired

Set to value 1 to denote an Dust 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

AliasAddress

type integerrequired

Set to value 8 to denote an Alias Address.

aliasId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.

NFTAddress

type integerrequired

Set to value 16 to denote an NFT Address.

nftId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.

returnAmount stringrequired

Amount of IOTA tokens the consuming transaction should deposit to the address defined in Return Address. Plain string encoded number.

TimelockUnlockCondition

type integerrequired

Set to value 2 to denote an Timelock Unlock Condition.

unixTime integerrequired

Unix time (seconds since Unix epoch) starting from which the output can be consumed.

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

AliasAddress

type integerrequired

Set to value 8 to denote an Alias Address.

aliasId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.

NFTAddress

type integerrequired

Set to value 16 to denote an NFT Address.

nftId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.

unixTime integerrequired

Before this unix time, Address Unlock Condition is allowed to unlock the output, after that only the address defined in Return Address.

]

features object[]

Features that add utility to the output but do not impose unlocking conditions.

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

AliasAddress

type integerrequired

Set to value 8 to denote an Alias Address.

aliasId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.

NFTAddress

type integerrequired

Set to value 16 to denote an NFT Address.

nftId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.

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

AliasAddress

type integerrequired

Set to value 8 to denote an Alias Address.

aliasId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.

NFTAddress

type integerrequired

Set to value 16 to denote an NFT Address.

nftId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.

MetadataFeature

type integerrequired

Set to value 2 to denote a Metadata Feature.

data stringrequired

Hex-encoded binary data with 0x prefix.

TagFeature

type integerrequired

Set to value 3 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

AliasAddress

type integerrequired

Set to value 8 to denote an Alias Address.

aliasId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the alias.

NFTAddress

type integerrequired

Set to value 16 to denote an NFT Address.

nftId stringrequired

The hex-encoded, 0x prefixed BLAKE2b-256 hash of the outputId that created the NFT.

MetadataFeature

type integerrequired

Set to value 2 to denote a Metadata Feature.

data stringrequired

Hex-encoded binary data with 0x prefix.

]

]

payload object

The optional embedded payload.

oneOf

TaggedDataPayload

type integerrequired

Set to value 5 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 string

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

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.

AliasUnlock

type integerrequired

Set to value 2 to denote an Alias 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.

]

MilestonePayload

type integerrequired

Set to value 7 to denote a Milestone Payload.

index integerrequired

The index of the milestone.

timestamp integerrequired

The Unix timestamp at which the milestone was issued. The unix timestamp is specified in seconds.

protocolVersion integerrequired

Protocol version of the Milestone Payload and its encapsulating block.

previousMilestoneId stringrequired

The Milestone ID of the milestone with Index Number - 1.

parents string[]required

The identifiers of the blocks this milestone references. Hex-encoded values with 0x prefix.

inclusionMerkleRoot stringrequired

The merkle root of all directly/indirectly referenced blocks (their IDs) which are newly confirmed by this milestone. Hex-encoded with 0x prefix.

appliedMerkleRoot stringrequired

The merkle root of all blocks (their IDs) carrying ledger state mutating transactions. Hex-encoded with 0x prefix.

options object[]

Array [

anyOf

ReceiptPayload

type integerrequired

Type identifier of a receipt payload (3).

migratedAt integerrequired

final booleanrequired

funds MigratedFundsEntry[]required

Array [

tailTransactionHash stringrequired

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

deposit integerrequired

]

transaction TreasuryTransactionPayloadrequired

type integerrequired

Set to value 4 to denote a Treasury Payload.

input TreasuryInputrequired

type integerrequired

Set to value 1 to denote a TreasuryInput.

milestoneId stringrequired

Hex-encoded with 0x prefix.

output TreasuryOutputrequired

type integerrequired

Set to value 2 to denote a TreasuryOutput.

amount stringrequired

Amount of IOTA tokens in the treasury. Plain string encoded number.

ProtocolParamsMilestoneOpt

type integerrequired

Defines the type of MilestoneOpt.

targetMilestoneIndex integerrequired

The milestone index at which these protocol parameters become active.

protocolVersion integerrequired

The to be applied protocol version.

params stringrequired

The protocol parameters in binary form. Hex-encoded with 0x prefix.

]

metadata string

Hex-encoded binary data with 0x prefix.

signatures object[]required

An array of signatures signing the serialized Milestone Essence. Hex-encoded with 0x prefix.

Array [

anyOf

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.

]

TaggedDataPayload

type integerrequired

Set to value 5 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 string

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

TreasuryTransactionPayload

type integerrequired

Set to value 4 to denote a Treasury Payload.

input TreasuryInputrequired

type integerrequired

Set to value 1 to denote a TreasuryInput.

milestoneId stringrequired

Hex-encoded with 0x prefix.

output TreasuryOutputrequired

type integerrequired

Set to value 2 to denote a TreasuryOutput.

amount stringrequired

Amount of IOTA tokens in the treasury. Plain string encoded number.

ReceiptPayload

type integerrequired

Type identifier of a receipt payload (3).

migratedAt integerrequired

final booleanrequired

funds MigratedFundsEntry[]required

Array [

tailTransactionHash stringrequired

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

deposit integerrequired

]

transaction TreasuryTransactionPayloadrequired

type integerrequired

Set to value 4 to denote a Treasury Payload.

input TreasuryInputrequired

type integerrequired

Set to value 1 to denote a TreasuryInput.

milestoneId stringrequired

Hex-encoded with 0x prefix.

output TreasuryOutputrequired

type integerrequired

Set to value 2 to denote a TreasuryOutput.

amount stringrequired

Amount of IOTA tokens in the treasury. Plain string encoded number.

nonce string

The nonce which lets this block fulfill the Proof-of-Work requirement. Hex-encoded with 0x prefix.

application/vnd.iota.serializer-v1

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": "0xa4dd36465af63d495d35a05f592d42a51511c153e1bae8fad00453c8cbb48727"
}

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/v2/blocks' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "protocolVersion": 0,
  "parents": [
    "string"
  ],
  "payload": {
    "type": 0,
    "essence": {
      "type": 0,
      "networkId": "string",
      "inputsCommitment": "string",
      "inputs": [
        {
          "type": 0,
          "transactionId": "string",
          "transactionOutputIndex": 0
        }
      ],
      "outputs": [
        {
          "type": 0,
          "amount": "string",
          "nativeTokens": [
            {
              "id": "string",
              "amount": "string"
            }
          ],
          "unlockConditions": [
            {
              "type": 0,
              "address": {
                "type": 0,
                "pubKeyHash": "string"
              }
            },
            {
              "type": 0,
              "returnAddress": {
                "type": 0,
                "pubKeyHash": "string"
              },
              "returnAmount": "string"
            },
            {
              "type": 0,
              "unixTime": 0
            },
            {
              "type": 0,
              "returnAddress": {
                "type": 0,
                "pubKeyHash": "string"
              },
              "unixTime": 0
            }
          ],
          "features": [
            {
              "type": 0,
              "address": {
                "type": 0,
                "pubKeyHash": "string"
              }
            },
            {
              "type": 0,
              "data": "string"
            },
            {
              "type": 0,
              "tag": "string"
            }
          ]
        },
        {
          "type": 0,
          "amount": "string",
          "nativeTokens": [
            {
              "id": "string",
              "amount": "string"
            }
          ],
          "aliasId": "string",
          "stateIndex": 0,
          "stateMetadata": "string",
          "foundryCounter": 0,
          "unlockConditions": [
            {
              "type": 0,
              "address": {
                "type": 0,
                "pubKeyHash": "string"
              }
            },
            {
              "type": 0,
              "address": {
                "type": 0,
                "pubKeyHash": "string"
              }
            }
          ],
          "features": [
            {
              "type": 0,
              "address": {
                "type": 0,
                "pubKeyHash": "string"
              }
            },
            {
              "type": 0,
              "data": "string"
            }
          ],
          "immutableFeatures": [
            {
              "type": 0,
              "address": {
                "type": 0,
                "pubKeyHash": "string"
              }
            },
            {
              "type": 0,
              "data": "string"
            }
          ]
        },
        {
          "type": 0,
          "amount": "string",
          "nativeTokens": [
            {
              "id": "string",
              "amount": "string"
            }
          ],
          "serialNumber": 0,
          "tokenScheme": [
            {
              "type": 0,
              "mintedTokens": "string",
              "meltedTokens": "string",
              "maxSupply": "string"
            }
          ],
          "unlockConditions": [
            {
              "type": 0,
              "address": {
                "type": 0,
                "aliasId": "string"
              }
            }
          ],
          "features": [
            {
              "type": 0,
              "data": "string"
            }
          ],
          "immutableFeatures": [
            {
              "type": 0,
              "data": "string"
            }
          ]
        },
        {
          "type": 0,
          "amount": "string",
          "nativeTokens": [
            {
              "id": "string",
              "amount": "string"
            }
          ],
          "nftId": "string",
          "unlockConditions": [
            {
              "type": 0,
              "address": {
                "type": 0,
                "pubKeyHash": "string"
              }
            },
            {
              "type": 0,
              "returnAddress": {
                "type": 0,
                "pubKeyHash": "string"
              },
              "returnAmount": "string"
            },
            {
              "type": 0,
              "unixTime": 0
            },
            {
              "type": 0,
              "returnAddress": {
                "type": 0,
                "pubKeyHash": "string"
              },
              "unixTime": 0
            }
          ],
          "features": [
            {
              "type": 0,
              "address": {
                "type": 0,
                "pubKeyHash": "string"
              }
            },
            {
              "type": 0,
              "address": {
                "type": 0,
                "pubKeyHash": "string"
              }
            },
            {
              "type": 0,
              "data": "string"
            },
            {
              "type": 0,
              "tag": "string"
            }
          ],
          "immutableFeatures": [
            {
              "type": 0,
              "address": {
                "type": 0,
                "pubKeyHash": "string"
              }
            },
            {
              "type": 0,
              "data": "string"
            }
          ]
        }
      ],
      "payload": {
        "type": 0,
        "tag": "string",
        "data": "string"
      }
    },
    "unlocks": [
      {
        "type": 0,
        "signature": {
          "type": 0,
          "publicKey": "string",
          "signature": "string"
        }
      },
      {
        "type": 0,
        "reference": 0
      },
      {
        "type": 0,
        "reference": 0
      },
      {
        "type": 0,
        "reference": 0
      }
    ]
  },
  "nonce": "string"
}'

Request Collapse all

Base URL

http://127.0.0.1:14265

Body required

Content-Type

application/jsonapplication/vnd.iota.serializer-v1

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

{
  "protocolVersion": 0,
  "parents": [
    "string"
  ],
  "payload": {
    "type": 0,
    "essence": {
      "type": 0,
      "networkId": "string",
      "inputsCommitment": "string",
      "inputs": [
        {
          "type": 0,
          "transactionId": "string",
          "transactionOutputIndex": 0
        }
      ],
      "outputs": [
        {
          "type": 0,
          "amount": "string",
          "nativeTokens": [
            {
              "id": "string",
              "amount": "string"
            }
          ],
          "unlockConditions": [
            {
              "type": 0,
              "address": {
                "type": 0,
                "pubKeyHash": "string"
              }
            },
            {
              "type": 0,
              "returnAddress": {
                "type": 0,
                "pubKeyHash": "string"
              },
              "returnAmount": "string"
            },
            {
              "type": 0,
              "unixTime": 0
            },
            {
              "type": 0,
              "returnAddress": {
                "type": 0,
                "pubKeyHash": "string"
              },
              "unixTime": 0
            }
          ],
          "features": [
            {
              "type": 0,
              "address": {
                "type": 0,
                "pubKeyHash": "string"
              }
            },
            {
              "type": 0,
              "data": "string"
            },
            {
              "type": 0,
              "tag": "string"
            }
          ]
        },
        {
          "type": 0,
          "amount": "string",
          "nativeTokens": [
            {
              "id": "string",
              "amount": "string"
            }
          ],
          "aliasId": "string",
          "stateIndex": 0,
          "stateMetadata": "string",
          "foundryCounter": 0,
          "unlockConditions": [
            {
              "type": 0,
              "address": {
                "type": 0,
                "pubKeyHash": "string"
              }
            },
            {
              "type": 0,
              "address": {
                "type": 0,
                "pubKeyHash": "string"
              }
            }
          ],
          "features": [
            {
              "type": 0,
              "address": {
                "type": 0,
                "pubKeyHash": "string"
              }
            },
            {
              "type": 0,
              "data": "string"
            }
          ],
          "immutableFeatures": [
            {
              "type": 0,
              "address": {
                "type": 0,
                "pubKeyHash": "string"
              }
            },
            {
              "type": 0,
              "data": "string"
            }
          ]
        },
        {
          "type": 0,
          "amount": "string",
          "nativeTokens": [
            {
              "id": "string",
              "amount": "string"
            }
          ],
          "serialNumber": 0,
          "tokenScheme": [
            {
              "type": 0,
              "mintedTokens": "string",
              "meltedTokens": "string",
              "maxSupply": "string"
            }
          ],
          "unlockConditions": [
            {
              "type": 0,
              "address": {
                "type": 0,
                "aliasId": "string"
              }
            }
          ],
          "features": [
            {
              "type": 0,
              "data": "string"
            }
          ],
          "immutableFeatures": [
            {
              "type": 0,
              "data": "string"
            }
          ]
        },
        {
          "type": 0,
          "amount": "string",
          "nativeTokens": [
            {
              "id": "string",
              "amount": "string"
            }
          ],
          "nftId": "string",
          "unlockConditions": [
            {
              "type": 0,
              "address": {
                "type": 0,
                "pubKeyHash": "string"
              }
            },
            {
              "type": 0,
              "returnAddress": {
                "type": 0,
                "pubKeyHash": "string"
              },
              "returnAmount": "string"
            },
            {
              "type": 0,
              "unixTime": 0
            },
            {
              "type": 0,
              "returnAddress": {
                "type": 0,
                "pubKeyHash": "string"
              },
              "unixTime": 0
            }
          ],
          "features": [
            {
              "type": 0,
              "address": {
                "type": 0,
                "pubKeyHash": "string"
              }
            },
            {
              "type": 0,
              "address": {
                "type": 0,
                "pubKeyHash": "string"
              }
            },
            {
              "type": 0,
              "data": "string"
            },
            {
              "type": 0,
              "tag": "string"
            }
          ],
          "immutableFeatures": [
            {
              "type": 0,
              "address": {
                "type": 0,
                "pubKeyHash": "string"
              }
            },
            {
              "type": 0,
              "data": "string"
            }
          ]
        }
      ],
      "payload": {
        "type": 0,
        "tag": "string",
        "data": "string"
      }
    },
    "unlocks": [
      {
        "type": 0,
        "signature": {
          "type": 0,
          "publicKey": "string",
          "signature": "string"
        }
      },
      {
        "type": 0,
        "reference": 0
      },
      {
        "type": 0,
        "reference": 0
      },
      {
        "type": 0,
        "reference": 0
      }
    ]
  },
  "nonce": "string"
}

ResponseClear

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