Events

[INDEXER] Get a range of BlockEvents

post

/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 Ada-Index implementations are not required to complete it to adhere to the Ada-Index spec. However, any Ada-Index "indexer" MUST support this endpoint.

Authorizations
Body

EventsBlocksRequest is utilized to fetch a sequence of BlockEvents indicating which blocks were added and removed from storage to reach the current state.

offsetinteger · int64Optional

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.

Example: 5
limitinteger · int64Optional

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

Example: 5
Responses
200
Expected response to a valid request
application/json
post
POST /events/blocks HTTP/1.1
Host: ada-index.nownodes.io
api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 204

{
  "network_identifier": {
    "blockchain": "cardano",
    "network": "mainnet",
    "sub_network_identifier": {
      "network": "shard 1",
      "metadata": {
        "producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
      }
    }
  },
  "offset": 5,
  "limit": 5
}
{
  "max_sequence": 5,
  "events": [
    {
      "sequence": 5,
      "block_identifier": {
        "index": 1123941,
        "hash": "0x1f2cc6c5027d2f201a5453ad1119574d2aed23a392654742ac3c78783c071f85"
      },
      "type": "block_added"
    }
  ]
}
PreviousConstructionNextSearch