Skip to main content

/v1/events REST API Endpoint

Retrieve on-chain events by their name within specified block heights or IDs.

Updated on
Oct 04, 2023

Parameters

type
string
REQUIRED

The type of event and also called as the identifier of the event

start_height
string

The starting height of the block range for events. It must be used with end_height. This parameter is incompatible with block_ids

end_height
string

The ending height of the block range for events. It must be used with start_height. This parameter is incompatible with block_ids

block_ids
string

The list of block IDs. Either provide block_ids or both height parameters. This parameter is incompatible with both heights parameters

select
string

A comma-separated list indicating which properties of the content to return

Returns

array
array

An array of event result objects for the requested block range or block IDs

block_id
string

The id of the block

block_height
string

The height of the block

block_timestamp
string

The timestamp associated with the block

events
array

An array of events that were emitted during the execution of the transactions. It contains the following fields:

type
string

The type of the event, which is typically a string that identifies the purpose or function of the event

transaction_id
string

The unique id of the transaction that emitted the event

transaction_index
string

The index of the transaction that emitted the event

event_index
string

The index of the event within the transaction

payload
string

The data payload associated with the event, which can be used to provide additional information about the event

_links
object

An object that contains links to related resources or endpoints

_self
string

It is a link that refers to the current resource itself

Request
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free