Sign in

v1

latestOpenAPI 3.1.02026-07-243035381.4 MB
Cardano - Rosetta

getEventsBlocks

/events/blocks allows the caller to query a sequence of BlockEvents indicating which blocks were added and removed from storage to reach the current state. Following BlockEvents allows lightweight clients to update their state without needing to implement their own syncing logic (like finding the common parent in a reorg).

/events/blocks is considered an "indexer" endpoint and Rosetta implementations are not required to complete it to adhere to the Rosetta spec. However, any Rosetta "indexer" MUST support this endpoint.

post/events/blocks

Request body

offsetinteger

offset is the offset into the event stream to sync events from. If this field is not populated, we return the limit events backwards from tip. If this is set to 0, we start from the beginning.

limitinteger

limit is the maximum number of events to fetch in one call. The implementation may return <= limit events.

Example request

{
  "network_identifier": {
    "blockchain": "bitcoin",
    "network": "mainnet",
    "sub_network_identifier": {
      "network": "shard 1",
      "metadata": {
        "producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
      }
    }
  },
  "offset": 5,
  "limit": 5
}

Response

Expected response to a valid request

max_sequenceinteger required

max_sequence is the maximum available sequence number to fetch.

Example response

{
  "max_sequence": 5,
  "events": [
    {
      "sequence": 5,
      "block_identifier": {
        "index": 1123941,
        "hash": "0x1f2cc6c5027d2f201a5453ad1119574d2aed23a392654742ac3c78783c071f85"
      }
    }
  ]
}