NOnodereal
Events

Get events by event key

This endpoint allows you to get a list of events of a specific type as identified by its event key, which is a globally unique ID.

get/events/{event_key}

Request

  • Base URL
    aptos-mainnet.nodereal.io/v1/{api_key}/v1 (relative, and the document’s source URL is not known)
  • URL
    aptos-mainnet.nodereal.io/v1/{api_key}/v1/events/{event_key}
  • Auth
    none declared

Path parameters

event_keystring hex required

Event key is a global index for an event stream.

It is hex-encoded BCS bytes of EventHandle guid field value, which is a combination of a uint64 creation number and account address (without trimming leading zeros).

For example, event key 0x000000000000000088fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 is combined by the following 2 parts:

  1. 0000000000000000: uint64 representation of 0.
  2. 88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1: 32 bytes of account address.
Example:0x000000000000000088fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

Event key to retrieve events by

Query parameters

startstring uint64

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

Example:32425224034

Starting sequence number of events.

If unspecified, by default will retrieve the most recent events

limitinteger

Max number of events to retrieve.

If unspecified, defaults to default page size

Response

versionstring uint64 required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

keystring hex required

Event key is a global index for an event stream.

It is hex-encoded BCS bytes of EventHandle guid field value, which is a combination of a uint64 creation number and account address (without trimming leading zeros).

For example, event key 0x000000000000000088fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 is combined by the following 2 parts:

  1. 0000000000000000: uint64 representation of 0.
  2. 88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1: 32 bytes of account address.
sequence_numberstring uint64 required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively.

typestring required

String representation of an on-chain Move type tag that is exposed in transaction payload. Values: - bool - u8 - u64 - u128 - address - signer - vector: vector<{non-reference MoveTypeId}> - struct: {address}::{module_name}::{struct_name}::<{generic types}>

Vector type value examples:
  - `vector<u8>`
  - `vector<vector<u64>>`
  - `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`

Struct type value examples:
  - `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
  - `0x1::account::Account`

Note:
  1. Empty chars should be ignored when comparing 2 struct tag ids.
  2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).
dataunknown required

Example response

[
  {
    "version": "32425224034",
    "key": "0x000000000000000088fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 ",
    "guid": {
      "creation_number": "32425224034",
      "account_address": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "
    },
    "sequence_number": "32425224034"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.