Comment on page
Get events by event handle

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.
Path Parameters:
address string required
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.
event_handle string<uint64> required
Name of struct to lookup event handle e.g. 0x1::account::Account
field_name string required
Name of field to lookup event handle e.g. withdraw_events
Query Parameters：
limit integer
Max number of events to retrieve. If unspecified, defaults to default page size.
start string<uint64>
Starting sequence number of events. If unspecified, by default will retrieve the most recent events
Response Header:
X-APTOS-BLOCK-HEIGHT integer 
Current block height of the chain
X-APTOS-CHAIN-ID integer 
Chain ID of the current chain
X-APTOS-EPOCH integer 
Current epoch of the chain
X-APTOS-LEDGER-OLDEST-VERSION integer 
Oldest non-pruned ledger version of the chain
X-APTOS-LEDGER-TIMESTAMPUSEC integer 
Current timestamp of the chain
X-APTOS-LEDGER-VERSION integer 
Current ledger version of the chain
X-APTOS-OLDEST-BLOCK-HEIGHT integer 
Oldest non-pruned block height of the chain
Response Body:
array of:
version string<uint64>
A string containing a 64-bit unsigned integer.
guid object 
    creation_number string<uint64>
    A string containing a 64-bit unsigned integer.Show all...
    account_address string<hex>
    A hex encoded 32 byte Aptos account address.Show all...
sequence_number string<uint64>
A string containing a 64-bit unsigned integer.
type string
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}>...
data
The JSON representation of the event
Example:
// Request
curl -X GET -H 'Content-Type: application/json' https://aptos.blockpi.network/aptos/v1/your_api_key/v1/accounts/0x6de517a18f003625e7fba9b9dc29b310f2e3026bbeb1997b3ada9de1e3cec8d6/events//0x1%3A%3Acoin%3A%3ACoinStore%3C0x1%3A%3Aaptos_coin%3A%3AAptosCoin%3E/withdraw_events
​
// Result
[
    {
        "version": "36173260",
        "guid": {
            "creation_number": "3",
            "account_address": "0x1deca4ed8fe4c606db4af334621e97f5c23a7aec1a262d0d15e513aba830daee"
        },
        "sequence_number": "0",
        "type": "0x1::coin::WithdrawEvent",
        "data": {
            "amount": "1188990000"
        }
    }
]
Get events by creation number
Show OpenAPI explorer
Last modified 1yr ago