API Reference
Start typing to search…

Get events by creation number

get https://api.shinami.com/aptos/node/v1/accounts//events/

Description

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.

Authentication

Authentication is via an 'Authorization: Bearer YOUR_API_ACCESS_KEY' header (which you must add to the sample requests).

Path Params
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.

string
required

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

Query Params
string

Starting sequence number of events.

If unspecified, by default will retrieve the most recent events

uint16

Max number of events to retrieve.

If unspecified, defaults to default page size

Headers
string
required

An API Access Key tied to the network you want to interact with (Testnet, Mainnet).

Responses

Response body
array of objects
object
string
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.

guid
object
required
string
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
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
required

The JSON representation of the event

Headers
object
uint8

Chain ID of the current chain

uint64

Current ledger version of the chain

uint64

Oldest non-pruned ledger version of the chain

uint64

Current timestamp of the chain

uint64

Current epoch of the chain

uint64

Current block height of the chain

uint64

Oldest non-pruned block height of the chain

uint64

The cost of the call in terms of gas

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.

Updated 27 days ago

Did this page help you?
Language

Updated 27 days ago

Did this page help you?