Sign in

v6

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2022-08-07178779.8 KB
Events

Get events by event handle

This API extracts event key from the account resource identified by the event_handle_struct and field_name, then returns events identified by the event key.

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

Path parameters

addressstring hex required

Hex encoded 32 byte Aptos account address

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:

  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_namestring required

Query parameters

startstring uint64

A string containing a 64-bit unsigned integer.

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

Example:32425224034
limitinteger

Response

versionstring uint64 required

A string containing a 64-bit unsigned integer.

We represent u64 values as a string to ensure compatability 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 compatability 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).
{"stackTrail":"components:schemas:VersionedEvent:properties:data","oasType":"schema","type":"unknown"}

Example response

[
  {
    "version": "32425224034",
    "sequence_number": "32425224034"
  }
]