Skip to main content
GET
/
accounts
/
{address}
/
events
/
{event_handle}
/
{field_name}
Get events by event handle
curl --request GET \
  --url https://aptos-mainnet.s.chainbase.online/{api-key}/v1/accounts/{address}/events/{event_handle}/{field_name}
[
  {
    "version": "32425224034",
    "guid": {
      "creation_number": "32425224034",
      "account_address": "0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd"
    },
    "sequence_number": "32425224034",
    "type": "<string>",
    "data": "<unknown>"
  }
]

Path Parameters

​
address
string<hex>
required

Hex-encoded 32 byte Aptos account, with or without a 0x prefix, for which events are queried. This refers to the account that events were emitted to, not the account hosting the move module that emits that event type. 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:

"0xc739507214d0e1bf9795485299d709e00024e92f7c0d055a4c2c39717882bdfd"

​
event_handle
string
required

Name of struct to lookup event handle e.g. 0x1::account::Account 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:

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

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

See doc for more details.

Example:

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

​
field_name
string
required

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

Query Parameters

​
start
string<uint64>

Starting sequence number of events.

If unspecified, by default will retrieve the most recent 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"

​
limit
integer<uint16>

Max number of events to retrieve.

If unspecified, defaults to default page size

Response

​
version
string<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.

Example:

"32425224034"

​
guid
object
required
​
sequence_number
string<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.

Example:

"32425224034"

​
type
string
required

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
required

The JSON representation of the event