Look up a commitment by a given commitment ID.

GET 
/api/core/v3/commitments/:commitmentId

Look up a commitment by a given commitment ID.

Request

Path Parameters

commitmentId stringrequired
Commitment ID of the commitment to look up.
Example: 0x7a09324557e9200f39bf493fc8fd6ac43e9ca750c6f6d884cc72386ddcb7d695

Responses

200

Successful operation.

application/json

Schema

Schema

protocolVersion integerrequired

The version of the protocol running.

slot integerrequired

The slot index of the commitment.

previousCommitmentId stringrequired

The commitment identifier of the previous slot.

rootsId stringrequired

The digest of multiple merkle roots within this slot.

cumulativeWeight stringrequired

The sum of previous slot commitment cumulative weight and weight of issuers of accepted blocks within index minus Maximum Committable Age. It indicates the weight of the chain at index minus Maximum Committable Age committed at index slot.

referenceManaCost stringrequired

This field provides the Reference Mana Cost (RMC) to be used in the slot with index Index + Max Committable Age.

Example (from schema)

{
  "protocolVersion": 0,
  "slot": 0,
  "previousCommitmentId": "string",
  "rootsId": "string",
  "cumulativeWeight": "string",
  "referenceManaCost": "string"
}

default

{
  "protocolVersion": 3,
  "slot": 986,
  "previousCommitmentId": "0xd91549dbf441da4c7e50063b58c05d5b2bfb1d33b346a2f9a18220ce6207f7a289010000",
  "rootsId": "0x6a8f424929e1f08d87a204efc8a60499b789465aaa28178b77debe75cc2915d3",
  "cumulativeWeight": "78901",
  "referenceManaCost": "600"
}

application/vnd.iota.serializer-v2

Schema

Schema

string binary

Commitment in raw binary format

default

0312000000075b05e0a8fd4b9c7e7bc165b62c48945292f7d76d23f76525f886c416dc0e364089b57c32ddb8c614ed1d2c844401d2a5325b4d153c7f94464bbda3a8d14289b203f96759000000000000009000000000000000

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