[INDEXER] Get a range of BlockEvents

POST

https://ada.nownodes.io/events/blocks

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

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

Body

application/json

Request value.

network_identifierNetworkIdentifierrequired

Rosetta network identifier object.

Show child attributes

blockchainstringrequired

Blockchain value.

networkstringrequired

If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet, preprod, or preview.

sub_network_identifierSubNetworkIdentifier

Sub Network Identifier value.

Show child attributes

networkstringrequired

Network value.

metadataobject

Additional metadata object.

offsetinteger<int64>>= 0

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<int64>>= 0

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

Response

200OK

HTTP 200 response for eventsBlocks.

400Bad Request

Bad Request. The request is malformed or contains invalid parameters.

401Unauthorized

Unauthorized: API key is present but rejected by the NOWNodes gateway.

422Unprocessable Entity

Missing API key. The NOWNodes gateway returns plain text for this error.

500Internal Server Error

Internal Server Error. The gateway or backend failed while processing the request.

[INDEXER] Get a range of BlockEvents

curl -X POST 'https://ada.nownodes.io/events/blocks' \
  -H 'Content-Type: application/json' \
  -d '{
    "network_identifier": {
      "blockchain": "cardano",
      "network": "mainnet",
      "sub_network_identifier": {
        "network": "shard 1",
        "metadata": {
          "producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
        }
      }
    },
    "offset": 5,
    "limit": 5
  }'

const response = await fetch('https://ada.nownodes.io/events/blocks', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network_identifier": {
        "blockchain": "cardano",
        "network": "mainnet",
        "sub_network_identifier": {
          "network": "shard 1",
          "metadata": {
            "producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
          }
        }
      },
      "offset": 5,
      "limit": 5
    }),
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://ada.nownodes.io/events/blocks')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "network_identifier": {
      "blockchain": "cardano",
      "network": "mainnet",
      "sub_network_identifier": {
        "network": "shard 1",
        "metadata": {
          "producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
        }
      }
    },
    "offset": 5,
    "limit": 5
  }'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

import requests

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

response = requests.post('https://ada.nownodes.io/events/blocks', json=payload)
data = response.json()

const response = await fetch('https://ada.nownodes.io/events/blocks', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network_identifier": {
        "blockchain": "cardano",
        "network": "mainnet",
        "sub_network_identifier": {
          "network": "shard 1",
          "metadata": {
            "producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
          }
        }
      },
      "offset": 5,
      "limit": 5
    }),
});

const data = await response.json();

const endpoint = "https://ada.nownodes.io/events/blocks";
const apiKey = "YOUR_API_KEY";

async function nownodesRequest(payload) {
  const response = await fetch(endpoint, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "api-key": apiKey,
    },
    body: JSON.stringify(payload),
  });

  return response.json();
}

const result = await nownodesRequest({
    "network_identifier": {
      "blockchain": "cardano",
      "network": "mainnet",
      "sub_network_identifier": {
        "network": "shard 1",
        "metadata": {
          "producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
        }
      }
    },
    "offset": 5,
    "limit": 5
  });
console.log(result);

const response = await fetch('https://ada.nownodes.io/events/blocks', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "network_identifier": {
        "blockchain": "cardano",
        "network": "mainnet",
        "sub_network_identifier": {
          "network": "shard 1",
          "metadata": {
            "producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
          }
        }
      },
      "offset": 5,
      "limit": 5
    }),
});

const data = await response.json();

import requests

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

response = requests.post('https://ada.nownodes.io/events/blocks', json=payload)
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://ada.nownodes.io/events/blocks')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "network_identifier": {
      "blockchain": "cardano",
      "network": "mainnet",
      "sub_network_identifier": {
        "network": "shard 1",
        "metadata": {
          "producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
        }
      }
    },
    "offset": 5,
    "limit": 5
  }'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

Request Body

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

{
  "max_sequence": 13646894,
  "events": [
    {
      "sequence": 13646894,
      "block_identifier": {
        "index": 13646894,
        "hash": "9945cd69ca8e6bcf2e5f9a14742be0c051bf9dd916f0bb0b00ab39977b140d53"
      },
      "type": "block_added"
    }
  ]
}

{
  "code": 4000,
  "message": "Invalid request",
  "retriable": false
}

{
  "status_code": 400,
  "message": "Bad Request",
  "error": "bad_request"
}

Unknown API_key

Missing API_key

{
  "status_code": 500,
  "message": "Internal Server Error",
  "error": "internal_server_error"
}