Events

Get events by event handle

Changed on Oct 9, 2025

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.

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

Request

Base URL
/v1 (relative, and the document was published on a file host, not at the API’s origin)
URL
/v1/accounts/{address}/events/{event_handle}/{field_name}
Auth
none declared

Path parameters

addressstring hex required

A hex encoded 32 byte Lumio 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.

Hex-encoded 32 byte Lumio 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.

event_handlestring required

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::lumio_coin::LumioCoin>
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::lumio_coin::LumioCoin>

Name of struct to lookup event handle e.g. 0x1::account::Account

field_namestring required

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

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

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.

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 - 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::lumio_coin::LumioCoin>>`

Struct type value examples:
  - `0x1::coin::CoinStore<0x1::lumio_coin::LumioCoin>
  - `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",
    "guid": {
      "creation_number": "32425224034"
    },
    "sequence_number": "32425224034"
  }
]

Changes

Oct 9, 20255bfbbc5f3ce7 Revision changes
- breaking
  the mandatory response header X-APTOS-BLOCK-HEIGHT removed for the status 200
- breaking
  the mandatory response header X-APTOS-CHAIN-ID removed for the status 200
- breaking
  the mandatory response header X-APTOS-EPOCH removed for the status 200
- breaking
  the mandatory response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 200
- breaking
  the mandatory response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 200
- breaking
  the mandatory response header X-APTOS-LEDGER-VERSION removed for the status 200
- breaking
  the mandatory response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 200
- warning
  the optional response header X-APTOS-BLOCK-HEIGHT removed for the status 400
- warning
  the optional response header X-APTOS-BLOCK-HEIGHT removed for the status 403
- warning
  the optional response header X-APTOS-BLOCK-HEIGHT removed for the status 404
- warning
  the optional response header X-APTOS-BLOCK-HEIGHT removed for the status 410
- warning
  the optional response header X-APTOS-BLOCK-HEIGHT removed for the status 500
- warning
  the optional response header X-APTOS-BLOCK-HEIGHT removed for the status 503
- warning
  the optional response header X-APTOS-CHAIN-ID removed for the status 400
- warning
  the optional response header X-APTOS-CHAIN-ID removed for the status 403
- warning
  the optional response header X-APTOS-CHAIN-ID removed for the status 404
- warning
  the optional response header X-APTOS-CHAIN-ID removed for the status 410
- warning
  the optional response header X-APTOS-CHAIN-ID removed for the status 500
- warning
  the optional response header X-APTOS-CHAIN-ID removed for the status 503
- warning
  the optional response header X-APTOS-CURSOR removed for the status 200
- warning
  the optional response header X-APTOS-EPOCH removed for the status 400
- warning
  the optional response header X-APTOS-EPOCH removed for the status 403
- warning
  the optional response header X-APTOS-EPOCH removed for the status 404
- warning
  the optional response header X-APTOS-EPOCH removed for the status 410
- warning
  the optional response header X-APTOS-EPOCH removed for the status 500
- warning
  the optional response header X-APTOS-EPOCH removed for the status 503
- warning
  the optional response header X-APTOS-GAS-USED removed for the status 200
- warning
  the optional response header X-APTOS-GAS-USED removed for the status 400
- warning
  the optional response header X-APTOS-GAS-USED removed for the status 403
- warning
  the optional response header X-APTOS-GAS-USED removed for the status 404
- warning
  the optional response header X-APTOS-GAS-USED removed for the status 410
- warning
  the optional response header X-APTOS-GAS-USED removed for the status 500
- warning
  the optional response header X-APTOS-GAS-USED removed for the status 503
- warning
  the optional response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 400
- warning
  the optional response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 403
- warning
  the optional response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 404
- warning
  the optional response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 410
- warning
  the optional response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 500
- warning
  the optional response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 503
- warning
  the optional response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 400
- warning
  the optional response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 403
- warning
  the optional response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 404
- warning
  the optional response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 410
- warning
  the optional response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 500
- warning
  the optional response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 503
- warning
  the optional response header X-APTOS-LEDGER-VERSION removed for the status 400
- warning
  the optional response header X-APTOS-LEDGER-VERSION removed for the status 403
- warning
  the optional response header X-APTOS-LEDGER-VERSION removed for the status 404
- warning
  the optional response header X-APTOS-LEDGER-VERSION removed for the status 410
- warning
  the optional response header X-APTOS-LEDGER-VERSION removed for the status 500
- warning
  the optional response header X-APTOS-LEDGER-VERSION removed for the status 503
- warning
  the optional response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 400
- warning
  the optional response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 403
- warning
  the optional response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 404
- warning
  the optional response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 410
- warning
  the optional response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 500
- warning
  the optional response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 503
Jun 3, 20256a8502f67ac1 Revision changes
- warning
  added the new rejected_by_filter enum value to the response property for the response status
- warning
  added the new rejected_by_filter enum value to the response property for the response status
- warning
  added the new rejected_by_filter enum value to the response property for the response status
- warning
  added the new rejected_by_filter enum value to the response property for the response status
- warning
  added the new rejected_by_filter enum value to the response property for the response status
- warning
  added the new rejected_by_filter enum value to the response property for the response status

Operation history (3 revisions)

Get events by event handle

Request

Path parameters

Query parameters

Response 200OK

Example response

Changes

Response