stellar-sdk/com.soneso.stellar.sdk.horizon.requests/LedgersRequestBuilder

LedgersRequestBuilder

class LedgersRequestBuilder(httpClient: HttpClient, serverUri: Url) : RequestBuilder

Builds requests connected to ledgers.

Ledgers are the foundation of the Stellar network. They represent the state of the network at a particular point in time and contain all the changes (transactions) that have occurred since the previous ledger.

Example usage:

val server = HorizonServer("https://horizon.stellar.org")

// Get a specific ledger by sequence
val ledger = server.ledgers().ledger(12345)

// Get a page of ledgers
val ledgers = server.ledgers()
    .limit(10)
    .order(Order.DESC)
    .execute()

Constructors

LedgersRequestBuilder

constructor(httpClient: HttpClient, serverUri: Url)

Functions

cursor

open override fun cursor(cursor: String): LedgersRequestBuilder

Sets the cursor parameter for pagination.

execute

suspend fun execute(): Page<LedgerResponse>

Build and execute request to get a page of ledgers.

ledger

suspend fun ledger(sequence: Long): LedgerResponse

Requests a specific ledger by sequence number.

limit

open override fun limit(number: Int): LedgersRequestBuilder

Sets the limit parameter defining maximum number of ledgers to return.

order

open override fun order(direction: RequestBuilder.Order): LedgersRequestBuilder

Sets the order parameter defining the order in which to return ledgers.

stream

fun <T : Response> stream(serializer: KSerializer<T>, listener: EventListener<T>, reconnectTimeout: Duration = SSEStream.DEFAULT_RECONNECT_TIMEOUT): SSEStream<T>

Creates a Server-Sent Events (SSE) stream for this request. The stream will automatically reconnect on connection loss and resume from the last received event.

LedgersRequestBuilder

See also

Constructors

Functions