Look up a milestone by a given milestone index.

GET 
/api/core/v2/milestones/by-index/:index

Look up a milestone by a given milestone index.

Request

Path Parameters

index numberrequired
Index of the milestone to look up.
Example: 154862

Responses

200

Successful operation.

application/json

Schema

Schema

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

Example (from schema)

{
  "type": 0,
  "index": 0,
  "timestamp": 0,
  "protocolVersion": 0,
  "previousMilestoneId": "string",
  "parents": [
    "string"
  ],
  "inclusionMerkleRoot": "string",
  "appliedMerkleRoot": "string",
  "options": [
    null,
    null
  ],
  "metadata": "string",
  "signatures": [
    null
  ]
}

default

{
  "type": 7,
  "index": 15465,
  "timestamp": 1602227215,
  "protocolVersion": 2,
  "previousMilestoneId": "0x7ad3d67fc7b619e72e588f51fef2379e43e6e9a856635843b3f29aa3a3f1f006",
  "parents": [
    "0x7ed3d67fc7b619e72e588f51fef2379e43e6e9a856635843b3f29aa3a3f1f006",
    "0x7a09324557e9200f39bf493fc8fd6ac43e9ca750c6f6d884cc72386ddcb7d695",
    "0xde9e9d780ba7ebeebc38da16cb53b2a8991d38eee94bcdc3f3ef99aa8c345652"
  ],
  "inclusionMerkleRoot": "0xa18996d96163405e3c0eb13fa3459a07f68a89e8cf7cc239c89e7192344daa5b",
  "appliedMerkleRoot": "0xee26ac07834c603c22130fced361ca58552b0dbfc63e4b73ba24b3b59d9f4050",
  "options": [
    {
      "type": 1,
      "targetMilestoneIndex": 15468,
      "protocolVersion": 3,
      "params": "0x27d0ca22753f76ef32d1e9e8fcc417aa9fc1c15eae854661e0253287be6ea68f649493fc8fd6ac43e9ca750c6f6d884cc72386ddcb7d6"
    }
  ],
  "metadata": "0xd6ac43e9ca750",
  "signatures": [
    {
      "type": 0,
      "publickKey": "0xee26ac07834c603c22130fced361ca58552b0dbfc63e4b73ba24b3b59d9f4050",
      "signature": "0x0492a353f96883c472e2686a640e77eda30be8fcc417aa9fc1c15eae854661e0253287be6ea68f649f19ca590de0a6c57fb88635ef0e013310e0be2b83609503"
    }
  ]
}

application/vnd.iota.serializer-v1

Schema

Schema

string

default

070000000a1a0000977c626276b19ef8b3c445709f2f0f2ccc4abb98d97617f421f240c0d1ee066d4306e67a0321889ef8ec89b7eff1378049e058f0fa87a78c2452ae72631a5a99d913d1cbb3525b8faa1800e28dfcb28154bcba10154c39ef87ceda793cb44f58ae1549c88ea13fe4a9695bb6f0aba6cb756522209e5066a96039ae12b398b975693bdc21e222997c86ff9bfc5844f0372d58ff6fa510688e53c181bbdf4db41f9b627540a70e5751c026e543b2e8ab2eb06099daa1d1e5df47778f7787faab45cdf12fe3a80000000300d85e5b1590d898d1e0cdebb2e3b5337c8b76270142663d78811683ba47c17c989ad7a8f0ff2c6438bf435786d4a5b0125a5caf7367061b49a739389d5ebea234c0466c86f88a3f8add03bff04c2e34b214683f2f6983641e1d1185da7e2c3e0200d9922819a39e94ddf3907f4b9c8df93f39f026244fcb609205b9a879022599f218be2536d8b7b8547faa3dbdfe98339ebe9e2b2417a8a03eee02b2a8312b9e026dd0a33261a58a240cd0a1b06cdf1775d98d316f162d3eec402f4bf08bea2a0700f9d9656a60049083eef61487632187b351294c1fa23d118060d813db6d03e8b6ca8180d435708e826bc2042ccd667babb59c5cc461ff29dba966359fcd6fc511cdfdf10d6576f36ac2a6e5cb691e13968c13947ffbd9239939d3802b2fbe0f06

400

Unsuccessful operation: indicates that the provided data is invalid.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 400,
    "message": "invalid data provided"
  }
}

403

Unsuccessful operation: indicates that the endpoint is not available for public use.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 403,
    "message": "not available for public use"
  }
}

404

Unsuccessful operation: indicates that the requested data was not found.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 404,
    "message": "could not find data"
  }
}

500

Unsuccessful operation: indicates that an unexpected, internal server error happened which prevented the node from fulfilling the request.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 500,
    "message": "internal server error"
  }
}

Loading...