Events

Get events by creation number

Event types are globally identifiable by an account address and monotonically increasing creation_number, one per event type emitted to the given account. This API returns events corresponding to that that event type.

get/accounts/{address}/events/{creation_number}

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.

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

Example:32425224034

Creation number corresponding to the event stream originating from the given account.

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 events

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

{"stackTrail":"components:schemas:VersionedEvent:properties:data","oasType":"schema","type":"unknown","description":"The JSON representation of the event"}

Example response

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

Changes

Changed in 3 of the 50 revisions of this API.762

Oct 9, 20255bfbbc5f3ce7750See the full diff
- ▲
  the mandatory response header X-APTOS-BLOCK-HEIGHT removed for the status 200
  required-response-header-removed
- ▲
  the mandatory response header X-APTOS-CHAIN-ID removed for the status 200
  required-response-header-removed
- ▲
  the mandatory response header X-APTOS-EPOCH removed for the status 200
  required-response-header-removed
- ▲
  the mandatory response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 200
  required-response-header-removed
- ▲
  the mandatory response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 200
  required-response-header-removed
- ▲
  the mandatory response header X-APTOS-LEDGER-VERSION removed for the status 200
  required-response-header-removed
- ▲
  the mandatory response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 200
  required-response-header-removed
- ●
  the optional response header X-APTOS-BLOCK-HEIGHT removed for the status 400
  optional-response-header-removed
- ●
  the optional response header X-APTOS-BLOCK-HEIGHT removed for the status 403
  optional-response-header-removed
- ●
  the optional response header X-APTOS-BLOCK-HEIGHT removed for the status 404
  optional-response-header-removed
- ●
  the optional response header X-APTOS-BLOCK-HEIGHT removed for the status 410
  optional-response-header-removed
- ●
  the optional response header X-APTOS-BLOCK-HEIGHT removed for the status 500
  optional-response-header-removed
- ●
  the optional response header X-APTOS-BLOCK-HEIGHT removed for the status 503
  optional-response-header-removed
- ●
  the optional response header X-APTOS-CHAIN-ID removed for the status 400
  optional-response-header-removed
- ●
  the optional response header X-APTOS-CHAIN-ID removed for the status 403
  optional-response-header-removed
- ●
  the optional response header X-APTOS-CHAIN-ID removed for the status 404
  optional-response-header-removed
- ●
  the optional response header X-APTOS-CHAIN-ID removed for the status 410
  optional-response-header-removed
- ●
  the optional response header X-APTOS-CHAIN-ID removed for the status 500
  optional-response-header-removed
- ●
  the optional response header X-APTOS-CHAIN-ID removed for the status 503
  optional-response-header-removed
- ●
  the optional response header X-APTOS-CURSOR removed for the status 200
  optional-response-header-removed
- ●
  the optional response header X-APTOS-EPOCH removed for the status 400
  optional-response-header-removed
- ●
  the optional response header X-APTOS-EPOCH removed for the status 403
  optional-response-header-removed
- ●
  the optional response header X-APTOS-EPOCH removed for the status 404
  optional-response-header-removed
- ●
  the optional response header X-APTOS-EPOCH removed for the status 410
  optional-response-header-removed
- ●
  the optional response header X-APTOS-EPOCH removed for the status 500
  optional-response-header-removed
- ●
  the optional response header X-APTOS-EPOCH removed for the status 503
  optional-response-header-removed
- ●
  the optional response header X-APTOS-GAS-USED removed for the status 200
  optional-response-header-removed
- ●
  the optional response header X-APTOS-GAS-USED removed for the status 400
  optional-response-header-removed
- ●
  the optional response header X-APTOS-GAS-USED removed for the status 403
  optional-response-header-removed
- ●
  the optional response header X-APTOS-GAS-USED removed for the status 404
  optional-response-header-removed
- ●
  the optional response header X-APTOS-GAS-USED removed for the status 410
  optional-response-header-removed
- ●
  the optional response header X-APTOS-GAS-USED removed for the status 500
  optional-response-header-removed
- ●
  the optional response header X-APTOS-GAS-USED removed for the status 503
  optional-response-header-removed
- ●
  the optional response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 400
  optional-response-header-removed
- ●
  the optional response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 403
  optional-response-header-removed
- ●
  the optional response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 404
  optional-response-header-removed
- ●
  the optional response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 410
  optional-response-header-removed
- ●
  the optional response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 500
  optional-response-header-removed
- ●
  the optional response header X-APTOS-LEDGER-OLDEST-VERSION removed for the status 503
  optional-response-header-removed
- ●
  the optional response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 400
  optional-response-header-removed
- ●
  the optional response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 403
  optional-response-header-removed
- ●
  the optional response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 404
  optional-response-header-removed
- ●
  the optional response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 410
  optional-response-header-removed
- ●
  the optional response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 500
  optional-response-header-removed
- ●
  the optional response header X-APTOS-LEDGER-TIMESTAMPUSEC removed for the status 503
  optional-response-header-removed
- ●
  the optional response header X-APTOS-LEDGER-VERSION removed for the status 400
  optional-response-header-removed
- ●
  the optional response header X-APTOS-LEDGER-VERSION removed for the status 403
  optional-response-header-removed
- ●
  the optional response header X-APTOS-LEDGER-VERSION removed for the status 404
  optional-response-header-removed
- ●
  the optional response header X-APTOS-LEDGER-VERSION removed for the status 410
  optional-response-header-removed
- ●
  the optional response header X-APTOS-LEDGER-VERSION removed for the status 500
  optional-response-header-removed
- ●
  the optional response header X-APTOS-LEDGER-VERSION removed for the status 503
  optional-response-header-removed
- ●
  the optional response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 400
  optional-response-header-removed
- ●
  the optional response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 403
  optional-response-header-removed
- ●
  the optional response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 404
  optional-response-header-removed
- ●
  the optional response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 410
  optional-response-header-removed
- ●
  the optional response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 500
  optional-response-header-removed
- ●
  the optional response header X-APTOS-OLDEST-BLOCK-HEIGHT removed for the status 503
  optional-response-header-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 3, 20256a8502f67ac16See the full diff
- ●
  added the new rejected_by_filter enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new rejected_by_filter enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new rejected_by_filter enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new rejected_by_filter enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new rejected_by_filter enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new rejected_by_filter enum value to the response property for the response status
  response-property-enum-value-added
May 16, 202328d6217d15796See the full diff
- ●
  added the new state_value_not_found enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new state_value_not_found enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new state_value_not_found enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new state_value_not_found enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new state_value_not_found enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new state_value_not_found enum value to the response property for the response status
  response-property-enum-value-added

Full history