Skip to content

Get events by creation number

GET
/accounts/{address}/events/{creation_number}
curl 'https://api.mainnet.aptoslabs.com/v1/accounts/{address}/events/{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.

Parameters

Path Parameters

address
required

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.

string format: hex
0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1

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

string format: uint64
32425224034

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

Query Parameters

start

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.

string format: uint64
32425224034

Starting sequence number of events.

If unspecified, by default will retrieve the most recent events

limit
integer format: uint16

Max number of events to retrieve.

If unspecified, defaults to default page size

Responses

200

Array<object>

An event from a transaction with a version

object
version
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.

string format: uint64
32425224034
guid
required
object
creation_number
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.

string format: uint64
32425224034
account_address
required

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.

string format: hex
0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
sequence_number
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.

string format: uint64
32425224034
type
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::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).
string
/^(bool|u8|u64|u128|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$/
data
required

The JSON representation of the event

Headers

X-APTOS-CHAIN-ID
required
integer format: uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION
required
integer format: uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION
required
integer format: uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC
required
integer format: uint64

Current timestamp of the chain

X-APTOS-EPOCH
required
integer format: uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT
required
integer format: uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT
required
integer format: uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED
integer format: uint64

The cost of the call in terms of gas

X-APTOS-CURSOR
string

Cursor to be used for endpoints that support cursor-based pagination. Pass this to the start field of the endpoint on the next call to get the next page of results.

400

application/json

This is the generic struct we use for all API errors, it contains a string message and an Aptos API specific error code.

object
message
required

A message describing the error

string
error_code
required

These codes provide more granular error information beyond just the HTTP status code of the response.

string
Allowed values: account_not_found resource_not_found module_not_found struct_field_not_found version_not_found transaction_not_found table_item_not_found block_not_found state_value_not_found version_pruned block_pruned invalid_input invalid_transaction_update sequence_number_too_old vm_error health_check_failed mempool_is_full internal_error web_framework_error bcs_not_supported api_disabled
vm_error_code

A code providing VM error details when submitting transactions to the VM

integer format: uint64

Headers

X-APTOS-CHAIN-ID
integer format: uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION
integer format: uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION
integer format: uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC
integer format: uint64

Current timestamp of the chain

X-APTOS-EPOCH
integer format: uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT
integer format: uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT
integer format: uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED
integer format: uint64

The cost of the call in terms of gas

403

application/json

This is the generic struct we use for all API errors, it contains a string message and an Aptos API specific error code.

object
message
required

A message describing the error

string
error_code
required

These codes provide more granular error information beyond just the HTTP status code of the response.

string
Allowed values: account_not_found resource_not_found module_not_found struct_field_not_found version_not_found transaction_not_found table_item_not_found block_not_found state_value_not_found version_pruned block_pruned invalid_input invalid_transaction_update sequence_number_too_old vm_error health_check_failed mempool_is_full internal_error web_framework_error bcs_not_supported api_disabled
vm_error_code

A code providing VM error details when submitting transactions to the VM

integer format: uint64

Headers

X-APTOS-CHAIN-ID
integer format: uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION
integer format: uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION
integer format: uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC
integer format: uint64

Current timestamp of the chain

X-APTOS-EPOCH
integer format: uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT
integer format: uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT
integer format: uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED
integer format: uint64

The cost of the call in terms of gas

404

application/json

This is the generic struct we use for all API errors, it contains a string message and an Aptos API specific error code.

object
message
required

A message describing the error

string
error_code
required

These codes provide more granular error information beyond just the HTTP status code of the response.

string
Allowed values: account_not_found resource_not_found module_not_found struct_field_not_found version_not_found transaction_not_found table_item_not_found block_not_found state_value_not_found version_pruned block_pruned invalid_input invalid_transaction_update sequence_number_too_old vm_error health_check_failed mempool_is_full internal_error web_framework_error bcs_not_supported api_disabled
vm_error_code

A code providing VM error details when submitting transactions to the VM

integer format: uint64

Headers

X-APTOS-CHAIN-ID
integer format: uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION
integer format: uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION
integer format: uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC
integer format: uint64

Current timestamp of the chain

X-APTOS-EPOCH
integer format: uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT
integer format: uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT
integer format: uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED
integer format: uint64

The cost of the call in terms of gas

410

application/json

This is the generic struct we use for all API errors, it contains a string message and an Aptos API specific error code.

object
message
required

A message describing the error

string
error_code
required

These codes provide more granular error information beyond just the HTTP status code of the response.

string
Allowed values: account_not_found resource_not_found module_not_found struct_field_not_found version_not_found transaction_not_found table_item_not_found block_not_found state_value_not_found version_pruned block_pruned invalid_input invalid_transaction_update sequence_number_too_old vm_error health_check_failed mempool_is_full internal_error web_framework_error bcs_not_supported api_disabled
vm_error_code

A code providing VM error details when submitting transactions to the VM

integer format: uint64

Headers

X-APTOS-CHAIN-ID
integer format: uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION
integer format: uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION
integer format: uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC
integer format: uint64

Current timestamp of the chain

X-APTOS-EPOCH
integer format: uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT
integer format: uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT
integer format: uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED
integer format: uint64

The cost of the call in terms of gas

500

application/json

This is the generic struct we use for all API errors, it contains a string message and an Aptos API specific error code.

object
message
required

A message describing the error

string
error_code
required

These codes provide more granular error information beyond just the HTTP status code of the response.

string
Allowed values: account_not_found resource_not_found module_not_found struct_field_not_found version_not_found transaction_not_found table_item_not_found block_not_found state_value_not_found version_pruned block_pruned invalid_input invalid_transaction_update sequence_number_too_old vm_error health_check_failed mempool_is_full internal_error web_framework_error bcs_not_supported api_disabled
vm_error_code

A code providing VM error details when submitting transactions to the VM

integer format: uint64

Headers

X-APTOS-CHAIN-ID
integer format: uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION
integer format: uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION
integer format: uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC
integer format: uint64

Current timestamp of the chain

X-APTOS-EPOCH
integer format: uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT
integer format: uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT
integer format: uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED
integer format: uint64

The cost of the call in terms of gas

503

application/json

This is the generic struct we use for all API errors, it contains a string message and an Aptos API specific error code.

object
message
required

A message describing the error

string
error_code
required

These codes provide more granular error information beyond just the HTTP status code of the response.

string
Allowed values: account_not_found resource_not_found module_not_found struct_field_not_found version_not_found transaction_not_found table_item_not_found block_not_found state_value_not_found version_pruned block_pruned invalid_input invalid_transaction_update sequence_number_too_old vm_error health_check_failed mempool_is_full internal_error web_framework_error bcs_not_supported api_disabled
vm_error_code

A code providing VM error details when submitting transactions to the VM

integer format: uint64

Headers

X-APTOS-CHAIN-ID
integer format: uint8

Chain ID of the current chain

X-APTOS-LEDGER-VERSION
integer format: uint64

Current ledger version of the chain

X-APTOS-LEDGER-OLDEST-VERSION
integer format: uint64

Oldest non-pruned ledger version of the chain

X-APTOS-LEDGER-TIMESTAMPUSEC
integer format: uint64

Current timestamp of the chain

X-APTOS-EPOCH
integer format: uint64

Current epoch of the chain

X-APTOS-BLOCK-HEIGHT
integer format: uint64

Current block height of the chain

X-APTOS-OLDEST-BLOCK-HEIGHT
integer format: uint64

Oldest non-pruned block height of the chain

X-APTOS-GAS-USED
integer format: uint64

The cost of the call in terms of gas