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:

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>

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:

0000000000000000: uint64 representation of 0.
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"
  }
]

Changes

Changed in 3 of the 6 revisions of this API.41522

Aug 7, 2022v12953a57ebb771See the full diff
- ○
  added the required property items/version to the response with the 200 status
  response-required-property-added
Aug 1, 2022v1ad82919b47971518See the full diff
- ●
  added the new bcs_serialization_error enum value to the error_code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new bcs_serialization_error enum value to the error_code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new bcs_serialization_error enum value to the error_code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new invalid_bcs_in_storage_error enum value to the error_code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new invalid_bcs_in_storage_error enum value to the error_code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new invalid_bcs_in_storage_error enum value to the error_code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new invalid_limit_param enum value to the error_code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new invalid_limit_param enum value to the error_code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new invalid_limit_param enum value to the error_code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new invalid_start_param enum value to the error_code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new invalid_start_param enum value to the error_code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new invalid_start_param enum value to the error_code response property for the response status 500
  response-property-enum-value-added
- ●
  added the new read_from_storage_error enum value to the error_code response property for the response status 400
  response-property-enum-value-added
- ●
  added the new read_from_storage_error enum value to the error_code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new read_from_storage_error enum value to the error_code response property for the response status 500
  response-property-enum-value-added
- ○
  removed the BcsSerializationError enum value from the error_code response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the BcsSerializationError enum value from the error_code response property for the response status 404
  response-property-enum-value-removed
- ○
  removed the BcsSerializationError enum value from the error_code response property for the response status 500
  response-property-enum-value-removed
- ○
  removed the InvalidBcsInStorageError enum value from the error_code response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the InvalidBcsInStorageError enum value from the error_code response property for the response status 404
  response-property-enum-value-removed
- ○
  removed the InvalidBcsInStorageError enum value from the error_code response property for the response status 500
  response-property-enum-value-removed
- ○
  removed the InvalidLimitParam enum value from the error_code response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the InvalidLimitParam enum value from the error_code response property for the response status 404
  response-property-enum-value-removed
- ○
  removed the InvalidLimitParam enum value from the error_code response property for the response status 500
  response-property-enum-value-removed
- ○
  removed the InvalidStartParam enum value from the error_code response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the InvalidStartParam enum value from the error_code response property for the response status 404
  response-property-enum-value-removed
- ○
  removed the InvalidStartParam enum value from the error_code response property for the response status 500
  response-property-enum-value-removed
- ○
  removed the ReadFromStorageError enum value from the error_code response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the ReadFromStorageError enum value from the error_code response property for the response status 404
  response-property-enum-value-removed
- ○
  removed the ReadFromStorageError enum value from the error_code response property for the response status 500
  response-property-enum-value-removed
- ○
  removed the UnsupportedAcceptType enum value from the error_code response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the UnsupportedAcceptType enum value from the error_code response property for the response status 404
  response-property-enum-value-removed
- ○
  removed the UnsupportedAcceptType enum value from the error_code response property for the response status 500
  response-property-enum-value-removed
Aug 1, 2022v15db9ba580d7443See the full diff
- ▲
  added the pattern ^0x[0-9a-zA-Z:_<>]+$ to the path request parameter event_handle
  request-parameter-pattern-added
- ▲
  for the path request parameter address, the type/format was changed from string/ to string/hex
  request-parameter-type-changed
- ▲
  for the query request parameter start, the type/format was changed from string/ to string/uint64
  request-parameter-type-changed
- ▲
  the items/type response's property type/format changed from object/ to string/ for status 200
  response-property-type-changed
- ○
  for the path request parameter event_handle, the type/format was generalized from object/ to string/
  request-parameter-type-generalized
- ○
  removed the non-success response with the status 415
  response-non-success-status-removed
- ○
  the items/type response's property pattern ^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_< >]+)$ was added for the status 200
  response-property-pattern-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history