stellar-sdk/com.soneso.stellar.sdk.rpc.requests/GetEventsRequest

GetEventsRequest

@Serializable

data class GetEventsRequest(val startLedger: Long? = null, val endLedger: Long? = null, val filters: List<GetEventsRequest.EventFilter>, val pagination: GetEventsRequest.Pagination? = null)

Request for JSON-RPC method getEvents.

Fetches a filtered list of events emitted by a given ledger range.

See also

getEvents documentation

Constructors

GetEventsRequest

constructor(startLedger: Long? = null, endLedger: Long? = null, filters: List<GetEventsRequest.EventFilter>, pagination: GetEventsRequest.Pagination? = null)

Types

@Serializable

data class EventFilter(val type: GetEventsRequest.EventFilterType? = null, val contractIds: List<String>? = null, val topics: List<List<String>>? = null)

Filter configuration for event matching.

EventFilterType

@Serializable

enum EventFilterType : Enum<GetEventsRequest.EventFilterType>

Type of event to filter.

@Serializable

data class Pagination(val cursor: String? = null, val limit: Long? = null)

Pagination options for controlling the number of results returned.

Properties

val endLedger: Long?

Ledger sequence number to end fetching events (inclusive). Optional. Must be greater than startLedger if both are provided. Must be omitted when cursor is provided.

val filters: List<GetEventsRequest.EventFilter>

List of event filters to match against. Events matching any filter will be included. Maximum 5 filters allowed. Can be empty to match all events.

val pagination: GetEventsRequest.Pagination?

Optional pagination configuration for limiting and controlling result sets.

val startLedger: Long?

Ledger sequence number to start fetching events from (inclusive). Required when pagination.cursor is null. Must be omitted when cursor is provided.