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

RootRequestBuilder

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

Builds requests for the root endpoint.

The root endpoint provides information about the Horizon server and the Stellar network it's connected to, including version information, protocol versions, and network passphrase.

Example usage:

val server = HorizonServer("https://horizon.stellar.org")
val rootInfo = server.root().execute()
println("Network: ${rootInfo.networkPassphrase}")
println("Horizon version: ${rootInfo.horizonVersion}")

Parameters

httpClient

The HTTP client to use for requests

serverUri

The base URI of the Horizon server

Constructors

RootRequestBuilder

constructor(httpClient: HttpClient, serverUri: Url)

Creates a RootRequestBuilder

Functions

cursor

open fun cursor(cursor: String): RequestBuilder

Sets the cursor parameter on the request. A cursor is a value that points to a specific location in a collection of resources. The cursor attribute itself is an opaque value meaning that users should not try to parse it.

execute

suspend fun execute(): RootResponse

Executes the request to get root endpoint information.

limit

open fun limit(number: Int): RequestBuilder

Sets the limit parameter on the request. It defines maximum number of records to return. For range and default values check documentation of the endpoint requested.

order

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

Sets the order parameter on the request.

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.