List events

POST

https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/ListEvents

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

List events matching the provided filters.

Events are returned in ascending or descending packed event sequence order according to the query options ordering.

gRPC method: sui.rpc.v2.LedgerService.ListEvents (server-streaming).

This is a gRPC method (HTTP/2, Protocol Buffers), not a REST endpoint. The request and response bodies below are shown in the proto3 JSON form that tools such as grpcurl and Postman accept and print. Pass your NOWNodes API key as the api-key gRPC metadata header. Proto files: sui/rpc/v2/ledger_service.proto.

This method is server-streaming: the server keeps the call open and sends a sequence of response messages; each message has the response schema below.

Example grpcurl request:

Copied!

grpcurl \
  -insecure \
  -H 'api-key: YOUR_API_KEY' \
  -emit-defaults \
  -proto './sui-apis-grpc/proto/sui/rpc/v2/ledger_service.proto' \
  -import-path './sui-apis-grpc/proto' \
  -d '{"startCheckpoint": "1000", "endCheckpoint": "1010", "options": {"limit": 10}}' \
  'sui-grpc.nownodes.io' \
  sui.rpc.v2.LedgerService.ListEvents

Body

application/json

Request message for LedgerService.ListEvents.

readMaskobject

Optional. Mask for specifying which parts of the Event should be returned. Read mask: list of field paths to return, in snake_case (e.g. "object_id", "version", "digest"). Nested fields use dots (e.g. "effects.status").

Show child attributes

pathsArray<string>required

Field paths to return.

startCheckpointstring<uint64>

Optional. Start of the checkpoint range to query (inclusive). Defaults to genesis.

endCheckpointstring<uint64>

Optional. End of the checkpoint range to query (exclusive). Defaults to the current indexed ledger tip.

filterEventFilter

Optional. DNF filter over indexed dimensions. If absent, all events in the range are returned.

optionsQueryOptions

Optional cursor-bounded query options. If unspecified, reads in ascending order with the default item limit. The server enforces a maximum item limit and silently coerces larger values down to it. To paginate, pass the last received Watermark.cursor as options.after (ascending) or options.before (descending) on the next request.

Response

200OK

Stream of response messages.

default

gRPC error. The status code (e.g. UNAUTHENTICATED, INVALID_ARGUMENT, NOT_FOUND) is returned in the grpc-status trailer, details in grpc-message.

List events

curl -X POST 'https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/ListEvents' \
  -H 'Content-Type: application/json' \
  -d '{
    "readMask": {
      "paths": [
        "string"
      ]
    },
    "startCheckpoint": "string",
    "endCheckpoint": "string",
    "filter": {
      "terms": [
        {
          "literals": [
            {
              "negated": true,
              "sender": {
                "address": "string"
              },
              "emitModule": {
                "module": "string"
              },
              "eventType": {
                "eventType": "string"
              },
              "eventStreamHead": {
                "streamId": "string"
              }
            }
          ]
        }
      ]
    },
    "options": {
      "limit": 0,
      "after": "dGVzdA==",
      "before": "dGVzdA==",
      "ordering": "ORDERING_ASCENDING"
    }
  }'

const response = await fetch('https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/ListEvents', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "readMask": {
        "paths": [
          "string"
        ]
      },
      "startCheckpoint": "string",
      "endCheckpoint": "string",
      "filter": {
        "terms": [
          {
            "literals": [
              {
                "negated": true,
                "sender": {
                  "address": "string"
                },
                "emitModule": {
                  "module": "string"
                },
                "eventType": {
                  "eventType": "string"
                },
                "eventStreamHead": {
                  "streamId": "string"
                }
              }
            ]
          }
        ]
      },
      "options": {
        "limit": 0,
        "after": "dGVzdA==",
        "before": "dGVzdA==",
        "ordering": "ORDERING_ASCENDING"
      }
    }),
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/ListEvents')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "readMask": {
      "paths": [
        "string"
      ]
    },
    "startCheckpoint": "string",
    "endCheckpoint": "string",
    "filter": {
      "terms": [
        {
          "literals": [
            {
              "negated": true,
              "sender": {
                "address": "string"
              },
              "emitModule": {
                "module": "string"
              },
              "eventType": {
                "eventType": "string"
              },
              "eventStreamHead": {
                "streamId": "string"
              }
            }
          ]
        }
      ]
    },
    "options": {
      "limit": 0,
      "after": "dGVzdA==",
      "before": "dGVzdA==",
      "ordering": "ORDERING_ASCENDING"
    }
  }'

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

import requests

payload = {
  "readMask": {
    "paths": [
      "string"
    ]
  },
  "startCheckpoint": "string",
  "endCheckpoint": "string",
  "filter": {
    "terms": [
      {
        "literals": [
          {
            "negated": True,
            "sender": {
              "address": "string"
            },
            "emitModule": {
              "module": "string"
            },
            "eventType": {
              "eventType": "string"
            },
            "eventStreamHead": {
              "streamId": "string"
            }
          }
        ]
      }
    ]
  },
  "options": {
    "limit": 0,
    "after": "dGVzdA==",
    "before": "dGVzdA==",
    "ordering": "ORDERING_ASCENDING"
  }
}

response = requests.post('https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/ListEvents', json=payload)
data = response.json()

const response = await fetch('https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/ListEvents', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "readMask": {
        "paths": [
          "string"
        ]
      },
      "startCheckpoint": "string",
      "endCheckpoint": "string",
      "filter": {
        "terms": [
          {
            "literals": [
              {
                "negated": true,
                "sender": {
                  "address": "string"
                },
                "emitModule": {
                  "module": "string"
                },
                "eventType": {
                  "eventType": "string"
                },
                "eventStreamHead": {
                  "streamId": "string"
                }
              }
            ]
          }
        ]
      },
      "options": {
        "limit": 0,
        "after": "dGVzdA==",
        "before": "dGVzdA==",
        "ordering": "ORDERING_ASCENDING"
      }
    }),
});

const data = await response.json();

const endpoint = "https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/ListEvents";
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({
    "readMask": {
      "paths": [
        "string"
      ]
    },
    "startCheckpoint": "string",
    "endCheckpoint": "string",
    "filter": {
      "terms": [
        {
          "literals": [
            {
              "negated": true,
              "sender": {
                "address": "string"
              },
              "emitModule": {
                "module": "string"
              },
              "eventType": {
                "eventType": "string"
              },
              "eventStreamHead": {
                "streamId": "string"
              }
            }
          ]
        }
      ]
    },
    "options": {
      "limit": 0,
      "after": "dGVzdA==",
      "before": "dGVzdA==",
      "ordering": "ORDERING_ASCENDING"
    }
  });
console.log(result);

const response = await fetch('https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/ListEvents', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
      "readMask": {
        "paths": [
          "string"
        ]
      },
      "startCheckpoint": "string",
      "endCheckpoint": "string",
      "filter": {
        "terms": [
          {
            "literals": [
              {
                "negated": true,
                "sender": {
                  "address": "string"
                },
                "emitModule": {
                  "module": "string"
                },
                "eventType": {
                  "eventType": "string"
                },
                "eventStreamHead": {
                  "streamId": "string"
                }
              }
            ]
          }
        ]
      },
      "options": {
        "limit": 0,
        "after": "dGVzdA==",
        "before": "dGVzdA==",
        "ordering": "ORDERING_ASCENDING"
      }
    }),
});

const data = await response.json();

import requests

payload = {
  "readMask": {
    "paths": [
      "string"
    ]
  },
  "startCheckpoint": "string",
  "endCheckpoint": "string",
  "filter": {
    "terms": [
      {
        "literals": [
          {
            "negated": True,
            "sender": {
              "address": "string"
            },
            "emitModule": {
              "module": "string"
            },
            "eventType": {
              "eventType": "string"
            },
            "eventStreamHead": {
              "streamId": "string"
            }
          }
        ]
      }
    ]
  },
  "options": {
    "limit": 0,
    "after": "dGVzdA==",
    "before": "dGVzdA==",
    "ordering": "ORDERING_ASCENDING"
  }
}

response = requests.post('https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/ListEvents', json=payload)
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://sui-grpc.nownodes.io/sui.rpc.v2.LedgerService/ListEvents')
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request.body = '{
    "readMask": {
      "paths": [
        "string"
      ]
    },
    "startCheckpoint": "string",
    "endCheckpoint": "string",
    "filter": {
      "terms": [
        {
          "literals": [
            {
              "negated": true,
              "sender": {
                "address": "string"
              },
              "emitModule": {
                "module": "string"
              },
              "eventType": {
                "eventType": "string"
              },
              "eventStreamHead": {
                "streamId": "string"
              }
            }
          ]
        }
      ]
    },
    "options": {
      "limit": 0,
      "after": "dGVzdA==",
      "before": "dGVzdA==",
      "ordering": "ORDERING_ASCENDING"
    }
  }'

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

Request Body

{
  "startCheckpoint": "1000",
  "endCheckpoint": "1010",
  "options": {
    "limit": 10
  }
}

200

{
  "event": {
    "packageId": "string",
    "module": "string",
    "sender": "string",
    "eventType": "string",
    "contents": {
      "name": "string",
      "value": "dGVzdA=="
    },
    "checkpoint": "string",
    "transactionDigest": "string",
    "transactionIndex": "string",
    "eventIndex": 0
  },
  "watermark": {
    "cursor": "dGVzdA==",
    "checkpoint": "string"
  },
  "end": {
    "reason": "QUERY_END_REASON_UNKNOWN"
  }
}