1 of 3

Events

Get Events by Creation Number

Event types are globally identifiable by an account address and monotonically increasing creation_number. This API returns events corresponding to that event type.

This method will use 30 Compute Units.

Get Events by Event Handle

This endpoint returns events emitted to the account matching a given event type.

This method will use 30 Compute Units.

Get Events by Event Handle

This endpoint returns events emitted to the account matching a given event type.

This method will use 30 Compute Units.

Get events by event handle

This API uses the given account address, eventHandle, and fieldName to build a key that can globally identify an event types. It then uses this key to return events emitted to the given account matching that event type.

GEThttps://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1/accounts/{address}/events/{event_handle}/{field_name}

Path parameters

address*Address (string (hex))

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "

event_handle*MoveStructTag (string)

String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.

It is a combination of:

move_module_address, module_name and struct_name, all joined by ::
struct generic type parameters joined by ,

Examples:

0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
0x1::account::Account

Note:

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

See doc for more details.

Example: "0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>"

Pattern: ^0x[0-9a-zA-Z:_<>]+$

field_name*IdentifierWrapper (string)

Name of field to lookup event handle e.g. withdraw_events

Query parameters

startU64 (string (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"

limitinteger (uint16)

Max number of events to retrieve.

If unspecified, defaults to default page size

Response

Headers

X-APTOS-CHAIN-ID*integer (uint8)

X-APTOS-LEDGER-VERSION*integer (uint64)

X-APTOS-LEDGER-OLDEST-VERSION*integer (uint64)

X-APTOS-LEDGER-TIMESTAMPUSEC*integer (uint64)

X-APTOS-EPOCH*integer (uint64)

X-APTOS-BLOCK-HEIGHT*integer (uint64)

X-APTOS-OLDEST-BLOCK-HEIGHT*integer (uint64)

X-APTOS-CURSORstring

Body

version*U64 (string (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"

guid*EventGuid (object)

creation_number*U64 (string (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"

account_address*Address (string (hex))

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "

sequence_number*U64 (string (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"

type*MoveType (string)

String representation of an on-chain Move type tag that is exposed in transaction payload. Values: - bool - u8 - u16 - u32 - u64 - u128 - u256 - 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).

data*any

The JSON representation of the event

Request

Response

Get Events by Creation Number

Event types are globally identifiable by an account address and monotonically increasing creation_number. This API returns events corresponding to that event type.

This method will use 30 Compute Units.

Get events by creation number

Event types are globally identifiable by an account address and monotonically increasing creation_number, one per event type emitted to the given account. This API returns events corresponding to that that event type.

GEThttps://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1/accounts/{address}/events/{creation_number}

Path parameters

address*Address (string (hex))

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "

creation_number*U64 (string (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"

Query parameters

startU64 (string (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"

limitinteger (uint16)

Max number of events to retrieve.

If unspecified, defaults to default page size

Response

Headers

X-APTOS-CHAIN-ID*integer (uint8)

X-APTOS-LEDGER-VERSION*integer (uint64)

X-APTOS-LEDGER-OLDEST-VERSION*integer (uint64)

X-APTOS-LEDGER-TIMESTAMPUSEC*integer (uint64)

X-APTOS-EPOCH*integer (uint64)

X-APTOS-BLOCK-HEIGHT*integer (uint64)

X-APTOS-OLDEST-BLOCK-HEIGHT*integer (uint64)

X-APTOS-CURSORstring

Body

version*U64 (string (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"

guid*EventGuid (object)

creation_number*U64 (string (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"

account_address*Address (string (hex))

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "

sequence_number*U64 (string (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"

type*MoveType (string)

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

data*any

The JSON representation of the event

Request

Response

Get events by event handle

GEThttps://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1/accounts/{address}/events/{event_handle}/{field_name}

Path parameters

address*Address (string (hex))

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "

event_handle*MoveStructTag (string)

String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.

It is a combination of:

move_module_address, module_name and struct_name, all joined by ::
struct generic type parameters joined by ,

Examples:

0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>
0x1::account::Account

Note:

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

See doc for more details.

Example: "0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>"

Pattern: ^0x[0-9a-zA-Z:_<>]+$

field_name*IdentifierWrapper (string)

Name of field to lookup event handle e.g. withdraw_events

Query parameters

startU64 (string (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"

limitinteger (uint16)

Max number of events to retrieve.

If unspecified, defaults to default page size

Response

Headers

X-APTOS-CHAIN-ID*integer (uint8)

X-APTOS-LEDGER-VERSION*integer (uint64)

X-APTOS-LEDGER-OLDEST-VERSION*integer (uint64)

X-APTOS-LEDGER-TIMESTAMPUSEC*integer (uint64)

X-APTOS-EPOCH*integer (uint64)

X-APTOS-BLOCK-HEIGHT*integer (uint64)

X-APTOS-OLDEST-BLOCK-HEIGHT*integer (uint64)

X-APTOS-CURSORstring

Body

version*U64 (string (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"

guid*EventGuid (object)

creation_number*U64 (string (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"

account_address*Address (string (hex))

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "

sequence_number*U64 (string (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"

type*MoveType (string)

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

data*any

The JSON representation of the event

Request

Response

Get events by creation number

GEThttps://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1/accounts/{address}/events/{creation_number}

Path parameters

address*Address (string (hex))

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "

creation_number*U64 (string (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"

Query parameters

startU64 (string (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"

limitinteger (uint16)

Max number of events to retrieve.

If unspecified, defaults to default page size

Response

Headers

X-APTOS-CHAIN-ID*integer (uint8)

X-APTOS-LEDGER-VERSION*integer (uint64)

X-APTOS-LEDGER-OLDEST-VERSION*integer (uint64)

X-APTOS-LEDGER-TIMESTAMPUSEC*integer (uint64)

X-APTOS-EPOCH*integer (uint64)

X-APTOS-BLOCK-HEIGHT*integer (uint64)

X-APTOS-OLDEST-BLOCK-HEIGHT*integer (uint64)

X-APTOS-CURSORstring

Body

version*U64 (string (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"

guid*EventGuid (object)

creation_number*U64 (string (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"

account_address*Address (string (hex))

A hex encoded 32 byte Aptos account address.

This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x.

For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.

Example: "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "

sequence_number*U64 (string (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"

type*MoveType (string)

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

data*any

The JSON representation of the event

Request

Response

const response = await fetch('https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1/accounts/{address}/events/{event_handle}/{field_name}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

[
  {
    "version": "32425224034",
    "guid": {
      "creation_number": "32425224034",
      "account_address": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "
    },
    "sequence_number": "32425224034",
    "type": "text"
  }
]

const response = await fetch('https://mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1/accounts/{address}/events/{creation_number}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

[
  {
    "version": "32425224034",
    "guid": {
      "creation_number": "32425224034",
      "account_address": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 "
    },
    "sequence_number": "32425224034",
    "type": "text"
  }
]