starknet_getEvents

Returns all events matching the given filter

Returns all event objects matching the conditions in the provided filter

Parameters

Parameter	Type	Description
filter	object	Event filter with from_block, to_block, address, keys, and chunk_size

Request

{
  "jsonrpc": "2.0",
  "method": "starknet_getEvents",
  "params": [
    {
      "chunk_size": 1,
      "from_block": {
        "block_hash": "0x05abbad1e5"
      },
      "to_block": {
        "block_hash": "0x05abbad1e5"
      },
      "address": "0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
      "keys": [
        [
          "0x1"
        ]
      ]
    }
  ],
  "id": 1
}

Returns

All the event objects matching the filter

Events chunk with matching events and continuation token

Errors

Code	Message
31	Requested page size is too big
33	The supplied continuation token is invalid or unknown
24	Block not found
34	Too many keys provided in a filter

Examples

cURL

curl -X POST https://api-starknet-mainnet.n.dwellir.com/YOUR_API_KEY \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "method": "starknet_getEvents",
    "params": [
      {
        "chunk_size": 1,
        "from_block": {
          "block_hash": "0x05abbad1e5"
        },
        "to_block": {
          "block_hash": "0x05abbad1e5"
        },
        "address": "0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
        "keys": [
          [
            "0x1"
          ]
        ]
      }
    ],
    "id": 1
  }'

JavaScript

import { RpcProvider } from 'starknet';

const provider = new RpcProvider({
  nodeUrl: 'https://api-starknet-mainnet.n.dwellir.com/YOUR_API_KEY',
});

const payload = {
  method: 'starknet_getEvents',
  params: [
    {
      "chunk_size": 1,
      "from_block": {
        "block_hash": "0x05abbad1e5"
      },
      "to_block": {
        "block_hash": "0x05abbad1e5"
      },
      "address": "0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
      "keys": [
        [
          "0x1"
        ]
      ]
    }
  ]
};

const result = await provider.fetchEndpoint(payload.method, payload.params);
console.log(result);