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

get

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.

Path parameters

addressstring · hexRequired

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_handlestringRequired

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>Pattern: ^0x[0-9a-zA-Z:_<>]+$

field_namestringRequired

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

Query parameters

startstring · uint64Optional

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 · uint16Optional

Max number of events to retrieve.

If unspecified, defaults to default page size

Responses

200Success

application/jsonapplication/x-bcs

400Error

application/json

403Error

application/json

404Error

application/json

410Error

application/json

500Error

application/json

503Error

application/json

get

/accounts/{address}/events/{event_handle}/{field_name}

HTTPcURLJavaScriptPython

GET /v1/<YOUR_API_KEY_HERE>/v1/accounts/{address}/events/{event_handle}/{field_name} HTTP/1.1
Host: mainnet.aptos.validationcloud.io/v1/<YOUR_API_KEY_HERE>/v1
Accept: */*

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