Skip to main content
GET
/
v1
/
events
Error
A valid request URL is required to generate request examples
{
  "events": [
    {
      "eventId": "<string>",
      "transactionSignature": {
        "value": "aSDinaTvuI8gbWludGxpZnk="
      },
      "program": {
        "value": "aSDinaTvuI8gbWludGxpZnk="
      },
      "payload": "aSDinaTvuI8gbWludGxpZnk=",
      "slot": "<string>",
      "callIdx": 123,
      "programIdx": 123,
      "payloadSize": 123,
      "blockOffset": 123,
      "timestamp": "2023-11-07T05:31:56Z"
    }
  ],
  "page": {
    "nextPageToken": "<string>",
    "totalSize": "<string>"
  }
}

Query Parameters

​
filter.expression
string

CEL expression applied server-side. Empty expressions are treated as no-op.

​
page.pageSize
integer<int64>

Maximum number of items to return in a single response.

​
page.pageToken
string

Token identifying the position to resume from.

​
page.orderBy
string

Optional ordering specification in "field [asc|desc]" form.

​
versionContext.slot
string<uint64>

Request the version for a specific slot number.

​
versionContext.timestamp
string<date-time>

Request the version nearest to the provided block timestamp.

​
versionContext.seq
string<uint64>

Request the version for a specific seq number. Relevant only for GetAccount and GetRawAccount requests.

​
minConsensus
enum<string>
default:CONSENSUS_STATUS_UNSPECIFIED
  • CONSENSUS_STATUS_UNSPECIFIED: CONSENSUS_STATUS_UNSPECIFIED indicates the consensus status is unknown.
  • CONSENSUS_STATUS_OBSERVED: CONSENSUS_STATUS_OBSERVED indicates the resource has been observed but not yet confirmed in a finalized block.
  • CONSENSUS_STATUS_INCLUDED: CONSENSUS_STATUS_INCLUDED indicates the resource has been included in the ledger but may not be finalized.
  • CONSENSUS_STATUS_FINALIZED: CONSENSUS_STATUS_FINALIZED indicates the resource is finalized for a slot.
  • CONSENSUS_STATUS_LOCALLY_EXECUTED: CONSENSUS_STATUS_LOCALLY_EXECUTED indicates the local node executed the resource but broader cluster finality may not have been achieved.
  • CONSENSUS_STATUS_CLUSTER_EXECUTED: CONSENSUS_STATUS_CLUSTER_EXECUTED indicates the entire cluster has executed and agreed on the resource.
Available options:
CONSENSUS_STATUS_UNSPECIFIED,
CONSENSUS_STATUS_OBSERVED,
CONSENSUS_STATUS_INCLUDED,
CONSENSUS_STATUS_FINALIZED,
CONSENSUS_STATUS_LOCALLY_EXECUTED,
CONSENSUS_STATUS_CLUSTER_EXECUTED

Response

A successful response.

ListEventsResponse returns paginated events.

​
events
object[]
​
page
object

PageResponse captures pagination metadata returned with list results.